【java】maven 分离打包资源文件、配置文件、依赖包

前言：

maven打包项目时候需要将配置文件、依赖包、资源文件和运行主程序分离打包，这样每次修改配置不需要将整个程序都重新编译打包。只要三个步骤就行，将下面的配置复制到自己项目中，稍微修改一些配置即可。

1. 第一步，创建assemble配置文件

在main/resouce 文件夹下创建package.xml文件，内容如下：

<?xml version="1.0" encoding="UTF-8"?>
<assembly xmlns="http://maven.apache.org/ASSEMBLY/2.0.0"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://maven.apache.org/ASSEMBLY/2.0.0 http://maven.apache.org/xsd/assembly-2.0.0.xsd">
    <!-- 压缩包的后缀 -->
    <id>web</id>
    <formats>
        <!-- 压缩格式 -->
        <format>zip</format>
    </formats>


    <fileSets>

        <!--资源文件的打包路径设置-->
        <fileSet>
            <!-- 资源文件位置 -->
            <directory>${project.basedir}/src/main/resources</directory>
            <!-- 输出的位置 -->
            <outputDirectory>conf</outputDirectory>
            <!-- 包含的资源文件 -->
            <includes>
                <include>**/*.properties</include>
                <include>*.yml</include>
            </includes>
            <!-- 排除的资源文件 -->
            <excludes>
                <exclude>package.xml</exclude>
                <exclude>mapper/**/*.xml</exclude>
            </excludes>
        </fileSet>


        <!--说明文档、启动程序的打包路径设置-->
        <fileSet>
            <!-- ../ 就是上一级目录 -->
            <directory>../bin</directory>
            <outputDirectory>bin</outputDirectory>
            <includes>
                <include>*.sh</include>
                <include>*.md</include>
                <include>*.txt</include>
            </includes>
            <!--  linux系统的文件权限 -->
            <fileMode>0755</fileMode>
        </fileSet>
    </fileSets>

    <files>
        <file>
            <!--  把启动类所在的 jar 包放到压缩包的根目录下 -->
            <source>target/${project.artifactId}.jar</source>
            <outputDirectory>.</outputDirectory>
        </file>
    </files>


    <dependencySets>

        <!-- 默认依赖外部包的位置的设置-->
        <dependencySet>
            <!--，默认设置为true,即项目本身生成的构件jar包也会分离，放到lib文件夹下-->
            <useProjectArtifact>true</useProjectArtifact>
            <!-- 依赖 jar 输出路径 -->
            <outputDirectory>lib</outputDirectory>
            <scope>runtime</scope>
        </dependencySet>


    </dependencySets>
</assembly>

2. 第二步，pom.xml 文件中添加编译插件

<build>
        <resources>
            <resource>
                <directory>src/main/resources</directory>
                <includes>
                    <!--编译需要的文件-->
                    <include>mapper/**/*.xml</include>
                    <include>*.yml</include>
                    <include>*.json</include>
                    <include>*.xml</include>
                    <include>*.properties</include>
                </includes>
            </resource>
        </resources>
        <plugins>
            <plugin>
                <!-- 当前模块的打包配置 -->
                <!-- 将工程打包成 zip 或者 tar.gz 等格式压缩包 -->
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-jar-plugin</artifactId>
                <version>3.1.1</version>
                <configuration>
                    <excludes>
                        <!-- 分离打包的配置文件 -->
                        <exclude>**/*.properties</exclude>
                        <exclude>*.properties</exclude>
                        <exclude>*.yml</exclude>
                        <exclude>package.xml</exclude>
                    </excludes>
                    <archive>
                        <manifest>
                              <!--此处要修改成你自己项目中的入口类 -->
                            <mainClass>ef.test.service.service</mainClass>
                            <!-- 最终所有 jar 都打包到压缩包解压后的 lib 下，所以添加 classpath 的前缀 -->
                            <addClasspath>true</addClasspath>
                            <classpathPrefix>lib/</classpathPrefix>
                        </manifest>
                        <manifestEntries>
                            <!-- 添加资源文件的路径，这个必须要配置好，
                            不然程序运行时候找不到资源文件的位置 -->
                            <Class-Path>conf/</Class-Path>

                        </manifestEntries>
                    </archive>

                </configuration>
            </plugin>
            <plugin>

                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-assembly-plugin</artifactId>
                <version>3.3.0</version>
                <configuration>
                    <descriptors>
                        <!-- 按照 package.xml 打包 -->
                        <descriptor>src/main/resources/package.xml</descriptor>
                    </descriptors>

                </configuration>
                <executions>
                    <execution>
                        <id>make-assembly</id>
                        <phase>package</phase>
                        <goals>
                            <goal>single</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <configuration>
                    <source>8</source>
                    <target>8</target>
                </configuration>
                <version>3.8.0</version>
            </plugin>
        </plugins>
        <!-- 程序打包后的名字 -->
        <finalName>${project.artifactId}</finalName>
    </build>

上面代码中只要修改一下程序入口类，即main()函数的类。如下图

示例中 maven-jar-plugin和maven-assembly-plugin两个插件实现分离打包

3. 打包

在右侧，点击clean --> pacakge即可打包成功

 打包生成一个zip的压缩包，其中就将资源文件、依赖包、运行包分离，并且可以运行正常。如下图：