maven-compiler-plugin

这个插件是用来编译源代码的。

例如报错 static import declarations are not supported in -source 1.3，这是因为编译的时候默认是 1.3 版本。可以设定编译器的版本为 1.6。

注意：target 版本一定大于等于 source 版本。

用法：

1
2
3
4
5
6
7
8
9
10
11
12
13
<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <version>2.3.2</version>
            <configuration>
                <source>1.6</source>
                <target>1.8</target>
            </configuration>
        </plugin>
    </plugins>
</build>

maven-jar-plugin

打 jar 包，无依赖包。package 中指定 jar，不单独在 plugin 中指定，使用默认版本。

用法：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-jar-plugin</artifactId>
    <version>2.4</version>
    <configuration>
        <archive>
            <!-- 生成的 jar 中，包含 pom.xml 和 pom.properties 这两个文件 -->
            <addMavenDescriptor>true</addMavenDescriptor>
            <!-- 生成 MANIFEST.MF 的设置 -->
            <manifest>
                <!--这个属性特别关键，如果没有这个属性，有时候我们引用的包 Maven 库
                下面可能会有多个包，并且只有一个是正确的，其余的可能是带时间戳的，
                此时会在 classpath 下面把那个带时间戳的给添加上去，
                然后我们在依赖打包的时候，打的是正确的，所以两头会对不上，报错。 -->
                <useUniqueVersions>false</useUniqueVersions>
                <!-- 为依赖包添加路径, 这些路径会写在 MANIFEST 文件的 Class-Path 下 -->
                <addClasspath>true</addClasspath>
                <!-- 这个 jar 所依赖的 jar 包添加 classPath 的时候的前缀，如果这个 jar 本身
                和依赖包在同一级目录，则不需要添加 -->
                <classpathPrefix>lib/</classpathPrefix>
                <!-- jar 启动入口类 -->
                <mainClass>com.ht.pojo.Test</mainClass>
            </manifest>
            <manifestEntries>
                <!-- 在 Class-Path 下添加配置文件的路径 -->
                <Class-Path>../config/</Class-Path>
                <!-- 假如这个项目可能要引入一些外部资源，但是你打包的时候并不想把
                这些资源文件打进包里面，这个时候你必须在这边额外指定一些这些资源
                文件的路径，这个位置指定的话，要根据你预期的这些位置去设置，我这边
                所有 jar 都在 lib 下，资源文件都在 config 下，lib 和 config 是同级的
                同时还需要注意另外一个问题，假如你的 pom 文件里面配置了
                <scope>system</scope>，就是你依赖是你本地的资源，这个时候使用
                这个插件，classPath 里面是不会添加，所以你得手动把这个依赖添加进
                这个地方，用空格隔开就行 -->
            </manifestEntries>
        </archive>
        <!-- jar 包的位置 -->
        <outputDirectory>${project.build.directory}/lib</outputDirectory>
        <includes>
            <!-- 打 jar 包时，打包 class 文件和 config 目录下面的 properties 文件 -->
            <!-- 有时候可能需要一些其他文件，这边可以配置，包括剔除的文件等等 -->
            <include>**/*.class</include>
            <include>**/*.properties</include>
        </includes>
    </configuration>
</plugin>

maven-dependency-plugin

我们在 IDE 的环境里编译和执行代码的时候，那是直接引用一些类库。但是在我们实际部署的环境里，那边很可能就一个 Java 执行环境，不可能有源代码和 IDE。这个时候，我们需要将源代码编译打包。如果我们引用的库很多的话，我们希望能够把他们统一打包到一个目录下，比如 lib 文件夹。这样部署执行的时候只需要将编译生成的程序 jar 包和依赖包文件夹拷到特定目录去执行。

用法：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-dependency-plugin</artifactId>
    <version>3.1.1</version>
    <executions>
        <execution>
            <id>copy-dependencies</id>
            <phase>package</phase>
            <goals>
                <goal>copy-dependencies</goal>
            </goals>
            <configuration>
                <outputDirectory>${project.build.directory}/alternateLocation</outputDirectory>
                <overWriteReleases>false</overWriteReleases>
                <overWriteSnapshots>false</overWriteSnapshots>
                <overWriteIfNewer>true</overWriteIfNewer>
            </configuration>
        </execution>
    </executions>
</plugin>

maven-assembly-plugin

一些非 Spring Boot 项目打成可执行的 jar 包，主要打发布包使用，通过一个 xml 文件定义更多自定义打包项。

用法：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
<?xml version="1.0" encoding="utf-8"?>
<assembly
    xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2 http://maven.apache.org/xsd/assembly-1.1.2.xsd">

    <!-- id 标识符，添加到生成文件名称的后缀符。如果指定 id 的话（这里指定的是项目的版本），目标文件则是 ${artifactId}-${id}.jar。【如 terminal-dispatch-5.0.0.0.jar】 -->
    <id>${project.version}</id>

    <!-- 指定打包格式。maven-assembly-plugin 插件支持的打包格式有 zip、tar、tar.gz (or tgz)、tar.bz2 (or tbz2)、jar、dir、war，可以同时指定多个打包格式 -->
    <formats>
        <format>jar</format>
    </formats>

    <!-- 指定打的包是否包含打包层目录（比如 finalName 是 terminal-dispatch，当值为 true，所有文件被放在包内的 terminal-dispatch 目录下，否则直接放在包的根目录下）-->
    <includeBaseDirectory>true</includeBaseDirectory>

    <!-- 指定将工程依赖的包打到包里的指定目录下 -->
    <dependencySets>
        <dependencySet>
            <useProjectArtifact>true</useProjectArtifact> <!-- 指定打包时是否包含工程自身生成的 jar 包 -->
            <outputDirectory>lib</outputDirectory> <!-- 指定将这些依赖包打到包里 lib 目录下 -->
            <scope>runtime</scope> <!-- 用于管理依赖的部署，runtime 表示只在运行时使用 -->
        </dependencySet>
    </dependencySets>

    <!-- 指定要包含的文件集，可以定义多个 fileSet -->
    <fileSets>
        <fileSet>
            <directory>src/main/script/linux/bin</directory> <!-- 指定归档文件（要打的 jar 包）要包含的目录（下的文件及文件夹） -->
            <outputDirectory>bin</outputDirectory> <!-- 指定要将当前目录（<directory> 标签中的目录放在归档文件（要打的 jar 包）bin 目录下） -->
            <includes>
                <include>terminal-dispatch</include> <!-- 精确控制要包含的文件，<exclude> 用于精确控制要排除的文件  -->
                <include>server</include>
            </includes>
            <fileMode>0755</fileMode> <!-- 设置文件 UNIX 属性，是一种读写权限 -->
        </fileSet>
        <fileSet>
            <directory>src/main/resources</directory>
            <outputDirectory>conf</outputDirectory>
            <includes>
                <include>config.properties</include>
                <include>logback.xml</include>
            </includes>
            <fileMode>0644</fileMode>
        </fileSet>
        <fileSet>
            <directory>src/main/script/conf</directory>
            <outputDirectory>conf</outputDirectory>
            <includes>
                <include>wrapper.conf</include>
            </includes>
            <fileMode>0644</fileMode>
        </fileSet>
        <fileSet>
            <directory>src/main/script/linux/lib</directory>
            <outputDirectory>lib</outputDirectory>
            <includes>
                <include>libwrapper.so</include>
                <include>wrapper.jar</include>
            </includes>
            <fileMode>0755</fileMode>
        </fileSet>
    </fileSets>

</assembly>

在 pom.xml 中引用：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
<build>
    <plugins>
       <plugin>
           <groupId>org.apache.maven.plugins</groupId>
           <artifactId>maven-assembly-plugin</artifactId>
           <version>2.4</version>
           <executions>
               <execution> <!--执行器 mvn assembly:assembly-->
                   <id>make-zip</id> <!--名字任意 -->
                   <phase>package</phase> <!-- 绑定到 package 生命周期阶段上 -->
                   <goals>
                       <goal>single</goal> <!-- 该打包任务只运行一次 -->
                   </goals>
                   <configuration>
                       <descriptors>
                           <descriptor>src/main/script/assembly.xml</descriptor>
                       </descriptors>
                   </configuration>
               </execution>
           </executions>
       </plugin>
    </plugins>
</build>

maven-shade-plugin

一些非 Spring Boot 项目打成可执行的 jar 包，主要打发布包使用，通过一个 xml 文件定义更多自定义打包项。

assembly 与 shade 的区别

对 xsd 文件的处理方式不同：

  • assembly：找到一个放入最终打出的 jar 包里，但是这样有个问题是当工程依赖到不同版本的依赖包时只能将某一个版本的 xsd 配置文件放入最终打出的 jar 包里，这就有可能遗漏了一些版本的 xsd 的本地映射，会报错
  • shade：打包时在对 spring.schemas 文件处理上，它能够将所有 jar 里的 spring.schemas 文件进行合并，在最终生成的单一 jar 包里，spring.schemas 包含了所有出现过的版本的集合

maven-surefire-plugin

Maven 通过 Maven Surefire Plugin 插件执行单元测试（通过 Maven Failsafe Plugin 插件执行集成测试），也可用于打包时跳过测试。

spotless-maven-plugin

代码自动格式化插件。

用法：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
<plugin>
    <groupId>com.diffplug.spotless</groupId>
    <artifactId>spotless-maven-plugin</artifactId>
    <version>2.44.4</version>
    <configuration>
        <java>
            <googleJavaFormat>
                <version>1.8</version>
                <style>AOSP</style>
            </googleJavaFormat>

            <!-- \# refers to the static imports -->
            <importOrder>
                <order>com.dtstack,org.apache.flink,org.apache.flink.shaded,,javax,java,scala,\#</order>
            </importOrder>

            <removeUnusedImports/>
        </java>
    </configuration>
    <executions>
        <execution>
            <id>spotless-check</id>
            <phase>validate</phase>
            <goals>
                <goal>check</goal>
            </goals>
        </execution>
    </executions>
</plugin>