成人免费xxxxx在线视频软件_久久精品久久久_亚洲国产精品久久久_天天色天天色_亚洲人成一区_欧美一级欧美三级在线观看

這可能是解決你Spring MVC接口漏洞百出的關鍵

作者：碼農小胖哥
開發 后端
在 Java 開發中接觸的開發者大多數不太注重對接口的測試，結果在聯調對接中出現各種問題。也有的使用 Postman 等工具進行測試，雖然在使用上沒有什么問題，如果接口增加了權限測試起來就比較惡心了。

[[346147]]

1. 前言

在 Java 開發中接觸的開發者大多數不太注重對接口的測試，結果在聯調對接中出現各種問題。也有的使用 Postman 等工具進行測試，雖然在使用上沒有什么問題，如果接口增加了權限測試起來就比較惡心了。所以建議在單元測試中測試接口，保證在交付前先自測接口的健壯性。今天就來分享一下胖哥在開發中是如何對 Spring MVC 接口進行測試的。

在開始前請務必確認添加了Spring Boot Test相關的組件，在最新的版本中應該包含以下依賴：

  1. <dependency> 
  2.     <groupId>org.springframework.boot</groupId> 
  3.     <artifactId>spring-boot-starter-test</artifactId> 
  4.     <scope>test</scope> 
  5.     <exclusions> 
  6.         <exclusion> 
  7.             <groupId>org.junit.vintage</groupId> 
  8.             <artifactId>junit-vintage-engine</artifactId> 
  9.         </exclusion> 
  10.     </exclusions> 
  11. </dependency> 

本文是在Spring Boot 2.3.4.RELEASE下進行的。

2. 單獨測試控制層

如果我們只需要對控制層接口(Controller)進行測試，且該接口不依賴@Service、@Component等注解聲明的 Spring Bean 時，可以借助@WebMvcTest來啟用只針對 Web 控制層的測試，例如

  1. @WebMvcTest 
  2. class CustomSpringInjectApplicationTests { 
  3.     @Autowired 
  4.     MockMvc mockMvc; 
  5.  
  6.     @SneakyThrows 
  7.     @Test 
  8.     void contextLoads() { 
  9.         mockMvc.perform(MockMvcRequestBuilders.get("/foo/map")) 
  10.                 .andExpect(ResultMatcher.matchAll(status().isOk(), 
  11.                         content().contentType(MediaType.APPLICATION_JSON), 
  12.                         jsonPath("$.test", Is.is("hello")))) 
  13.                 .andDo(MockMvcResultHandlers.print()); 
  14.     } 
  15.  
  16. } 

這種方式要快的多，它只加載了應用程序的一小部分。但是如果你涉及到服務層這種方式是不湊效的，我們就需要整體測試了方了。

3. 整體測試

大多數 Spring Boot 下的接口測試是整體而又全面的測試，涉及到控制層、服務層、持久層等方方面面，所以需要加載比較完整的 Spring Boot 上下文。這時我們可以這樣做，聲明一個抽象的測試基類：

  1. package cn.felord.custom; 
  2.  
  3. import org.springframework.beans.factory.annotation.Autowired; 
  4. import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc; 
  5. import org.springframework.boot.test.context.SpringBootTest; 
  6. import org.springframework.test.web.servlet.MockMvc; 
  7.  
  8.  
  9. /** 
  10.  * 測試基類， 
  11.  * @author felord.cn 
  12.  */ 
  13. @SpringBootTest 
  14. @AutoConfigureMockMvc 
  15. abstract class CustomSpringInjectApplicationTests { 
  16.     /** 
  17.      * The Mock mvc. 
  18.      */ 
  19.     @Autowired 
  20.     MockMvc mockMvc; 
  21.     // 其它公共依賴和處理方法 
  22. } 

只有當@AutoConfigureMockMvc存在時MockMvc才會被注入 Spring IoC。

然后針對具體的控制層進行如下測試代碼的編寫：

  1. package cn.felord.custom; 
  2.  
  3. import lombok.SneakyThrows; 
  4. import org.hamcrest.core.Is; 
  5. import org.junit.jupiter.api.Test; 
  6. import org.springframework.http.MediaType; 
  7. import org.springframework.test.web.servlet.ResultMatcher; 
  8. import org.springframework.test.web.servlet.request.MockMvcRequestBuilders; 
  9. import org.springframework.test.web.servlet.result.MockMvcResultHandlers; 
  10.  
  11. import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.*; 
  12.  
  13. /** 
  14.  * 測試FooController. 
  15.  * 
  16.  * @author felord.cn 
  17.  */ 
  18. public class FooTests extends CustomSpringInjectApplicationTests { 
  19.     /** 
  20.      * /foo/map接口測試. 
  21.      */ 
  22.     @SneakyThrows 
  23.     @Test 
  24.     void contextLoads() { 
  25.         mockMvc.perform(MockMvcRequestBuilders.get("/foo/map")) 
  26.                 .andExpect(ResultMatcher.matchAll(status().isOk(), 
  27.                         content().contentType(MediaType.APPLICATION_JSON), 
  28.                         jsonPath("$.test", Is.is("bar")))) 
  29.                 .andDo(MockMvcResultHandlers.print()); 
  30.     } 
  31. } 

4. MockMvc 測試

集成測試時，希望能夠通過輸入 URL 對 Controller 進行測試，如果通過啟動服務器，建立 http client 進行測試，這樣會使得測試變得很麻煩，比如，啟動速度慢，測試驗證不方便，依賴網絡環境等，為了可以對 Controller 進行測試，所以引入了MockMvc。

MockMvc實現了對 Http 請求的模擬，能夠直接使用網絡的形式，轉換到 Controller 的調用，這樣可以使得測試速度快、不依賴網絡環境，而且提供了一套驗證的工具，這樣可以使得請求的驗證統一而且很方便。接下來我們來一步步構造一個測試的模擬請求，假設我們存在一個下面這樣的接口：

  1. @RestController 
  2. @RequestMapping("/foo") 
  3. public class FooController { 
  4.     @Autowired 
  5.     private MyBean myBean; 
  6.  
  7.     @GetMapping("/user") 
  8.     public Map<String, String> bar(@RequestHeader("Api-Version") String apiVersion, User user) { 
  9.         Map<String, String> map = new HashMap<>(); 
  10.         map.put("test", myBean.bar()); 
  11.         map.put("version", apiVersion); 
  12.         map.put("username", user.getName()); 
  13.         //todo your business 
  14.         return map; 
  15.     } 
  16. } 

參數設定為name=felord.cn&age=18，那么對應的 HTTP 報文是這樣的：

  1. GET /foo/user?name=felord.cn&age=18 HTTP/1.1 
  2. Host: localhost:8888 
  3. Api-Version: v1 

可以預見的返回值為：

  1. { 
  2.     "test": "bar", 
  3.     "version": "v1", 
  4.     "username": "felord.cn" 
  5. } 

事實上對接口的測試可以分為以下幾步。

構建請求

構建請求由MockMvcRequestBuilders負責，他提供了請求方法(Method)，請求頭(Header)，請求體(Body)，參數(Parameters)，會話(Session)等所有請求的屬性構建。/foo/user接口的請求可以轉換為：

  1. MockMvcRequestBuilders.get("/foo/user") 
  2.                 .param("name", "felord.cn") 
  3.                 .param("age", "18") 
  4.                 .header("Api-Version", "v1") 

執行 Mock 請求

然后由MockMvc執行 Mock 請求：

  1. mockMvc.perform(MockMvcRequestBuilders.get("/foo/user") 
  2.                 .param("name", "felord.cn") 
  3.                 .param("age", "18") 
  4.                 .header("Api-Version", "v1")) 

對結果進行處理

請求結果被封裝到ResultActions對象中，它封裝了多種讓我們對 Mock 請求結果進行處理的方法。

對結果進行預期期望

ResultActions#andExpect(ResultMatcher matcher)方法負責對響應的結果的進行預期期望，看看是否符合測試的期望值。參數ResultMatcher負責從響應對象中提取我們需要期望的部位進行預期比對。

假如我們期望接口/foo/user返回的是JSON，并且 HTTP 狀態為200，同時響應體包含了version=v1的值，我們應該這么聲明：

  1. ResultMatcher.matchAll(MockMvcResultMatchers.status().isOk(), 
  2.                MockMvcResultMatchers.content().contentType(MediaType.APPLICATION_JSON), 
  3.                MockMvcResultMatchers.jsonPath("$.version", Is.is("v1"))); 

JsonPath是一個強大的 JSON 解析類庫，請通過其項目倉庫https://github.com/json-path/JsonPath了解。

對響應進行處理

ResultActions#andDo(ResultHandler handler)方法負責對整個請求/響應進行打印或者 log 輸出、流輸出，由MockMvcResultHandlers工具類提供這些方法。我們可以通過以上三種途徑來查看請求響應的細節。

例如/foo/user接口：

  1. MockHttpServletRequest: 
  2.       HTTP Method = GET 
  3.       Request URI = /foo/user 
  4.        Parameters = {name=[felord.cn], age=[18]} 
  5.           Headers = [Api-Version:"v1"] 
  6.              Body = null 
  7.     Session Attrs = {} 
  8.  
  9. Handler: 
  10.              Type = cn.felord.xbean.config.FooController 
  11.            Method = cn.felord.xbean.config.FooController#urlEncode(String, Params) 
  12.  
  13. Async: 
  14.     Async started = false 
  15.      Async result = null 
  16.  
  17. Resolved Exception: 
  18.              Type = null 
  19.  
  20. ModelAndView: 
  21.         View name = null 
  22.              View = null 
  23.             Model = null 
  24.  
  25. FlashMap: 
  26.        Attributes = null 
  27.  
  28. MockHttpServletResponse: 
  29.            Status = 200 
  30.     Error message = null 
  31.           Headers = [Content-Type:"application/json"] 
  32.      Content type = application/json 
  33.              Body = {"test":"bar","version":"v1","username":"felord.cn"} 
  34.     Forwarded URL = null 
  35.    Redirected URL = null 
  36.           Cookies = [] 

獲取返回結果

如果你希望進一步處理響應的結果，也可以通過ResultActions#andReturn()拿到MvcResult類型的結果進行進一步的處理。

完整的測試過程

通常andExpect是我們必然會選擇的，而andDo和andReturn在某些場景下會有用，它們兩個是可選的。我們把上面的連在一起。

  1. @Autowired 
  2. MockMvc mockMvc; 
  3.  
  4. @SneakyThrows 
  5. @Test 
  6. void contextLoads() { 
  7.  
  8.      mockMvc.perform(MockMvcRequestBuilders.get("/foo/user") 
  9.             .param("name", "felord.cn") 
  10.             .param("age", "18") 
  11.             .header("Api-Version", "v1")) 
  12.             .andExpect(ResultMatcher.matchAll(status().isOk(), 
  13.                     content().contentType(MediaType.APPLICATION_JSON), 
  14.                     jsonPath("$.version", Is.is("v1")))) 
  15.             .andDo(MockMvcResultHandlers.print()); 
  16.  
  17. } 

這種流式的接口單元測試從語義上看也是比較好理解的，你可以使用各種斷言、正例、反例測試你的接口，最終讓你的接口更加健壯。

5. 總結

一旦你熟練了這種方式，你編寫的接口將更加具有權威性而不會再漏洞百出，甚至有時候你也可以使用 Mock 來設計接口，使之更加貼合業務。所以 CRUD 不是完全沒有技術含量，高質量高效率的 CRUD 往往需要這種工程化的單元測試來支撐。

本文轉載自微信公眾號「碼農小胖哥」，可以通過以下二維碼關注。轉載本文請聯系碼農小胖哥公眾號。

 

責任編輯：武曉燕 來源： 碼農小胖哥
Spring MVC接口漏洞
相關推薦

2017-04-11 21:37:26

2013-07-08 10:36:57

2009-12-15 09:04:40

Windows 7系統漏洞

2016-10-26 10:20:22

2015-03-19 10:01:26

2017-02-20 15:51:07

2017-06-08 11:11:32

互聯網

2018-07-16 10:10:43

WiFi上網網速

2021-08-27 10:14:22

機器學習工具手冊人工智能

2021-11-03 16:10:16

RedisJava內存

2018-10-25 09:37:02

Docker入門容器

2024-08-28 11:56:33

2020-12-28 10:22:43

手機App青少年模式網絡

2023-02-08 10:39:09

ChatGPT論文人工智能

2023-02-26 00:00:01

Spring數據庫組件

2023-01-11 08:24:32

2023-02-26 10:14:51

Spring第三方庫

2018-11-12 00:16:21

云計算行業科技

2018-11-05 08:10:30

Netty架構模型

2020-04-14 10:50:47

FlutterGithub
點贊
收藏

51CTO技術棧公眾號

主站蜘蛛池模板： 欧美在线国产精品 | 免费精品 | 亚洲品质自拍视频网站 | 日韩精品成人 | 69av片| 少妇一级淫片aaaaaaaaa | 国产专区在线 | 日本在线看片 | 日韩成人免费视频 | 亚洲欧美另类在线观看 | 一级看片免费视频囗交动图 | 一级毛片免费 | 在线国产精品一区 | 久久久精品一区 | 一区二区三区四区在线视频 | 欧美a在线 | 天天久| 国产精品视频在线播放 | 黄色一级大片在线免费看产 | 视频一区二区在线观看 | 欧美成人手机视频 | 亚洲综合大片69999 | www.av在线| 国产高清一二三区 | 国产激情在线观看视频 | 国产高清久久 | 电影91久久久 | 免费视频一区二区 | 2020天天操 | 精品国产乱码久久久久久蜜柚 | 久草综合在线视频 | 欧美99| 国产综合精品一区二区三区 | 夜夜爽99久久国产综合精品女不卡 | 日韩中文一区二区三区 | 亚洲一区二区三区欧美 | 91av视频在线观看 | 国产精品久久久久aaaa九色 | 日本中出视频 | 国产一级淫片免费视频 | 国产成人精品一区 |