美文网首页
Spring Boot应用打包时不包含关联jar包以及配置文件

Spring Boot应用打包时不包含关联jar包以及配置文件

作者: jackzh | 来源:发表于2019-02-12 18:23 被阅读5次

1. pom.xml中的配置

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-jar-plugin</artifactId>
            <configuration>
                <excludes>
                    <exclude>**/*.properties</exclude>
                    <exclude>**/*.xml</exclude>
                    <exclude>**/*.yml</exclude>
                    <exclude>static/**</exclude>
                    <exclude>templates/**</exclude>
                </excludes>
            </configuration>
        </plugin>

        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
            <configuration>
                <layout>ZIP</layout>
                <includes>
                    <include>
                        <groupId>non-exists</groupId>
                        <artifactId>non-exists</artifactId>
                    </include>
                </includes>
            </configuration>
            <!--
            <executions>
                <execution>
                    <goals>
                        <goal>repackage</goal>
                    </goals>
                    <configuration>
                        <classifier>classes</classifier>
                        <attach>false</attach>
                    </configuration>
                </execution>
            </executions>
            -->
        </plugin>

        <plugin>
            <artifactId>maven-assembly-plugin</artifactId>
            <configuration>
                <descriptors>
                    <descriptor>assembly.xml</descriptor>
                </descriptors>
                <finalName>saas-wechat-webapp-${project.version}</finalName>
                    <appendAssemblyId>false</appendAssemblyId>
                </configuration>
                <executions>
                    <execution>
                        <phase>package</phase>
                        <goals>
                            <goal>single</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>
插件 说明
maven-jar-plugin 通过此配置,可以在生成jar包时,不包含resources中的配置文件以及可能存在的网页模板等信息
spring-boot-maven-plugin 这个是spring boot使用的插件,通过相关的配置可以不生成fat jar包,即在jar包中不包含关联的jar包,其中的executions配置是可以将springboot启动相关的类单独打在一个包中,不需要的话,就注释掉即可
maven-assembly-plugin 这个assembly插件,可以根据需要生成相关的发布目录,并进行压缩打包处理。使用此插件后,可以在命令行运行mvn package就会自动进行打包处理

2. assembly.xml配置文件

assembly插件是根据配置将代码进行组织,如果我们不使用fatjar包格式,那么可以使用这个插件,组织好发布运行相关的目录。

准备发布的项目目录结构如下:

$ ---
    |-- config:保存系统相关的配置文件
    |-- static: 保存所有静态页面的文件,如果是前后端分离的情况,就是前端代码所在
    |-- resources: 保存项目自己的页面模板等代码
    |-- lib: 保存所有依赖的jar包
    |-- xxxxx-main.jar: 项目主要的运行包,包括了springboot所有相关的启动类
    |-- startup.sh: 系统启动脚本
    |-- shutdown.sh: 系统停止脚本
  • 通过以下配置将配置文件拷贝到发布包的config目录下
<fileSet>
    <directory>target/classes</directory>
    <outputDirectory>config</outputDirectory>
    <includes>
        <include>*.yml</include>
        <include>*.xml</include>
        <include>*.properties</include>
    </includes>
</fileSet>
  • 通过以下配置将页面模板等信息拷贝到发布包的static目录下
<fileSet>
    <directory>target/classes</directory>
    <outputDirectory>resources</outputDirectory>
    <includes>
        <include>static/**</include>
        <include>templates/**</include>
    </includes>
</fileSet>
  • 通过以下配置将项目所有依赖包拷贝到发布包的lib目录下
<dependencySets>
    <dependencySet>
        <outputDirectory>lib</outputDirectory>
        <useProjectArtifact>false</useProjectArtifact>
    </dependencySet>
</dependencySets>

3. 定制run命令

spring boot classpath搜索次序:

1. 当前目录下的 /config  子目录。
2. 当前目录。
3. classpath下的 /config  包。
4. classpath根路径(root)。
该列表是按优先级排序的(列表中位置高的路径下定义的属性将覆盖位置低的)

spring boot对资源文件的处理方式:

  • 默认的静态资源路径有:classpath:/META-INF/resources/,classpath:/resources/,classpath:/static/,classpath:/public/,都是放在classpath中,在fatjar的情况下,都是直接压缩在jar包中的,要做到修改非常不方便。

  • 可以通过修改spring.resources.static-locations使用默认的配置失效,从而定义自己指定的地址,如

    spring.resources.static-locations=classpath:/META-INF/resources/,\
                                      classpath:/resources/,\
                                      classpath:/static/,\
                                      classpath:/public/,\
                                      file:/data/service/saas-ggb-server/static/,\
                                      file:${web.file.upload.path},\
                                      file:${qr.path}
    

    从spring boot搜索classpath来说,如果static、public、resources等目录在当前运行目录下,也可以搜索到

在启动时直接使用类似如下的命令即可:

java -Dloader.path=./lib,config -jar xxxxx-main.jar

4. 使用jenkins部署时的要点

  • 在第一次发布时,可以直接把打包好的zip上传到服务器进行安装(解压即可)
  • 以后在发布时,基本不需要更新常用的第三方jar包,只需要更新与业务相关的自己的jar包即可,所以在对maven项目命名时,最好设计相关便于识别的jar包的名称

相关文章

网友评论

      本文标题:Spring Boot应用打包时不包含关联jar包以及配置文件

      本文链接:https://www.haomeiwen.com/subject/czgkeqtx.html