深入解析开源项目之Retrofit（二）框架篇

最新推荐文章于 2024-06-27 23:57:40 发布

原创

最新推荐文章于 2024-06-27 23:57:40 发布 · 1.8k 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#github #开源项目 #square #Retrofit #Api框架

本文深入解析开源项目Retrofit，探讨其运行原理、框架设计，包括平台、请求、拦截和返回等关键环节。Retrofit是Square公司的一款HTTP客户端框架，支持OkHttp和RxJava，简化网络请求。文章详细阐述了如何通过RestAdapter和RestHandler实现动态代理，如何处理请求和响应，以及如何利用Converter进行数据转换。同时，还介绍了在不同平台上的实现策略，如Android、AppEngine和Base。通过对Retrofit的全面分析，有助于开发者更好地理解和运用这个强大的框架。

珍惜作者劳动成果，如需转载，请注明出处。
http://blog.youkuaiyun.com/zhengzechuan91/article/details/50349934

Retrofit（Github地址）是square公司一套开源的http框架，简单易用，并且支持okhttp和RxJava，如果你不想为配置繁杂的http请求而写一套自己的网络请求框架，那么这套优雅的框架你不妨试试。

上篇博客我们介绍了retrofit在项目中的使用，今天我们就来说说这个框架实现的原理。

Retrofit原理

我们先来说说Retrofit运行原理：

生成RestAdapter实例，然后RestAdapter的内部类RestHandler动态代理我们实际的操作接口RealService；
当我们调用RealService的方法时，就会由RestHandler.invoke()代理；
生成RequestBuilder实例，并通过setArguments(Object[])将参数解析到RequestBuilder实例中，如果参数为POJO类型，通过Converter的toBody(Object)将POJO转换为TypedOutput；
利用我们设置的RequestInterceptor，在发送http请求前拦截RequestBuilder并向其中添加参数，最后转换为Request；
执行Client.execute(Request)，返回Response；
如果返回Response的状态码为2**，继续处理，否则抛出各种RetrofitError异常；
需要的返回类型为Response，同步直接返回，异步时包装为ResponseWrapper；
需要的返回类型如果不为Response，通过设定的Converter的fromBody(TypedInput, Type)将TypedInput转化为POJO，同步直接返回，异步包装为ResponseWrapper。

通过上面我们看到，这个框架将不同的平台抽象为Platform，将不同的请求方式抽象为Request，将不同的返回结果抽象为Response，而Converter提供了Request与POJO的转换和Response与POJO的转换，思路还是非常清晰。

既然我们对框架有了整体的理解，我们看看一些细节，以加深我们对框架的理解。

框架

我们根据上面的思路从平台、请求、拦截、返回四个角度对框架做深入的分析

平台

在平台的选择上是通过抽象类Platform来切换的。

Platform对平台相关的变量都通过方法进行了抽象：

/* Platform.java */

  //默认Converter
  abstract Converter defaultConverter();
  //默认Client
  abstract Client.Provider defaultClient();
  //默认同步http线程池
  abstract Executor defaultHttpExecutor();
  //默认异步http线程池
  abstract Executor defaultCallbackExecutor();
  //默认log
  abstract RestAdapter.Log defaultLog();

而三个内部类Android、AppEngine和Base都实现了以上的抽象方法，分别代表三个不同的平台。而进行选择时，我们也会从前往后以此选取，当前面两个平台都不满足时，则会使用默认的Base。

/* Platform$Android.java */

  private static class Android extends Platform {
   
   
    @Override Converter defaultConverter() {
      //默认为Gson解析
      return new GsonConverter(new Gson());
    }

    @Override Client.Provider defaultClient() {
      final Client client;
      if (hasOkHttpOnClasspath()) {
        //使用了okhttp框架，使用OkClient
        client = OkClientInstantiator.instantiate();
      } else if (Build.VERSION.SDK_INT < Build.VERSION_CODES.GINGERBREAD) {
        //android2.3以下，使用ApacheClient
        client = new AndroidApacheClient();
      } else {
        //android2.3及以上，使用HttpURLConnection
        client = new UrlConnectionClient();
      }
      return new Client.Provider() {
        @Override public Client get() {
          return client;
        }
      };
    }

    @Override Executor defaultHttpExecutor() {
      //同步任务添加到线程池
      return Executors.newCachedThread