快捷導(dǎo)航

詳解SpringBoot項(xiàng)目的創(chuàng)建與單元測(cè)試

更新時(shí)間：2021年03月08日 09:15:24 作者：Java伴我余生

這篇文章主要介紹了詳解SpringBoot項(xiàng)目的創(chuàng)建與單元測(cè)試，幫助大家更好的理解和學(xué)習(xí)使用SpringBoot，感興趣的朋友可以了解下

前言

Spring Boot 設(shè)計(jì)之初就是為了用最少的配置，以最快的速度來(lái)啟動(dòng)和運(yùn)行 Spring 項(xiàng)目。Spring Boot使用特定的配置來(lái)構(gòu)建生產(chǎn)就緒型的項(xiàng)目。

Hello World

1.可以在 Spring Initializr上面添加，也可以手動(dòng)在 pom.xml中添加如下代碼∶

<dependency>
 <groupId>org.springframework.boot</groupId>
 <artifactId>Spring-boot-starter-web</artifactId>
</dependency>

pom.xml 文件中默認(rèn)有個(gè)模塊∶

<dependency>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-starter-test</artifactId>
 <scope>test</scope>
</dependency>

<scope>test</scope>表示依賴(lài)的組件僅僅參與測(cè)試相關(guān)的工作，包括測(cè)試代碼的編譯和執(zhí)行，不會(huì)被打包包含進(jìn)去;spring-boot-starter-test 是 Spring Boot 提供項(xiàng)目測(cè)試的工具包，內(nèi)置了多種測(cè)試工具，方便我們?cè)陧?xiàng)目中做單元測(cè)試、集成測(cè)試。

2. 編寫(xiě) Controller 內(nèi)容

在目錄 src\main\java\下新建一個(gè)包：com.reminis.web,然后在該包下創(chuàng)建 HelloController∶

@RestControler 的意思是 Contoller 里面的方法都以JSON格式輸出，不需要有其他額外的配置;如果配置為@Controller，代表輸出內(nèi)容到頁(yè)面。
@RequestMapping（"hello"）提供路由信息，"hello"路徑的HTTP Request 都會(huì)被映射到hello(）方法上進(jìn)行處理。
啟動(dòng)主程序
右鍵單擊項(xiàng)目中的 DemoAppicationrun命令，就可以啟動(dòng)項(xiàng)目了，若出現(xiàn)以下內(nèi)容表示啟動(dòng)成功∶

@RestController
public class HelloController {
 @RequestMapping("/hello") 
 public String hello(){
  return "hello world";
 }
 }

@RestControler 的意思是 Contoller 里面的方法都以JSON格式輸出，不需要有其他額外的配置;如果配置為@Controller，代表輸出內(nèi)容到頁(yè)面。
@RequestMapping（"hello"）提供路由信息，"hello"路徑的HTTP Request 都會(huì)被映射到hello(）方法上進(jìn)行處理。

3.啟動(dòng)主程序

右鍵單擊項(xiàng)目中的 DemoAppicationrun命令，就可以啟動(dòng)項(xiàng)目了，若出現(xiàn)以下內(nèi)容表示啟動(dòng)成功∶

如果啟動(dòng)過(guò)程中出現(xiàn)javaClassNotFoundException 異常，請(qǐng)檢查 M aven 配置是否正確，具體如下：

檢查 Maven 的 settigs.xml文件是否引入正確。
檢查 IDE 工具中的 Maven插件是否配置為本機(jī)的 Maven地址，如下圖

Spring Boot 還提供了另外兩種啟動(dòng)項(xiàng)目的方式∶

在項(xiàng)目路徑下，使用命令行mvnspring-boot∶run來(lái)啟動(dòng)，其效果和上面"啟動(dòng)主程序"的效果是一致的;
或者將項(xiàng)目打包，打包后以Jar 包的形式來(lái)啟動(dòng)。

 # 進(jìn)行項(xiàng)目根目錄 
 cd ../demo
 # 執(zhí)行打包命令 
 mvn clean package
 # 以 Jar 包的形式啟動(dòng)
 java -jar target/hello-0.0.1-SNAPSHOT.jar

啟動(dòng)成功后，打開(kāi)瀏覽器輸入網(wǎng)址∶http∶//localhost:8080/hello，就可以看到以下內(nèi)容了∶

開(kāi)發(fā)階段建議使用第一種方式啟動(dòng)，便于開(kāi)發(fā)過(guò)程中調(diào)試。

4. 如果我們想傳入?yún)?shù)怎么辦?

請(qǐng)求傳參一般分為URL地址傳參和表單傳參兩種方式，兩者各有優(yōu)缺點(diǎn)，但基本都以鍵值對(duì)的方式將參數(shù)傳遞到后端。作為后端程序不用關(guān)注前端采用的那種方式，只需要根據(jù)參數(shù)的鍵來(lái)獲取值，Spring提供了很多種參數(shù)接收方式，本章我們了解最簡(jiǎn)單的方式∶通過(guò) URL傳參。只要后端處理請(qǐng)求的方法中存在參數(shù)鍵相同名稱(chēng)的屬性，在請(qǐng)求的過(guò)程中Spring會(huì)自動(dòng)將參數(shù)值賦值到屬性中，最后在方法中直接使用即可。下面我們以 hello（）為例進(jìn)行演示。

@RestController
public class HelloController {

 @RequestMapping("/hello")
 public String hello(String name) {
  System.out.println("name..." + name);
  return "hello world, " + name;
 }
}

重新啟動(dòng)項(xiàng)目，打開(kāi)瀏覽器輸入網(wǎng)址 http∶//localhost8080/hello?name=reminis，返回如下內(nèi)容：

到這里，我們的第一個(gè) Spring Boot項(xiàng)目就開(kāi)發(fā)完成了，有沒(méi)有感覺(jué)很簡(jiǎn)單?經(jīng)過(guò)測(cè)試發(fā)現(xiàn)，修改Controllr內(nèi)相關(guān)的代碼，需要重新啟動(dòng)項(xiàng)目才能生效，這樣做很麻煩是不是?別著急，Spring Boot又給我們提供了另外一個(gè)組件來(lái)解決。

熱部署

熱啟動(dòng)就需要用到一個(gè)組件∶spring-boot-devtools。它是 Spring Boot 提供的一組開(kāi)發(fā)工具包，其中就包含我們需要的熱部署功能，在使用這個(gè)功能之前還需要再做一些配置。

添加依賴(lài)

在 pom.xml文件中添加 spring-boot-devtools 組件。

  <dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-devtools</artifactId>
   <optional>true</optional>
  </dependency>

在 plugin 中配置另外一個(gè)屬性 fork，并且配置為 true。

 <build>
  <plugins>
   <plugin>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-maven-plugin</artifactId>
    <configuration>
     <fork>true</fork>
    </configuration>
   </plugin>
  </plugins>
 </build>

OK，以上的配置就完成了，如果你使用的是 Eclipse 集成開(kāi)發(fā)環(huán)境，那么恭喜你大功告成了;如果你使用的是 IDEA 集成開(kāi)發(fā)環(huán)境，那么還需要做以下配置。配置 IDEA
選擇 File-Settings-Compiler 命令，然后勾選 Build project automati cally復(fù)選框，低版本的 IDEA請(qǐng)勾選make project automatically 復(fù)選框。

使用快捷鍵Ctrl+Shift+A，在輸入框中輸入 Registry，勾選復(fù)選框∶

全部配置完成后，IDEA 就支持熱部署了，大家可以試著去改動(dòng)一下代碼，等待5秒就會(huì)發(fā)現(xiàn) Spring Boot會(huì)自動(dòng)重新加載，再也不需要手動(dòng)單擊重新啟動(dòng)了。

為什么 IDEA需要多配置后面這一步呢?因?yàn)?IDEA默認(rèn)不是自動(dòng)編譯的，需要我們手動(dòng)去配置后才會(huì)自動(dòng)編譯，而熱部署依賴(lài)于項(xiàng)目的自動(dòng)編譯功能。
該模塊在完整的打包環(huán)境下運(yùn)行的時(shí)候會(huì)被禁用，如果你使用 java-jar 啟動(dòng)應(yīng)用或者用一個(gè)特定的classloader 啟動(dòng)，它會(huì)認(rèn)為這是一個(gè)"生產(chǎn)環(huán)境"。

單元測(cè)試

單元測(cè)試在我們?nèi)粘ｉ_(kāi)發(fā)中必不可少，一個(gè)優(yōu)秀的程序員，單元測(cè)試開(kāi)發(fā)也非常完善。下面我們看下 Spring Boot 對(duì)單元測(cè)試又做了哪些支持?

如果我們只想運(yùn)行一個(gè)hello world，只需要一個(gè)@Test 注解就可以了。在src/test 目錄下新建一個(gè) HelloTest類(lèi)，代碼如下∶

public class HelloTest {
 @Test
 private void hello() {
  System.out.println("hello world");
 }
}

右鍵單擊"運(yùn)行"按鈕，發(fā)現(xiàn)控制臺(tái)會(huì)輸出∶hello world。如果需要測(cè)試 Web 層的請(qǐng)求呢? Spring Boot 也給出了支持。
以往我們?cè)跍y(cè)試 Web 請(qǐng)求的時(shí)候，需要手動(dòng)輸入相關(guān)參數(shù)在頁(yè)面測(cè)試查看效果，或者自己寫(xiě)post 請(qǐng)求。在 Spring Boot體系中，Spring 給出了一個(gè)簡(jiǎn)單的解決方案，使用 MockMVC進(jìn)行 Web測(cè)試， MockMVC內(nèi)置了很多工具類(lèi)和方法，可以模擬 post、get 請(qǐng)求，并且判斷返回的結(jié)果是否正確等，也可以利用 print（）打印執(zhí)行結(jié)果。

@SpringBootTest(classes = DemoApplication.class)
class DemoApplicationTests {

 private MockMvc mockMvc;

 @BeforeEach
 public void setUp() {
  mockMvc = MockMvcBuilders.standaloneSetup(new HelloController()).build();
 }

 @Test
 public void getHello() throws Exception {
  mockMvc.perform(MockMvcRequestBuilders
    .post("/hello?name=reminis")
    .accept(MediaType.APPLICATION_JSON))
    .andDo(MockMvcResultHandlers.print());
 }
}

@BeforeEach注解的方法表示在測(cè)試啟動(dòng)的時(shí)候優(yōu)先執(zhí)行，一般用作資源初始化。由于我的SpringBoot項(xiàng)目版本是2.4.3，集成的是Junit5，JUnit5的環(huán)境下， @BeforeEach 和@AfterEach去替代@Before和@After注解。Junit4是使用@Before和@After注解.

在類(lèi)的上面添加@SpringBootTest，系統(tǒng)會(huì)自動(dòng)加載 Spring Boot 容器。在日常測(cè)試中，可以注入bean 來(lái)做一些局部的業(yè)務(wù)測(cè)試。MockMvcRequestBuilders 可以支持 post、get 請(qǐng)求，使用 MockMvcResultHandlers.print() 方法會(huì)將請(qǐng)求和相應(yīng)的過(guò)程都打印出來(lái)，具體如下∶

MockHttpServletRequest:
  HTTP Method = POST
  Request URI = /hello
  Parameters = {name=[reminis]}
   Headers = [Accept:"application/json"]
    Body = <no character encoding set>
 Session Attrs = {}

Handler:
    Type = com.reminis.demo.controller.HelloController
   Method = com.reminis.demo.controller.HelloController#hello(String)

Async:
 Async started = false
  Async result = null

Resolved Exception:
    Type = null
ModelAndView:
  View name = null
    View = null
   Model = null

FlashMap:
  Attributes = null

MockHttpServletResponse:
   Status = 200
 Error message = null
   Headers = [Content-Type:"application/json", Content-Length:"20"]
  Content type = application/json
    Body = hello world, reminis
 Forwarded URL = null
 Redirected URL = null
   Cookies = []
    Type = null

ModelAndView:
  View name = null
    View = null
   Model = null

FlashMap:
  Attributes = null

MockHttpServletResponse:
   Status = 200
 Error message = null
   Headers = [Content-Type:"application/json", Content-Length:"20"]
  Content type = application/json
    Body = hello world, reminis
 Forwarded URL = null
 Redirected URL = null
   Cookies = []

從返回的Body= hello world ，reminis可以看出請(qǐng)求成功了。當(dāng)然每次請(qǐng)求都看這么多返回結(jié)果，不太容易識(shí)別，MockMVC提供了更多方法來(lái)判斷返回結(jié)果，其中就有判斷返回值。我們將上面的 getHello（）方法稍稍進(jìn)行改造，具體如下所示∶

 @Test
 public void getHello() throws Exception {
  mockMvc.perform(MockMvcRequestBuilders
    .post("/hello?name=reminis")
    .accept(MediaType.APPLICATION_JSON))
    /*.andDo(MockMvcResultHandlers.print())*/
    .andExpect(MockMvcResultMatchers.content(). string(Matchers.containsString("reminis")));
 }

MockMvcResultMatchers.content()這段代碼的意思是獲取到 Wceb 請(qǐng)求執(zhí)行后的結(jié)果;Matchers.contansString（"reminis"），判斷返回的結(jié)果集中是否包含"reminis"這個(gè)字符串.

我們簡(jiǎn)單做一下對(duì)比，使用Spring Boot之前和使用之后。使用 Spring Boot 前∶