Spring Boot 中 RestTemplate 的核心用法指南

 更新时间:2025年12月13日 11:09:25   作者:一勺菠萝丶  
本文详细介绍了RestTemplate的使用,包括基础用法、进阶配置技巧、实战案例以及最佳实践建议,通过一个腾讯地图路线规划的案例,展示了如何在实际项目中应用RestTemplate进行服务间通信,感兴趣的朋友跟随小编一起看看吧

在分布式系统开发中,服务间通信是常见需求。作为 Spring 框架的重要组件,RestTemplate 为开发者提供了简洁优雅的 HTTP 客户端解决方案。本文将从零开始讲解 RestTemplate 的核心用法,并附赠真实地图 API 对接案例。

一、环境准备

在 Spring Boot 项目中添加依赖:

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

通过配置类初始化 RestTemplate:

@Configuration
public class RestTemplateConfig {
    @Bean
    public RestTemplate restTemplate() {
        return new RestTemplate();
    }
}

用的时候引入

    @Autowired
    private RestTemplate restTemplate;

二、基础用法全解析

1. GET 请求的三种姿势

方式一:路径参数(推荐)

String url = "https://api.example.com/users/{id}";
Map<String, Object> params = new HashMap<>();
params.put("id", 1001);
User user = restTemplate.getForObject(url, User.class, params);

方式二:显式拼接参数

String url = "https://api.example.com/users?id=1001";
User user = restTemplate.getForObject(url, User.class);

方式三:URI 构造器

UriComponentsBuilder builder = UriComponentsBuilder
        .fromUriString("https://api.example.com/users")
        .queryParam("name", "John")
        .queryParam("age", 25);
User user = restTemplate.getForObject(builder.toUriString(), User.class);

2. POST 请求深度实践

发送表单数据:

MultiValueMap<String, String> formData = new LinkedMultiValueMap<>();
formData.add("username", "admin");
formData.add("password", "123456");
ResponseEntity<String> response = restTemplate.postForEntity(
        "https://api.example.com/login", 
        formData, 
        String.class
);

提交 JSON 对象:

User newUser = new User("Alice", 28);
HttpHeaders headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_JSON);
HttpEntity<User> request = new HttpEntity<>(newUser, headers);
User createdUser = restTemplate.postForObject(
        "https://api.example.com/users", 
        request, 
        User.class
);

三、进阶配置技巧

1. 超时控制

@Bean
public RestTemplate customRestTemplate() {
    return new RestTemplateBuilder()
            .setConnectTimeout(Duration.ofSeconds(5))
            .setReadTimeout(Duration.ofSeconds(10))
            .build();
}

2. 拦截器实战

public class LoggingInterceptor implements ClientHttpRequestInterceptor {
    @Override
    public ClientHttpResponse intercept(HttpRequest request, byte[] body, 
            ClientHttpRequestExecution execution) throws IOException {
        logRequest(request, body);
        ClientHttpResponse response = execution.execute(request, body);
        logResponse(response);
        return response;
    }
    private void logRequest(HttpRequest request, byte[] body) {
        // 实现请求日志记录
    }
    private void logResponse(ClientHttpResponse response) {
        // 实现响应日志记录
    }
}

注册拦截器:

@Bean
public RestTemplate restTemplate() {
    RestTemplate restTemplate = new RestTemplate();
    restTemplate.setInterceptors(Collections.singletonList(new LoggingInterceptor()));
    return restTemplate;
}

四、实战案例:腾讯地图路线规划

@Service
public class MapService {
    @Value("${tencent.map.key}")
    private String apiKey;
    @Autowired
    private RestTemplate restTemplate;
    public DrivingRoute calculateRoute(Location start, Location end) {
        String url = "https://apis.map.qq.com/ws/direction/v1/driving/"
                + "?from={start}&to={end}&key={key}";
        Map<String, String> params = new HashMap<>();
        params.put("start", start.toString());
        params.put("end", end.toString());
        params.put("key", apiKey);
        ResponseEntity<MapResponse> response = restTemplate.getForEntity(
                url, 
                MapResponse.class, 
                params
        );
        if (response.getStatusCode() == HttpStatus.OK && 
            response.getBody().getStatus() == 0) {
            return response.getBody().getResult().getRoutes().get(0);
        }
        throw new MapServiceException("路线规划失败");
    }
}

五、最佳实践建议

  • 响应处理策略
    • 使用 ResponseEntity<T> 获取完整响应信息
    • 实现自定义错误处理器 ResponseErrorHandler
    • 对于复杂 JSON 结构,建议定义完整的 DTO 类
  • 性能优化
    • 启用连接池(推荐 Apache HttpClient)
    • 合理设置超时时间
    • 考虑异步调用(结合 AsyncRestTemplate)
  • 安全防护
    • 启用 HTTPS
    • 敏感参数加密处理
    • 配置请求频率限制

六、常见问题排查

问题1:收到 400 Bad Request

  • 检查请求参数格式
  • 确认 Content-Type 设置正确
  • 验证请求体 JSON 结构

问题2:出现乱码

  • 设置正确的字符编码
  • 检查服务端和客户端的编码一致性
  • 在 headers 中明确指定 charset=UTF-8

问题3:超时配置不生效

  • 确认使用的 RestTemplate 实例正确
  • 检查连接池配置是否覆盖超时设置
  • 验证网络防火墙设置

到此这篇关于Spring Boot 中 RestTemplate 的核心用法指南的文章就介绍到这了,更多相关Spring Boot RestTemplate使用内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Mybatis使用命令生成逆向工程的方法

    Mybatis使用命令生成逆向工程的方法

    这篇文章主要介绍了Mybatis使用命令生成逆向工程的方法,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2021-01-01
  • Java两个集合取差集4种方式举例

    Java两个集合取差集4种方式举例

    在Java 编程中,经常需要对集合进行一些操作,比如取两个集合的交集、并集和差集,下面这篇文章主要给大家介绍了关于Java两个集合取差集的4种方式,需要的朋友可以参考下
    2024-08-08
  • SpringSecurity集成图片验证码的详细过程

    SpringSecurity集成图片验证码的详细过程

    SpringSecurity是通过过滤器链来完成的,接下来的验证码,可以尝试创建一个过滤器放到Security的过滤器链中,在自定义的过滤器中比较验证码,本文通过实例代码介绍SpringSecurity集成图片验证码的详细过程,感兴趣的朋友一起看看吧
    2023-12-12
  • Java Web应用小案例之实现用户登录功能全过程

    Java Web应用小案例之实现用户登录功能全过程

    在Java开发过程中实现用户的注册功能是最基本的,这篇文章主要给大家介绍了关于Java Web应用小案例之实现用户登录功能的相关资料,文中通过图文介绍的非常详细,需要的朋友可以参考下
    2024-01-01
  • java设计模式责任链模式原理案例详解

    java设计模式责任链模式原理案例详解

    一个事件需要经过多个对象处理是一个挺常见的场景,譬如采购审批流程,请假流程,软件开发中的异常处理流程,web请求处理流程等各种各样的流程,可以考虑使用责任链模式来实现
    2021-09-09
  • JPA默认值设置没有效果的解决

    JPA默认值设置没有效果的解决

    这篇文章主要介绍了JPA默认值设置没有效果的解决方案,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-11-11
  • idea maven项目启动项目不编译target 文件的问题及解决方法

    idea maven项目启动项目不编译target 文件的问题及解决方法

    代码编辑器中无编译错误,通过maven 的clean 、compile、package进行各种操作也都没问题,但是单击绿色箭头运行(默认会先执行IDE本身的Build操作)却报:程序包xxx不存在,这篇文章主要介绍了解决idea maven项目启动项目不编译target文件问题,需要的朋友可以参考下
    2023-05-05
  • idea 如何查找类中的某个方法

    idea 如何查找类中的某个方法

    这篇文章主要介绍了idea 如何查找类中的某个方法,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2021-02-02
  • 通过实例解析传统jar包引用方式

    通过实例解析传统jar包引用方式

    这篇文章主要介绍了通过实例解析传统jar包引用方式,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-07-07
  • Java服务器处理图片上传的方法

    Java服务器处理图片上传的方法

    这篇文章主要为大家详细介绍了Java服务器处理图片上传,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2022-06-06

最新评论