Java 中怎么使用 TestRestTemplate 测试完整的 HTTP 请求响应流程

风丽同学_2553

风丽同学_2553

2026-11-01

706人浏览

原创

TestRestTemplate是Spring Boot集成测试专用HTTP客户端,自动集成ApplicationContext,支持JSON序列化、认证、自定义Header等,需配合@SpringBootTest(webEnvironment=RANDOM_PORT)使用。

java 中怎么使用 testresttemplate 测试完整的 http 请求响应流程

在 Spring Boot 项目中,TestRestTemplate 是专为集成测试设计的轻量级 HTTP 客户端,它自动集成 ApplicationContext,支持 JSON 自动序列化/反序列化、基础认证、自定义 header 等,适合测试 Controller 层完整 HTTP 请求响应流程(含路由、参数绑定、状态码、响应体、异常处理等)。

启用 TestRestTemplate

确保测试类使用 @SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT) 或 .INTEGRATION 模式,这样容器会启动嵌入式服务器(如 Tomcat),并允许通过真实端口发起 HTTP 调用。

直接注入即可:

@Autowired
private TestRestTemplate restTemplate;

也可手动构建(适用于需自定义配置的场景):

TestRestTemplate restTemplate = new TestRestTemplate(
    new RestTemplateBuilder()
        .basicAuthentication("user", "pass")
        .setConnectTimeout(Duration.ofSeconds(5))
);

发送 GET 请求并验证响应

最常见的是测试 RESTful 查询接口。假设有一个 GET /api/users/{id} 接口返回 User 对象:

  • 使用 getForObject() 获取反序列化后的对象(推荐用于成功响应)
  • 使用 getForEntity() 获取完整 ResponseEntity,可断言状态码、header 和 body

示例:

Java 接口排错助手
Java 接口排错助手

在调试 Java 后端 API 故障时使用此技能,尤其适用于以下任务:分析日志、跨 Controller、Service 和 Mapper 层追踪请求、定位异常根因、检查 SQL 执行或参数流转,以及生成简洁的诊断结论与修复方案。

下载
ResponseEntity<user> response = restTemplate.getForEntity("/api/users/1", User.class);
assertThat(response.getStatusCode()).isEqualTo(HttpStatus.OK);
assertThat(response.getBody()).isNotNull();
assertThat(response.getBody().getName()).isEqualTo("Alice");
</user>

发送 POST 请求并携带 JSON 数据

测试创建接口(如 POST /api/users)时,TestRestTemplate 默认使用 MappingJackson2HttpMessageConverter,可直接传入 Java 对象:

  • 构造请求体对象(如 new User("Bob", "bob@example.com"))
  • 调用 postForEntity(),自动序列化为 JSON 并设置 Content-Type: application/json
  • 检查返回的 ResponseEntity:状态码应为 201 CREATED,Location header 应包含新资源路径

示例:

User newUser = new User("Bob", "bob@example.com");
ResponseEntity<user> response = restTemplate.postForEntity("/api/users", newUser, User.class);
assertThat(response.getStatusCode()).isEqualTo(HttpStatus.CREATED);
assertThat(response.getHeaders().getLocation()).isNotNull();
</user>

处理认证、Header 和错误响应

TestRestTemplate 支持灵活的请求定制:

  • 带 Basic Auth:用 new TestRestTemplate("user", "pass") 构造,或在 builder 中调用 .basicAuthentication()
  • 自定义 Header:使用 HttpEntity 封装请求体和 headers
  • 捕获错误响应:即使返回 4xx/5xx,restTemplate 默认不抛异常;用 exchange() 方法配合 ResponseEntity 手动检查

示例(带 token 的请求):

HttpHeaders headers = new HttpHeaders();
headers.setBearerAuth("eyJhbGciOiJIUzI1NiJ9...");
HttpEntity<string> entity = new HttpEntity(headers);
ResponseEntity<string> response = restTemplate.exchange(
    "/api/admin/data", HttpMethod.GET, entity, String.class
);
assertThat(response.getStatusCode()).isEqualTo(HttpStatus.FORBIDDEN);
</string></string>

不复杂但容易忽略:务必确认 Controller 方法有正确注解(如 @RestController、@GetMapping)、实体类有无参构造器和 getter/setter,且测试类在 Spring Boot 主应用包扫描路径下,否则端点不会被注册。

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

java

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
java
java

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

2023.06.15

11677

6

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

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

2023.07.05

8782

9

java自学难吗
java自学难吗

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

2023.07.31

7552

8

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

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

2023.08.01

1244

3

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

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

2023.08.02

1008

3

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

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

2023.08.02

1496

5

java有什么用
java有什么用

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

2023.08.02

3069

5

java在线网站
java在线网站

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

2023.08.03

20311

3

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

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

2023.08.03

1335

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习