Spring Boot(十二):Spring Boot 如何测试打包部署
有很多网友会时不时的问我, spring boot 项目如何测试,如何部署,在生产中有什么好的部署方案吗?这篇文章就来介绍一下 spring boot 如何开发、调试、打包到最后的投产上线。
开发阶段
单元测试
在开发阶段的时候最重要的是单元测试了, spring boot 对单元测试的支持已经很完善了。
1、在 pom 包中添加 spring-boot-starter-test
包引用
-
<dependency>
-
<groupid>org.springframework.boot</groupid>
-
<artifactid>spring-boot-starter-test</artifactid>
-
<scope>test</scope>
-
</dependency>
2、开发测试类
以最简单的 helloworld 为例,在测试类的类头部需要添加: @runwith(springrunner.class)
和 @springboottest
注解,在测试方法的顶端添加 @test
即可,最后在方法上点击右键run就可以运行。
-
@runwith(springrunner.class)
-
@springboottest
-
public class applicationtests {
-
-
@test
-
public void hello() {
-
system.out.println("hello world");
-
}
-
-
}
实际使用中,可以按照项目的正常使用去注入数据层代码或者是 service 层代码进行测试验证, spring-boot-starter-test
提供很多基础用法,更难得的是增加了对 controller 层测试的支持。
-
//简单验证结果集是否正确
-
assert.assertequals(3, usermapper.getall().size());
-
-
//验证结果集,提示
-
assert.asserttrue("错误,正确的返回值为200", status == 200);
-
assert.assertfalse("错误,正确的返回值为200", status != 200);
引入了 mockmvc
支持了对 controller 层的测试,简单示例如下:
-
public class hellocontrolertests {
-
-
private mockmvc mvc;
-
-
//初始化执行
-
@before
-
public void setup() throws exception {
-
mvc = mockmvcbuilders.standalonesetup(new hellocontroller()).build();
-
}
-
-
//验证controller是否正常响应并打印返回结果
-
@test
-
public void gethello() throws exception {
-
mvc.perform(mockmvcrequestbuilders.get("/hello").accept(mediatype.application_json))
-
.andexpect(mockmvcresultmatchers.status().isok())
-
.anddo(mockmvcresulthandlers.print())
-
.andreturn();
-
}
-
-
//验证controller是否正常响应并判断返回结果是否正确
-
@test
-
public void testhello() throws exception {
-
mvc.perform(mockmvcrequestbuilders.get("/hello").accept(mediatype.application_json))
-
.andexpect(status().isok())
-
.andexpect(content().string(equalto("hello world")));
-
}
-
-
}
单元测试是验证你代码第一道屏障,要养成每写一部分代码就进行单元测试的习惯,不要等到全部集成后再进行测试,集成后因为更关注整体运行效果,很容易遗漏掉代码底层的bug.
集成测试
整体开发完成之后进入集成测试, spring boot 项目的启动入口在 application 类中,直接运行 run 方法就可以启动项目,但是在调试的过程中我们肯定需要不断的去调试代码,如果每修改一次代码就需要手动重启一次服务就很麻烦, spring boot 非常贴心的给出了热部署的支持,很方便在 web 项目中调试使用。
pom 需要添加以下的配置:
-
<dependencies>
-
<dependency>
-
<groupid>org.springframework.boot</groupid>
-
<artifactid>spring-boot-devtools</artifactid>
-
<optional>true</optional>
-
</dependency>
-
</dependencies>
-
-
<build>
-
<plugins>
-
<plugin>
-
<groupid>org.springframework.boot</groupid>
-
<artifactid>spring-boot-maven-plugin</artifactid>
-
<configuration>
-
<fork>true</fork>
-
</configuration>
-
</plugin>
-
</plugins>
-
</build>
添加以上配置后,项目就支持了热部署,非常方便集成测试。
投产上线
其实我觉得这个阶段,应该还是比较简单一般分为两种;一种是打包成 jar 包直接执行,另一种是打包成 war 包放到 tomcat 服务器下。
打成 jar 包
如果你使用的是 maven 来管理项目,执行以下命令既可以
-
cd 项目跟目录(和pom.xml同级)
-
mvn clean package
-
## 或者执行下面的命令
-
## 排除测试代码后进行打包
-
mvn clean package -dmaven.test.skip=true
打包完成后 jar 包会生成到 target 目录下,命名一般是 项目名+版本号.jar
启动 jar 包命令
-
java -jar target/spring-boot-scheduler-1.0.0.jar
这种方式,只要控制台关闭,服务就不能访问了。下面我们使用在后台运行的方式来启动:
-
nohup java -jar target/spring-boot-scheduler-1.0.0.jar &
也可以在启动的时候选择读取不同的配置文件
-
java -jar app.jar --spring.profiles.active=dev
也可以在启动的时候设置 jvm 参数
-
java -xms10m -xmx80m -jar app.jar &
gradle
如果使用的是 gradle,使用下面命令打包
-
gradle build
-
java -jar build/libs/mymodule-0.0.1-snapshot.jar
打成 war 包
打成 war 包一般可以分两种方式来实现,第一种可以通过 eclipse 这种开发工具来导出 war 包,另外一种是使用命令来完成,这里主要介绍后一种
1、maven 项目,修改 pom 包
将
-
<packaging>jar</packaging>
改为
-
<packaging>war</packaging>
2、打包时排除tomcat.
-
<dependency>
-
<groupid>org.springframework.boot</groupid>
-
<artifactid>spring-boot-starter-web</artifactid>
-
</dependency>
-
<dependency>
-
<groupid>org.springframework.boot</groupid>
-
<artifactid>spring-boot-starter-tomcat</artifactid>
-
<scope>provided</scope>
-
</dependency>
在这里将 scope 属性设置为 provided,这样在最终形成的 war 中不会包含这个 jar 包,因为 tomcat 或 jetty 等服务器在运行时将会提供相关的 api 类。
3、注册启动类
创建 servletinitializer.java,继承 springbootservletinitializer ,覆盖 configure(),把启动类 application 注册进去。外部 web 应用服务器构建 web application context 的时候,会把启动类添加进去。
-
public class servletinitializer extends springbootservletinitializer {
-
@override
-
protected springapplicationbuilder configure(springapplicationbuilder application) {
-
return application.sources(application.class);
-
}
-
}
最后执行
-
mvn clean package -dmaven.test.skip=true
会在 target 目录下生成:项目名+版本号.war文件,拷贝到 tomcat 服务器中启动即可。
gradle
如果使用的是 gradle,基本步奏一样,build.gradle中 添加 war 的支持,排除 spring-boot-starter-tomcat:
-
...
-
-
apply plugin: 'war'
-
-
...
-
-
dependencies {
-
compile("org.springframework.boot:spring-boot-starter-web:1.4.2.release"){
-
exclude mymodule:"spring-boot-starter-tomcat"
-
}
-
}
-
...
再使用构建命令
-
gradle build
war 会生成在 build\libs 目录下。
生产运维
查看 jvm 参数的值
可以根据 java 自带的 jinfo 命令:
-
jinfo -flags pid
来查看 jar 启动后使用的是什么 gc、新生代、老年代分批的内存都是多少,示例如下:
-
-xx:cicompilercount=3 -xx:initialheapsize=234881024 -xx:maxheapsize=3743416320 -xx:maxnewsize=1247805440 -xx:minheapdeltabytes=524288 -xx:newsize=78118912 -xx:oldsize=156762112 -xx:+usecompressedclasspointers -xx:+usecompressedoops -xx:+usefastunorderedtimestamps -xx:+useparallelgc
-
-xx:cicompilercount
:最大的并行编译数 -
-xx:initialheapsize
和-xx:maxheapsize
:指定 jvm 的初始和最大堆内存大小 -
-xx:maxnewsize
: jvm 堆区域新生代内存的最大可分配大小 -
...
-
-xx:+useparallelgc
:垃圾回收使用 parallel 收集器
如何重启
简单粗暴
直接 kill 掉进程再次启动 jar 包
-
ps -ef|grep java
-
##拿到对于java程序的pid
-
kill -9 pid
-
## 再次重启
-
java -jar xxxx.jar
当然这种方式比较传统和暴力,所以建议大家使用下面的方式来管理
脚本执行
如果使用的是maven,需要包含以下的配置
-
<plugin>
-
<groupid>org.springframework.boot</groupid>
-
<artifactid>spring-boot-maven-plugin</artifactid>
-
<configuration>
-
<executable>true</executable>
-
</configuration>
-
</plugin>
如果使用是 gradle,需要包含下面配置
-
springboot {
-
executable = true
-
}
启动方式:
1、 可以直接 ./yourapp.jar
来启动
2、注册为服务
也可以做一个软链接指向你的jar包并加入到 init.d
中,然后用命令来启动。
init.d 例子:
-
ln -s /var/yourapp/yourapp.jar /etc/init.d/yourapp
-
chmod +x /etc/init.d/yourapp
这样就可以使用 stop
或者是 restart
命令去管理你的应用。
-
/etc/init.d/yourapp start|stop|restart
或者
-
service yourapp start|stop|restart
到此 spring boot 项目如何测试、联调和打包投产均已经介绍完,以后可以找时间研究一下 spring boot 的自动化运维,以及 spring boot 和 docker 相结合的使用。
文章内容已经升级到 spring boot 2.x
示例代码-https://github.com/ityouknow/spring-boot-examples/tree/master/spring-boot-package
java 极客技术公众号,是由一群热爱 java 开发的技术人组建成立,专注分享原创、高质量的 java 文章。如果您觉得我们的文章还不错,请帮忙赞赏、在看、转发支持,鼓励我们分享出更好的文章。
关注公众号,大家可以在公众号后台回复“博客园”,免费获得作者 java 知识体系/面试必看资料。