Spring Boot 2.x基礎教程：構建RESTful API與單元測試
首先，回顧並詳細說明一下在快速入門中使用的@Controller、@RestController、@RequestMapping註解。如果您對Spring MVC不熟悉並且還沒有嘗試過快速入門案例，建議先看一下快速入門的內容。
@Controller：修飾class，用來建立處理http請求的物件@RestController：Spring4之後加入的註解，原來在@Controller中返回json需要@ResponseBody來配合，如果直接用@RestController替代@Controller就不需要再配置@ResponseBody，預設返回json格式@RequestMapping：配置url對映。現在更多的也會直接用以Http Method直接關聯的對映註解來定義，比如：GetMapping、PostMapping、DeleteMapping、PutMapping等
下面我們通過使用Spring MVC來實現一組對User物件操作的RESTful API，配合註釋詳細說明在Spring MVC中如何對映HTTP請求、如何傳參、如何編寫單元測試。
** RESTful API具體設計如下：**
定義User實體
@Data public class User { private Long id; private String name; private Integer age; }
注意：相比1.x版本教程中自定義set和get函式的方式，這裡使用@Data註解可以實現在編譯器自動新增set和get函式的效果。該註解是lombok提供的，只需要在pom中引入加入下面的依賴就可以支援：
<dependency>
<groupid>org.projectlombok</groupid>
<artifactid>lombok</artifactid>
</dependency>
實現對User物件的操作介面
@RestController @RequestMapping(value = "/users") // 通過這裡配置使下面的對映都在/users下 public class UserController { // 建立執行緒安全的Map，模擬users資訊的儲存 static Map<long, user> users = Collections.synchronizedMap(new HashMap<long, user>()); /** * 處理"/users/"的GET請求，用來獲取使用者列表 * * @return */ @GetMapping("/") public List<user> getUserList() { // 還可以通過@RequestParam從頁面中傳遞引數來進行查詢條件或者翻頁資訊的傳遞 List<user> r = new ArrayList<user>(users.values()); return r; } /** * 處理"/users/"的POST請求，用來建立User * * @param user * @return */ @PostMapping("/") public String postUser(@RequestBody User user) { // @RequestBody註解用來繫結通過http請求中application/json型別上傳的資料 users.put(user.getId(), user); return "success"; } /** * 處理"/users/{id}"的GET請求，用來獲取url中id值的User資訊 * * @param id * @return */ @GetMapping("/{id}") public User getUser(@PathVariable Long id) { // url中的id可通過@PathVariable繫結到函式的引數中 return users.get(id); } /** * 處理"/users/{id}"的PUT請求，用來更新User資訊 * * @param id * @param user * @return */ @PutMapping("/{id}") public String putUser(@PathVariable Long id, @RequestBody User user) { User u = users.get(id); u.setName(user.getName()); u.setAge(user.getAge()); users.put(id, u); return "success"; } /** * 處理"/users/{id}"的DELETE請求，用來刪除User * * @param id * @return */ @DeleteMapping("/{id}") public String deleteUser(@PathVariable Long id) { users.remove(id); return "success"; } }
> 這裡相較1.x版本教程中，用更細化的@GetMapping、@PostMapping等系列註解替換了以前的@RequestMaping註解；另外，還使用@RequestBody替換了@ModelAttribute的引數繫結。
編寫單元測試
下面針對該Controller編寫測試用例驗證正確性，具體如下。當然也可以通過瀏覽器外掛等進行請求提交驗證。
@RunWith(SpringRunner.class)
@SpringBootTest
public class Chapter21ApplicationTests {
private MockMvc mvc;
@Before
public void setUp() {
mvc = MockMvcBuilders.standaloneSetup(new UserController()).build();
}
@Test
public void testUserController() throws Exception {
// 測試UserController
RequestBuilder request;
// 1、get查一下user列表，應該為空
request = get("/users/");
mvc.perform(request)
.andExpect(status().isOk())
.andExpect(content().string(equalTo("[]")));
// 2、post提交一個user
request = post("/users/")
.contentType(MediaType.APPLICATION_JSON)
.content("{\"id\":1,\"name\":\"測試大師\",\"age\":20}");
mvc.perform(request)
.andExpect(content().string(equalTo("success")));
// 3、get獲取user列表，應該有剛才插入的資料
request = get("/users/");
mvc.perform(request)
.andExpect(status().isOk())
.andExpect(content().string(equalTo("[{\"id\":1,\"name\":\"測試大師\",\"age\":20}]")));
// 4、put修改id為1的user
request = put("/users/1")
.contentType(MediaType.APPLICATION_JSON)
.content("{\"name\":\"測試終極大師\",\"age\":30}");
mvc.perform(request)
.andExpect(content().string(equalTo("success")));
// 5、get一個id為1的user
request = get("/users/1");
mvc.perform(request)
.andExpect(content().string(equalTo("{\"id\":1,\"name\":\"測試終極大師\",\"age\":30}")));
// 6、del刪除id為1的user
request = delete("/users/1");
mvc.perform(request)
.andExpect(content().string(equalTo("success")));
// 7、get查一下user列表，應該為空
request = get("/users/");
mvc.perform(request)
.andExpect(status().isOk())
.andExpect(content().string(equalTo("[]")));
}
}
對MockMvc不熟悉的讀者，可能會碰到一些函式不存在而報錯。必須引入下面這些靜態函式的引用：
import static org.hamcrest.Matchers.equalTo;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.*;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
> 這裡相較1.x版本教程中，主要有兩個地方不同。測試類採用@RunWith(SpringRunner.class)和@SpringBootTest修飾啟動；另外，由於POST和PUT介面的引數採用@RequestBody註解，所以提交的會是一個json字串，而不是之前的引數形式，這裡在定義請求的時候使用contentType(MediaType.APPLICATION_JSON)指定提交內容為json格式，使用content傳入要提交的json字串。如果用@ModelAttribute的話就得用param方法新增引數，具體可以看1.x版本的教程。
至此，我們通過引入web模組（沒有做其他的任何配置），就可以輕鬆利用Spring MVC的功能，以非常簡潔的程式碼完成了對User物件的RESTful API的建立以及單元測試的編寫。其中同時介紹了Spring MVC中最為常用的幾個核心註解：@RestController,RequestMapping以及一些引數繫結的註解：@PathVariable,@RequestBody等。
程式碼示例
本文的相關例子可以檢視下面倉庫中的chapter2-1目錄：
- Github：https://github.com/dyc87112/SpringBoot-Learning/tree/2.x
- Gitee：https://gitee.com/didispace/SpringBoot-Learning/tree/2.x
如果您覺得本文不錯，歡迎Star支援，您的關注是我堅持的動力！
歡迎關注我的公眾號：程式猿DD，獲得獨家整理的學習資源和日常乾貨推送。如果您對我的專題內容感興趣，也可以關注我的部落格：didispace.