restTemplate源码解析（一）构造restTemplate的Bean实例

所有文章

https://www.cnblogs.com/lay2017/p/11740855.html

 

正文

构造一个restTemplate的Bean实例很容易，只需这样配置

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

但我们希望更多得了解一个这个构造过程做了哪些事情。为此，我们需要去打开restTemplate这个黑盒子。

 

restTemplate设计

先试着从restTemplate得类图上获得一些灵感，看看spring的作者是一个什么样的设计思路吧。

我们看到，简单的几个类和接口展示了标准的抽象设计。

HttpAccessor是一个抽象类，它抽象的是一个http访问器的概念。这说明，RestTemplate具备http方式请求响应的处理能力。再看RestOperations，它是一个接口，抽象的是restful风格的操作方法，这意味着RestTemplate的操作风格将是Restful的。

http访问器和restful风格操作做了一个分离。restTemplate则是聚合了两者，既有http访问器的基础能力，又在这个基础之上构建了restful风格。设计者把Restful操作作为接口，其实从规范角度上，我们应该面向RestOperations接口使用它。但大多数人似乎都直接使用RestTemplate，我们上面的代码示例也无意识地直接面向了RestTemplate这个实现类。

 

restTemplate实例构造过程

接下来，我们再看看new一个RestTemplate对象做了哪些事情。

进入RestTemplate类的构造方法

private final List<HttpMessageConverter<?>> messageConverters = new ArrayList<>();

private UriTemplateHandler uriTemplateHandler;

public RestTemplate() {
    // 添加HttpMessageConverterjie
    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());
    }
    // uri模板处理器
    this.uriTemplateHandler = initUriTemplateHandler();
}

构造方法有点长，但只做了两件事

1）添加HttpMessageConverter的实现类，熟悉springmvc的话估计知道HttpMessageConverter。顾名思义，它就是用来转换http请求响应过程中的消息数据的。

2）初始化一个UriTemplateHandler

 

我们跟进initUriTemplateHandler方法，看看怎么初始化一个uri模板处理器的

private static DefaultUriBuilderFactory initUriTemplateHandler() {
    DefaultUriBuilderFactory uriFactory = new DefaultUriBuilderFactory();
    uriFactory.setEncodingMode(EncodingMode.URI_COMPONENT);  // for backwards compatibility..
    return uriFactory;
}

这里只是简单地构造了实例，并直接返回。由此可见，DefaultUriBuilderFactory应该直接或者间接实现了UriTemplateHandler

我们看看DefaultUriBuilderFactory的类图

与我们猜想的一样，DefaultUriBuilderFactory间接实现了UriTemplateHandler

 

RestTemplate的构造方法中就做了这两件事，我们再看看HttpAccessor

public abstract class HttpAccessor {
    // ...

    private ClientHttpRequestFactory requestFactory = new SimpleClientHttpRequestFactory();

    // ...
}

默认创建了一个ClientHttpRequestFactory的实例，ClientHttpRequestFactory这个接口是用来创建客户端的request请求对象的，我们并没有去自定义设置它默认采用SimpleClientHttpRequestFactory这个实现类。

ClientHttpRequestFactory作为工厂模式，将会生产ClientHttpRequest。ClientHttpRequest抽象了Http请求操作，执行ClientHttpRequest将会发送请求与服务端交互。

 

总结

到这里，RestTemplate的实例构造过程就结束了。其实它的原理就是封装了http请求操作而已。

我们再大体过一下RestTemplate的构造过程

1）在RestTemplate构造方法中添加了多个HttpMessageConverter后续用于http请求响应的数据转换

2）在RestTemplate构造方法中初始化了一个Uri模板的处理器，后续用于处理uri相关的东西

3）HttpAccessor默认创建了一个ClientHttpRequestFactory的成员实例，后续用于创建请求对象。

不过，似乎最有学习价值的还是一开始的restTemplate的设计图。能够理解抽象类与接口的标准设计理念，兴许对面向对象分析与设计大有裨益。