RestTemplate常用请求

已于 2022-04-24 17:34:39 修改
阅读量1.6k 收藏 2
点赞数 3
分类专栏： java后端技术 文章标签： java spring
于 2022-04-24 17:34:08 首次发布
原文链接：https://blog.csdn.net/qq_36498949/article/details/122099821
版权

一 基本配置


1 简单使用

@Bean
public RestTemplate restTemplate() {
  return new RestTemplate();
}
@Autowired
private RestTemplate restTemplate;

2 处理中文乱码

@Bean
public RestTemplate getRestTemplate(){
    RestTemplate restTemplate = new RestTemplate();
    //解决中文乱码
    restTemplate.getMessageConverters().set(1, new StringHttpMessageConverter(StandardCharsets.UTF_8));
    return restTemplate;
}


3 发送https请求

@Bean
public RestTemplate restTemplate() throws KeyStoreException, NoSuchAlgorithmException, KeyManagementException {
 
     TrustStrategy acceptingTrustStrategy = (X509Certificate[] chain, String authType) -> true;
 
     SSLContext sslContext = org.apache.http.ssl.SSLContexts.custom()
                .loadTrustMaterial(null, acceptingTrustStrategy)
                .build();
 
     SSLConnectionSocketFactory csf = new SSLConnectionSocketFactory(sslContext);
 
     CloseableHttpClient httpClient = HttpClients.custom()
                .setSSLSocketFactory(csf)
                .build();
 
     HttpComponentsClientHttpRequestFactory requestFactory =
                new HttpComponentsClientHttpRequestFactory();
 
     requestFactory.setHttpClient(httpClient);
     RestTemplate restTemplate = new RestTemplate(requestFactory);
     return restTemplate;
}


如果 org.apache.http 包没有引入下面这个依赖

<dependency>
    <groupId>org.apache.httpcomponents</groupId>
    <artifactId>httpclient</artifactId>
    <version>4.5.5</version>
</dependency>


二 GET

1 getForObject

(1) 不带参数
服务端:

@GetMapping("/getData")
public Object getData() {
    return "收到数据";
}

客户端:

@GetMapping("/getData")
public Object getData() {
    String url = "http://localhost:8060/getData";
    return restTemplate.getForObject(url, String.class);
}


(2) 带参数-按顺序绑定( http://.../getData/{name}/{age})
服务端:

@GetMapping("/getData/{name}/{age}")
public Object getData(@PathVariable("name") String name,
                      @PathVariable("age") String age) {
    return "收到数据：name:"+name+", age:"+age;
}

客户端:

@GetMapping("/getData")
public Object getData() {
    String url = "http://localhost:8060/getData/{name}/{age}";
    return restTemplate.getForObject(url, String.class, "小东", "18");
}

或

@GetMapping("/getData")
public Object getData() {
    String url = "http://localhost:8060/getData/{name}/{age}";
    Map<String, Object> map = new HashMap<>();
    map.put("name", "小南");
    map.put("age", "18");
    return restTemplate.getForObject(url, String.class, map);
}

(3) 带参数 (http://.../getData?name=xxx&age=xxx)
服务端:

@GetMapping("/getData")
public Object getData(Student student) {
    return "收到数据：name:"+student.getName()+", age:"+student.getAge();
}
 
@Data
public class Student  {
    private String name;
    private String age;
}

或

@GetMapping("/getData")
public Object getData(String name, String age) {
    return "收到数据：name:"+name+", age:"+age;
}


客户端:

方式1: 使用UriComponentsBuilder

@GetMapping("/getData")
public Object getData() {
    String url = "http://localhost:8060/getData";
    UriComponentsBuilder builder = UriComponentsBuilder.fromHttpUrl(url);
    builder.queryParam("name", "小南");
    builder.queryParam("age", "18");
    // 使用 builder.build().toUriString() 防止中文乱码。
    //如果直接builder.toUriString()会中文乱码
    return restTemplate.getForObject(builder.build().toUriString(), String.class);
}

或

@GetMapping("/getData")
public Object getData() {
    String url = "http://localhost:8060/getData";
 
    MultiValueMap<String, String> params = new LinkedMultiValueMap<>();
    params.add("name", "小小");
    params.add("age", "18");
 
    UriComponentsBuilder builder = UriComponentsBuilder.fromHttpUrl(url);
    builder.queryParams(params);
    // 使用 builder.build().toUriString() 防止中文乱码。
    // 如果直接builder.toUriString()会中文乱码
    return restTemplate.getForObject(builder.build().toUriString(), String.class);
}


方式2: 直接拼接到URL

@GetMapping("/getData")
public Object getData() {
    String url = "http://localhost:8060/getData?name=小西&age=18";
    return restTemplate.getForObject(url, String.class);
}


方式3: 使用占位符

@GetMapping("/getData")
public Object getData() {
    String url = "http://localhost:8060/getData?name={name}&age={age}";
    Map<String, String> map = new HashMap<>();
    map.put("name", "小南");
    map.put("age", "18");
    return restTemplate.getForObject(url, String.class, map);
}

或

@GetMapping("/getData")
public Object getData() {
    String url = "http://localhost:8060/getData?name={name}&age={age}";
    return restTemplate.getForObject(url, String.class, "小红", "21");
}


2 getForEntity

调用和 getForObject类似， 但可以从getForEntiy获取更多的响应数据

客户端:

@GetMapping("/getData")
public Object getData() {
    String url = "http://localhost:8060/getData?name={name}&age={age}";
    ResponseEntity<String> entity = restTemplate.getForEntity(url, String.class, "小男", "18");
    HttpStatus statusCode = entity.getStatusCode();
    String body = entity.getBody();
    int statusCodeValue = entity.getStatusCodeValue();
    HttpHeaders headers = entity.getHeaders();
    return "statusCode:"+statusCode+", statusCodeValue:"+statusCodeValue+", body"+body+" , headers："+headers;
}


3 为URL设置编码

客户端:

@GetMapping("/getData")
public Object getData() throws UnsupportedEncodingException {
    String url = "http://localhost:8060/getData";
 
    MultiValueMap<String, String> params = new LinkedMultiValueMap<>();
    params.add("name", "小小");
    params.add("age", "18");
 
    UriComponentsBuilder builder = UriComponentsBuilder.fromHttpUrl(url);
    builder.queryParams(params);
 
    // builder.toUriString()会中文乱码
    // 可以使用 URLDecoder 对其进行编码
    String decode = URLDecoder.decode(builder.toUriString(), "utf-8");
 
    return restTemplate.getForObject(decode, String.class);
}

4 设置请求头

使用 exchange 方法发送get请求

服务端:

@GetMapping("/getData")
public Object getData(HttpServletRequest request, String name, String age) {
    String token = request.getHeader("token");
    return "收到数据：token: +"+token+" ,name:"+name+", age:"+age;
}


客户端:

@GetMapping("/getData")
public Object getData() throws UnsupportedEncodingException {
    String url = "http://localhost:8060/getData?name={name}&age={age}";
 
    HttpHeaders headers = new HttpHeaders();
    headers.add("token","123456");
 
    HttpEntity request = new HttpEntity<>(headers);
 
    return restTemplate.exchange(url, HttpMethod.GET, request, String.class, "小男", "18");
}


三 POST

1 postForObject

(1) application/x-www-form-urlencoded (无参)
服务端:

@PostMapping("/getData")
public Object getData() {
    return "收到数据";
}

客户端:

String url = "http://localhost:8060/getData";
restTemplate.postForObject(url, null, String.class);


(2) application/x-www-form-urlencoded (有参)
服务端:

@PostMapping("/getData")
public Object getData(Student student) {
    return  "收到数据：name:"+student.getName()+", age:"+student.getAge();
}

客户端:

String url = "http://localhost:8060/getData";
 
MultiValueMap<String, String> map = new LinkedMultiValueMap<>();
map.add("name", "小明");
map.add("age", "20");
 
restTemplate.postForObject(url, map, String.class);

(3) JSON
服务端:

@PostMapping("/getData")
public Object getData(@RequestBody Student student) {
    return  "收到数据：name:"+student.getName()+", age:"+student.getAge();
}

客户端:

String url = "http://localhost:8060/getData";
 
Student student = new Student();
student.setName("小明");
student.setAge(5);
 
restTemplate.postForObject(url, student, String.class);

或

String url = "http://localhost:8060/getData";
 
Map<String, Object> map = new HashMap<>();
map.put("name", "小红");
map.put("age", "18");
 
restTemplate.postForObject(url, map, String.class);

2 postForEntity

和 postForObject类似

3 带请求头

(1) application/x-www-form-urlencoded
服务端:

@PostMapping("/getData")
public Object getData(HttpServletRequest request, Student student) {
    String token = request.getHeader("token");
    return  "收到数据：token: "+token+", name:"+student.getName()+", age:"+student.getAge();
}

客户端:

String url = "http://localhost:8060/getData";
// 请求参数
MultiValueMap<String, String> map = new LinkedMultiValueMap<>();
map.add("name", "小明");
map.add("age", "20");
// 请求头
HttpHeaders headers = new HttpHeaders();
headers.add("token", "1234");
// 将请求头放到 HttpEntity中
HttpEntity httpEntity = new HttpEntity<>(map,headers);
// 发送请求
restTemplate.postForObject(url, httpEntity, String.class);

或

String url = "http://localhost:8060/getData";
// 请求参数
MultiValueMap<String, String> map = new LinkedMultiValueMap<>();
map.add("name", "小明");
map.add("age", "20");
// 组装url 和 请求参数
UriComponentsBuilder builder = UriComponentsBuilder.fromHttpUrl(url);
builder.queryParams(map);
// 请求头
HttpHeaders headers = new HttpHeaders();
headers.add("token", "1234");
// 将请求头放到 HttpEntity中
HttpEntity<HttpHeaders> httpEntity = new HttpEntity<>(headers);
// 发送请求
restTemplate.postForObject(builder.build().toUriString(), httpEntity, String.class);

(2) JSON
服务端:

@PostMapping("/getData")
public Object getData(HttpServletRequest request,@RequestBody Student student) {
    String token = request.getHeader("token");
    return  "收到数据：token: "+token+", name:"+student.getName()+", age:"+student.getAge();
}

客户端:

String url = "http://localhost:8060/getData";
// 请求参数
Student student = new Student();
student.setName("小欧");
student.setAge(5);
// 请求头
HttpHeaders headers = new HttpHeaders();
headers.add("token", "1234");
// 将请求头放到 HttpEntity中
HttpEntity httpEntity = new HttpEntity<>(student, headers);
// 发送请求
return restTemplate.postForObject(url, httpEntity, String.class);

或

String url = "http://localhost:8060/getData";
 
// 请求参数
Map<String, String> map = new HashMap<>();
map.put("name", "小明");
map.put("age", "20");
// 请求头
HttpHeaders headers = new HttpHeaders();
headers.add("token", "1234");
// 将请求头放到 HttpEntity中
HttpEntity httpEntity = new HttpEntity<>(map,headers);
// 发送请求
restTemplate.postForObject(url, httpEntity, String.class);

四 获取状态码非200的Body

       restTemplate调用时，当响应的状态码非200 （401，500等）均会以异常的形式抛出。 可通过 HttpClientErrorException 获取body。

服务端:

// 响应的状态码设置为400
@ResponseStatus(value = HttpStatus.BAD_REQUEST)
@GetMapping("/getData")
public Object getData() {
    return  "接口异常了";
}

客户端:

String url = "http://localhost:8060/getData";
// 转态码
int code = 0;
// body
String body = "";
try {
    ResponseEntity<String> result = restTemplate.getForEntity(url, String.class);
} catch (HttpClientErrorException e) {
    code = e.getStatusCode().value();
    body = e.getResponseBodyAsString();
}

谢月
关注
专栏目录
RestTemplate的请求方式
uciiiii的博客
06-12 526
SpringMVC提供 RestTemplate请求http接口，RestTemplate的底层可以使用第三方的http客户端工具实现http 的 请求，，常用的http客户端工具有Apache HttpClient、OkHttpClient等。 在SpringBoot启动类中配置 RestTemplate @Bean @LoadBalanced//开启负载均衡 public RestTempla...
RestTemplate请求工具
qq_33493956的博客
07-27 338
传统情况下在java代码里访问restful服务，一般使用Apache的HttpClient。不过此种方法使用起来太过繁琐。spring提供了一种简单便捷的模板类来进行操作，这就是RestTemplate。
http、restTemplate请求资源(含带头部信息)
05-24
Get请求、Post请求、带头部的GET请求、带头部的POST请求
Http请求-RestTemplate
weixin_40017062的博客
03-14 1748
是从 Spring3.0 开始支持的一个 HTTP 请求工具，它提供了常见的REST请求方案的模版，例如 GET 请求、POST 请求、PUT 请求、DELETE 请求以及一些通用的请求执行方法 exchange 以及 execute。GETHEADPOSTPOSTPOSTputPUTdeleteDELETEexchangeexecutecallback：提供常规的 Rest API（GET、POST、DELETE 等）方法调用；
【Spring】RestTemplate之自定义请求头
最新发布
九师兄
06-30 1644
本篇将主要集中在如何携带自定义的请求头，如设置User-Agent，携带Cookie。
RestTemplate发送请求
倾锋落颖花
12-16 2045
自定义拦截器示例//打印请求明细 logRequestDetails(request , body);//打印响应明细 logResponseDetails(response);} }使用构造类，添加自定义拦截器，构造带有自定义拦截器的实例return builder . additionalInterceptors(new CustomClientHttpRequestInterceptor()) //构建 . build();} }
Spring RestTemplate中几种常见的请求方式
liuyaokai1990的博客
02-06 246
目录(?)[+] https://github.com/lenve/SimpleSpringCloud/tree/master/RestTemplate在Spring Cloud中服务的发现与消费一文中，当我们从服务消费端去调用服务提供者的服务的时候，使用了一个很好用的对象，叫做RestTemplate，当时我们只使用了RestTemplate中最简单的一个功能getForEntit...
Spring Boot中RestTemplate的常用请求体类型
北辰
05-24 283
1.请求体类型为x-www-form-urlencoded import cn.hutool.http.HttpStatus; import org.junit.jupiter.api.Test; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.http
SpringBoot中使用RestTemplate封装请求头
g13954103148的博客
02-27 1640
RestTemplate的基本使用 关于RestTemplate的使用可以参考这篇文章 转载：https://blog.csdn.net/jinjiniao1/article/details/100849237 在RestTemplate中设置请求头和请求体 废话不多说，先上代码 String url = "**********************"; HttpHeaders headers ...
RestTemplate常用使用示例.rar
01-18
在Java开发中，`RestTemplate`是Spring框架提供的一种用于执行HTTP请求的工具，它使得与RESTful服务的交互变得更加简单。本示例主要聚焦于`RestTemplate`的基础使用和常见操作，帮助开发者理解如何利用它来实现...
RestTemplate中form请求方式
9981
06-09 6445
1.restTemplate是为我们提供了一种更简便进行远程调用的方式。 一般来说我们常用的提交参数方式有form和payload方式，下面简单记载一下。 form 方式 HttpHeaders headers = new HttpHeaders(); //设置为form方式 headers.setContentType(MediaType.APPLICATION_FORM_URLE...
使用 RestTemplate 进行网络接口请求
asxyxxx的博客
12-31 1243
RestTemplate是Spring框架提供的一个工具类，用于进行网络请求。通过RestTemplate，可以简化开发，提高开发效率，避免重复造轮子等。本文将介绍RestTemplate的常见用法，包括GET和POST请求、文件上传、以及常用配置。
restTemplate的使用
m0_72167535的博客
11-12 9485
restTemplate的使用
restTemplate
2301_79281358的博客
11-27 2574
使用Apache HttpClient 的重试处理器时，超时和抛出异常都有可能触发重试。当发生超时，HttpClient 通常会抛出 socketTimeoutException 或 connectTimeoutException 异常，这将触发重试。同时，HttpClient的 HttprequestRetryHander 接口允许你自定义在请求失败时进行重试的逻辑，这样你可以根据自己的需求判断是否要进行重试，不仅限于异常的抛出。
RestTemplate 的传参方式（Get、Put、Post）
热门推荐
Jsundoku的博客
02-24 1万+
文章目录一、RestTemplate 简介1、RestTemplate 概述2、RestTemplate 的配置项3、RestTemplate 请求方式二、RestTemplate 使用1、Get请求方式2、Post 请求方式3、Put 请求方式3、Delete 请求4、RestTemplate 其他方法 一、RestTemplate 简介 1、RestTemplate 概述 2、RestTemp...
RestTemplate 携带请求头
jieepre的博客
10-25 588
详解 RestTemplate 操作 import lombok.extern.slf4j.Slf4j; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.http.*; import org.springframework.stereotype.Component; ...
RestTemplate网络请求方法总结
niuniubeibeikzh的博客
09-10 307
RestTemplate是spring提供了一种简单便捷的模板类 POST请求 1.实例的创建 （1）RestTemplate() 创建默认设置的实例 （2）RestTemplate(ClientHttpRequestFactory requestFactory) （3）RestTemplate(List<HttpMessageConverter<?>> messageConverters) 2.使用 RestTemplate restTemplate = new RestTempl
RestTemplate调用第三方接口发送请求
zcpcom的博客
02-01 1008
我们在工作业务中有时候会经常去调用第三方接口发送请求，也有很多方法来发送http请求，但是大部分的返回结果都是只能是String字符串，不能自定义返回结果，而且RestTemplate的用法也比较简单
resttemplate get请求
03-16
其中，GET请求是最常用的一种请求方式，可以通过RestTemplate的getForObject()方法或getForEntity()方法发送GET请求，并获取响应结果。 getForObject()方法发送GET请求并返回响应结果的对象，可以直接将响应结果...
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值