关于springboot:Spring-Boot-2x基础教程构建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等。

评论

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注

这个站点使用 Akismet 来减少垃圾评论。了解你的评论数据如何被处理