RestTemplate入门

最新推荐文章于 2024-05-03 02:43:18 发布
最新推荐文章于 2024-05-03 02:43:18 发布
阅读量1.1k 收藏
点赞数
文章标签： java spring springboot
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_34285557/article/details/103574947
版权

RestTemplate入门

 本篇主要讲解RestTemplate的基本使用，它是Spring提供的用来访问Rest服务的客户端，RestTmplate提供了很多便捷的方法，可以大大提供开发效率，本篇只涉及基本使用，内部原理后续再展开

 1.RestTemplate简述

 RestTemplate是Spring提供的用于发送HTTP请求的客户端工具，它遵循Restful原则，RestTemplate默认依赖JDK的Http连接工具HttpUrlConnection,你也可以替换不同的源，比如OkHttp、Apache HttpComponents 等等。。

 2.HttpMessageConverter

 在说RestTemplate之前,先介绍HttpMessageConverter，RestTemplate默认使用的转化HttpMessageConverter去将Http消息转换成POJO 或者 POJO转化成Http消息。在创建RestTemplate的时候会默认添加一组HttpMessageConveter的实现。

 HttpMessageConverter源码：

    public interface HttpMessageConverter<T> {
        //指示此转换器是否可以读取给定的类。
        boolean canRead(Class<?> clazz, @Nullable MediaType mediaType);
        //指示此转换器是否可以写给定的类。
        boolean canWrite(Class<?> clazz, @Nullable MediaType mediaType);
        //返回List<MediaType>
        List<MediaType> 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中如何添加HttpMessageConverter的

 构造器源码：

    static {
        ClassLoader classLoader = RestTemplate.class.getClassLoader();
        romePresent = ClassUtils.isPresent("com.rometools.rome.feed.WireFeed", classLoader);
        jaxb2Present = ClassUtils.isPresent("javax.xml.bind.Binder", classLoader);
        jackson2Present =
                ClassUtils.isPresent("com.fasterxml.jackson.databind.ObjectMapper", classLoader) &&
                        ClassUtils.isPresent("com.fasterxml.jackson.core.JsonGenerator", classLoader);
        jackson2XmlPresent = ClassUtils.isPresent("com.fasterxml.jackson.dataformat.xml.XmlMapper", classLoader);
        jackson2SmilePresent = ClassUtils.isPresent("com.fasterxml.jackson.dataformat.smile.SmileFactory", classLoader);
        jackson2CborPresent = ClassUtils.isPresent("com.fasterxml.jackson.dataformat.cbor.CBORFactory", classLoader);
        gsonPresent = ClassUtils.isPresent("com.google.gson.Gson", classLoader);
        jsonbPresent = ClassUtils.isPresent("javax.json.bind.Jsonb", classLoader);
    }

    public RestTemplate() {
        this.messageConverters.add(new ByteArrayHttpMessageConverter());
        this.messageConverters.add(new StringHttpMessageConverter());
        this.messageConverters.add(new ResourceHttpMessageConverter(false));
        try {
            this.messageConverters.add(new SourceHttpMessageConverter<>());
        }
        catch (Error err) {
            // Ignore when no TransformerFactory implementation is available
        }
        this.messageConverters.add(new AllEncompassingFormHttpMessageConverter());
        if (romePresent) {
            this.messageConverters.add(new AtomFeedHttpMessageConverter());
            this.messageConverters.add(new RssChannelHttpMessageConverter());
        }
        if (jackson2XmlPresent) {
            this.messageConverters.add(new MappingJackson2XmlHttpMessageConverter());
        }
        else if (jaxb2Present) {
            this.messageConverters.add(new Jaxb2RootElementHttpMessageConverter());
        }
        if (jackson2Present) {
            this.messageConverters.add(new MappingJackson2HttpMessageConverter());
        }
        else if (gsonPresent) {
            this.messageConverters.add(new GsonHttpMessageConverter());
        }
        else if (jsonbPresent) {
            this.messageConverters.add(new JsonbHttpMessageConverter());
        }
        if (jackson2SmilePresent) {
            this.messageConverters.add(new MappingJackson2SmileHttpMessageConverter());
        }
        if (jackson2CborPresent) {
            this.messageConverters.add(new MappingJackson2CborHttpMessageConverter());
        }
        this.uriTemplateHandler = initUriTemplateHandler();
    }

 从RestTemplate的构造器源码中我们可以看到构造方法中 根据ClassUtils.isPresent判断当前项目是否存在某些jar包向RestTemplate中添加不同的 HttpMessageConverter实现，Spring默认会添加 StringHttpMessageConverter ， MappingJackson2XmlHttpMessageConverter等等

Xnip20191210_231205.png

 3.getForObject()

 首先来看Get请求 RestTemplate提供了2种方法其中一种就是 getForObject()方法

    public <T> T getForObject(String url, Class<T> responseType, Object... uriVariables){}
    public <T> T getForObject(String url, Class<T> responseType, Map<String, ?> uriVariables)
    public <T> T getForObject(URI url, Class<T> responseType)
  3.1 不带参数的Get请求

    客户端
     String url = "http://localhost:9999/testGetMethod";
     String str = restTemplate.getForObject(url , String.class);、
    服务端
    @RequestMapping("/testGetMethod")
    public String testGetMethod(){
        return "hello";
    }
  3.2 带参数的Get请求 （按{}顺序绑定参数）

    客户端
     String url = "http://localhost:9999/testGetMethod/{talk}/{name}"; 
        //或者testGetMethod/{1}/{2} {里面的参数无所谓，只是根据下面的Object... uriVariables 逐一绑定到上面{} 中去的}
     String str = restTemplate.getForObject(url , String.class,"hello" , "johnny");
    服务端
      @RequestMapping("/testGetMethod/{talk}/{name}")
    public String testGetMethod(@PathVariable("talk") String talk ,
                                @PathVariable("name") String name){
        log.info("【{} : {}】" , talk , name);
        return "hello";
    }

 说明{} http://localhost:9999/testGetMethod/{talk}/{name} 里面的参数名称无所谓，只是根据下面的Object... uriVariables 逐一绑上去的，具体绑定源码请看 DefaultUriBuilderFactory的fromUriString方法内部是根据正则表达式进行绑定的，最终将返回 URI，URI的string属性 就是绑定后要访问的路径Xnip20191210_234530.png

//不早了 先写这么多吧 明天把下面的补齐 ，先去睡觉了！！！//继续补齐。。

  3.3 带参数的Get请求（按Map的key绑定{}参数）

     String url = "http://localhost:9999/testGetMethod/{talk}/{name}";
     Map<String,String> map = new HashMap<>(); 
     map.put("talk" , "hello"); 
     map.put("name" , "johnny"); 
     String str = restTemplate.getForObject(url , String.class,map);

  可以看出来是通过Map绑定参数的，这个和上面不一样的是 map的key 一定要和 url中 {} 中的 保持一致 ，如果不一致会报错

     String url = "http://localhost:9999/testGetMethod/{talk}/{name}"; 
     map.put("talk2" , "hello");

Xnip20191210_234530.png

源码

Xnip20191212_135605.png

 4.getForEntity()

 RestTemplate 提供的Get请求的第二种方法 ，基本和getForObject一致 ，就是返回类型不同，它是在getForObject返回的基础上再包装了一层 ResponseEntity 用于包含Http请求的全部信息

    public <T> ResponseEntity<T> getForEntity(String url, Class<T> responseType, Object... uriVariables){}
    public <T> ResponseEntity<T> getForEntity(String url, Class<T> responseType, Map<String, ?> uriVariables){}
    public <T> ResponseEntity<T> getForEntity(URI url, Class<T> responseType){}
  4.1 不带参数的Get请求

        String url = "http://localhost:9999/testGetMethodForEntity/";
        ResponseEntity<Student> responseEntity = restTemplate.getForEntity(url , Student.class);
        responseEntity.getStatusCode();
        responseEntity.getHeaders();
        responseEntity.getBody();
        log.info("【responseEntity : {}】" , responseEntity);

Xnip20191212_214059.png

  4.2 带参数的Get请求 （按{}顺序绑定参数）

    
        String url = "http://localhost:9999/testGetMethodForEntity/{name}/{age}";
        ResponseEntity<Student> responseEntity = restTemplate.getForEntity(url , Student.class , "johnny" , "23");
        log.info("【responseEntity : {}】" , responseEntity);
  4.3 带参数的Get请求 （按Ma的keyp绑定{}参数）

    
        String url = "http://localhost:9999/testGetMethodForEntity/{name}/{age}";
           Map<String,String> map = new HashMap<>();
        map.put("name","johnny");
        map.put("age" , "23");
        ResponseEntity<Student> responseEntity = restTemplate.getForEntity(url , Student.class ,"map");
        log.info("【responseEntity : {}】" , responseEntity);

**但是,通常情况下我们并不想要Http请求的全部信息,只需要相应体即可.对于这种情况,RestTemplate提供了 getForObject() 方法用来只获取 响应体信息.getForObject 和 getForEntity 用法几乎相同,指示返回值返回的是 响应体,省去了我们 再去 getBody() .**

 5.postForObject()

    public <T> T postForObject(String url, @Nullable Object request, Class<T> responseType, Object... uriVariables)
            throws RestClientException {}
    public <T> T postForObject(String url, @Nullable Object request, Class<T> responseType, Map<String, ?> uriVariables)
            throws RestClientException {}
    public <T> T postForObject(URI url, @Nullable Object request, Class<T> responseType) throws RestClientException {}
  5.1 post请求 提交参数 Student 对象

    客户端代码：
          String url = "http://localhost:9999/testPostMethodForObject";
        Student student = new Student();
        student.setName("johnny");
        student.setAge("23");
        String msg = restTemplate.postForObject(url , student , String.class);
    服务端代码：
         @RequestMapping("/testPostMethodForObject")
        public String testGetMethodForEntity(@RequestBody Student student){
         log.info("【studeng: {}】"  , student);
         return "success";
       }

 6.postForEntity()

    public <T> T postForObject(String url, @Nullable Object request, Class<T> responseType, Object... uriVariables)
            throws RestClientException {}
    public <T> T postForObject(String url, @Nullable Object request, Class<T> responseType, Map<String, ?> uriVariables)
            throws RestClientException {}
    public <T> T postForObject(URI url, @Nullable Object request, Class<T> responseType) throws RestClientException {}
  6.1 post请求 提交参数 Student 对象

    @RequestMapping("/testPostMethodForEntity")
    public void testPostMethodForEntity(){
        String url = "http://localhost:9999/testPostMethodForEntity";
        Student student = new Student();
        student.setName("johnny");
        student.setAge("23");
        ResponseEntity<String> responseEntity = restTemplate.postForEntity(url , student , String.class);
        log.info(responseEntity.getBody());
    }

 7. ResponseExtractor 源码

 可以看出来postForEntity和postForObject 几乎一样。

 唯有 ResponseExtractor 不同

Xnip20191212_220311.png

Xnip20191212_221136.png

 HttpMessageConverterExtractor.extractData()方法

Xnip20191212_220906.png

 ResponseEntityResponseExtractor.extractData()方法

Xnip20191212_220722.png

 总结：

  本篇主要讲解RestTemplate的基本的 Get Post 的用法，简单的涉及了一点源码，其实内部源码很多 很深 包括和解析url模板 绑定参数的 UriBuilderFactory UriTemplateHandler 等等 , 建议去跟着跑一遍会更加熟悉 用起来也更加轻松。

个人博客网站 https://www.askajohnny.com 欢迎来访问！

本文由博客一文多发平台 OpenWrite 发布！

Aska小强
关注
SpringBoot入门教程：RestTemplate
人不风流枉少年
11-09 1004
一：简介 通常在Java代码中调用其它http 接口的话会使用HttpClient，不过这个使用起来有些繁琐，Spring中推出了一个简单的RestTemplate用来调用rest api，使用起来非常简单。 二：基础示例 @RestController @RequestMapping("/user") public class UserController { @PostMapping("/regist") public User regist(@RequestBody CreateUs
4-1 SpringCloud快速开发入门:RestTemplate类详细解读
lixuanhong的博客
03-13 416
RestTemplate类详细解读
RestTemplate的Get请求
热门推荐
实践求真知
07-19 3万+
一 getForEntity系列函数 函数原型： 1 getForEntity(String url,Class responseType,Object ... urlVariables) 2 getForEntity(String url,Class responseType,Map urlVariables) 3 getForEntity(URI url,Class responseT...
resttemplate入门
m0_54042402的博客
06-16 139
restTemplate 1.编写测试接口 /** * 测试get请求,参数为name * @param name * @return */ @GetMapping("/getTest") public String getTest(String name){ System.out.println(name); return "测试get请求成功"; } /** * 测试post请求，参数为
resttemplate get请求_简单粗暴的RestTemplate
weixin_39953740的博客
11-26 538
前言通常访问http接口，我们有时候会使用httpclient，但是其代码复杂，还得费心进行各种资源回收的编写，不建议直接使用。而RestTemplate是Spring提供的用于访问Rest服务的客户端，对get，post等请求以及反序列化支持都封装的比较好，使用起来简单粗暴优雅。但是笔者在使用时候碰到一些问题：1、乱码。2、不同的请求需要设置不同的超时时间。故整理出来与大家分享如何循序...
精讲RestTemplate第3篇-GET请求使用方法详解
字母哥博客
08-05 1万+
本文是精讲RestTemplate第3篇，前篇的blog访问地址如下： 精讲RestTemplate第1篇-在Spring或非Spring环境下如何使用 精讲RestTemplate第2篇-多种底层HTTP客户端类库的切换 RestTemplate可以发送HTTP GET请求，经常使用到的方法有两个： getForObject() getForEntity() 二者的主要区别在于，getForObject()返回值是HTTP协议的响应体。getForEntity()返回的是ResponseEntit
Spring的RestTemplate(RPC和HTTP)
少营营的博客
07-16 4812
服务调用方式 1 . 目标 理解RPC和HTTP的区别 能使用RestTemplate发送请求 2. 讲解 1 . RPC和HTTP 常见远程调用方式： RPC:(Remote Produce Call)远程过程调用 1.基于Socket 2.自定义数据格式 3.速度快，效率高 4.典型应用代表：Dubbo，WebService，ElasticSearch集群间互相调用 ...
Spring中使用RestTemplate发送Http请求
最新发布
2401_83915450的博客
05-03 686
无论是哪家公司，都很重视高并发高可用的技术，重视基础，重视JVM。面试是一个双向选择的过程，不要抱着畏惧的心态去面试，不利于自己的发挥。同时看中的应该不止薪资，还要看你是不是真的喜欢这家公司，是不是能真的得到锻炼。其实我写了这么多，只是我自己的总结，并不一定适用于所有人，相信经过一些面试，大家都会有这些感触。最后我整理了一些面试真题资料，技术知识点剖析教程，还有和广大同仁一起交流学习共同进步，还有一些职业经验的分享。《一线大厂Java面试题解析+核心总结学习笔记+最新讲解视频+实战项目源码》点击传送门。
resttemplate get请求_RestTemplate使用
weixin_39530960的博客
12-08 917
点击程序员IT课堂关注我们RestTemplateRest发送请求时携带CookieList cookieList = new ArrayList<>(4);HttpHeaders requestHeaders = new HttpHeaders();String token = "aaaaa";String cookieUrl = "https://mydomain.c...
resttemplate get请求_RestTemplate 使用
weixin_39901558的博客
12-08 1318
RestTemplate Rest 模板概述带负载均衡(@LoadBalanced)的 RestTemplate 必须使用微服务名称发起请求，不能使用 ip:port不带负载均衡(@LoadBalanced)的 RestTemplate 不能使用微服务名称发起请求，只能使用 ip:port1、org.springframework.web.client.RestTemplate 类是 spring...
RestTemplate快速入门
qq_34763130的博客
03-18 532
记录一次源码研究 // 案例 @Controller @RequestMapping("api") public class Api { @Autowired private RestTemplate restTemplate; @GetMapping("login") public Object login(@RequestParam("username")S...
RestTemplate优雅的发送Get请求
小英雄
05-31 2万+
在我们的项目中，如果借助RestTemplate发送Get请求，我们可以通过拼接字符串的方式将url拼接出来，比如下面这种方式： String url = "http://127.0.0.1/get?id=" + id + "&name=" + name;
resttemplate get请求_RestTemplate 最详解
weixin_39827306的博客
11-26 3857
在项目中，当我们需要远程调用一个 HTTP 接口时，我们经常会用到 RestTemplate 这个类。这个类是 Spring 框架提供的一个工具类。Spring 官网对它的介绍如下：RestTemplate: The original Spring REST client with a synchronous, template method API.从上面的介绍中我们可以知道：RestTempl...
RestTempalate 基本使用
蒜蓉粉丝蒸扇贝的专栏
06-21 2301
0. 目标 在介绍如何使用RestTemplate之前，我们先抛出一些小目标，至少需要知道通过RestTemplate可以做些什么，以及我们要用它来干些什么 简单的给出了一下常见的问题如下 普通的Get请求获取返回数据，怎么玩？ post提交表达的请求，如何处理 post请求中RequestBody的请求方式与普通的请求方式区别 https/http两种访问如何分别处理 如何在请求中...
spring boot单元测试之RestTemplate(三)——api详解
weixin_30410999的博客
06-20 418
本篇内容来自翟永超的《Springcloud微服务实战》，转载请注明。 一、GET请求 在RestTemplate中，对GET请求可以通过如下两个方法进行调用实现。 第一种：getForEntity函数。 该方法返回的是ResponseEntity,该对象是Spring对HTTP请求响应的封装，其中主要存储了HTTP的几个重要元素，比如HTTP请求状态码的枚举对象HttpStatus(也就...
RestTemplate 入门
oyc的博客
01-16 2653
 REST基础       当谈论REST时，有一种常见的错误就是将其视为“基于URL的Web服务”——将REST作为另一 种类型的远程过程调用（remote procedure call，RPC）机制，就像SOAP一样，只不过是通过简单 的HTTP URL来触发，而不是使用SOAP大量的XML命名空间         恰好相反，REST与RPC几乎没有任何关系。RPC是面向服务的，并关注于行...
Spring RestTemplate 之get请求
weixin_30654419的博客
03-13 471
一，简介：Spring RestTemplate 是 Spring 提供的用于访问 Rest 服务的客户端，RestTemplate 提供了多种便捷访问远程Http服务的方法，能够大大提高客户端的编写效率 二、RestTemplate中几种常见请求方法的使用 ●get请求：在RestTemplate中，发送一个GET请求，我们可以通过如下两种方式 第一种：getFo...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值