Springboot之HTTP的RestTemplate详解

RestTemplate是spring提供的用于访问Rest服务的客户端,RestTemplate提供了多种便捷访问远程Http服务的方法，能够大大提高客户端的编写效率。

之前的Http开发的使用apache的HttpClient开发，代码复杂，还得操心资源回收等。代码很复杂，冗余代码多，稍微截张图，这是我封装好的一个post请求工具

本文将带领大家实现Spring生态内RestTemplate的Get请求和Post请求还有exchange指定请求类型的实践和RestTemplate核心方法源码的分析，看完就会用更优雅的方式来发HTTP请求。

简述RestTemplate

它是spring用于同步client端的核心类，简化了与http服务的通信，并满足RestFul原则，程度代码可以给他提供URL，并提供结果。默认情况下，RestTemplate默认依赖jdk的http链接工具。当然也可以额通过setRequestFactory属性切换到不同的http源，比如ApacheHttpComponents、Netty和OkHttp。

RestTemplate更大幅度简化了提交表单数据的难度，并且附带了自动转换JSON数据的功能，但只有理解了HttpEntity的组成结构(header 与body),且理解了与uriVaribales之间的差异，才能真正掌握其用法。这一点在post请求更加突出，下面会介绍到。

该类的入口主要是根据http的6个方法制定：

HTTP method RestTemplate methods

DELETE delete

GET getForObject

getForEntity

HEAD headForHeaders

OPTIONS optionsForAllow

POST postForLocation

postForObject

PUT put

any exchange

execute

此外，exchange和excute可以通用上述方法。

在内部，RestTemplate默认使用HttpMessageConverte实例将HTTP消息转换成POJO转换成HTTP消息。默认情况下会注册主mime类型的的转换器，但也可以通过setMessageConverters注册其他的转换器。

其实这点在使用的时候是察觉不到的，很多方法有一个responseType参数，它让你传入一个响应体映射成对象，然后底层使用HttpMessageConverter将其做映射

HttpMessageConverterExtractor responseExtractor =
new HttpMessageConverterExtractor<>(responseType, getMessageConverters(), logger);

HttpMessageConverter.java 源码

public interface HttpMessageConverter {
        //指示此转换器是否可以读取给定的类。
    boolean canRead(Class<?> clazz, @Nullable MediaType mediaType);
 
        //指示此转换器是否可以写给定的类。
    boolean canWrite(Class<?> clazz, @Nullable MediaType mediaType);
 
        //返回List
    List getSupportedMediaTypes();
 
        //读取一个inputMessage
    T read(Class<? extends T> clazz, HttpInputMessage inputMessage)
            throws IOException, HttpMessageNotReadableException;
 
        //往output message写一个Object
    void write(T t, @Nullable MediaType contentType, HttpOutputMessage outputMessage)
            throws IOException, HttpMessageNotWritableException;
 
}

在内部，RestTemplate默认使用SimpleCLientHttpRequestFactory 和 DefaultResponseErrorHandler 来分别处理Http的创建和错误，但也可以通过setRequestFackory和setErrorHandler来覆盖。

2 get请求实践

2.1 getForObject()方法

public  T getForObject(String url, Class responseType, Object... uriVariables){}
public  T getForObject(String url, Class responseType, Map uriVariables)
public  T getForObject(URI url, Class responseType)

getForObject()其实比getForEntity()多包含了将http转成pojo的功能，但是getForObject没有处理response的能力。因为她拿到手的是成型的pojo，省了很多response的信息。

2.1.1 POJO

public class Notice {
    private int status;
    private Object msg;
    private List data;
}
public  class DataBean {
  private int noticeId;
  private String noticeTitle;
  private Object noticeImg;
  private long noticeCreateTime;
  private long noticeUpdateTime;
  private String noticeContent;
}

不带参的get请求


/**
     * 不带参的get请求
     */
    @Test
    public void restTemplateGetTest(){
        RestTemplate restTemplate = new RestTemplate();
        Notice notice = restTemplate.getForObject("http://xxx.top/notice/list/1/5"
                , Notice.class);
        System.out.println(notice);
    }

控制台打印

   INFO 19076 --- [           main] c.w.s.c.w.c.HelloControllerTest         
: Started HelloControllerTest in 5.532 seconds (JVM running for 7.233)
 
Notice{status=200, msg=null, data=[DataBean{noticeId=21, noticeTitle='aaa', noticeImg=null,
noticeCreateTime=1525292723000, noticeUpdateTime=1525292723000, noticeContent='aaa'},
DataBean{noticeId=20, noticeTitle='ahaha', noticeImg=null, noticeCreateTime=1525291492000,
noticeUpdateTime=1525291492000, noticeContent='ah.......'

2.1.3 带参数的get请求

Notice notice = restTemplate.getForObject("http://fantj.top/notice/list/{1}/{2}"
                , Notice.class,1,5);

使用了占位符{1}

2.1.4 带参数的get请求

Map map = new HashMap();
        map.put("start","1");
        map.put("page","5");
        Notice notice = restTemplate.getForObject("http://fantj.top/notice/list/"
                , Notice.class,map);

此就是利用map参数装载参数，不过它默认解析的是PathVariable的url形式。

2.2 getForEntity()方法

public  ResponseEntity getForEntity(String url, Class responseType, Object... uriVariables){}
public  ResponseEntity getForEntity(String url, Class responseType, Map uriVariables){}
public  ResponseEntity getForEntity(URI url, Class responseType){}

与getForObject()方法不同的是返回的是ResponseEntity对象，如果需要转成pojo，还需要json工具类的引入，这个按个人喜好。

下边讲一下，ResponseEntity, HttpStatus, BodyBuilder结构

ResponseEntity.java

public HttpStatus getStatusCode(){}
public int getStatusCodeValue(){}
public boolean equals(@Nullable Object other) {}
public String toString() {}
public static BodyBuilder status(HttpStatus status) {}
public static BodyBuilder ok() {}
public static  ResponseEntity ok(T body) {}
public static BodyBuilder created(URI location) {}
...

HttpStatus.java

public enum HttpStatus {
public boolean is1xxInformational() {}
public boolean is2xxSuccessful() {}
public boolean is3xxRedirection() {}
public boolean is4xxClientError() {}
public boolean is5xxServerError() {}
public boolean isError() {}
}

BodyBuilder.java

public interface BodyBuilder extends HeadersBuilder {
    //设置正文的长度，以字节为单位，由Content-Length标头
      BodyBuilder contentLength(long contentLength);
    //设置body的MediaType 类型
      BodyBuilder contentType(MediaType contentType);
    //设置响应实体的主体并返回它。
       ResponseEntity body(@Nullable T body);
｝

可以看出来，ResponseEntity包含了HttpStatus和BodyBuilder的这些信息，这个方便我们处理response原生的东西。

实例：

@Test
public void rtGetEntity(){
        RestTemplate restTemplate = new RestTemplate();
        ResponseEntity entity = restTemplate.getForEntity("http://fantj.top/notice/list/1/5"
                , Notice.class);
 
        HttpStatus statusCode = entity.getStatusCode();
        System.out.println("statusCode.is2xxSuccessful()"+statusCode.is2xxSuccessful());
 
        Notice body = entity.getBody();
        System.out.println("entity.getBody()"+body);
 
 
        ResponseEntity.BodyBuilder status = ResponseEntity.status(statusCode);
        status.contentLength(100);
        status.body("我在这里添加一句话");
        ResponseEntity> body1 = status.body(Notice.class);
        Class body2 = body1.getBody();
        System.out.println("body1.toString()"+body1.toString());
    }
  
 
statusCode.is2xxSuccessful()true
entity.getBody()Notice{status=200, msg=null, data=[DataBean{noticeId=21, noticeTitle='aaa', ...
body1.toString()<200 OK,class com.waylau.spring.cloud.weather.pojo.Notice,{Content-Length=[100]}>

3 post请求

同样的，post请求也有postForObject 和 postForEntity

public  T postForObject(String url, @Nullable Object request, Class responseType, Object... uriVariables)
            throws RestClientException {}
public  T postForObject(String url, @Nullable Object request, Class responseType, Map uriVariables)
            throws RestClientException {}
public  T postForObject(URI url, @Nullable Object request, Class responseType) throws RestClientException {}

示例

@Test
public void rtPostObject(){
    RestTemplate restTemplate = new RestTemplate();
    String url = "http://123123123/register/checkEmail";
    HttpHeaders headers = new HttpHeaders();
    headers.setContentType(MediaType.APPLICATION_FORM_URLENCODED);
    MultiValueMap map= new LinkedMultiValueMap<>();
    map.add("email", "12312312@qq.com");
 
    HttpEntity> request = new HttpEntity<>(map, headers);
    ResponseEntity response = restTemplate.postForEntity( url, request , String.class );
    System.out.println(response.getBody());
}

执行结果：

代码中，MultiValueMap是Map的一个子类，它的一个key可存储多个value，简单地看下接口

public interface MultiValueMap extends Map> {...}

为什么用MultiValueMap? 因为HttpEntity接受的request类型是它。

public HttpEntity(@Nullable T body, @Nullable MultiValueMap headers){}
//我这里只展示它的一个construct,从它可以看到我们传入的map是请求体，headers是请求头。

为什么httpEntity是因为RestTemplate.postForEntity方法虽然表面上接收的request是@Nullable Object request类型，但是你追踪西区会发现，这个request是用HttpEntity来解析。核心代码如下：

if (requestBody instanceof HttpEntity) {
    this.requestEntity = (HttpEntity<?>) requestBody;
}else if (requestBody != null) {
    this.requestEntity = new HttpEntity<>(requestBody);
}else {
    this.requestEntity = HttpEntity.EMPTY;
}

4 使用exchange指定调用方式

exchange() 方法跟上边说的方法不同之后，在于指定了http类型。

@Test
    public void rtExchangeTest() throws JSONException {
        RestTemplate restTemplate = new RestTemplate();
        String url = "http://xxx.top/notice/list";
        HttpHeaders headers = new HttpHeaders();
        headers.setContentType(MediaType.APPLICATION_FORM_URLENCODED);
        JSONObject jsonObj = new JSONObject();
        jsonObj.put("start",1);
        jsonObj.put("page",5);
 
        HttpEntity entity = new HttpEntity<>(jsonObj.toString(), headers);
        ResponseEntity exchange = restTemplate.exchange(url,
                                          HttpMethod.GET, entity, JSONObject.class);
        System.out.println(exchange.getBody());
    }

这次可以看到，我使用了jsonobject对象传入和返回。

5 excute()指定调用方式

excute（）的用法和exchange()大同小异了，它同样可以指定不同的HttpMethod,不同的是它返回的对象是响应体所映射成的对象，而不是ResponseEntity.

需要强调的是，execute()方式是以上所有方法的底层调用，随便看一个。

@Override
    @Nullable
    public  T postForObject(String url, @Nullable Object request, Class responseType, Map uriVariables)
            throws RestClientException {
 
        RequestCallback requestCallback = httpEntityCallback(request, responseType);
        HttpMessageConverterExtractor responseExtractor =
                new HttpMessageConverterExtractor<>(responseType, getMessageConverters(), logger);
        return execute(url, HttpMethod.POST, requestCallback, responseExtractor, uriVariables);
    }

欢迎拍砖

展开阅读全文

页面更新：2024-03-10

标签：转换器底层详解指示源码客户端实例对象核心参数消息类型代码方式工具方法科技

1 2 3 4 5

Springboot之HTTP的RestTemplate详解

2 get请求实践

最长耳朵的狗，青少年中最大的脚··· 2022年版吉尼斯世界纪录发布

Java Jvm中jstack日志的深入理解

谁会出现在你的回忆里？她们是好莱坞历史上最美丽的女星（一）

Mysql EXISTS的用法

Mybatis批量更新多条数据

让你老得更快的5个日常习惯

谁会出现在你的记忆里？她们是好莱坞史上最美女星（二）

华为智能家居“化零为整”全面升级坐实行业引领地位

荣获行业高峰论坛三大奖项，解码康佳白电高质量发展密钥

清洁电器新消费趋势：更智能更便捷

易来总裁刘达平：生产灯具没有门槛智慧照明的核心在软件系统

大白电用户的消费核心：品牌与品质并重

长三角国货家电论坛在宁举办新国货生态培优计划正式启动

营收目标剑指100亿国际巨头汤姆逊终于进军中国内地市场

#风口下的卧室#破圈奥克斯的流量密码从何而来？

易来总裁刘达平：生产灯具没有门槛智慧照明的核心在软

大白电用户的消费核心：品牌与品质并重

“高级营养师”实测COLMO TURING套系· 营养空间站冰

在第26届科技月上方洪波说出了美的未来成长的唯一路

java如何对map进行排序详解(map集合的使用)

git生成公私钥，并放到github中，免用户名、密码下载代码

java对象的结构是什么样的？

Mybatis-Plus条件构造器select方法返回指定字段

插播一条好消息：苹果要把iPhone X的“刘海”剪短点

驱动行业高端化跃迁，科沃斯如何用科技创新开启行业3.0