java依赖管理和构建工具Maven

July 19, 2022

Apache Maven is a software project management and comprehension tool. Based on the concept of a project object model (POM), Maven can manage a project's build, reporting and documentation from a central piece of information.

Maven 镜像

进入~/.m2目录（Windows 下为%USERPROFILE%/.m2），新建settings.xml文件，内容修改为

xml

<settings>
    <mirrors>
        <mirror>
            <id>aliyun</id>
            <name>aliyun</name>
            <mirrorOf>central</mirrorOf>
            <url>https://maven.aliyun.com/repository/central</url>
        </mirror>
    </mirrors>
</settings>

新建一个项目

https://maven.apache.org/guides/getting-started/maven-in-five-minutes.html

mvn archetype:generate -DgroupId=com.mycompany.app -DartifactId=my-app -DarchetypeArtifactId=maven-archetype-quickstart -DarchetypeVersion=1.4 -DinteractiveMode=false

第一次运行这个命令会下载一些 artifacts(plugin jars and other files)
生成my-app文件夹，含以下目录结构

my-app
 │  pom.xml
 │
 └─src
     ├─main
     │  └─java
     │      └─com
     │          └─mycompany
     │              └─app
     │                      App.java
     │
     └─test
         └─java
             └─com
                 └─mycompany
                     └─app
                             AppTest.java

在 pom.xml 中可以看到项目名、包名和版本
与指定 -DgroupId=com.mycompany.app -DartifactId=my-app 的一致

xml

<groupId>com.mycompany.app</groupId>
<artifactId>my-app</artifactId>
<version>1.0-SNAPSHOT</version>

项目属性，构建选项

xml

<properties>
  <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  <maven.compiler.source>1.7</maven.compiler.source>
  <maven.compiler.target>1.7</maven.compiler.target>
</properties>

依赖

xml

<dependencies>
  <dependency>
    <groupId>junit</groupId>
    <artifactId>junit</artifactId>
    <version>4.11</version>
    <scope>test</scope>
  </dependency>
</dependencies>

What did I just do?
You executed the Maven goal archetype:generate, and passed in various parameters to that goal. The prefix archetype is the plugin that provides the goal. If you are familiar with Ant, you may conceive of this as similar to a task. This archetype:generate goal created a simple project based upon a maven-archetype-quickstart archetype. Suffice it to say for now that a plugin is a collection of goals with a general common purpose. For example the jboss-maven-plugin, whose purpose is "deal with various jboss items".

执行以下命令构建这个项目

mvn package

运行构建产物

java -cp target/my-app-1.0-SNAPSHOT.jar com.mycompany.app.App

输出

Hello World!

注意，如果需要支持 java9 及以上，需要指定pom.xml ，例如：

xml

    <properties>
        <maven.compiler.release>11</maven.compiler.release>
    </properties>

    <build>
        <pluginManagement>
            <plugins>
                <plugin>
                    <groupId>org.apache.maven.plugins</groupId>
                    <artifactId>maven-compiler-plugin</artifactId>
                    <version>3.8.1</version>
                </plugin>
            </plugins>
        </pluginManagement>
    </build>

一些命令

https://maven.apache.org/guides/getting-started/index.html

编译应用源码

mvn compile

编译后的 class 文件将置于 ${basedir}/target/classes 文件夹

编译测试和运行单元测试

mvn test

如果只编译测试不运行，则执行以下命令

mvn test-compile

生成 jar 文件

mvn package

jar 文件将生成至 ${basedir}/target目录

安装至本地仓库

mvn install

生成文档网站

mvn site

清理 target 文件夹

mvn clean

添加资源至 jar 包

所有置于 ${basedir}/src/main/resources 目录的文件都会被打包至 jar 文件，并且资源文件相对于 jar 包根路径有相同的目录结构

添加依赖

https://search.maven.org/

依赖定义于 pom.xml 如下

xml

<dependencies>
  <dependency>
    <groupId>junit</groupId>
    <artifactId>junit</artifactId>
    <version>4.11</version>
    <scope>test</scope>
  </dependency>
</dependencies>

依赖有四种类型：compile provided runtime test

Maven 读取依赖的顺序是，先在 ~/.m2/repository （本地仓库）查找，没有查找到则在远程仓库（中央仓库）查找

生命周期

Maven 中存在三种生命周期：clean、default、site，分别用于清理项目、构建项目、生成项目站点，而在一个生命周期中通常又会包含若干个 phase（阶段）

default 生命周期是所有生命周期中最核心部分，包括以下 phase

validate
initialize
generate-sources
process-sources
generate-resources
process-resources
compile
process-classes
generate-test-sources
process-test-sources
generate-test-resources
process-test-resources
test-compile
process-test-classes
test
prepare-package
package
pre-integration-test
integration-test
post-integration-test
verify
install
deploy

例如，运行 mvn package 后，Maven 执行 default 生命周期，将运行 validate 到 package 之间（闭区间）的所有 phase

clean 生命周期（lifecycle），包括以下 phase

pre-clean
clean
post-clean

上文介绍了一些 mvn 命令，实际上，命令还可以指定多个 phase，这些 phase 依次进行，例如

mvn clean compile # 清理后编译
mvn clean package # 清理后打包

执行 phase 时，触发多个 goal。goal 的命名总是 abc:xyz 这种形式。

例如，执行 test 时，触发 compiler:testCompile surefire:test

也可以直接指定执行 goal，例如 mvn tomcat:run

注：也可以这样执行 goal：

mvn [groupId]:[artifactId]:[version]:[goalName]
mvn org.apache.maven.plugins:maven-dependency-plugin:2.1:list

一个 Maven 插件中，可以具备一个或多个功能，插件功能实现了 goal。

因此，phase 实际上是绑定到一个或多个 goal 工作，goal 由 plugin 提供

Maven 自带 phase 绑定了如下 goal

生命周期（lifecycle）	阶段（phase）	目标（goal）
clean	clean	maven-clean-plugin:clean
default	process-resources	maven-resources-plugin:resources
	compile	maven-compiler-plugin:compile
	process-test-resources	maven-resources-plugin:testResources
	test	maven-surefire-plugin:test
	package	maven-jar-plugin:jar
	install	maven-install-plugin:install
	deploy	maven-deploy-plugin:deploy
site	site	maven-site-plugin:site
site	site-deploy	maven-site-plugin:deploy

其余绑定需要在 pom.xml 中配置，例如

xml

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-source-plugin</artifactId>
    <version>2.1.1</version>
    <executions>
        <execution>
            <id>attach-sources</id>
            <phase>package</phase>
            <goals>
                <goal>jar-no-fork</goal>
            </goals>
        </execution>
    </executions>
</plugin>