Spring Boot构建RESTful API与单元测试

系统管理员 2023-06-11 09:28 76阅读 0赞

本文由 [程序猿DD-翟永超][DD-] 创作，采用 [CC BY 3.0 CN协议][CC BY 3.0 CN] 进行许可，转自：[http://blog.didispace.com/springbootrestfulapi/][http_blog.didispace.com_springbootrestfulapi]

--------------------

首先，回顾并详细说明一下在[快速入门][Link 1]中使用的`@Controller`、`@RestController`、`@RequestMapping`注解。如果您对Spring MVC不熟悉并且还没有尝试过快速入门案例，建议先看一下[快速入门][Link 1]的内容。

*  `@Controller`：修饰class，用来创建处理http请求的对象
 *  `@RestController`：Spring4之后加入的注解，原来在`@Controller`中返回json需要`@ResponseBody`来配合，如果直接用`@RestController`替代`@Controller`就不需要再配置`@ResponseBody`，默认返回json格式。
 *  `@RequestMapping`：配置url映射

下面我们尝试使用Spring MVC来实现一组对User对象操作的RESTful API，配合注释详细说明在Spring MVC中如何映射HTTP请求、如何传参、如何编写单元测试。

**RESTful API具体设计如下：**

[![format_png][]][format_png 1]

User实体定义：

public class User { 
     
        private Long id; 
        private String name; 
        private Integer age;  
        // 省略setter和getter    
    }

@RestController 
    @RequestMapping(value="/users")     // 通过这里配置使下面的映射都在/users下 
    public class UserController { 
     
        // 创建线程安全的Map 
        static Map<Long, User> users = Collections.synchronizedMap(new HashMap<Long, User>()); 
     
        @RequestMapping(value="/", method=RequestMethod.GET) 
        public List<User> getUserList() { 
            // 处理"/users/"的GET请求，用来获取用户列表 
            // 还可以通过@RequestParam从页面中传递参数来进行查询条件或者翻页信息的传递 
            List<User> r = new ArrayList<User>(users.values()); 
            return r; 
        } 
     
        @RequestMapping(value="/", method=RequestMethod.POST) 
        public String postUser(@ModelAttribute User user) { 
            // 处理"/users/"的POST请求，用来创建User 
            // 除了@ModelAttribute绑定参数之外，还可以通过@RequestParam从页面中传递参数 
            users.put(user.getId(), user); 
            return "success"; 
        } 
     
        @RequestMapping(value="/{id}", method=RequestMethod.GET) 
        public User getUser(@PathVariable Long id) { 
            // 处理"/users/{id}"的GET请求，用来获取url中id值的User信息 
            // url中的id可通过@PathVariable绑定到函数的参数中 
            return users.get(id); 
        } 
     
        @RequestMapping(value="/{id}", method=RequestMethod.PUT) 
        public String putUser(@PathVariable Long id, @ModelAttribute User user) { 
            // 处理"/users/{id}"的PUT请求，用来更新User信息 
            User u = users.get(id); 
            u.setName(user.getName()); 
            u.setAge(user.getAge()); 
            users.put(id, u); 
            return "success"; 
        } 
     
        @RequestMapping(value="/{id}", method=RequestMethod.DELETE) 
        public String deleteUser(@PathVariable Long id) { 
            // 处理"/users/{id}"的DELETE请求，用来删除User 
            users.remove(id); 
            return "success"; 
        } 
     
    }

实现对User对象的操作接口

下面针对该Controller编写测试用例验证正确性，具体如下。当然也可以通过浏览器插件等进行请求提交验证。

@RunWith(SpringJUnit4ClassRunner.class) 
    @SpringApplicationConfiguration(classes = MockServletContext.class) 
    @WebAppConfiguration 
    public class ApplicationTests { 
     
    	private MockMvc mvc; 
     
    	@Before 
    	public void setUp() throws Exception { 
    		mvc = MockMvcBuilders.standaloneSetup(new UserController()).build(); 
    	} 
     
    	@Test 
    	public void testUserController() throws Exception { 
            // 测试UserController 
    		RequestBuilder request = null; 
     
    		// 1、get查一下user列表，应该为空 
    		request = get("/users/"); 
    		mvc.perform(request) 
    				.andExpect(status().isOk()) 
    				.andExpect(content().string(equalTo("[]"))); 
     
    		// 2、post提交一个user 
    		request = post("/users/") 
    				.param("id", "1") 
    				.param("name", "测试大师") 
    				.param("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") 
    				.param("name", "测试终极大师") 
    				.param("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("[]"))); 
     
    	} 
     
    }

至此，我们通过引入web模块（没有做其他的任何配置），就可以轻松利用Spring MVC的功能，以非常简洁的代码完成了对User对象的RESTful API的创建以及单元测试的编写。其中同时介绍了Spring MVC中最为常用的几个核心注解：`@Controller`,`@RestController`,`RequestMapping`以及一些参数绑定的注解：`@PathVariable`,`@ModelAttribute`,`@RequestParam`等。

## 代码示例 ##

本文的相关例子可以查看下面仓库中的`chapter3-1-1`目录：

*  Github：[https://github.com/dyc87112/SpringBoot-Learning][https_github.com_dyc87112_SpringBoot-Learning]
 *  Gitee：[https://gitee.com/didispace/SpringBoot-Learning][https_gitee.com_didispace_SpringBoot-Learning]

[DD-]: http://blog.didispace.com/
[CC BY 3.0 CN]: http://creativecommons.org/licenses/by/3.0/cn
[http_blog.didispace.com_springbootrestfulapi]: http://blog.didispace.com/springbootrestfulapi/
[Link 1]: http://blog.didispace.com/spring-boot-learning-1/
[format_png]: /images/20230531/964a5c4a82b742249acf4dbc60141cd7.png
[format_png 1]: http://blog.didispace.com/content/images/posts/springbootrestfulapi-1.png
[https_github.com_dyc87112_SpringBoot-Learning]: https://github.com/dyc87112/SpringBoot-Learning/tree/1.x
[https_gitee.com_didispace_SpringBoot-Learning]: https://gitee.com/didispace/SpringBoot-Learning/tree/1.x