如何测试Spring MVC应用

更新时间：2020年10月12日 14:33:33 作者：Ricky

这篇文章主要介绍了如何测试Spring MVC应用，帮助大家更好的理解和使用spring框架，感兴趣的朋友可以了解下

Spring的依赖注入使得我们的代码非常容易进行单元测试——@Controller, @Service，@Entity等注解标注的类基本都是POJO(plain old Java object)，也就是说很少依赖于Spring容器本身的API。我们可以非常容易地使用JUnit或TestNG编写测试代码。另一方面，对于三层架构的Spring Web应用（Controller, Service, DAO），使用Mock活Stub方法也能够更好的来测试我们的代码逻辑。例如Service层代码的单元测试中，依赖的DAO（或Repository)对象都是根据应用测试需求Mock出来的，而不需要真正去访问数据库。

Spring Web测试

在对Spring Web应用中的@Controller代码进行单元测试的过程中，一般的方法是创建@Controller对象，同时将它依赖的一些Mock对象——例如MockHttpServletRequest, MockHttpServletResponse（都由spring-test模块提供，无需自己编写）作为@Controller方法的参数。但是对于处理Web请求的@Controller代码来说，仅仅测试Handler方法里的代码是远远不够的，对于一个处理HTTP请求的@Controller`，我们还需要测试：

@RequestMapping路由是否正确
数据绑定、类型转换、校验逻辑是否正确——数据包括URL参数、表单、@PathVariable等
@InitBinder, @ModelAttribute, @ExceptionHandler等注解的方法或属性计算过程

上述过程贯穿于HTTP请求处理的生命周期中，所以对于Spring Web应用中@Controller代码单元测试的概念，应该做一些扩充——不仅仅局限于代码本身，也要结合MVC框架中的各个处理过程。

本文接下来的内容代码，都以Spring Boot为例，首先假设我们通过Spring Boot创建了一个最简单的Web Mvc应用——包含了一个最简单的Conroller，处理/users/{id}对应的HTTP请求，返回值是id={id}（通过String.format()方法），那么可以为它创建如下测试代码：

import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;

@RunWith(SpringJUnit4ClassRunner.class)
@SpringApplicationConfiguration(classes = SpringMvcTestDemoApplication.class)
@WebAppConfiguration
public class SpringMvcTestDemoApplicationTests {

  private MockMvc mockMvc;

  @Before
  public void init() {
    this.mockMvc = MockMvcBuilders.standaloneSetup(new UserController()).build();
  }

  @Test
  public void getUserById() throws Exception {
    long id = 1;
    this.mockMvc.perform(get("/users/" + id))
        .andExpect(status().isOk())
        .andExpect(content().string("id=" + id));
  }

}

运行上述测试时，很容易从控制台中的日志发现，SpringJUnit4ClassRunner创建了一个Spring Web应用上下文，并且在其中进行了Web Mvc框架的配置——这里是注册@RequestMapping方法。接下来mockMvc.perform()方法实际上向该Spring Web应用发起了一个HTTP请求：

请求的url为/users/{id}
andExpect()方法也就是测试中常用的Assert
status()用于检查返回状态吗，这里是200
content()用于检查内容

如果我们不小心将@RequestMapping的路由路径写错，那么这里运行的结果一定不会是status().isOk()，这也就完成了对HTTP请求路由的测试。接下来我们将继续探索MVC框架中的其他方面。

Mock Service

在Spring Web应用三层结构里，Controller层代码通常会调用Service层代码，例如：

@RestController
public class UserController {

  @Autowired
  private UserService userService;

  @RequestMapping(value = "/users/{id}", method = GET)
  public String get(@PathVariable("id") long id) {
    String username = userService.getUsername(id);
    return String.format("username=%s", username);
  }
}

对UserController进行单元测试需要排除Service代码的影响，所以需要对Service进行Mock，这里我们使用Mockito框架，在Spring上下文中Mock一个UserService对象：

@Configuration
public class TestContext {

  @Bean
  public UserService userServiceMock() {
    return Mockito.mock(UserService.class);
  }
}

同时通过Mockito的API来MockUserService.getUsername(long id)方法，@Controller的测试代码如下：

@RunWith(SpringJUnit4ClassRunner.class)
@SpringApplicationConfiguration(classes = {
    SpringMvcTestDemoApplication.class,
    TestContext.class
})
@WebAppConfiguration
public class SpringMvcTestDemoApplicationTests {

  @Autowired
  UserService userService;

  @Autowired
  UserController controller;

  MockMvc mockMvc;

  @Before
  public void init() {
    this.mockMvc = MockMvcBuilders.standaloneSetup(controller).build();
  }

  @Test
  public void getUserById() throws Exception {
    long id = 1L;
    String ricky = "Ricky";
    Mockito.when(userService.getUsername(id)).thenReturn(ricky);
    this.mockMvc.perform(get("/users/" + id))
        .andExpect(status().isOk())
        .andExpect(content().string("username=" + ricky));
  }

}

由于需要进行依赖注入，所以UserService和UserController都使用@Autowired注解。Mockito.when(userService.getUsername(id)).thenReturn(ricky);表明userService.getUsername()方法的参数为1L时，返回值为"Ricky"，Mockito提供能很多强大的Mock API，更多用法请参考官方文档。

测试REST API

当我们构建REST服务时，大多数情况会使用JSON作为数据交换格式，Spring MVC测试框架同样提供了一种简洁的方式对JSON结果进行断言，假设现在有@Controller如下：

@RequestMapping(value = "/users/{id}/json", method = GET)
public User getUser(@PathVariable("id") long id) {
  String username = userService.getUsername(id);
  return new User(id, username);
}

static class User {
  public long id;
  public String username;
  //构造方法，Getter/Setter略
}

实际应用返回的JSON数据是：

{
 "id": 1,
 "username": "Ricky"
}

测试代码可以这样断言：

@Test
public void getUser() throws Exception {
  this.mockMvc.perform(get("/users/{id}/json", id).accept(MediaType.APPLICATION_JSON))
      .andExpect(status().isOk())
      .andExpect(jsonPath("$.id").value(id.intValue()))
      .andExpect(jsonPath("$.username").value(ricky));
}

$.id, $.username都是JsonPath提供的JSON表达式，可以通过jsonPath、value()等方法来轻松对JSON数据进行断言而不需要自己编写JSON文本处理。

以上就是如何测试Spring MVC应用的详细内容，更多关于测试Spring MVC应用的资料请关注脚本之家其它相关文章！

您可能感兴趣的文章:

最新SpringCloud Stream消息驱动讲解
SpringCloud Stream 是一个构建消息驱动微服务的框架，通过 SpringCloud Stream 连接消息中间件，以实现消息事件驱动，这篇文章主要介绍了SpringCloud Stream消息驱动,需要的朋友可以参考下
2022-11-11
springboot集成redis并使用redis生成全局唯一索引ID
本文主要介绍了springboot集成redis并使用redis生成全局唯一索引ID，文中通过示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2022-03-03
Java实现JSP在Servelt中连接Oracle数据库的方法
这篇文章主要介绍了Java实现JSP在Servelt中连接Oracle数据库的方法,需要的朋友可以参考下
2014-07-07
SpringBoot 2.6.x整合springfox 3.0报错问题及解决方案
这篇文章主要介绍了SpringBoot 2.6.x整合springfox 3.0报错问题及解决方案,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
2024-01-01
Jmeter内置变量vars和props的使用详解
JMeter是一个功能强大的负载测试工具,它提供了许多有用的内置变量来支持测试过程,其中最常用的变量是 vars 和 props,本文通过代码示例详细给大家介绍了Jmeter内置变量vars和props的使用,需要的朋友可以参考下
2024-08-08
Mybatis返回值(resultType＆resultMap)的具体使用
返回值属性有两种设置,一种是resultType,一种是resultMap,本文主要介绍了Mybatis返回值(resultType＆resultMap)的具体使用,具有一定的参考价值,感兴趣的可以了解一下
2023-08-08
Java技术长久占居主要地位的12个原因
这篇文章主要为大家详细介绍了12个Java长久占居主要地位的原因，感兴趣的小伙伴们可以参考一下
2016-07-07
写了两年代码之后再来谈一谈Spring中的Bean
这篇文章主要介绍了写了两年代码之后再来看看Spring中的Bean,这里列出四种常用的添加Bean的方式，介绍最基本的@Bean注解，@Bean注解声明这个类是一个Bean，需要的朋友可以参考下
2021-10-10
java中注解的原理解析
这篇文章主要介绍了java中注解的原理解析,java 注解又称 Java 标注,是 JDK5.0 引入的一种注释机制,可以理解为为某个东西,打个标记的记号,等要使用这个注解时,可以通过反射获取标注里面的内容,需要的朋友可以参考下
2023-10-10
SpringBoot中实现文件上传、下载、删除功能的步骤
本文将详细介绍如何在 Spring Boot 中实现文件上传、下载、删除功能,采用的技术框架包括：Spring Boot 2.4.2、Spring MVC、MyBatis 3.5.6、Druid 数据源、JUnit 5 等,文中有详细的操作步骤和示例代码供大家参考,需要的朋友可以参考下
2024-01-01

如何测试Spring MVC应用

相关文章

最新评论

大家感兴趣的内容

最近更新的内容

常用在线小工具