SpringBoot分离资源文件打包

Love The Way You Lie 2023-10-18 17:07 75阅读 0赞

> Springboot给了我们很多方便，不再需要单独部署一个tomcat，运行起来也很简单。但是对于配置文件因为项目经常修改的时候，却有些不太方便，每次改完配置都得重新打包。这里我也探索了一下将资源包分离的方式，请看下面的具体实现。

##### 方式一、使用maven插件来打包 #####

###### 1.修改pom文件 ######

首先添加几个插件，`maven-jar-plugin`,`maven-dependency-plugin`,`maven-resources-plugin`

<build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    
                    <includes>
                        <include>
                            <groupId>null</groupId>
                            <artifactId>null</artifactId>
                        </include>
                    </includes>
                    <layout>ZIP</layout>
                    
                    <addResources>true</addResources>
                    <outputDirectory>${project.build.directory}</outputDirectory>
                </configuration>
                <executions>
                    <execution>
                        <goals>
                            <goal>repackage</goal>
                        </goals>
                        <configuration>
                            
                        </configuration>
                    </execution>
                </executions>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-jar-plugin</artifactId>
                <configuration>
                    <archive>
                    	
                        <manifest>
                            <addClasspath>true</addClasspath>
                            <classpathPrefix>lib/</classpathPrefix>
                            <useUniqueVersions>false</useUniqueVersions>
                            <mainClass>com.xxx.StarterApplication</mainClass>
                        </manifest>
                        <manifestEntries>
                            
                            <Class-Path>./config/</Class-Path>
                        </manifestEntries>
                    </archive>
                </configuration>
            </plugin>
            <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>
    								
                                    
                                    
                                    
                                </resource>
                            </resources>
                           	
                            <outputDirectory>${project.build.directory}/config</outputDirectory>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>

###### 2.打包 ######

然后执行`mvn clear`和`mvn install`或直接`mvn clean install`，之后可以在`target`目录看到相应的包和文件  
![在这里插入图片描述][20190415095344801.]  
打开`config`目录看一下  
![在这里插入图片描述][20190415100010235.]  
原来`resource`的配置文件都打包进来了，当然`lib`也是一样的。

###### 3.执行 ######

可以将这几个目录和文件拷贝出来，然后编写启动脚本

@echo off
    java -jar xxx-service.jar

保存为`startup.bat`,双击文件即可执行.然后可以试着修改一下`application.yml`的配置再次运行看看效果

##### 方式二、使用assembly插件 #####

1.修改pom文件

<build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-jar-plugin</artifactId>
                <configuration>
                    <archive>
                        <manifest>
                            <addClasspath>true</addClasspath>
                            <classpathPrefix>lib/</classpathPrefix>
                            <useUniqueVersions>false</useUniqueVersions>
                            <mainClass>com.xxx.StarterApplication</mainClass>
                        </manifest>
                        <manifestEntries>
                            
                            <Class-Path>./resource/</Class-Path>
                        </manifestEntries>
                    </archive>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-assembly-plugin</artifactId>
                
                <configuration>
                    
                    <descriptors>
                        <descriptor>src/main/package.xml</descriptor>
                    </descriptors>
                </configuration>
                <executions>
                    <execution>
                        <id>make-assembly</id>
                        <phase>package</phase>
                        <goals>
                            <goal>single</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
        <resources>
        	
            <resource>
                <directory>src/main/java</directory>
                <includes>
                    <include>**/*.xml</include>
                </includes>
                <filtering>false</filtering>
            </resource>
            
            <resource>
                <directory>src/main/resources</directory>
                <includes>
                    <include>**/*.xml</include>
                </includes>
            </resource>
            
            <resource>
                <directory>lib/</directory>
                <targetPath>lib</targetPath>
                <includes>
                    <include>**/*.jar</include>
                </includes>
            </resource>
        </resources>
    </build>

###### package.xml文件 ######

然后在`src/main/`目录新建一个`package.xml`文件

<?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>${project.build.directory}/classes</directory>
                <outputDirectory>config</outputDirectory>
                <includes>
                    <include>*.properties</include>
                    <include>*.yml</include>
                </includes>
            </fileSet>
    
            
            <fileSet>
                <directory>${project.build.directory}</directory>
                <outputDirectory>/</outputDirectory>
                <includes>
                    <include>*.jar</include>
                </includes>
            </fileSet>
        </fileSets>
    </assembly>

###### 2.打包 ######

然后执行`mvn clear`和`mvn install`或直接`mvn clean install`，之后可以在`target`目录看到相应的包和文件  
![在这里插入图片描述][20190415103558670.]  
多了一个`zip`的包，解压出来可以看到  
![在这里插入图片描述][20190415103643903.]  
`config`目录里面的文件结构  
![在这里插入图片描述][2019041510370634.]

###### 3.执行 ######

@echo off
    java -jar xxx-service.jar --spring.config.location=config/application.yml

保存为`startup.bat`，试着修改一下`application.yml`的配置再次运行看看效果

--------------------

###### 参考： ######

https://www.jianshu.com/p/dbdece9062b3  
https://blog.csdn.net/u013314786/article/details/81120240

--------------------

2020-11-05 补充  
一个项目一个jar包的配置

<build>
      <plugins>
          <plugin>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-maven-plugin</artifactId>
             <version>2.2.6.RELEASE</version>
             <configuration>
                 <fork>true</fork> 
             </configuration>
             <executions>
                <execution>
                    <goals>
                      <goal>repackage</goal>
                    </goals>
                </execution>
             </executions>
          </plugin>
          <plugin>
              <groupId>org.apache.maven.plugins</groupId>
              <artifactId>maven-war-plugin</artifactId>
              <version>3.1.0</version>
              <configuration>
                  <failOnMissingWebXml>false</failOnMissingWebXml>
                  <warName>${project.artifactId}</warName>
              </configuration>
          </plugin>
      </plugins>
      <finalName>${project.artifactId}</finalName>
    </build>

[20190415095344801.]: https://img-blog.csdnimg.cn/20190415095344801.
[20190415100010235.]: https://img-blog.csdnimg.cn/20190415100010235.
[20190415103558670.]: https://img-blog.csdnimg.cn/20190415103558670.
[20190415103643903.]: https://img-blog.csdnimg.cn/20190415103643903.
[2019041510370634.]: https://img-blog.csdnimg.cn/2019041510370634.