Spring MVC PUT请求测试实践

Spring MVC PUT请求测试实践

在Spring MVC框架中，对控制器的测试是一个重要的环节，尤其是处理PUT请求的控制器。本文将通过一个具体的实例，展示如何使用Spring的单元测试API和模拟对象来测试处理PUT请求的控制器。

控制器示例

首先，我们定义一个ArticleController控制器，它有两个处理PUT请求的方法：一个用于处理XML格式的请求，另一个用于处理表单编码的请求。

@Controller
@RequestMapping("/articles")
public class ArticleController {
    // XML和JSON处理
    @PutMapping("/{id}")
    public String createNewArticle(@RequestBody Article article) {
        System.out.println("Creating Article in controller: " + article);
        return "Article created.";
    }

    // 表单编码处理
    @PutMapping(value = "/{id}", consumes = MediaType.APPLICATION_FORM_URLENCODED_VALUE)
    @ResponseBody
    public String createNewArticleWithFormParams(@RequestBody MultiValueMap<String, String> formParams) {
        System.out.println("Creating Article in controller. MultiValueMap= " + formParams);
        return "Article created.";
    }
}

Java配置

接着，我们创建一个Java配置类MyWebConfig来启用Web MVC。

@EnableWebMvc
@Configuration
public class MyWebConfig implements WebMvcConfigurer {
    // 配置内容
}

单元测试

现在，我们将为XML、JSON和表单编码的请求创建并运行测试。

测试XML PUT请求

以下是使用JUnit和Spring TestContext框架编写的测试类，用于测试XML格式的PUT请求。

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(classes = MyWebConfig.class)
public class ControllerPutTests {
    @Autowired
    private WebApplicationContext wac;
    private MockMvc mockMvc;

    @Test
    public void testXmlController() throws Exception {
        long id = 1;
        MockHttpServletRequestBuilder builder =
                MockMvcRequestBuilders.put("/articles/" + id)
                        .contentType(MediaType.APPLICATION_XML_VALUE)
                        .accept(MediaType.APPLICATION_XML)
                        .characterEncoding("UTF-8")
                        .content(getArticleInXml(id));
        this.mockMvc.perform(builder)
                .andExpect(MockMvcResultMatchers.status().isOk())
                .andExpect(MockMvcResultMatchers.content().string("Article created."))
                .andDo(MockMvcResultHandlers.print());
    }

    private String getArticleInXml(long id) {
        return "<article><id>" + id + "</id><content>test data</content></article>";
    }
}

输出

测试执行后，控制台将输出请求和响应的详细信息，包括请求方法、URI、头信息、请求体等。

测试JSON PUT请求

类似地，我们可以为JSON格式的PUT请求编写测试。

测试表单编码PUT请求

对于表单编码的PUT请求，我们也需要编写相应的测试。

示例项目

以下是项目中使用的一些依赖和技术：

• spring-webmvc 5.0.3.RELEASE
• jackson-databind 2.9.4
• spring-test 5.0.3.RELEASE
• junit 4.12
• javax.servlet-api 3.0.1
• JDK 1.8
• Maven 3.3.9

通过上述步骤，我们可以确保我们的控制器能够正确处理不同类型的PUT请求，并通过单元测试验证其功能。这不仅提高了代码的可靠性，也方便了后续的维护和升级。