• 1 说明

• 2 使用

• 3 功能说明以及注意事项

  • 3.1 编码声明

  • 3.2 Java以及编译版本

  • 3.3 maven基础插件的声明

    • 3.3.1 maven-compiler-plugin
    • 3.3.2 maven-source-plugin
      • 3.3.2.1 使用注意事项
    • 3.3.3 maven-surefire-plugin
      • 3.3.3.1 使用注意事项
    • 3.3.4 maven-deploy-plugin
      • 3.3.4.1 使用注意事项

  • 3.4 声明了nexus仓库地址

1 说明

parent pom通常用来定义一些项目所共同遵守的约定，比如一些公共的三方依赖、编码、版本、插件、发布的仓库等等。此项目中定义了一些编码、版本、插件的声明以及发布仓库的声明。其他项目要以此项目作为父pom。

2 使用

• 创建自己的项目或者克隆此项目
• 根据实际需要修改项目的名称、groupId、artifactId、version等
• 将此项目发布到需要的仓库中
• 在其他的项目中指定当前项目为父模块即可

其他项目中的POM文件中引用当前项目为父模块：

<parent>
    <groupId>fun.pullock</groupId>
    <artifactId>parent-pom</artifactId>
    <version>2.0.0-SNAPSHOT</version>
</parent>

3 功能说明以及注意事项

3.1 编码声明

声明了构建以及报告输出的编码为UTF-8

3.2 Java以及编译版本

声明了java的版本以及maven编译的版本为17

3.3 maven基础插件的声明

声明并升级了maven基础插件，列表如下：

• maven-compiler-plugin：编译插件
• maven-source-plugin：源码插件
• maven-surefire-plugin：单测插件
• maven-deploy-plugin：部署插件

3.3.1 maven-compiler-plugin

• 升级了maven-compiler-plugin插件版本为3.11.0
• maven-compiler-plugin的java版本升级为17`

具体声明如下：

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-compiler-plugin</artifactId>
    <version>${maven-compiler-plugin.version}</version>
    <configuration>
        <source>${java.version}</source>
        <target>${java.version}</target>
    </configuration>
</plugin>

maven-compiler-plugin有如下两个目标：

• compiler:compile：默认绑定到default生命周期的compile阶段
• compiler:testCompile：默认绑定到default生命周期的test-compile阶段

一般实际使用的时候无需特别指定，在mvn package以及往上的阶段执行的时候都会默认执行掉maven-compiler-plugin的两个目标，如果需要单独执行compiler的目标，只需要使用如下命令即可：mvn compile或者mvn test-compile。

3.3.2 maven-source-plugin

• 升级了maven-source-plugin插件版本为3.2.1
• 指定了执行的目标为jar-no-fork和test-jar-no-fork

具体声明如下：

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-source-plugin</artifactId>
    <version>${maven-source-plugin.version}</version>
    <executions>
        <execution>
            <id>attach-sources</id>
            <goals>
                <goal>jar-no-fork</goal>
                <goal>test-jar-no-fork</goal>
            </goals>
        </execution>
    </executions>
</plugin>

maven-source-plugin的jar、test-jar、jar-no-fork、test-jar-no-fork四个目标默认绑定到default声明周期的package阶段，并且默认执行的目标是jar和test-jar，由于jar和test-jar两个目标在执行前会自动执行其他阶段的目标，导致重复执行，故在此将执行目标指定为了：jar-no-fork和test-jar-no-fork，这样可以防止重复执行其他阶段的目标。

由于默认绑定到了default生命周期的package阶段，故在mvn package以及以上的阶段执行的时候会自动执行maven-source-plugin的目标，如果需要单独执行目标，只需要使用如下命令即可：mvn source:jar、mvn source:test-jar、mvn source:jar-no-fork、mvn source:test-jar-no-fork。

3.3.2.1 使用注意事项

一般情况下只需要将对外提供的api的源码打包并且deploy到仓库中，对于项目中核心实现的代码并不需要打包源码并且deploy到仓库中，可以在实际的实现模块中禁用maven-source-plugin插件。使用方式是在核心实现模块的pom文件中添加如下方式进行禁用：

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-source-plugin</artifactId>
    <configuration>
        <!-- 指定当前模块不打包源码 -->
        <skipSource>true</skipSource>
    </configuration>
</plugin>

3.3.3 maven-surefire-plugin

• 升级了maven-surefire-plugin插件版本为3.1.0

具体声明如下：

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-surefire-plugin</artifactId>
    <version>${maven-surefire-plugin.version}</version>
</plugin>

maven-surefire-plugin只有一个surefire:test目标，默认绑定到default声明周期的test阶段，在mvn test以及以上的阶段执行的时候都会执行surefire:test目标。

3.3.3.1 使用注意事项

如果需要执行其他的一些不符合默认命名规则的单测类，可以在项目中使用如下配置进行添加：

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-surefire-plugin</artifactId>
    <configuration>
        <includes>
            <!--- 添加spock的单测类 -->
            <include>**/*Spec</include>

            <!-- 以下将默认的命名规则添加进来 -->
            <include>**/Test*.java</include>
            <include>**/*Test.java</include>
            <include>**/*Tests.java</include>
            <include>**/*TestCase.java</include>
        </includes>
    </configuration>
</plugin>

有些项目中可能会需要指定需要的单测框架的版本，可以在项目中进行配置，比如如下示例是指定junit4的依赖：

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-surefire-plugin</artifactId>
    <dependencies>
        <dependency>
            <groupId>org.apache.maven.surefire</groupId>
            <artifactId>surefire-junit4</artifactId>
            <version>${surefire-junit4.version}</version>
        </dependency>
    </dependencies>
</plugin>

3.3.4 maven-deploy-plugin

• 升级了maven-deploy-plugin插件版本为3.1.1

具体声明如下：

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-deploy-plugin</artifactId>
    <version>${maven-deploy-plugin.version}</version>
</plugin>

maven-deploy-plugin插件的deploy目标默认绑定到default生命周期的deploy阶段，需要使用mvn deploy命令来进行执行。

3.3.4.1 使用注意事项

一般情况下只需要将对外提供的api包打包并且deploy到仓库中，对于项目中核心实现的代码并不需要打包并且deploy到仓库中，可以在实际的实现模块中禁用maven-deploy-plugin插件。使用方式是在核心实现模块的pom文件中添加如下方式进行禁用：

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-deploy-plugin</artifactId>
    <configuration>
        <!-- 指定当前模块不deploy -->
        <skip>true</skip>
    </configuration>
</plugin>

3.4 声明了nexus仓库地址

具体声明如下：

<distributionManagement>
    <repository>
        <id>releases</id>
        <name>Releases</name>
        <url>http://修改成需要的Releases的URL</url>
    </repository>
    <snapshotRepository>
        <id>snapshots</id>
        <name>Snapshots</name>
        <url>http://修改成需要的Snapshots的URL</url>
    </snapshotRepository>
</distributionManagement>