Maven2使用项目开发规范说明.doc

《Maven2使用项目开发规范说明》，图文并茂，详细介绍了使用 Maven2 开发一个规范项目的流程。 目录： 1. 环境配置 3 1.1. 配置Maven2 3 1.2. 配置Eclipse环境变量MIA_LIB 4 1.3. 安装Maven2 的eclipse plugin 4 2. Maven2使用说明 5 2.1. 简单例子 5 2.2. groupId, artifactId, version的作用 7 2.3. Maven2的plugin, goal和phase的说明 8 2.3.1. plugin和goal 8 2.3.2. phase 9 2.3.3. plugin goal与phase的区别 10 2.3.4. 命令行一次执行多个 goal或phase 12 2.4. 几个常用的phase: clean, compile, package, install 12 2.5. 工程依赖jar包的设置 13 2.5.1. 设置说明 13 2.5.2. 关于maven2资源库 15 2.6. 手动安装jar包到本地资源库 16 2.7. 使用maven编译项目代码注意事项 17 3. 构建项目规范说明 18 3.1. 项目目录结构 18 3.2. 设置groupId, artifactId规范 20 3.3. 在Eclipse要引用的jar包设置规范 20 3.4. MIA_LIB维护更新规范 22 4. 参考资料链接 23 ### Maven2使用项目开发规范说明 #### 环境配置 **1.1. 配置Maven2** 为了能够顺利地使用Maven2进行项目开发，首先需要正确配置Maven2环境。按照以下步骤进行操作： 1. **下载与安装Maven2：** - 将Maven2从服务器（例如：`\\192.168.22.51\Group\MIA\开发环境\tool\apache-maven-2.2.1`）复制到本地机器，例如放置在`D:\work\apache-maven-2.2.1`目录下。 2. **配置系统环境变量Path：** - 在系统的环境变量设置中添加Maven2的bin目录。例如，如果Maven2被安装在`D:\work\apache-maven-2.2.1`目录下，则需要将`D:\work\apache-maven-2.2.1\bin`添加到Path环境变量中。 3. **配置本地资源库：** - 使用版本控制系统（如SVN）从指定地址（例如`http://192.168.22.53/svn/mobile_mia/mlib/`）checkout资源库到本地机器的一个目录中，例如`D:\work\mlib`。 - 修改Maven2安装目录下的`conf\settings.xml`文件，将其中的`<localRepository>`元素的值设置为前面提到的资源库路径。例如： ```xml <localRepository>D:/work/mlib</localRepository> ``` **1.2. 配置Eclipse环境变量MIA_LIB** 为了使Eclipse能够正确地引用Maven项目的本地资源库，需要配置Eclipse的环境变量MIA_LIB。具体步骤如下： 1. 打开Eclipse，进入“Window”->“Preferences”。 2. 在弹出的窗口中，定位到相应的配置选项，并设置MIA_LIB环境变量指向Maven2的`<localRepository>`目录。 **1.3. 安装Maven2的Eclipse插件** 为了更好地集成Maven2到Eclipse中，需要安装Maven2的Eclipse插件。可以通过Eclipse的更新功能来完成这一过程，具体步骤如下： 1. 打开Eclipse，进入“Help”->“Install New Software...”。 2. 在“Work with:”输入框中输入Maven2 Eclipse插件的安装地址，例如：`http://m2eclipse.sonatype.org/update`。 3. 选择需要安装的组件，然后点击“Next”按钮，按照提示完成安装过程。 #### Maven2使用说明 **2.1. 简单例子** 创建一个新的Maven2项目，并定义其基本结构，包括必要的目录和文件。一个典型的项目结构如下： - `src/main/java`：存放主要的Java源代码。 - `src/main/resources`：存放应用资源文件。 - `src/test/java`：存放测试相关的Java源代码。 - `src/test/resources`：存放测试相关的资源文件。 **2.2. groupId, artifactId, version的作用** - **groupId**：表示项目所在的组织或者公司，通常采用反向域名的形式。 - **artifactId**：表示项目本身的名字。 - **version**：表示项目的版本号。 这些元数据对于构建项目、管理依赖以及部署等都是至关重要的。 **2.3. Maven2的plugin, goal和phase的说明** - **plugin**：插件是Maven的核心组成部分，它提供了具体的构建逻辑。 - **goal**：插件中定义的具体任务。 - **phase**：构建过程中的一系列阶段。 **2.3.1. plugin和goal** - **plugin**：每个插件都对应一组特定的功能，例如编译源代码、打包等。 - **goal**：每个插件都有一个或多个目标（goal），用于实现不同的功能。 **2.3.2. phase** 构建生命周期中的不同阶段，例如： - `clean`：清理项目的输出目录。 - `compile`：编译源代码。 - `package`：打包项目。 - `install`：安装构建结果到本地仓库。 **2.3.3. plugin goal与phase的区别** - **goal**：执行具体的构建任务。 - **phase**：定义了整个构建过程中的各个阶段。 **2.3.4. 命令行一次执行多个goal或phase** 可以通过命令行同时执行多个goal或phase，例如： - `mvn clean compile test` - `mvn install -P release` **2.4. 几个常用的phase: clean, compile, package, install** - **clean**：删除项目构建产生的文件，如编译后的class文件。 - **compile**：编译项目源代码。 - **package**：将编译后的代码打包成可发布的格式。 - **install**：将打包后的项目安装到本地仓库中。 **2.5. 工程依赖jar包的设置** - **设置说明**：在`pom.xml`文件中定义项目的依赖关系。 - **关于maven2资源库**：Maven2会自动查找远程和本地资源库中的依赖，并将其下载到本地仓库中。 **2.6. 手动安装jar包到本地资源库** 有时候可能需要手动将一些第三方的jar包安装到本地仓库中，可以通过命令行工具`mvn install:install-file`来实现。 **2.7. 使用maven编译项目代码注意事项** - 确保所有的依赖都已经正确配置。 - 遵循Maven的最佳实践，比如使用标准目录结构。 - 在`pom.xml`文件中正确配置插件的目标（goal）。 #### 构建项目规范说明 **3.1. 项目目录结构** Maven2项目应遵循标准的目录结构，这有助于统一管理和构建项目。 **3.2. 设置groupId, artifactId规范** 为了便于管理，需要遵循一定的命名规范。例如： - `groupId`：`com.example.organization`。 - `artifactId`：`example-project`。 **3.3. 在Eclipse要引用的jar包设置规范** 确保所有外部依赖都被正确地添加到了项目的构建路径中。 **3.4. MIA_LIB维护更新规范** 对于MIA_LIB的维护和更新，需要制定相应的规则，以保证资源库的稳定性和有效性。 通过上述步骤，可以有效地利用Maven2进行项目的开发和管理，提高开发效率，保证代码质量。