Spring Boot(十二):Spring Boot 如何測試打包部署

Java極客技術發表於2019-07-28

 

有很多網友會時不時的問我, Spring Boot 專案如何測試,如何部署,在生產中有什麼好的部署方案嗎?這篇文章就來介紹一下 Spring Boot 如何開發、除錯、打包到最後的投產上線。

開發階段

單元測試

在開發階段的時候最重要的是單元測試了, Spring Boot 對單元測試的支援已經很完善了。

1、在 pom 包中新增 spring-boot-starter-test 包引用

  1. <dependency>

  2. <groupId>org.springframework.boot</groupId>

  3. <artifactId>spring-boot-starter-test</artifactId>

  4. <scope>test</scope>

  5. </dependency>

2、開發測試類

以最簡單的 helloworld 為例,在測試類的類頭部需要新增: @RunWith(SpringRunner.class)@SpringBootTest註解,在測試方法的頂端新增 @Test即可,最後在方法上點選右鍵run就可以執行。

  1. @RunWith(SpringRunner.class)

  2. @SpringBootTest

  3. public class ApplicationTests {

  4.  

  5. @Test

  6. public void hello() {

  7. System.out.println("hello world");

  8. }

  9.  

  10. }

實際使用中,可以按照專案的正常使用去注入資料層程式碼或者是 Service 層程式碼進行測試驗證, spring-boot-starter-test 提供很多基礎用法,更難得的是增加了對 Controller 層測試的支援。

  1. //簡單驗證結果集是否正確

  2. Assert.assertEquals(3, userMapper.getAll().size());

  3.  

  4. //驗證結果集,提示

  5. Assert.assertTrue("錯誤,正確的返回值為200", status == 200);

  6. Assert.assertFalse("錯誤,正確的返回值為200", status != 200);

引入了 MockMvc支援了對 Controller 層的測試,簡單示例如下:

  1. public class HelloControlerTests {

  2.  

  3. private MockMvc mvc;

  4.  

  5. //初始化執行

  6. @Before

  7. public void setUp() throws Exception {

  8. mvc = MockMvcBuilders.standaloneSetup(new HelloController()).build();

  9. }

  10.  

  11. //驗證controller是否正常響應並列印返回結果

  12. @Test

  13. public void getHello() throws Exception {

  14. mvc.perform(MockMvcRequestBuilders.get("/hello").accept(MediaType.APPLICATION_JSON))

  15. .andExpect(MockMvcResultMatchers.status().isOk())

  16. .andDo(MockMvcResultHandlers.print())

  17. .andReturn();

  18. }

  19.  

  20. //驗證controller是否正常響應並判斷返回結果是否正確

  21. @Test

  22. public void testHello() throws Exception {

  23. mvc.perform(MockMvcRequestBuilders.get("/hello").accept(MediaType.APPLICATION_JSON))

  24. .andExpect(status().isOk())

  25. .andExpect(content().string(equalTo("Hello World")));

  26. }

  27.  

  28. }

單元測試是驗證你程式碼第一道屏障,要養成每寫一部分程式碼就進行單元測試的習慣,不要等到全部整合後再進行測試,整合後因為更關注整體執行效果,很容易遺漏掉程式碼底層的bug.

整合測試

整體開發完成之後進入整合測試, Spring Boot 專案的啟動入口在 Application 類中,直接執行 run 方法就可以啟動專案,但是在除錯的過程中我們肯定需要不斷的去除錯程式碼,如果每修改一次程式碼就需要手動重啟一次服務就很麻煩, Spring Boot 非常貼心的給出了熱部署的支援,很方便在 Web 專案中除錯使用。

pom 需要新增以下的配置:

  1. <dependencies>

  2. <dependency>

  3. <groupId>org.springframework.boot</groupId>

  4. <artifactId>spring-boot-devtools</artifactId>

  5. <optional>true</optional>

  6. </dependency>

  7. </dependencies>

  8.  

  9. <build>

  10. <plugins>

  11. <plugin>

  12. <groupId>org.springframework.boot</groupId>

  13. <artifactId>spring-boot-maven-plugin</artifactId>

  14. <configuration>

  15. <fork>true</fork>

  16. </configuration>

  17. </plugin>

  18. </plugins>

  19. </build>

新增以上配置後,專案就支援了熱部署,非常方便整合測試。

投產上線

其實我覺得這個階段,應該還是比較簡單一般分為兩種;一種是打包成 jar 包直接執行,另一種是打包成 war 包放到 tomcat 伺服器下。

打成 jar 包

如果你使用的是 maven 來管理專案,執行以下命令既可以

  1. cd 專案跟目錄(和pom.xml同級)

  2. mvn clean package

  3. ## 或者執行下面的命令

  4. ## 排除測試程式碼後進行打包

  5. mvn clean package -Dmaven.test.skip=true

打包完成後 jar 包會生成到 target 目錄下,命名一般是 專案名+版本號.jar

啟動 jar 包命令

  1. java -jar target/spring-boot-scheduler-1.0.0.jar

這種方式,只要控制檯關閉,服務就不能訪問了。下面我們使用在後臺執行的方式來啟動:

  1. nohup java -jar target/spring-boot-scheduler-1.0.0.jar &

也可以在啟動的時候選擇讀取不同的配置檔案

  1. java -jar app.jar --spring.profiles.active=dev

也可以在啟動的時候設定 jvm 引數

  1. java -Xms10m -Xmx80m -jar app.jar &

gradle
如果使用的是 gradle,使用下面命令打包

  1. gradle build

  2. java -jar build/libs/mymodule-0.0.1-SNAPSHOT.jar

打成 war 包

打成 war 包一般可以分兩種方式來實現,第一種可以通過 eclipse 這種開發工具來匯出 war 包,另外一種是使用命令來完成,這裡主要介紹後一種

1、maven 專案,修改 pom 包

  1. <packaging>jar</packaging>

改為

  1. <packaging>war</packaging>

 

2、打包時排除tomcat.

  1. <dependency>

  2. <groupId>org.springframework.boot</groupId>

  3. <artifactId>spring-boot-starter-web</artifactId>

  4. </dependency>

  5. <dependency>

  6. <groupId>org.springframework.boot</groupId>

  7. <artifactId>spring-boot-starter-tomcat</artifactId>

  8. <scope>provided</scope>

  9. </dependency>

在這裡將 scope 屬性設定為 provided,這樣在最終形成的 WAR 中不會包含這個 JAR 包,因為 Tomcat 或 Jetty 等伺服器在執行時將會提供相關的 API 類。

3、註冊啟動類

建立 ServletInitializer.java,繼承 SpringBootServletInitializer ,覆蓋 configure(),把啟動類 Application 註冊進去。外部 Web 應用伺服器構建 Web Application Context 的時候,會把啟動類新增進去。

  1. public class ServletInitializer extends SpringBootServletInitializer {

  2. @Override

  3. protected SpringApplicationBuilder configure(SpringApplicationBuilder application) {

  4. return application.sources(Application.class);

  5. }

  6. }

最後執行

  1. mvn clean package -Dmaven.test.skip=true

會在 target 目錄下生成:專案名+版本號.war檔案,拷貝到 tomcat 伺服器中啟動即可。

gradle

如果使用的是 Gradle,基本步奏一樣,build.gradle中 新增 war 的支援,排除 spring-boot-starter-tomcat:

  1. ...

  2.  

  3. apply plugin: 'war'

  4.  

  5. ...

  6.  

  7. dependencies {

  8. compile("org.springframework.boot:spring-boot-starter-web:1.4.2.RELEASE"){

  9. exclude mymodule:"spring-boot-starter-tomcat"

  10. }

  11. }

  12. ...

再使用構建命令

  1. gradle build

war 會生成在 build\libs 目錄下。

生產運維

檢視 JVM 引數的值

可以根據 Java 自帶的 jinfo 命令:

  1. jinfo -flags pid

來檢視 jar 啟動後使用的是什麼 gc、新生代、老年代分批的記憶體都是多少,示例如下:

  1. -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 包

  1. ps -ef|grep java

  2. ##拿到對於Java程式的pid

  3. kill -9 pid

  4. ## 再次重啟

  5. Java -jar xxxx.jar

當然這種方式比較傳統和暴力,所以建議大家使用下面的方式來管理

指令碼執行

如果使用的是maven,需要包含以下的配置

  1. <plugin>

  2. <groupId>org.springframework.boot</groupId>

  3. <artifactId>spring-boot-maven-plugin</artifactId>

  4. <configuration>

  5. <executable>true</executable>

  6. </configuration>

  7. </plugin>

如果使用是 gradle,需要包含下面配置

  1. springBoot {

  2. executable = true

  3. }

啟動方式:

1、 可以直接 ./yourapp.jar 來啟動

2、註冊為服務

也可以做一個軟連結指向你的jar包並加入到 init.d中,然後用命令來啟動。

init.d 例子:

  1. ln -s /var/yourapp/yourapp.jar /etc/init.d/yourapp

  2. chmod +x /etc/init.d/yourapp

這樣就可以使用 stop或者是 restart命令去管理你的應用。

  1. /etc/init.d/yourapp start|stop|restart

或者

  1. 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 知識體系/面試必看資料。

 

相關文章