SpringBoot项目打包分离lib,配置和资源文件部署总结

• 前言

先前发布springboot项目的时候，每次改动一点东西，就需要将整个项目重新打包部署，并且打包出来的jar包太庞大，每次更新项目的时候，需要上传的文件很大，十分不便，故把依赖lib里面的jar包从项目分离出来，每次部署只需要发布代码即可。

先前使用的是spring-boot-maven-plugin来打包，这个插件会将项目所有的依赖打入BOOT-INF/lib下，替换为maven-jar-plugin

# 原来使用的打包插件：spring-boot-maven-plugin
<build>
      <plugins>
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
            <version>2.1.1.RELEASE</version>
            <executions>
                <execution>
                    <goals>
                        <goal>repackage</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

半自动化部署

1.替换为maven-jar-plugin插件：

• addClasspath：表示需要加入到类构建路径
• classpathPrefix：指定生成的Manifest文件中Class-Path依赖lib前面都加上该前缀路径，构建出lib/xx.jar
• mainClass：表示项目的启动类。

<build>
   <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-jar-plugin</artifactId>
            <version>3.1.1</version>
            <configuration>
                <archive>
                    <!-- 生成的jar中不要包含pom.xml和pom.properties这两个文件 -->
                    <addMavenDescriptor>false</addMavenDescriptor>
                    <manifest>
                        <addClasspath>true</addClasspath>
                        <classpathPrefix>lib/</classpathPrefix>
                        <!--这里需要修改为你的项目的主启动类-->
                        <mainClass>com.cecjx.business.BusinessApplication</mainClass> 
                    </manifest>
                </archive>
            </configuration>
        </plugin>
    </plugins>
</build>

2.拷贝依赖的jar外面的lib目录

<build>
   <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-dependency-plugin</artifactId>
            <executions>
                <execution>
                    <id>copy-lib</id>
                    <phase>package</phase>
                    <goals>
                        <goal>copy-dependencies</goal>
                    </goals>
                    <configuration>
                        <outputDirectory>target/lib</outputDirectory>
                        <excludeTransitive>false</excludeTransitive>
                        <stripVersion>false</stripVersion>
                        <includeScope>runtime</includeScope>
                    </configuration>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

3.在和jar包同级的目录下新建一个config目录，放入application.yml文件
这里可能有小伙伴有疑问了，打包的jar里面不是应该有application.yml文件吗，这里为什么再放一份？
这是因为springboot读取配置有一个优先级，放在jar包外面config目录优先级最高，主要是便于从外部修改配置，而不是改jar包中的application.yml文件。优先级如下：
　　　　(1)当前目录的config目录下
　　　　(2)当前目录
　　　　(3)classpath的config目录下
　　　　(4)classpath的根目录

4 启动项目
加入–debug可以让你可以看到比较详细的启动日志:
java -jar xxx-1.0.0.jar --debug

### 全自动化部署

前面介绍的步骤中，需要手动的拷贝application.yml文件，并且jar包内外都存在配置。这里引入一种自动化配置，将所有东西打成zip文件，直接发布到服务目录，解压后，即可启动。
1.替换为maven-jar-plugin插件：

• addClasspath：表示需要加入到类构建路径
• classpathPrefix：指定生成的Manifest文件中Class-Path依赖lib前面都加上该前缀路径，构建出lib/xx.jar
• mainClass：表示项目的启动类。

<build>
   <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-jar-plugin</artifactId>
            <version>3.1.1</version>
            <configuration>
                <archive>
                    <!-- 生成的jar中不要包含pom.xml和pom.properties这两个文件 -->
                    <addMavenDescriptor>false</addMavenDescriptor>
                    <manifest>
                        <addClasspath>true</addClasspath>
                        <classpathPrefix>lib/</classpathPrefix>
                        <!--这里需要修改为你的项目的主启动类-->
                        <mainClass>com.cecjx.business.BusinessApplication</mainClass> 
                    </manifest>
                </archive>
            </configuration>
        </plugin>
    </plugins>
</build>

2.拷贝依赖的jar外面的lib目录

<build>
   <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-dependency-plugin</artifactId>
            <executions>
                <execution>
                    <id>copy-lib</id>
                    <phase>package</phase>
                    <goals>
                        <goal>copy-dependencies</goal>
                    </goals>
                    <configuration>
                        <outputDirectory>target/lib</outputDirectory>
                        <excludeTransitive>false</excludeTransitive>
                        <stripVersion>false</stripVersion>
                        <includeScope>runtime</includeScope>
                    </configuration>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

3.排除resources下面的yml(因为我们需要把它放在jar外部,不能让jar打包插件将其打入jar包classpath下去)

<build>
    <plugins>
        <plugin>
            <artifactId>maven-assembly-plugin</artifactId>
            <configuration>
                <!-- 打包后的包名是否包含assembly的id名 -->
                <appendAssemblyId>false</appendAssemblyId>
                <!-- 指定最后tar或者zip包的名字 -->
                <finalName>djys-business</finalName>
                <!-- tar或者zip包的输出目录 -->
                <outputDirectory>target/</outputDirectory>
                <descriptors>
                    <!-- 引用的assembly配置文件-->
                    <descriptor>src/main/resources/assembly.xml</descriptor>
                </descriptors>
            </configuration>
            <executions>
                <!-- phase加入package后，则在执行maven package时就可以调用maven-assembly-plugin插件定义的打包方式 -->
                <execution>
                    <!--名字任意 -->
                    <id>make-assembly</id>
                    <!-- 绑定到package生命周期阶段上 -->
                    <phase>package</phase>
                    <goals>
                        <!-- 只运行一次 -->
                        <goal>single</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

assembly.xml配置，该文件放在resources目录下面即可。

<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>package</id>
    <formats>
        <format>zip</format>
    </formats>
    <includeBaseDirectory>true</includeBaseDirectory>
    <fileSets>
        <!--拷贝application.yml文件到jar包的外部config目录下面-->
        <fileSet>
            <directory>${basedir}/src/main/resources</directory>
            <includes>
                <include>*.yml</include>
            </includes>
            <filtered>true</filtered>
            <outputDirectory>${file.separator}config</outputDirectory>
        </fileSet>

        <!--拷贝lib包到jar包的外部lib下面-->
        <fileSet>
            <directory>${project.build.directory}/lib</directory>
            <outputDirectory>${file.separator}lib</outputDirectory>
            <!-- 打包需要包含的文件 -->
            <includes>
                <include>*.jar</include>
            </includes>
        </fileSet>

        <!--如有需要，可以配置多个需要拷贝的文件即可-->
        <fileSet>
            <directory>${project.build.directory}</directory>
            <outputDirectory>${file.separator}</outputDirectory>
            <includes>
                <include>*.jar</include>
            </includes>
        </fileSet>
    </fileSets>
</assembly>

4.解压zip，启动