springboot打包JAR包瘦身lib和配置文件分離方式

更新時(shí)間：2024年11月21日 14:50:57 作者：H90P0820

本文介紹了如何通過優(yōu)化POM.xml配置來減小JAR包大小,提高傳輸速度,主要步驟包括：指定打包環(huán)境和跳過編譯單元測(cè)試、JAR打包排除配置文件和lib、提供全量包便于開發(fā)環(huán)境使用、將lib和配置文件單獨(dú)復(fù)制出來

springboot打包JAR包瘦身lib和配置文件分離

最近項(xiàng)目在部署使用的過程中，傳輸JAR包的時(shí)候發(fā)現(xiàn)JAR包有點(diǎn)大，傳輸速度有點(diǎn)慢。

筆者基于這個(gè)前提對(duì)項(xiàng)目的打包配置進(jìn)行優(yōu)化進(jìn)行探索，一般來說lib是很少修改，配置文件會(huì)根據(jù)需求會(huì)有所變動(dòng)，如果講配置文件打進(jìn)JAR生產(chǎn)環(huán)境會(huì)修改等不便等操作。

以下配置再pom.xml中 <build> <plugins>添加相關(guān)配置</plugins></build>

1.指定打包環(huán)境和跳過編譯單元測(cè)試

<!--定義項(xiàng)目的編譯環(huán)境-->
			<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>
			<!--默認(rèn)執(zhí)行src/test/java路徑下的測(cè)試用例，建議跳過執(zhí)行-->
			<plugin>
				<groupId>org.apache.maven.plugins</groupId>
				<artifactId>maven-surefire-plugin</artifactId>
				<configuration>
					<skip>true</skip>
				</configuration>
			</plugin>

2.JAR打包排除配置文件和lib

<plugin>
				<groupId>org.apache.maven.plugins</groupId>
				<artifactId>maven-jar-plugin</artifactId>
				<version>3.2.0</version>
				<configuration>
					<!-- 不打包資源文件,如果放開全量JAR也不會(huì)打進(jìn)去-->
<!--					<excludes>-->
<!--						<exclude>*.yml</exclude>-->
<!--						<exclude>*.properties</exclude>-->
<!--					</excludes>-->
					<archive>
						<manifest>
							<addClasspath>true</addClasspath>
							<!-- MANIFEST.MF 中 Class-Path 加入前綴 -->
							<classpathPrefix>lib/</classpathPrefix>
							<!-- jar包不包含唯一版本標(biāo)識(shí) -->
							<useUniqueVersions>false</useUniqueVersions>
							<!--指定啟動(dòng)入口類 -->
							<mainClass>com.xxxx.Application</mainClass>
						</manifest>
						<manifestEntries>
							<!--MANIFEST.MF 中 Class-Path 加入資源文件目錄 -->
							<Class-Path>./resources/</Class-Path>
						</manifestEntries>
					</archive>
					<outputDirectory>${project.build.directory}</outputDirectory>
				</configuration>
			</plugin>

3.如果需要全量包也可以增加如下配置

便于開發(fā)環(huán)境打包使用

			<!--全量JAR包，最初的打包方式，springboot的默認(rèn)編譯插件，默認(rèn)會(huì)把所有的文件打包成一個(gè)jar,-->
			<plugin>
				<groupId>org.springframework.boot</groupId>
				<artifactId>spring-boot-maven-plugin</artifactId>
				<executions>
					<execution>
						<goals>
							<goal>repackage</goal>
						</goals>
					</execution>
				</executions>
				<configuration>
                    <!--設(shè)置springboot的啟動(dòng)類或者是JAR包的啟動(dòng)類-->
					<mainClass>com.xxxx.Application</mainClass>
					<fork>true</fork>
					<addResources>true</addResources>
					<outputDirectory>${project.build.directory}/jar</outputDirectory>
				</configuration>
			</plugin>

4.將lib和配置文件單獨(dú)復(fù)制出來

<!--復(fù)制關(guān)聯(lián)JAR包到指定lib打包目錄 ，target目錄下的文件夾下，按需修改 -->
			<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>

			<!-- 復(fù)制配置文件到指定resources打包目錄 ，target目錄下的文件夾下，按需修改-->
			<plugin>
				<groupId>org.apache.maven.plugins</groupId>
				<artifactId>maven-resources-plugin</artifactId>
				<version>3.2.0</version>
				<executions>
					<execution> <!-- 復(fù)制配置文件 -->
						<id>copy-resources</id>
						<phase>package</phase>
						<goals>
							<goal>copy-resources</goal>
						</goals>
						<configuration>
							<resources>
								<resource>
									<directory>src/main/resources</directory>
									<includes>
										<include>*.yml</include>
										<include>*.properties</include>
									</includes>
								</resource>
							</resources>
							<outputDirectory>${project.build.directory}/resources</outputDirectory>
						</configuration>
					</execution>
				</executions>
			</plugin>

5.全量配置如下,拷貝即用

注意啟動(dòng)類的指定：

以下配置再pom.xml中 <build> 添加相關(guān)配置</build>

	<!--拆分配置文件和LIB，給JAR瘦身-->
		<!--啟動(dòng)參考命令，再JAR目錄執(zhí)行，也可以指定絕對(duì)路徑：
${project.build.directory}工程路徑下的target目錄
		Dloader.path:加載本地lib
		Dspring.config.location:加載本地配置
		server.port：指定端口
		/-/- 這個(gè)有轉(zhuǎn)義，注命令要去掉/
		java -Dloader.path=lib/ -jar xxxx.jar /-/-Dspring.config.location=resources/ /-/-server.port=8080
		-->
		<plugins>
			<!--定義項(xiàng)目的編譯環(huán)境-->
			<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>
			<!--默認(rèn)執(zhí)行src/test/java路徑下的測(cè)試用例，建議跳過執(zhí)行-->
			<plugin>
				<groupId>org.apache.maven.plugins</groupId>
				<artifactId>maven-surefire-plugin</artifactId>
				<configuration>
					<skip>true</skip>
				</configuration>
			</plugin>
			<!--全量JAR包，最初的打包方式，springboot的默認(rèn)編譯插件，默認(rèn)會(huì)把所有的文件打包成一個(gè)jar-->
			<plugin>
				<groupId>org.springframework.boot</groupId>
				<artifactId>spring-boot-maven-plugin</artifactId>
				<executions>
					<execution>
						<goals>
							<goal>repackage</goal>
						</goals>
					</execution>
				</executions>
				<configuration>
					<mainClass>com.xxxx</mainClass>
					<fork>true</fork>
					<addResources>true</addResources>
					<outputDirectory>${project.build.directory}/jar</outputDirectory>
				</configuration>
			</plugin>
			<!-- 打JAR包 -->
			<plugin>
				<groupId>org.apache.maven.plugins</groupId>
				<artifactId>maven-jar-plugin</artifactId>
				<version>3.2.0</version>
				<configuration>
					<!-- 不打包資源文件,如果放開全量JAR也不會(huì)打進(jìn)去-->
<!--					<excludes>-->
<!--						<exclude>*.yml</exclude>-->
<!--						<exclude>*.properties</exclude>-->
<!--					</excludes>-->
					<archive>
						<manifest>
							<addClasspath>true</addClasspath>
							<!-- MANIFEST.MF 中 Class-Path 加入前綴 -->
							<classpathPrefix>lib/</classpathPrefix>
							<!-- jar包不包含唯一版本標(biāo)識(shí) -->
							<useUniqueVersions>false</useUniqueVersions>
							<!--指定springboot啟動(dòng)入口類 -->
							<mainClass>com.xxxx</mainClass>
						</manifest>
						<manifestEntries>
							<!--MANIFEST.MF 中 Class-Path 加入資源文件目錄 -->
							<Class-Path>./resources/</Class-Path>
						</manifestEntries>
					</archive>
					<outputDirectory>${project.build.directory}</outputDirectory>
				</configuration>
			</plugin>
			<!--復(fù)制關(guān)聯(lián)JAR包到指定lib打包目錄 ，target目錄下的文件夾下，按需修改 -->
			<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>

			<!-- 復(fù)制配置文件到指定resources打包目錄 ，target目錄下的文件夾下，按需修改-->
			<plugin>
				<groupId>org.apache.maven.plugins</groupId>
				<artifactId>maven-resources-plugin</artifactId>
				<version>3.2.0</version>
				<executions>
					<execution> <!-- 復(fù)制配置文件 -->
						<id>copy-resources</id>
						<phase>package</phase>
						<goals>
							<goal>copy-resources</goal>
						</goals>
						<configuration>
							<resources>
								<resource>
									<directory>src/main/resources</directory>
									<includes>
										<include>*.yml</include>
										<include>*.properties</include>
									</includes>
								</resource>
							</resources>
							<outputDirectory>${project.build.directory}/resources</outputDirectory>
						</configuration>
					</execution>
				</executions>
			</plugin>
		</plugins>