RestTemplate常用请求

最新推荐文章于 2024-02-26 15:13:08 发布
最新推荐文章于 2024-02-26 15:13:08 发布
阅读量1.9k 收藏 6
点赞数
文章标签： java 后端 resttemplate
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_36498949/article/details/122099821
版权

目录

一 基本配置

1 简单使用

2 处理中文乱码

3 发送https请求

二 GET

1 getForObject

(1) 不带参数

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

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

2 getForEntity

3 为URL设置编码

4 设置请求头

三 POST

1 postForObject

(1) application/x-www-form-urlencoded (无参)

(2) application/x-www-form-urlencoded (有参)

(3) JSON

2 postForEntity

3 带请求头

(1) application/x-www-form-urlencoded

(2) JSON

四 获取状态码非200的Body

一 基本配置

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();
}

壹介叔生
关注
  • 0
    点赞
  • 踩
  • 6
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
http、restTemplate请求资源(含带头部信息)
05-24
Get请求、Post请求、带头部的GET请求、带头部的POST请求
RestTemplate常用使用示例.rar
01-18
RestTemplate简单常用使用示例
restemplate请求乱码一种解决
weixin_43887870的博客
11-09 1729
今天有一个通过Restemplate请求一个天气API，发现其Body数据是乱码。乱码的第一反应是编码格式出了问题。检查头部信息， content-encoding="gzip" content-type="application/json;charset=UTF-8" 返回值是UTF-8，Restemplate设置的也是UTF-8。在翻看其他博客，发现问题原因是http存在一个压缩格式：Gzip。 Gzip是一个压缩算法，当请求数据或返回数据体积过大，为减少网络负载压力而使用的压缩算法。通常在服务器端使
精讲RestTemplate自定义请求失败异常处理.docx
06-28
异常抛出之后，程序后面的代码就执行不到了，无法进行后面的代码执行。实际的业务开发中，有的时候我们更期望的结果是：不管你服务端是超时了还是服务不存在，我们都应该获得最终的请求结果（HTTP请求结果状态400、500），而不是获得一个抛出的异常。 二、源码解析-默认实现 首先我要说一个结论：RestTemplate请求结果异常是可以自定义处理的。在开始进行自定义的异常处理逻辑之前，我们有必要看一下异常处理的默认实现。也就是：为什么会产生上面小节提到的现象？ ResponseErrorHandler是RestTemplate请求结果的异常处理器接口 o接口的第一个方法hasError用于判断HttpResponse是否是异常响应（通过状态码） o接口的第二个方法handleError用于处理异常响应结果（非200状态码段） DefaultResponseErrorHandler是ResponseErrorHandler的默认实现
restTemplate系列-exchange
最新发布
qq_41982874的博客
02-26 237
restTemplate的get和post使用的比较多，那么更为通用的exchange怎么使用呢。代码如下（示例）：exchange// 1.3 get请求返回List<T>类型// 1.4 get请求返回Map类型// 1.5 get请求返回自定义泛型类型id=" + id;// header根据实际情况设置，没有就空着headers.add("AccessKey", "自定义的API访问key");// header根据实际情况设置，没有就空着。
Java RestTemplate中几种常见的请求方式
hudeyong926的专栏
03-11 1万+
在REST接口的设计中，利用RestTemplate进行接口测试是种常见的方法。本文主要从以下四个方面来看RestTemplate的使用： GET请求 POST请求 PUT请求 DELETE请求 OK，开始吧。 1. 用exchange方法提交 exchange既可以执行POST方法，还可以执行GET，设置header，所以应用最为广泛。 String url = "http://localhost/mirana-ee/app/login"; RestTemplate client = ne
简单记录下RestTemplate中exchange()方法的使用
weixin_45496485的博客
03-18 7239
简单记录下RestTemplate中exchange()方法的使用 1.Post请求 post请求需要用LinkedMultiValueMap来传递参数 String url = “https://xx.xx.com/app/order/getNumber”; MultiValueMap<String, Object> paramMap = new LinkedMultiValueMap<String, Object>(); paramMap.add(“name”, “name”);
restTemplate的exchange请求如何实现
無言的博客
03-13 9906
为什么要用RestTemplate？？ 相信大家之前都用过apache的HTTPClient类，逻辑繁琐，代码复杂，还要自己编写使用类HttpClientUtil，封装对应的post，get，delete等方法。 RestTemplate的行为可以通过callback回调方法和配置HttpMessageConverter 来定制，用来把对象封装到HTTP请求体，将响应信息放到一个对象中。Rest...
RestTemplate.exchange各种用法（包括泛型等 --全）
天罡gg的专栏
11-06 2万+
在我们日常开发中，无论是内部服务之间的调用，还是调用第三方服务，都免不了发起Http请求，在Java中发起Http请求常见的方式大致有原生HttpURLConnection、Apache的HttpClient、Spring的RestTemplate等，如果您基于Spring框架，那么强烈推荐使用RestTemplate，理由很简单：非常符合我们发起http请求的习惯，就像使用postman，只需要关心具体的url、header、body等即可，对于繁琐的细节RestTemplate都帮我们安排(封装)的明明
Http请求实战 ---- 【restTemplate.exchange方法】的简单了解应用
m0_46459413的博客
03-31 1万+
1、什么是RestTemplate RestTemple是Spring提供的用于访问Http请求的客户端； 相对于apache的HTTPClient类，逻辑繁琐，代码复杂，还要自己编写使用类HttpClientUtil，封装对应的post，get，delete等方法。 RestTemplate可以通过callback回调方法和配置HttpMessageConverter 来定制，用来把对象封装到HTTP请求体，将响应信息放到一个对象中。RestTemplate提供更高等级的符合HTTP的六种主要方法，可以很
RestTemplate使用实战-exchange方法讲解
热门推荐
zxh1991811的博客
10-28 8万+
RestTemplate是什么 RestTemple是Spring提供的用于访问Http请求的客户端，RestTemple提供了多种简洁的远程访问服务的方法，省去了很多无用的代码。 为什么要用RestTemplate 相信大家之前都用过apache的HTTPClient类，逻辑繁琐，代码复杂，还要自己编写使用类HttpClientUtil，封装对应的post，get，delete等方法。 Rest...
RestTemplate中exchange发起请求
百木成林
07-09 1818
在项目中，我们可能需要发起HTTP请求，请求目标URL来获取响应数据做一些处理。就需要用到HTTP请求工具，常用的Java类工具有：HttpUrlConnection、Apache HttpClient、OK Http等，这些可能需要一些繁琐的配置，不太适合Spring项目的开发。Spring RestTemplate 是 Spring 提供的用于访问 Rest 服务的工具。RestTemplate是Spring提供的进行远程调用客户端的工具。
RestTemplate发送application/x-www-form-urlencoded格式的post请求
weixin_49990593的博客
11-28 2993
RestTemplate发送application/x-www-form-urlencoded格式的post请求
RestTemplate请求失败自动重试机制.docx
06-26
在RestTemplate发送请求得到非200状态结果的时候，间隔一定的时间再次发送n次请求。n次请求都失败之后，最后抛出HttpClientErrorException。 在开始本节代码之前，将上一节的RestTemplate自定义异常处理的代码注释掉...
java中使用restTemplate发送http请求
11-10
java中使用restTemplate发送http请求，内涵post和get方法，单例模式，开箱即用
一文吃透接口调用神器RestTemplate
路人甲Java
10-31 3万+
文末可以领取所有系列高清 pdf。大家好，我是路人，这是 SpringMVC 系列第 21 篇。本文介绍 Spring web 中特别牛逼的一个类 RestTemplate。目录1、Res...
RestTemplate
水月青花
03-11 865
服务间调用RestTemplate 1. 利用RestTemplate实现负载均衡 在配置RestTemplate上加@LoadBalanced 注解 @Bean @LoadBalanced public RestTemplate getRestTemplate(){ return new RestTemplate(); } 不需要在去choose provider服务，之间用服务id就可以了。就会自动实现负载均衡。 @R...
RestTemplate异常信息（4xx和5xx）处理
qgnczmnmn的博客
10-18 859
在日常开发中经常会用到RestTemplate这一客户端进行访问其他的接口时，经常会遇到异常处理的问题，关于RestTemplate的异常处理，主要会用到一个接口org.springframework.web.client.ResponseErrorHandler，源码如下： public interface ResponseErrorHandler { // 判断是否有异常 boolean hasError(ClientHttpResponse response) throws IOExceptio
RestTemplate源码分析
tideseng的博客
05-04 487
相信RestTemplate是我们在SpringBoot中用过的最多的http客户端，今天来分析他的源码。 一、最简单的用法 首先需要向容器中注入RestTemplate的Bean实例 @Configurationpublic class RestTemplateConfig { @Bean public RestTemplate getRestTemplate() { retur...
resttemplate get请求
03-16
RestTemplate是Spring框架提供的一个用于发送HTTP请求的工具类，可以发送GET请求、POST请求、PUT请求、DELETE请求等。其中，GET请求是最常用的一种请求方式，可以通过RestTemplate的getForObject()方法或getForEntity()方法发送GET请求，并获取响应结果。 getForObject()方法发送GET请求并返回响应结果的对象，可以直接将响应结果转换为指定的Java对象类型。例如： ```java RestTemplate restTemplate = new RestTemplate(); String url = "http://example.com/api/user/{id}"; User user = restTemplate.getForObject(url, User.class, 123); ``` getForEntity()方法发送GET请求并返回响应结果的实体对象，可以获取响应状态码、响应头信息和响应结果。例如： ```java RestTemplate restTemplate = new RestTemplate(); String url = "http://example.com/api/user/{id}"; ResponseEntity<User> responseEntity = restTemplate.getForEntity(url, User.class, 123); HttpStatus statusCode = responseEntity.getStatusCode(); HttpHeaders headers = responseEntity.getHeaders(); User user = responseEntity.getBody(); ```

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值