Apache Maven

从官网下载 Maven 包后，解压后，把其 bin 子目录加入到环境变量 PATH 中即可使用。

可以用命令 mvn -v 来测试安装是否成功，如：

$ mvn -v
Apache Maven 3.3.3 (7994120775791599e205a5524ec3e0dfe41d4a06; 2015-04-22T04:57:37-07:00)
Maven home: /opt/apache-maven-3.3.3
Java version: 1.8.0_45, vendor: Oracle Corporation
Java home: /Library/Java/JavaVirtualMachines/jdk1.8.0_45.jdk/Contents/Home/jre
Default locale: en_US, platform encoding: UTF-8
OS name: "mac os x", version: "10.8.5", arch: "x86_64", family: "mac"

参考：https://maven.apache.org/install.html

mvn 命令的基本格式如下：

$ mvn [options] [<goal(s)>] [<phase(s)>]

可以用下面命令得到选项的帮助文档：

$ mvn -h

参考：Maven in 5 Minutes

Maven 会自动从远程 Repositories 中下载依赖包到本地仓库。本地仓库位于：

~/.m2/repository                  # Unix-like system
C:\Users\username\.m2\repository  # Windows

下面是一个 minimum pom 文件的例子：

<project>
  <modelVersion>4.0.0</modelVersion>
  <groupId>com.mycompany.app</groupId>
  <artifactId>my-app</artifactId>
  <version>1</version>
</project>

其中， groupId, artifactId, version 必须存在，它们用来标识一个工程。

参考：https://maven.apache.org/guides/introduction/introduction-to-the-pom.html#Project_Inheritance

工程比较大时，往往分成几个子工程。每个子工程都有自己的 POM 文件，设置它们为父子关系，构造父工程就会构建所有的子工程。子工程的 POM 会继承父工程的 POM 中的设置。

所有的 POM 都继承于 Super POM，它设置了一些默认值。
有效 POM(Effective POM)就是 Project POM 加上 Supper POM，可以用命令 mvn help:effective-pom 查看有效 POM。

下面这些元素会在父子工程中合并：

• dependencies
  
• developers and contributors
  
• plugin lists (including reports)
  
• plugin executions with matching ids
  
• plugin configuration
  
• resources
  

参考：https://maven.apache.org/guides/introduction/introduction-to-dependency-mechanism.html#Importing_Dependencies

用 Maven 可以方便地管理依赖关系。依赖关系定义在 POM.xml 文件的 dependencies 元素中。
如，前面介绍的 Hello World 工程的 POM.xml 文件中有下面片断：

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

在 Maven 中，依赖是传递的。假设工程 A 依赖于库 B，而库 B 依赖于库 C。这时工程 A 显然也会依赖于库 C，但我们在工程 A 的配置中 只需要指定它的直接依赖关系（即库 B），而不用指定它的间接依赖（即库 C） ，Maven 会自动找到库 C（这个信息可以从库 B 的配置中找到）。如，前面例子中 junit 其实也会依赖于其它的包，但我们不需要关心它，如果本地库中不存在，Maven 会自动下载它们。

如何查看 Plugin 有哪些 Goal？

方法一：直接在官网上查看。http://maven.apache.org/plugins/index.html
方法二：用命令 mvn <plugin-name>:help 或者 mvn help:describe -Dplugin=<plugin-name> 。例如：

$ mvn help:describe -Dplugin=compiler
[INFO] org.apache.maven.plugins:maven-compiler-plugin:2.5.1

Maven Compiler Plugin
  The Compiler Plugin is used to compile the sources of your project.

This plugin has 3 goals:

compiler:compile
  Compiles application sources

compiler:help
  Display help information on maven-compiler-plugin.
  Call
    mvn compiler:help -Ddetail=true -Dgoal=<goal-name>
  to display parameter details.

compiler:testCompile
  Compiles application test sources.

maven 不会使用环境变量 http_proxy/https_proxy 中的配置，可以在 settings.xml 文件中配置代理。

可以使用类似于下面的内容来设置 proxy（设置了两个 proxy，分别用于 http 协议和 https 协议）：

<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
                      https://maven.apache.org/xsd/settings-1.0.0.xsd">
  <proxies>
    <proxy>
      <id>myproxy1</id>
      <active>true</active>
      <protocol>http</protocol>
      <host>proxy.somewhere.com</host>
      <port>8080</port>
      <username>proxyuser</username>
      <password>somepassword</password>
      <nonProxyHosts>localhost|127.0.0.1</nonProxyHosts>
    </proxy>
    <proxy>
      <id>myproxy2</id>
      <active>true</active>
      <protocol>https</protocol>
      <host>proxy.somewhere.com</host>
      <port>8080</port>
      <username>proxyuser</username>
      <password>somepassword</password>
      <nonProxyHosts>localhost|127.0.0.1</nonProxyHosts>
    </proxy>
  </proxies>
</settings>

注：上面设置中，如果 proxy 服务器不需要 username, password 可以省略它们。

有时工程依赖的 jar 包（比如自己写了一个 ldapjdk.jar）不在公共仓库中，这时如何把它加入到 maven 的依赖中呢？

方法一（不推荐）：把依赖配置为 system scope。
把依赖的 scope 中配置为 system，并且把依赖的 systemPath 中指定 jar 包的路径。如：

<project xmlns="http://maven.apache.org/POM/4.0.0"

   ......
   <dependencies>
      ......
      <dependency>
         <groupId>test</groupId>
         <artifactId>ldapjdk</artifactId>
         <scope>system</scope>
         <version>1.0</version>
         <systemPath>${project.basedir}/lib/ldapjdk.jar</systemPath>
      </dependency>
   </dependencies>
</project>

注：使用 jar-with-dependencies 打包时，system scope 的 jar 包不会被包含，你可以通过配置复制 resources 来包含这个 jar 包。不推荐使用这种方式。
参考：https://www.tutorialspoint.com/maven/maven_external_dependencies.htm

方法二（推荐）：建立本地仓库。
可以建立一个本地仓库，这样引入本地仓库中的依赖和引入公共仓库中的依赖完全相同。

<project xmlns="http://maven.apache.org/POM/4.0.0"

   ......
   <dependencies>
      ......
      <dependency>
         <groupId>test</groupId>
         <artifactId>ldapjdk</artifactId>
         <version>1.0</version>
      </dependency>
   </dependencies>

  <repositories>
    <repository>
      <id>in-project</id>
      <name>In Project Repo</name>
      <url>file://${project.basedir}/lib</url>
    </repository>
  </repositories>
</project>

注：本地仓库中你 jar 包名字及路径需要遵循下面格式：

groupId/artifactId/version/artifactId-verion.jar

这个例子中，你需要确保仓库目录“${project.basedir}/lib”中存在文件“test/ldapjdk/1.0/ldapjdk-1.0.jar”。

使用 maven-shade-plugin 可以生成包含所有依赖的 jar 包。

在 pom.xml 中增加下面内容即可：

    <build>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-shade-plugin</artifactId>
        <version>3.1.0</version>
        <executions>
          <execution>
            <phase>package</phase>
            <goals>
              <goal>shade</goal>
            </goals>
            <configuration>
              <transformers>
                <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
                  <manifestEntries>
                    <Main-Class>com.youcompany.app.App</Main-Class>     <!-- 请修改它 -->
                  </manifestEntries>
                </transformer>
              </transformers>
            </configuration>
          </execution>
        </executions>
      </plugin>
    </plugins>
  </build>

运行 mvn package 后，可以得到包含所有依赖的 jar 包，这样可使用 java -jar 执行它，如： java -jar target/your-app-1.0.jar 。

参考：http://maven.apache.org/plugins/maven-shade-plugin/examples/executable-jar.html

Maven 支持下面的命令行选项来控制日志输出的级别：

-e, --errors

Produce execution error messages

-X, --debug

Produce execution debug output

-q, --quiet

Quiet output, only show errors

参考：http://books.sonatype.com/mvnref-book/reference/running-sect-options.html#running-sect-verbose-option

有效 POM(Effective POM)就是 Project POM 加上 Supper POM，可以用下面命令查看有效 POM。

$ mvn help:effective-pom

假设工程中有两个模块：my-app(jar)和 my-webapp(war)，其中 my-webapp 又依赖于 my-app。则如何组织和编译它们呢？

一般，可按下面目录结构组织工程。

+- pom.xml
+- my-app
|  +- pom.xml
|  +- src
|    +- main
|      +- java
+- my-webapp
|  +- pom.xml
|  +- src
|    +- main
|      +- webapp

工程中，一共有 3 个 POM 文件（pom.xml, my-app/pom.xml, my-webapp/pom.xml）。

其中，pom.xml 称为父 POM，其内容如下：

<project xmlns="http://maven.apache.org/POM/4.0.0"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
                      http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>

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

  <modules>
    <module>my-app</module>
    <module>my-webapp</module>
  </modules>
</project>

在 my-app/pom.xml, my-webapp/pom.xml 中都包含下面内容：

<project xmlns="http://maven.apache.org/POM/4.0.0"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
                      http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <parent>
    <groupId>com.mycompany.app</groupId>
    <artifactId>app</artifactId>
    <version>1.0-SNAPSHOT</version>
  </parent>
  ...

此外，由于 my-webapp 依赖于 my-app，所以在 my-webapp/pom.xml 还应包含下面内容：

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

参考：How do I build more than one project at once?

要增加 repository，可以在工程的 pom.xml 文件中，或者~/.m2/settings.xml 文件中配置。

下面是在工程的 pom.xml 文件中增加 repository 的例子：

<project ...>
......
  <repositories>
    <repository>
      <id>your.customized.name</id>
      <url>https://maven.java.net/content/repositories/public/</url>
    </repository>
  </repositories>
</project>

参考：
https://maven.apache.org/guides/mini/guide-multiple-repositories.html