Spring Boot之構建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等。