Springboot 瘦身打包

分离 lib 依赖和资源文件

在实际生产过程中，常常会遇到资源打包文件太大，在部署的时候很不方便，传统的打包方式会将所有的文件（jar 和资源配置文件）都打包在了一个 jar 文件中，这样后期在修改配置信息的时候，相当的不方便。

因此，如何将项目本身的 jar 文件和依赖 jar 文件分离，并把资源文件也分离出来，分别独立成自己的文件目录是很有必要的。

一、传统打包方式
传统的打包方式在 pom.xml 中只需要在 build 插件中配置spring-boot-maven-plugin即可：

<plugin><groupId>org.springframework.boot</groupId><artifactId>spring-boot-maven-plugin</artifactId>
</plugin>

打包出来的 jar 包是下面这样的，项目生成了target文件目录，里面打包好了一个完整的 jar 文件，直接使用：java -jar king-0.0.1-SNAPSHOT.jar就能运行了。

打成完整的 jar 包

将 jar 包解压开，会得到下面的目录结构：

打成完整 jar 包的内部结构

注意在META-INF文件目录中存在MANIFEST.MF文件，里面记录了启动类Start-Class 、依赖类Spring-Boot-Lib等信息。

运行 jar 包的时候，首先启动的是启动类，并依赖BOOT-INF/lib/文件目录中的 jar 文件。

二、springboot 打包 lib 和资源文件分离
现在有如下的打包需求：

项目自身 jar 文件打包在 zip 包根目录下，其他所有依赖包打包在lib文件夹下，资源文件全部打包在resources文件目录下，项目运行的脚本文件打包在bin文件目录下。

在pom.xml配置：

<build><plugins><!--打包jar --><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-jar-plugin</artifactId><configuration><!--不打包资源文件 --><excludes><exclude>bin/**</exclude><exclude>config/**</exclude><exclude>static/**</exclude><exclude>templates/**</exclude><exclude>*.yml</exclude></excludes><!-- <archive><manifest><addClasspath>true</addClasspath>// MANIFEST.MF 中 Class-Path 加入前缀，不需要配置，在外部命令行指定                         <classpathPrefix>lib/</classpathPrefix> // jar包不包含唯一版本标识 <useUniqueVersions>false</useUniqueVersions>
`                       // 指定入口类,如果程序里只有一个main方法就建议不要手动配置 <mainClass>org.woodwhale.king.KingApplication</mainClass></manifest><manifestEntries> // MANIFEST.MF 中 Class-Path 加入资源文件目录，不需要配置，在外部命令行指<Class-Path>./resources/</Class-Path> </manifestEntries></archive>--><!-- 生成到 target 目录下，也可以放到指定目录，例如： ${project.build.directory}/boot--><outputDirectory>${project.build.directory}</outputDirectory></configuration></plugin><!--拷贝依赖 copy-dependencies --><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><overWriteReleases>false</overWriteReleases><overWriteSnapshots>false</overWriteSnapshots><overWriteIfNewer>true</overWriteIfNewer></configuration></execution></executions></plugin><!--拷贝资源文件 copy-resources --><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-resources-plugin</artifactId><executions><execution><id>copy-resources</id><phase>package</phase><goals><goal>copy-resources</goal></goals><configuration><encoding>UTF-8</encoding><resources><resource><directory>src/main/resources</directory></resource></resources><outputDirectory>${project.build.directory}/resources</outputDirectory></configuration></execution></executions></plugin><!-- spring boot repackage，依赖 maven-jar-plugin 打包的jar包 重新打包成 spring boot的jar包--><plugin><groupId>org.springframework.boot</groupId><artifactId>spring-boot-maven-plugin</artifactId><configuration><!-- 包含本地 jar 依赖 --><includeSystemScope>true</includeSystemScope><!-- 重写包含依赖，包含不存在的依赖，jar里没有pom里的依赖 --><includes><include><groupId>null</groupId><artifactId>null</artifactId></include></includes><layout>ZIP</layout><!-- 使用外部配置文件，jar包里没有资源文件 --><addResources>true</addResources><outputDirectory>${project.build.directory}</outputDirectory></configuration><executions><execution><goals><goal>repackage</goal></goals><configuration><!-- 配置jar包特殊标识 配置后，保留原文件，生成新文件 *-run.jar 配置jar包特殊标识 不配置， 原文件命名为 *.jar.original，生成新文件 *.jar--><classifier>run</classifier></configuration></execution></executions></plugin><!-- 打包发布时，跳过单元测试 --><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-surefire-plugin</artifactId><configuration><skipTests>true</skipTests></configuration></plugin><!-- 使用assembly打zip包 --><plugin><artifactId>maven-assembly-plugin</artifactId><configuration><appendAssemblyId>false</appendAssemblyId><descriptors><!-- assembly配置文件位置 --><descriptor>assembly.xml</descriptor></descriptors></configuration><executions><execution><id>make-assembly</id><phase>package</phase><goals><goal>single</goal></goals></execution></executions></plugin></plugins>
</build>

注意：在spring-boot-maven-plugin中配置了包含本地jar依赖的配置<includeSystemScope>true</includeSystemScope>

在项目根目录下存在放置assembly.xml配置：

<assemblyxmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2 http://maven.apache.org/xsd/assembly-1.1.2.xsd"><id>${project.artifactId}</id><formats><format>zip</format></formats><!-- 压缩包下是否生成和项目名相同的根目录 --><includeBaseDirectory>false</includeBaseDirectory><baseDirectory>${project.artifactId}-${project.version}</baseDirectory><fileSets><fileSet><directory>${project.build.directory}</directory><outputDirectory></outputDirectory> <includes><include>${artifact.artifactId}-${artifact.version}.jar</include></includes></fileSet><fileSet>  <directory>src/main/resources</directory><outputDirectory>${file.separator}resources</outputDirectory></fileSet><fileSet>  <directory>bin/</directory><outputDirectory>${file.separator}bin</outputDirectory></fileSet><fileSet>  <directory>lib/</directory><outputDirectory>${file.separator}lib</outputDirectory></fileSet></fileSets><!-- 使用项目的artifact，第三方 jar 打包进zip文件的 lib 目录 --><dependencySets><dependencySet><useProjectArtifact>true</useProjectArtifact><outputDirectory>lib</outputDirectory><scope>runtime</scope><includes><include>*:*</include></includes><excludes><exclude>${groupId}:${artifactId}</exclude><exclude>org.springframework.boot:spring-boot-devtools</exclude></excludes></dependencySet></dependencySets>
</assembly>

在bin脚本文件目录中放置脚本文件和配置文件：

配置文件用于指定 jar 的名称及版本信息

ARTIFACTID=king
VERSION=0.0.1

windows 脚本start.bat文件：

ECHO offECHO "checking config.ini..."SET ROOT=%~dp0
SET CONFIG_FILE=%ROOT%config.ini
REM **从配置文件中读取内容**
FOR /F "tokens=1,2 delims==" %%i IN (%CONFIG_FILE%) DO (SET %%i=%%j
)
SET APP_NAME=%ARTIFACTID%-%VERSION%IF "%APP_NAME%" == "" (ECHO "this config.ini is not exist，please check this config file."  GOTO End
) ELSE (ECHO "checking JAVA_HOME config from checking config.ini..."GOTO OkPath
):OkPath
echo "check java_home..."
if not "%JAVA_HOME%" == "" GOTO OkJHome:OkJHome
if exist "%JAVA_HOME%\bin\java.exe" GOTO Runserver:Runserver
SET JAR_NAME=%APP_NAME%.jar
SET APP_CONFIG=-Dloader.path=.,resources,libECHO "111:%RUN_JAVA%"
ECHO "Starting the %JAR_NAME%"ECHO "%JAVA_HOME%\bin\java -Xms512m -Xmx512m -jar %APP_CONFIG% %JAR_NAME%"
CD ..
%JAVA_HOME%\bin\java.exe -Xms512m -Xmx512m -jar %APP_CONFIG% %JAR_NAME%
GOTO End:End
PAUSE

脚本解释：最为关键的就是运行jar 文件的时候携带-Dloader.path=.,resources,lib

linux 脚本startup.sh文件：

#!/bin/sh## java env
export JAVA_HOME=/usr/java/jdk1.8.0_162
API_NAME=./king-0.0.1.jarexport JRE_HOME=JAVA_HOME/jre
API_CONFIG=.,resources,lib
JAR_NAME=$API_NAME.jar
PID=$API_NAME.pidusage() {echo "Usage: sh startup.sh [start|stop|restart|status]"exit 1
}is_exist(){pid=`ps -ef|grep $JAR_NAME|grep -v grep|awk '{print $2}' `if [ -z "${pid}" ]; thenreturn 1elsereturn 0fi
}start(){is_existif [ $? -eq "0" ]; then echo ">>> ${JAR_NAME} is already running PID=${pid} <<<" else nohup $JRE_HOME/bin/java -Xms256m -Xmx512m -jar -Dloader.path=$API_CONFIG $JAR_NAME >/dev/null 2>&1 &echo $! > $PIDecho ">>> start $JAR_NAME successed PID=$! <<<" fi}stop(){#is_existpidf=$(cat $PID)#echo "$pidf"  echo ">>> api PID = $pidf begin kill $pidf <<<"kill $pidfrm -rf $PIDsleep 2is_existif [ $? -eq "0" ]; then echo ">>> api 2 PID = $pid begin kill -9 $pid  <<<"kill -9  $pidsleep 2echo ">>> $JAR_NAME process stopped <<<"  elseecho ">>> ${JAR_NAME} is not running <<<"fi
}status(){is_existif [ $? -eq "0" ]; thenecho ">>> ${JAR_NAME} is running PID is ${pid} <<<"elseecho ">>> ${JAR_NAME} is not running <<<"fi
}restart(){stopstart
}case "$1" in"start")start;;"stop")stop;;"status")status;;"restart")restart;;*)usage;;
esac
exit 0

shell 脚本里需要配置JAVA_HOME路径和 jar 文件名即可。

Springboot 瘦身打包相关推荐

springboot瘦身打包
为什么瘦身打包:Spring Boot把整个项目打包成一个可运行的Jar包(即所谓的Fat Jar),导致了这个Jar包很大(通常有40M+).如今迭代发布时常有的事情,每次都上传一个如此庞大的文件, ...
SpringBoot瘦身打包部署
一.前言最近做的项目由于引入第三方库导致在运行mvn clean package 打jar时,编译出来的 Jar 包很大(服务器多达500MB). 二.瘦身前的Jar包 SpringBoot编译出来 ...
Springboot瘦身（lib和程序分开打包）
Springboot瘦身(lib和程序分开打包) 1. 首先用mvn clean package正常打出jar包这个jar包可能有几百兆大小,lib占了绝大多数将jar包解压,将 BOOT-INF ...
Maven打包(瘦身打包部署)，不包含第三方依赖jar包
方式1 pom 配置 <properties><startClass>com.answer.jaemon.Application</startClass> < ...
spring boot项目精简瘦身打包
1.背景介绍当网络不是很给力的时候,一个大的jar包传输是费时的,往往存在修改1分钟,传包10分钟的尴尬时刻. 1)正常打包出来的jar 2)解压出来后的包大小98M 3)lib的jar包大小综上 ...
Spring Boot Gradle 瘦身打包 thinJar，分离 lib jar 依赖
原文地址:weiku.co/article/135/ ,欢迎转载需求背景: srping boot 2.0+ 打包生产的 fat jar 虽然部署起来很方便,但将所有依赖都打包到一个 jar 包中使 ...
SpringBoot瘦身
1. 什么是瘦身 SpringBoot应用瘦身指的是:将SpringBoot应用打包利用合理的方式减小体积. 2. 为什么要瘦身现有的应用开发中,springboot作为底层框架,打包时最终都会以j ...
spring boot 瘦身打包排除其他依赖jar包
一个普通的spring boot项目差不多就要50M左右的大小,随着项目的进行,代码包大小才1M以内,对于我们开发人员来说是一种极大的痛苦,查找了一下网上的资源, 在<excludeGroupI ...
SpringBoot-Maven打包压缩瘦身
SpringBoot-Maven打包压缩瘦身一.Spring Boot 可执行 jar 分析 1.1 打包 1.2 两种 jar 的比较 1.3 一次打包两个 jar 二.SpringBoot迭代发 ...

Springboot 瘦身打包

分离 lib 依赖和资源文件

Springboot 瘦身打包相关推荐

最新文章

热门文章