将spring boot项目成jar包，并把配置文件等放在jar包外部

接上篇：如何使用maven打包spring boot项目，打成jar包

前面说了如何将springboot项目打包成jar包，但是这样打包会将所有文件都放入jar包。当我们部署在其他地方需要修改配置时就比较麻烦，那么怎么实现将配置文件打包在外面呢？首先看下我项目的配置文件路径结构：

目标是将自定义config文件下的properties文件和默认application.properties文件放在jar包外

下面是教程：

1.首先在pom.xml文件中添加两个plugin:

<plugin>
	<groupId>org.apache.maven.plugins</groupId>
	<artifactId>maven-jar-plugin</artifactId>
	<configuration>
		<archive>
			<manifest>
				<addClasspath>true</addClasspath>
				<classpathPrefix></classpathPrefix>
				<mainClass>com.Application</mainClass>
			</manifest>
		</archive>
	</configuration>
</plugin>
<plugin>
	<groupId>org.apache.maven.plugins</groupId>
	<artifactId>maven-assembly-plugin</artifactId>
	<!-- The configuration of the plugin -->
	<configuration>
		<descriptors>
			<descriptor>src/main/resources/config/package.xml</descriptor>
		</descriptors>
	</configuration>
	<executions>
		<execution>
			<id>make-assembly</id>
			<phase>package</phase>
			<goals>
				<goal>single</goal>
			</goals>
		</execution>
	</executions>
</plugin>	<groupId>org.apache.maven.plugins</groupId>
	<artifactId>maven-jar-plugin</artifactId>
	<configuration>
		<archive>
			<manifest>
				<addClasspath>true</addClasspath>
				<classpathPrefix></classpathPrefix>
				<mainClass>com.Application</mainClass>
			</manifest>
		</archive>
	</configuration>
</plugin>
<plugin>
	<groupId>org.apache.maven.plugins</groupId>
	<artifactId>maven-assembly-plugin</artifactId>
	<!-- The configuration of the plugin -->
	<configuration>
		<descriptors>
			<descriptor>src/main/resources/config/package.xml</descriptor>
		</descriptors>
	</configuration>
	<executions>
		<execution>
			<id>make-assembly</id>
			<phase>package</phase>
			<goals>
				<goal>single</goal>
			</goals>
		</execution>
	</executions>
</plugin>

 

上面配置中的2个plugin分别是：

 

maven-jar-plugin：负责将应用程序打包成可执行的jar文件 

maven-assembly-plugin：负责将整个项目按照自定义的目录结构打成最终的压缩包，方便实际部署

2.在src/main/resources/下新建一个config文件,并新增一个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>
        <!-- 把项目相关的说明文件，打包进zip文件的根目录 -->
        <fileSet>
            <directory>${project.basedir}</directory>
            <outputDirectory>/</outputDirectory>
            <includes>
            	<include>*.sql</include>
                <include>*.bat</include>
                <include>*.md</include>
                <!-- <include>LICENSE*</include>
                <include>NOTICE*</include>
                <include>build.info</include> -->
            </includes>
        </fileSet>


        <fileSet>
            <directory>${project.basedir}/src/main/resources</directory>
            <outputDirectory>/</outputDirectory>
            <includes>
                <include>config/*.xml</include>
                <include>config/*.properties</include>
                <include>*.properties</include>
            </includes>
        </fileSet>
        <!-- 把项目自己编译出来的jar文件，打包进zip文件的根目录 -->
        <fileSet>
            <directory>${project.build.directory}</directory>
            <outputDirectory>/</outputDirectory>
            <includes>
                <include>*.jar</include>
            </includes>
        </fileSet>
    </fileSets>
</assembly>  

现在整个配置就完成了，按照上篇文章的内容运行打包后结果如下：

解压zip后目录结构：

可以看到，已经将application.properties和config下的properties文件放在jar包外了。但是这里需要注意的是：我们现在只是将配置文件打包在jar包外，实际jar包里面还有一份，jar包运行的时候实质还是执行的jar包里面的配置文件，现在修改外面的配置文件是没有用的。那我们为什么还要打包出来呢？实际上我们可以通过在pom.xml文件添加配置将jar包里面的配置删掉。但是，这样做如果程序本身在开发的时没有将配置路径写成外部路径的话会报错导致程序无法运行的。所以我更推荐通过命令指定程序运行时执行外部配置文件，当不执行命令参数时，程序会执行jar包里面的配置正常运行。执行命令参数如下：

<strong>java -jar -Dspring.config.location=%cd%\application.properties -Dlogging.path=%cd%\log %cd%\xxx.jar</strong>

%d%:表示当前application.properties所在的目录路径（需要自行修改成自己的路径）

xxx.jar:表示自己的jar包名字

-Dspring.config.location:指定spring运行时执行的config路径，这里指我们的application.properties文件所在路径

-Dlogging.path:指定日志文件存放路径（根据自己需求填写）

最后是效果图：

验证：当我们在外部更改配置信息后，重启项目发现生效即成功！当不带参数只执行

 

<strong>java -jar %cd%\xxx.jar</strong>

发现变回默认配置启动！我就不贴图了。最后，更改config文件里面的内容发现没效果，只是更改application.properties配置文件才有效，自定义的配置文件无效，怎么解决呢？这个和打包关系不大，主要是引用外部资源的问题，下次再写吧。。。

上一篇：如何使用maven将spring boot项目打成jar包

下一篇：Spring boot项目读取自定义的config文件