基于Spring-WS的Restful API的集成测试

在很多Java企业级应用中，Spring占据了非常重要的位置，这就导致了基本上的技术选型都是围绕着Spring来， 比方说笔者最近的项目需要开发一个Restful的API接口，选型的时候就说，客户架构师直接就拍了spring-ws，原因呢？系统中其他的模块都是用的Spring-ws，保持一致，而且社区活跃，文档丰富，遇到问题易解决。好了，入正题。


既然选定了Spring-WS， 已经TDD入魔的我，首先想到的就是我应该怎么测试这个API接口呢？ 作为业界最成熟的框架，Spring为测试其Web应用提供了非常好用的辅助类MockMvc。



首先，在项目的测试代码中加入辅助Spring Web测试的库

1. testCompile(
2. "org.springframework:spring-test:$springVersion",
3. "org.springframework.ws:spring-ws-test:2.1.0.RELEASE",
4. "javax.servlet:javax.servlet-api:3.0.1",
5. "com.jayway.jsonpath:json-path-assert:0.9.0"
6. )

其中，jsonpath库的依赖是为了更好的做json格式数据的断言。



然后，编写测试代码

1. //指定使用SpringIntegration测试，并且制定了运行测试的ApplicationContext
2. @RunWith(SpringJUnit4ClassRunner.class)
3. @ContextConfiguration(locations = {"classpath:spring-servlet.xml"})
4. public class ApiControllerIntegrationTest {
5. @Autowired
6. private ApiController controller;
7. private MockMvc mockMvc;
8. @Before
9. public void setUp() throws Exception {
10. //绑定需要测试的Controller到MockMvcshang
11. mockMvc = MockMvcBuilders.standaloneSetup(controller).build();
12. }
13. @Test
14. public void testGet() throws Exception {
15. //发出请求，在请求中可以设置一个http request可设置的所有参数
16. mockMvc.perform(get("/requests/1")
17. .contentType(MediaType.APPLICATION_JSON)
18. .accept(MediaType.APPLICATION_JSON)
19. .param("userId", "xianlinbox")
20. )
21. //验证Respondse，status()中，可验证所有的HTTP Status CODE
22. //另外，使用了jsonPath更优雅的做json属性值的验证
23. .andExpect(status().isOk())
24. .andExpect(jsonPath("$.userId").value("xianlinbox"))
25. .andExpect(jsonPath("$.requestId").value("1"))
26. .andExpect(jsonPath("$.requestType").value("GET"));
27. }
28. @Test
29. public void testPost() throws Exception {
30. mockMvc.perform(post("/requests")
31. .contentType(MediaType.APPLICATION_JSON)
32. .accept(MediaType.APPLICATION_JSON)
33. .content("this is the message")
34. .param("userId", "xianlinbox")
35. )
36. //使用print()可打印出当前测试设计的HTTP Request/Responsed的所有信息，方便定位问题
37. //Post方法的返回结果应该是202（HttpStatus.Created），对象创建成功
38. .andDo(print())
39. .andExpect(status().isCreated())
40. .andExpect(jsonPath("$.userId").value("xianlinbox"))
41. .andExpect(jsonPath("$.requestType").value("POST"))
42. .andExpect(jsonPath("$.message").value("this is the message"));
43. }
44. }

testPost方法中的print()语句打印出的效果如下:

MockHttpServletRequest:

         HTTP Method = POST

         Request URI = /requests

          Parameters = {userId=[xianlinbox]}

             Headers = {Content-Type=[application/json], Accept=[application/json]}



             Handler:

                Type = com.xianlinbox.api.ApiController

              Method = public com.xianlinbox.api.Request
com.xianlinbox.api.ApiController.post(java.lang.String,java.lang.String)



               Async:

   Was async started = false

        Async result = null



  Resolved Exception:

                Type = null



        ModelAndView:

           View name = null

                View = null

               Model = null



            FlashMap:



MockHttpServletResponse:

              Status = 201

       Error message = null

             Headers = {Content-Type=[application/json;charset=UTF-8]}

        Content type = application/json;charset=UTF-8

                Body = {"userId":"xianlinbox","requestId":"1","requestType":"POST","message":"this is the message"}

       Forwarded URL = null

      Redirected URL = null

             Cookies = []



看完了测试， 来简单的看下具体的实现代码：

1. @Controller
2. public class ApiController {
3. @RequestMapping(value = "/requests/{requestId}", method = RequestMethod.GET)
4. @ResponseBody
5. public Request get(@PathVariable String requestId, @RequestParam(value = "userId") String userId) {
6. return new Request(userId, requestId, "GET");
7. }
8. @RequestMapping(value = "/requests", method = RequestMethod.POST)
9. @ResponseBody
10. @ResponseStatus(value = HttpStatus.CREATED)
11. public Request post(@RequestParam(value = "userId") String userId, @RequestBody String content) {
12. Request request = new Request(userId, "1", "POST");
13. request.setMessage(content);
14. return request;
15. }
16. }

• 使用RequestMapping定义URL
• 使用@ResponseBody表示返回json
• 使用@PathVariable 获取路径参数
• 使用@RequestParam获取request payload中的参数
• 使用@RequestBody获取request body
• 使用@ResponseStatus(value = HttpStatus.CREATED)，定义返回的HTTP STATUS CODE

该Demo的所有代码： https://github.com/xianlinbox/TDD_Demo/tree/master/spring-ws-rest