关于springboot:Spring-Boot-2x基础教程构建RESTful-API与单元测试

24次阅读

共计 4333 个字符,预计需要花费 11 分钟才能阅读完成。

首先,回顾并具体阐明一下在疾速入门中应用的 @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 等。

正文完
 0