Spring Boot 中 REST 接口单元测试怎么编写

雨芳吖_5939

雨芳吖_5939

2026-10-16

627人浏览

原创

spring boot rest接口单元测试首选@webmvctest,用mockmvc模拟请求并验证状态码、json响应等;通过@mockbean隔离service依赖,避免启动全量上下文。

spring boot 中 rest 接口单元测试怎么编写

Spring Boot 中 REST 接口单元测试主要围绕 Controller 层 展开,核心是用 MockMvc 模拟 HTTP 请求,验证接口行为是否符合预期——包括状态码、响应内容、JSON 结构等。不启动真实 Web 容器,速度快、隔离性好。

选对测试注解:@WebMvcTest 最常用

推荐优先使用 @WebMvcTest,它只加载 Web 层组件(如 @Controller、@RestController、@JsonComponent),自动忽略 @Service、@Repository 等非 Web Bean,避免全量上下文启动,测试更轻量、更聚焦。

  • 指定测试目标控制器:@WebMvcTest(UserController.class)
  • 若需模拟依赖服务,用 @MockBean 替换真实实现(例如 @MockBean UserService userService)
  • 无需手动构建 MockMvc,它会自动注入到测试类中

构造请求并断言响应

使用 mockMvc.perform(...) 发起模拟请求,链式调用 andExpect(...) 验证结果:

  • 检查 HTTP 状态:.andExpect(status().isOk())、.andExpect(status().isNotFound())
  • 校验 JSON 响应体:.andExpect(jsonPath("$.name").value("Alice"))、.andExpect(jsonPath("$.[0].id").value(1))
  • 验证响应头或内容类型:.andExpect(content().contentType(MediaType.APPLICATION_JSON))
  • GET 请求带参数:get("/users").param("page", "1").param("size", "10")
  • POST/PUT 提交 JSON:post("/users").content(asJsonString(user)).contentType(MediaType.APPLICATION_JSON)(需自定义 asJsonString() 方法,内部用 ObjectMapper 序列化)

处理依赖与数据模拟

Controller 通常调用 Service,而 Service 又依赖 DAO 或外部服务。单元测试中应切断这些真实依赖:

  • 用 @MockBean 替换 Service 实现,控制返回值:when(userService.findById(1L)).thenReturn(new User(1L, "Tom", 25))
  • 避免在测试中操作真实数据库;如需验证完整流程(含 DB),改用 @DataJpaTest 或集成测试注解
  • 异常路径也要覆盖:比如传入非法 ID 时,应返回 400 或 404,并检查错误消息结构

基础依赖和准备

确保 pom.xml 中已引入测试起步依赖:

  • Maven:<dependency><groupid>org.springframework.boot</groupid><artifactid>spring-boot-starter-test</artifactid><scope>test</scope></dependency>
  • 测试类放在 src/test/java,资源文件(如测试用 JSON)放 src/test/resources
  • 建议为 JSON 转换封装工具方法(如 objectMapper.writeValueAsString(obj)),提升可读性

不复杂但容易忽略:测试前确认 Controller 的 URL 映射(@RequestMapping 或 @GetMapping)与测试中写的路径完全一致,注意斜杠、路径变量占位符(如 {id})和实际传值的匹配。

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.15

10597

6

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

2023.07.05

7722

9

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

2023.07.31

6732

8

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.01

1144

3

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.02

948

3

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

1396

5

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

2789

5

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

2023.08.03

20091

3

配置java环境变量
配置java环境变量

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1235

8

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习