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";
    }

}      

這裡相較

中，用更細化的

@

GetMapping

@PostMapping

等系列注解替換了以前的

@RequestMaping

注解；另外，還使用

@RequestBody

替換了

@ModelAttribute

的參數綁定。

https://blog.didispace.com/spring-boot-learning-21-2-1/#%E7%BC%96%E5%86%99%E5%8D%95%E5%85%83%E6%B5%8B%E8%AF%95 編寫單元測試

下面針對該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;      

中，主要有兩個地方不同。測試類采用

@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

等。

本系列教程

《Spring Boot 2.x基礎教程》點選直達！

。學習過程中如遇困難，建議加入

Spring技術交流群

，參與交流與讨論，更好的學習與進步！

https://blog.didispace.com/spring-boot-learning-21-2-1/#%E4%BB%A3%E7%A0%81%E7%A4%BA%E4%BE%8B 代碼示例

本文的相關例子可以檢視下面倉庫中的

chapter2-1

目錄：

• Github： https://github.com/dyc87112/SpringBoot-Learning/
• Gitee： https://gitee.com/didispace/SpringBoot-Learning/