maven-assembly-plugin的使用

maven-assembly-plugin支持自定义打包结构，也可以定制依赖项等。

项目中往往有很多shell脚本、SQL脚本、.properties及.xml配置项等，采用maven-assembly-plugin插件可以让输出的结构清晰而标准化。

1. 引入插件

要使用插件，需要在pom文件中引入以下内容。

配置的描述符文件package.xml中指定了打包方式。

使用该插件，在IDEA中打包时会自动生成jar包。

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-assembly-plugin</artifactId>
    <configuration>
        <!-- not append assembly id in release file name -->
        <appendAssemblyId>false</appendAssemblyId>
        <!-- 配置描述符文件 -->
        <descriptors>
            <descriptor>src/main/build/package.xml</descriptor>
        </descriptors>
    </configuration>
    <executions>
        <execution>
            <id>make-assembly</id>
            <!-- 绑定到package生命周期 -->
            <phase>package</phase>
            <goals>
                <!-- 只运行一次 -->
                <goal>single</goal>
            </goals>
        </execution>
    </executions>
</plugin>

2. 描述符文件

<?xml version="1.0" encoding="UTF-8"?>
<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.3" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.3 http://maven.apache.org/xsd/assembly-1.1.3.xsd">
    <id>package</id>
    <formats>
        <format>zip</format>
    </formats>
    <includeBaseDirectory>true</includeBaseDirectory>
    <fileSets>
        <fileSet>
            <directory>src/main/docker_cmd</directory>
            <outputDirectory>/</outputDirectory>
            <includes>
                <include>ServiceCmd.sh</include>
            </includes>
        </fileSet>
        <fileSet>
            <directory>src/main/resources</directory>
            <outputDirectory>/ap/config</outputDirectory>
            <includes>
                <include>*.yml</include>
                <include>*.xml</include>
                <include>*.properties</include>
            </includes>
        </fileSet>
        <fileSet>
            <directory>src/main/bin</directory>
            <outputDirectory>/ap</outputDirectory>
            <includes>
                <include>boot.sh</include>
            </includes>
        </fileSet>
        <fileSet>
            <directory>src/main/docker_cmd</directory>
            <outputDirectory>/ap</outputDirectory>
            <includes>
                <include>InitAP*.sh</include>
            </includes>
        </fileSet>
        <fileSet>
            <directory>${project.build.directory}</directory>
            <outputDirectory>/ap</outputDirectory>
            <includes>
                <include>*.jar</include>
            </includes>
        </fileSet>
        <fileSet>
            <directory>src/main/docker_app</directory>
            <outputDirectory>/ap</outputDirectory>
            <includes>
                <include>*</include>
            </includes>
        </fileSet>
        <fileSet>
            <directory>src/main/docker_cmd</directory>
            <outputDirectory>/db</outputDirectory>
            <includes>
                <include>InitDB*.sh</include>
            </includes>
        </fileSet>
        <fileSet>
            <directory>src/main/resources</directory>
            <outputDirectory>/db</outputDirectory>
            <includes>
                <include>sql/*.sql</include>
            </includes>
        </fileSet>
        <fileSet>
            <directory>src/main/docker_db</directory>
            <outputDirectory>/db</outputDirectory>
            <includes>
                <include>*</include>
            </includes>
        </fileSet>
    </fileSets>
    <dependencySets>
        <dependencySet>
            <outputDirectory>/ap/libs</outputDirectory>
            <useProjectArtifact>false</useProjectArtifact>
        </dependencySet>
    </dependencySets>
</assembly>

• formats：assembly插件支持的打包文件格式，有zip、tar、tar.gz、tar.bz2、jar、war。可以同时定义多个format。
• id：添加到打包文件名的标识符，用来做后缀。但是在pom文件中配置了<appendAssemblyId>false</appendAssemblyId>，所以在最后的打包文件中，<id>中的内容不显示。
• fileSets/fileSet：用来设置一组文件在打包时的属性。
  • directory：源目录的路径。
  • includes/excludes：设定包含或排除哪些文件，支持通配符。
  • fileMode：指定该目录下的文件属性，采用Unix八进制描述法，默认值是0644
  • outputDirectory：生成目录的路径。
• dependencySets/dependencySet：用来设置工程依赖文件在打包时的属性。也与fileSets大致相同，不过还有两个特殊的配置：
  • unpack：布尔值，false表示将依赖以原来的JAR形式打包，true则表示将依赖解成*.class文件的目录结构打包。
  • scope：表示符合哪个作用范围的依赖会被打包进去。compile与provided都不用管，一般是写runtime。

3. 使用

使用IDEA进行打包。将打包之后的文件上传到服务器，解压即可。

参考

• https://blog.csdn.net/qq_32736999/article/details/93395246