且构网

分享程序员开发的那些事...
且构网 - 分享程序员编程开发的那些事

SpringBoot从入门到精通(三十三)Spring Boot项目打包,实现静态文件、配置文件与jar分离!

更新时间:2021-08-16 15:34:17

前面介绍了Spring Boot项目的打包、发布和部署。我们知道Spring Boot打包时,默认是会把resource目录下的静态资源文件和配置文件统一打包到jar文件中。这样部署到生产环境中一旦需要修改配置文件,则非常麻烦。


所以,在实际项目中,需要将静态文件、配置文件和jar包分离。将Jar包的依赖文件、资源文件、配置文件与Jar包分离,如下所示:

SpringBoot从入门到精通(三十三)Spring Boot项目打包,实现静态文件、配置文件与jar分离!

如上图所示,lib目录为依赖jar包目录,html为存放配置文件和静态资源文件目录。这样如果需要修改配置文件、js、css等文件时,直接改html中的相关文件即可,无需更新打包。


下面通过示例演示如何Spring Boot项目打包,实现静态文件、配置文件与jar分离!

一、修改配置

Spring Boot 使用Maven创建的项目能够非常轻松地实现静态文件、配置文件与jar包的分离。

首先修改项目中的pom.xml文件,将pom.xml 配置文件中的节点,修改为自定义maven打包插件即可,配置示例如下:

<build>
    <plugins>
        <!--定义项目的编译环境-->
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <configuration>
                <source>1.8</source>
                <target>1.8</target>
                <encoding>UTF-8</encoding>
            </configuration>
        </plugin>
        <!-- 打JAR包 -->
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-jar-plugin</artifactId>
            <configuration>
                <!-- 不打包资源文件(配置文件和依赖包分开) -->
                <excludes>
                    <exclude>*.yml</exclude>
                    <exclude>*.properties</exclude>
                    <exclude>mapper/**</exclude>
                    <exclude>static/**</exclude>
                    <include>templates/**</include>
                </excludes>
                <archive>
                    <manifest>
                        <addClasspath>true</addClasspath>
                        <!-- MANIFEST.MF 中 Class-Path 加入前缀 -->
                        <classpathPrefix>lib/</classpathPrefix>
                        <!-- jar包不包含唯一版本标识 -->
                        <useUniqueVersions>false</useUniqueVersions>
                        <!--指定入口类 -->
                        <mainClass>com.weiz.example01.Example01Application</mainClass>
                    </manifest>
                    <manifestEntries>
                        <!--MANIFEST.MF 中 Class-Path 加入资源文件目录 -->
                        <Class-Path>./html/</Class-Path>
                    </manifestEntries>
                </archive>
                <outputDirectory>${project.build.directory}</outputDirectory>
            </configuration>
        </plugin>
        <!-- 该插件的作用是用于复制依赖的jar包到指定的文件夹里 -->
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-dependency-plugin</artifactId>
            <executions>
                <execution>
                    <id>copy-dependencies</id>
                    <phase>package</phase>
                    <goals>
                        <goal>copy-dependencies</goal>
                    </goals>
                    <configuration>
                        <outputDirectory>${project.build.directory}/lib/</outputDirectory>
                    </configuration>
                </execution>
            </executions>
        </plugin>
        <!-- 该插件的作用是用于复制指定的文件 -->
        <plugin>
            <artifactId>maven-resources-plugin</artifactId>
            <executions>
                <execution> <!-- 复制配置文件 -->
                    <id>copy-resources</id>
                    <phase>package</phase>
                    <goals>
                        <goal>copy-resources</goal>
                    </goals>
                    <configuration>
                        <resources>
                            <resource>
                                <directory>src/main/resources</directory>
                                <includes>
                                    <include>mapper/**</include>
                                    <include>static/**</include>
                                    <include>templates/**</include>
                                    <include>*.yml</include>
                                    <include>*.properties</include>
                                </includes>
                            </resource>
                        </resources>
                        <outputDirectory>${project.build.directory}/html</outputDirectory>
                    </configuration>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

上面的示例,看起来很复杂。其实,就实现了3个功能:

(1)打包时排查src/main/resources目录下的静态文件和配置文件。

(2)将项目中的依赖库拷贝到lib目录

(2)将src/main/resources目录下静态文件和配置文件拷贝到target目录下。


二、打包项目

在项目根目录下,在控制台执行如下命令:

mvn clean package -Dmaven.test.skip=true

命令执行完之后,就可以看到target目录下,生成了jar包、资源文件和配置文件。jar包文件也变得非常小了。

SpringBoot从入门到精通(三十三)Spring Boot项目打包,实现静态文件、配置文件与jar分离!



最后

以上就把Spring Boot项目打包,资源文件分离介绍完了。我们可以发现生成了jar包、资源文件和配置文件。jar包文件也变得非常小。