Maven

Maven POM

POM的全称是Project Obejet Model, 整个项目的核心配置和信息都包含在这份xml文件中,一个最基本的pom文件要求至少有下列三要素:groupId, artifactId, version, 因此一个最小的POM配置文件如下所示:

    <project>
      <modelVersion>4.0.0</modelVersion>
      <groupId>com.mycompany.app</groupId>
      <artifactId>my-app</artifactId>
      <version>1</version>
    </project>
  1. 超级POM
    • 作用:所有的POM全部继承自该POM, 意味着所有POM的默认配置也位于这里
      举例的配置如下:
      build directory: target
      source directory: src/main/java
      test source directory: src/test/java
      output directory: classes

    • 位置:位于 maven 安装目录的lib文件夹下的一个jar包中,使用Java反编译工具(如Java-Decompiler)即可查看,以本机为例,超级POM的位置如下:

      C:\Program Files (x86)\apache-maven-3.6.1\lib\maven-model-builder-3.6.1.jar
      
    • 内容:

      <?xml version="1.0" encoding="UTF-8"?>
      
      <!--
      Licensed to the Apache Software Foundation (ASF) under one
      or more contributor license agreements.  See the NOTICE file
      distributed with this work for additional information
      regarding copyright ownership.  The ASF licenses this file
      to you under the Apache License, Version 2.0 (the
      "License"); you may not use this file except in compliance
      with the License.  You may obtain a copy of the License at
      
          http://www.apache.org/licenses/LICENSE-2.0
      
      Unless required by applicable law or agreed to in writing,
      software distributed under the License is distributed on an
      "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
      KIND, either express or implied.  See the License for the
      specific language governing permissions and limitations
      under the License.
      -->
      
      <!-- START SNIPPET: superpom -->
      <project>
      <modelVersion>4.0.0</modelVersion>
      
      <repositories>
          <repository>
          <id>central</id>
          <name>Central Repository</name>
          <url>https://repo.maven.apache.org/maven2</url>
          <layout>default</layout>
          <snapshots>
              <enabled>false</enabled>
          </snapshots>
          </repository>
      </repositories>
      
      <pluginRepositories>
          <pluginRepository>
          <id>central</id>
          <name>Central Repository</name>
          <url>https://repo.maven.apache.org/maven2</url>
          <layout>default</layout>
          <snapshots>
              <enabled>false</enabled>
          </snapshots>
          <releases>
              <updatePolicy>never</updatePolicy>
          </releases>
          </pluginRepository>
      </pluginRepositories>
      
      <build>
          <directory>${project.basedir}/target</directory>
          <outputDirectory>${project.build.directory}/classes</outputDirectory>
          <finalName>${project.artifactId}-${project.version}</finalName>
          <testOutputDirectory>${project.build.directory}/test-classes</testOutputDirectory>
          <sourceDirectory>${project.basedir}/src/main/java</sourceDirectory>
          <scriptSourceDirectory>${project.basedir}/src/main/scripts</scriptSourceDirectory>
          <testSourceDirectory>${project.basedir}/src/test/java</testSourceDirectory>
          <resources>
          <resource>
              <directory>${project.basedir}/src/main/resources</directory>
          </resource>
          </resources>
          <testResources>
          <testResource>
              <directory>${project.basedir}/src/test/resources</directory>
          </testResource>
          </testResources>
          <pluginManagement>
          <!-- NOTE: These plugins will be removed from future versions of the super POM -->
          <!-- They are kept for the moment as they are very unlikely to conflict with lifecycle mappings (MNG-4453) -->
          <plugins>
              <plugin>
              <artifactId>maven-antrun-plugin</artifactId>
              <version>1.3</version>
              </plugin>
              <plugin>
              <artifactId>maven-assembly-plugin</artifactId>
              <version>2.2-beta-5</version>
              </plugin>
              <plugin>
              <artifactId>maven-dependency-plugin</artifactId>
              <version>2.8</version>
              </plugin>
              <plugin>
              <artifactId>maven-release-plugin</artifactId>
              <version>2.5.3</version>
              </plugin>
          </plugins>
          </pluginManagement>
      </build>
      
      <reporting>
          <outputDirectory>${project.build.directory}/site</outputDirectory>
      </reporting>
      
      <profiles>
          <!-- NOTE: The release profile will be removed from future versions of the super POM -->
          <profile>
          <id>release-profile</id>
      
          <activation>
              <property>
              <name>performRelease</name>
              <value>true</value>
              </property>
          </activation>
      
          <build>
              <plugins>
              <plugin>
                  <inherited>true</inherited>
                  <artifactId>maven-source-plugin</artifactId>
                  <executions>
                  <execution>
                      <id>attach-sources</id>
                      <goals>
                      <goal>jar-no-fork</goal>
                      </goals>
                  </execution>
                  </executions>
              </plugin>
              <plugin>
                  <inherited>true</inherited>
                  <artifactId>maven-javadoc-plugin</artifactId>
                  <executions>
                  <execution>
                      <id>attach-javadocs</id>
                      <goals>
                      <goal>jar</goal>
                      </goals>
                  </execution>
                  </executions>
              </plugin>
              <plugin>
                  <inherited>true</inherited>
                  <artifactId>maven-deploy-plugin</artifactId>
                  <configuration>
                  <updateReleaseInfo>true</updateReleaseInfo>
                  </configuration>
              </plugin>
              </plugins>
          </build>
          </profile>
      </profiles>
      
      </project>
      <!-- END SNIPPET: superpom -->
      

POM的继承

子 module 可以继承的元素如下

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

假设现有的项目结构如下:

.
 |-- my-module
 |   `-- pom.xml
 `-- pom.xml

两份 pom 的内容分别如下:

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

现在如果想让 my-module 继承 my-app 的元素,需要在 my-module/pom.xml 中添加 parent 节点,更改后的 my-module/pom.xml 配置如下

    <project>
      <modelVersion>4.0.0</modelVersion>
      <parent>
        <groupId>com.mycompany.app</groupId>
        <artifactId>my-app</artifactId>
        <version>1</version>
        <!--如果project中的pom是子module上层目录,该节点可不做配置-->
        <relativePath>../pom.xml</relativePath>
      </parent>
      <!--注意这里没有配置groupId,version节点,此时groupId,version的值会继承自父POM-->
      <artifactId>my-module</artifactId>
    </project>

模块化聚合

Maven 中的 POM 除了继承,还可以使用聚合来联系各个独立的 POM。我们知道继承是在子模块下定义 parent 节点,这样每个子模块是知道自己的父 POM 是谁,聚合则和继承相反,聚合在父 POM 中定义它所有的子模块,这样做的好处是,父 POM 知道他所有的子模块,这样对父 POM 执行一些命令时,其所有的子模块也会得到执行。
假设现有的项目结构如下:

.
 |-- my-module
 |   `-- pom.xml
 `-- pom.xml

两份 pom 的内容分别如下:

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

现在想让 my-app 和 my-moudle 以聚合的方式连接,只需修改 my-app 的 POM 文件如下:

    <!--project pom 配置-->
    <project>
      <modelVersion>4.0.0</modelVersion>
      <groupId>com.mycompany.app</groupId>
      <artifactId>my-app</artifactId>
      <version>1</version>
      <!--packing方式必须为pom-->
      <packaging>pom</packaging>
      <!--声明它的子module-->
      <modules>
        <!--module节点的值为子模块的artifactId, 注意该值需要根据路径进行调整(如../my-module)-->
        <module>my-module</module>
      </modules>
    </project>
  • 聚合和继承的区别
    继承:使得子模块继承父 POM 的一些属性和配置,可以继承的元素如下:
dependencies
developers and contributors
plugin lists (including reports)
plugin executions with matching ids
plugin configuration
resources

聚合:对父 POM 执行命令时,相同的命令会同时在所有的子模块中执行一遍,方便多模块的打包和测试。注意聚合并不会继承父 POM 中的任何属性和配置。
继承+聚合:子模块继承父 POM 中的属性和配置,同时在父 POM 中执行命令时,在子模块也会得到执行。(常用+推荐)

Maven Properties

为了减少重复性的工作,POM 支持变量,从而达到修改一处,处处生效的效果。在每一个 POM 中,Maven 已经构建了一些内置的变量供我们使用,如

  • ${project.groupId}
  • ${project.artifactId}
  • ${project.version}
  • ${project.basedir}
  • ${project.baseuri}
  • ${maven.build.timestamp}

我们自己也可以声明变量,声明方式如下:

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

<properties>
    <dbcp-version>1.4</dbcp-version>
    <jdk.version>1.8</jdk.version>
    <maven.compiler.encoding>UTF-8</maven.compiler.encoding>
    <mysql-version>5.1.38</mysql-version>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <spring.version>3.2.6.RELEASE</spring.version>
  </properties>
</project>

声明变量之后,在 POM 文件的任何地方都可以引用该变量了。引用的方式如下:

    <dependency>
        <groupId>commons-dbcp</groupId>
        <artifactId>commons-dbcp</artifactId>
        <version>${dbcp-version}</version>
    </dependency>

变量也存在继承关系,子模块也会覆盖父 POM 中定义的变量。这和面向对象的思想是一样的。

Maven Profile

  1. profile的作用
    我们在开发的时候经常需要不同的运行环境,不同运行环境的配置可能不相同,如数据源,日志文件等,Maven中的profile给予我们开发人员基于不同环境灵活的切换不同配置的能力

  2. 在project中定义你的profile
    我们在如下的pom中定义了两个不同的profile,分别是 testproduction,根据不同的环境,Maven编译的时候会自动把这些变量编译到properties文件中

    <profiles>
        <profile>
            <id>test</id>
            <activation>
                <!--默认使用该profile-->
                <activationByDefault>true</activationByDefault>
            </activation>
            <properties>
                <mvn.log.path>/export/Logs/com.fanyank.app</mvn.log.path>
                <mvn.log.level>INFO</mvn.log.level>
                <mvn.jdbc.mysql.driver></mvn.jdbc.mysql.driver>
                <mvn.jdbc.mysql.url>jdbc:mysql://111.111.111.111:3358/app</mvn.jdbc.mysql.url>
                <mvn.jdbc.mysql.username>fanyank</mvn.jdbc.mysql.username>
                <mvn.jdbc.mysql.password>fanyank</mvn.jdbc.mysql.password>
            </properties>
        </profile>
    
        <profile>
            <id>production</id>
            <properties>
                <mvn.log.path>/export/Logs/com.fanyank.app</mvn.log.path>
                <mvn.log.level>ERROR</mvn.log.level>
                <mvn.jdbc.mysql.driver></mvn.jdbc.mysql.driver>
                <mvn.jdbc.mysql.url>jdbc:mysql://222.222.222.222:3358/app</mvn.jdbc.mysql.url>
                <mvn.jdbc.mysql.username>fanyank</mvn.jdbc.mysql.username>
                <mvn.jdbc.mysql.password>fanyank</mvn.jdbc.mysql.password>
            </properties>
        </profile>
    </profiles>
    
  3. 如何使profile生效呢?

    • 命令指定
      使用 -P 指定生效的profile为production
    mvn groupId:artifactId:goal -P production
    
    • pom中指定
        <profile>
            <id>prod</id>
            <properties>
                <profiles.active>prod</profiles.active>
            </properties>
            <!--activation用来指定激活方式,可以根据jdk环境,环境变量,文件的存在或缺失-->
            <activation>
                <!--配置默认激活-->
                <activeByDefault>true</activeByDefault>
                
                <!--通过jdk版本-->
                <!--当jdk环境版本为1.5时,此profile被激活-->
                <jdk>1.5</jdk>
                <!--当jdk环境版本1.5或以上时,此profile被激活-->
                <jdk>[1.5,)</jdk>
    
                <!--根据当前操作系统-->
                <os>
                    <name>Windows XP</name>
                    <family>Windows</family>
                    <arch>x86</arch>
                    <version>5.1.2600</version>
                </os>
    
                <!--通过系统环境变量,name-value自定义-->
                <property>
                    <name>env</name>
                    <value>test</value>
                </property>
    
                <!--通过文件的存在或缺失-->
                <file>
                    <missing>target/generated-sources/axistools/wsdl2java/
                        com/companyname/group</missing>
                    <exists/>
                </file>
            </activation>
        </profile>
    
    • settings.xml
      针对全局声明的profile(${maven.home}/conf/settings.xml),使用 <activeProfiles> 标签指定生效的profile
    <settings>
      ...
      <activeProfiles>
        <activeProfile>profile-1</activeProfile>
      </activeProfiles>
      ...
    </settings>
    
  4. 我可以使用profile定制化哪些内容?

    • external files
      external files包括全局setting.xml, 你的profile只能用来修改如下三个参数 <repositories>, <pluginRepositories>, <properties>
      其中 <repositories>用来存放你们公司的私服仓库地址,<pluginRepositories>用来存放私服plugin地址,<properties>很少使用
    • profile in POMs
      定制任意数量的键值对,并在编译时期注入到properties中
    <dependencies>
    <plugins>
    <properties>
    <modules>
    <reporting>
    <dependencyManagement>
    <distributionManagement>
    a subset of the <build> element, which consists of:
    <defaultGoal>
    <resources>
    <testResources>
    <finalName>
    
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,001评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,210评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 161,874评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,001评论 1 291
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,022评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,005评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,929评论 3 416
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,742评论 0 271
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,193评论 1 309
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,427评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,583评论 1 346
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,305评论 5 342
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,911评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,564评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,731评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,581评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,478评论 2 352

推荐阅读更多精彩内容