SpringBoot 打包部署最佳实践
共 8611字，需浏览 18分钟
·
2021-09-23 14:29
spring boot介绍
Spring Boot目前流行的java web应用开发框架，相比传统的spring开发，spring boot极大简化了配置，并且遵守约定优于配置的原则即使0配置也能正常运行，这在spring中是难以想象的。spring boot应用程序可以独立运行，框架内嵌web容器，使得web应用程序可以像本地程序一样启动和调试，十分的方便，这种设计方式也使得spring boot应用程序非常适合容器化进行大规模部署。生态方面，spring boot提供了非常丰富的组件，目前流行的java web框架基本都有spring boot版本，生态十分庞大，是目前java web开发最好的方案。
Springboot应用程序有两种运行方式
以jar包方式运行
以war包方式运行
两种方式应用场景不一样，各有优缺点
通过插件spring-boot-maven-plugin，在进行打包时，会动态生成jar的启动类org.springframework.boot.loader.JarLauncher，借助该类对springboot应用程序进行启动。
本地无需搭建web容器，方便开发和调试。
因为自带web容器，可以避免由于web容器的差异造成不同环境结果不一致问题。
一个jar包就是全部，方便应用扩展。
借助容器化，可以进行大规模的部署。
应用过于独立，难以统一管理。
数据源无法通过界面进行管理。
应用体积过大。
修改web容器相关配置较为困难，需要借助代码实现。
以war包方式运行，通过maven插件spring-boot-maven-plugin进行相关配置后，最终生成一个可运行在tomcat，weblogic等java web容器中的war包。
可以借助web容器管理界面对应用进行管理。
可以管理JNDI数据源。
web容器配置较为灵活，配置和程序分离。
应用体积较小，甚至可以借助web容器的包管理功能(比如weblogic Library)进一步减小应用大小。
本地需要搭建web容器，对本地环境要求更高点，学习成本也响应更高。
调试较为困难，需要借助web容器。
无法兼容所有web容器（比如spring boot2.x无法运行在weblogic 11g上）。
在实际的项目中，并没有哪一种方式是最好的，根据客户不同的需求制定不同的部署方案，比如有些客户比较看中管理功能，要求数据源和tomcat相关配置必须由管理员进行管理，那么选择war包方式，有些客户希望借助容器化进行大规模部署，那么jar方式更适合。不管选择哪种方式，在部署时都会遇到下面的问题
如果需要打war包，那么不仅是pom文件需要修改，应用程序也要做相应的改动，改动完后，应用程序就无法本地运行，需要打完包后将配置信息修改回来，这样不仅麻烦，还容易出错。
不管是war包还是jar包，如何管理不同环境的配置文件，保证不会出错，虽然spring boot有提供spring.profiles.active配置设置不同的环境，但一方面需要人为修改配置文件，只要是人为的就有可能出错，另一方面，客户有时出于安全考虑不会提供生产环境配置信息，那么这时候就无法指定prifiles.active。
如何将多个spring boot模块打包在一起。
jar包需要配合容器化才能发挥出最大的优势，如果没有容器，spring boot jar包就是一个玩具，随处运行的jar包，缺少统一管理，是达不到生产的要求，那么如果从jar包到容器也是一个问题。
早期碰到这些问题，都是人工解决，不仅效率十分低下，部署一次都需要十几分钟，而且很容易出错，一百次出错一次算是概率低了，但是生产出错一次都是重大事件，所以我们也在思考如何通过自动化解决以上问题，如何将开发和部署分离，开发人员只关心开发，开发完提交代码，打包和部署都是后台透明的完成。以下就是我们的解决方案。
spring boot打war包的步骤如下
在pom.xml中将打包方式改为war。
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">...war...设置spring-boot-starter-tomcat范围为providedorg.springframework.bootspring-boot-starter-tomcatprovided修改spring boot的启动类，继承SpringBootServletInitializerpublic class DemoApplication extends SpringBootServletInitializer{@Overrideprotected SpringApplicationBuilder configure(SpringApplicationBuilder builder) {return builder.sources(DemoApplication.class);}}
每打包一次都要修改pom.xml和启动类，打包完再修改回来，十分的繁琐，因为，我们提出以下整改方案
从pom.xml复制一个pom-war.xml文件，将pom-war.xml修改为war包配置
在根目录下(除了src目录外都可以)复制一份启动类的代码，修改为war包的配置方式。
编写shell脚本进行打包。
备份当前启动类的java代码。 将war包启动类的代码替换掉当前启动类的代码。 maven指定pom-war.xml文件进行打包。 打包结束后恢复启动类文件。
app-war.sh#!/usr/bin/env bashv1=src/main/java/com/definesys/demo/DemoApplication.javav2=war/DemoApplication.javav3=war/DemoApplication-bak.javacp -rf $v2 $v1mvn clean package -Dmaven.test.skip=true -f war-pom.xml#recoverycp -rf $v3 $v1
通过预先配置好pom文件和启动类文件，开发人员只要运行app-war.sh脚本无需修改任何文件即可生成war包。
以上方案pom文件和启动类文件都需要预先准备好，未实现完全的自动化，通过优化方案做到完全自动化。
脚本可以通过find命令搜索以*Application.java结尾的文件，作为启动类文件，读取文件名获取类名，通过字符串替换方式动态生成war包启动类文件。
在pom.xml中用注释设置好锚点，脚本通过替换锚点动态生成pom.xml文件。
如果不希望通过锚点实现，可以借助更高级的脚本语言，比如python对xml进行解析，再动态生成xml。
这里的多模块指的是maven中的多模块，项目工程中的代码多模块，一个项目按功能划分模块后，在创建工程时一般也按照功能层面上的模块进行创建，这样避免一个模块代码过于庞大，也利于任务的分工，但打包却更麻烦了。
每个模块都是独立的spring boot程序，整合到一个包的时候会出现多个启动类，多个配置文件冲突的问题。
每个模块有引用相同的依赖，依赖包版本升级后，需要每个pom文件都做修改。
通过优化项目结构解决以上问题
父项目的pom指定spring boot的依赖和公共的依赖。
创建一个spring boot的子项目，作为启动项目，我们称为start项目。
其余子项目为普通的java maven项目，parent设置为第一步创建的spring boot父项目。
start项目的pom引用其他子项目的依赖。
本地调试可以直接运行start的启动类，ide会自动编译其他模块并引用。
打包可以在父项目上进行install后再进入start项目进行打包，脚
mvn clean installcd startmvn clean package
.├── pom.xml├── role│ ├── pom.xml│ └── src│ ├── main│ │ ├── java│ │ │ └── com│ │ │ └── definesys│ │ │ └── demo│ │ │ └── controller│ │ │ └── RoleController.java│ │ └── resources├── start│ ├── pom.xml│ ├── src│ │ ├── main│ │ │ ├── java│ │ │ │ └── com│ │ │ │ └── definesys│ │ │ │ └── demo│ │ │ │ └── DemoApplication.java│ │ │ └── resources│ │ │ └── application.properties└── user├── pom.xml└── src└── main├── java│ └── com│ └── definesys│ └── demo│ └── controller│ └── UserController.java└── resources
start pom.xml<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">blog0915com.definesys.demo1.0-SNAPSHOT4.0.0startcom.definesys.demouser1.0.0com.definesys.demorole1.0.0org.springframework.bootspring-boot-maven-plugin
父项目parent为spring boot，引用spring boot相关依赖和各个子项目公共的依赖
父项目 pom.xml
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">4.0.0pomuserrolestartorg.springframework.bootspring-boot-starter-parent2.1.2.RELEASEcom.definesys.demoblog09151.0-SNAPSHOTorg.springframework.bootspring-boot-starter-web
所有非start的子项目需要指定版本号并且父项目都设为根目录项目。
子项目 pom.xml
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> blog0915 com.definesys.demo 1.0-SNAPSHOT 4.0.0 role 1.0.0所有子项目的包路径前缀必须一样，并且以start项目作为基本路径。
spring boot提供spring.profiles.active指定配置文件，但生产环境有时候客户出于安全考虑不提供配置信息给开发人员，而是预先将配置文件上传到服务器指定路径，程序需要在运行时去引用该配置文件，如果运行环境是kubernetes，则会提供一个config map作为配置文件，这时候就要求spring boot程序读取外部配置文件。
这里讨论的是线上环境配置文件方案，本地调试参考子模块打包相关内容，可以将配置文件统一写在start项目中。
jar包外部配置文件读取
jar运行可以通过指定参数spring.config.location引用外部文件，命令参考如下：
java -jar start-1.0-SNAPSHOT.jar --spring.config.location=/Users/asan/workspace/config
config目录存放properties配置文件
可以通过配合spring.profiles.active参数可以指定目录下配置文件，如：
java -jar start-1.0-SNAPSHOT.jar --spring.profiles.active=prod --spring.config.location=/Users/asan/workspace/config
则会读取/Users/asan/workspace/config/appliction-prod.properties文件作为配置文件。
war包外部配置文件读取
以tomcat为例，需要在tomcat启动时指定-Dspring.config.location参数，可以设置服务器环境变量CATALINA_OPTS达到目的。可以编辑用户 prifile文件
export CATALINA_OPTS=/Users/asan/workspace/config
同样，也可以通过-Dspring.profiles.active指定配置文件名称。
spring boot借助容器化，可以如虎添翼，发挥出更大的威力，也只有通过容器化，才能体会到spring boot开发的高效。通过以上的介绍，你可以很顺利的打好一个jar包或者war包，那么可以通过编写dockerfile文件进行镜像的构建。spring boot在构建镜像时有两个地方需要考虑时区问题，基础镜像的时区默认是UTC，比北京时间早8小时，需要指定镜像时区。
配置文件问题，需要指定外部配置文件（根据项目具体情况选择）。
app-jar-dockerfile.DockerfileFROM openjdk:8-jdk-alpineMAINTAINER definesys.comVOLUME /tmpADD start-1.0-SNAPSHOT.jar app.jarRUN echo "Asia/Shanghai" > /etc/timezoneEXPOSE 8080ENTRYPOINT ["java","-Djava.security.egd=file:/dev/./urandom","-jar","--spring.config.location=/Users/asan/workspace/config","/app.jar"]app-war.dockerfile.DockerfileFROM tomcatMAINTAINER definesys.comENV CATALINA_OPTS -Dspring.config.location=file:/middleware/config/ADD start-1.0-SNAPSHOT.war /usr/local/tomcat/webapps/app.jarRUN echo "Asia/Shanghai" > /etc/timezoneEXPOSE 8080
早期我们采用的是以下部署过程
逆锋起笔是一个专注于程序员圈子的技术平台，你可以收获最新技术动态、最新内测资格、BAT等大厂的经验、精品学习资料、职业路线、副业思维，微信搜索逆锋起笔关注！
