Retrofit源码解析（一）：基础使用

正文

首先我们回顾一下Retrofit的用法：

首先需要定义我们的接口文件，这个类必须是接口类型：

/**
 * Created by li.zhipeng on 2018/8/29.
 */public interface TestApi {    /**
     * 模拟GET一个数据请求
     */
    @GET
    ResponseWrapper getData(@Url String url);    /**
     * 模拟POST一个数据请求
     */
    @POST
    @FormUrlEncoded
    ResponseWrapper postData(@Url String url, @Field("wd") String key);
}

非常简单的get请求，我们需要指定请求的类型@Get，@POST，@PUT等等，这写请求类型的注解可以设置网络请求的相对地址。如果有参数，还可以指定网络请求的参数，通过@Field（“paramName”），注解内的value是提交的参数对应的key。

有些用过Retrofit的朋友可能会问：为什么你的返回类型是ResponseWrapper？

其实这是我通过Retrofit的api指定的返回的类型，我们可以按照自己的需要指定任何类型。

接下来初始化Retrofit的配置信息，并解析定义的接口文件：

val retrofit = Retrofit.Builder()                // 必填项
                .baseUrl("http://www.baidu.com")
                .client(OkHttpClient())                // 对得到的结果进行转换，常用的有加密解密，json转换等等
                .addConverterFactory(StringConvertFactory())                // 对返回的结果进行封装，常用的有之间转化成Rxjava对象
                // 这里我们简单的进行包装
                .addCallAdapterFactory(ResponseWrapperCallAdapterFactory())
                .build()

api = retrofit.create(TestApi::class.java)

baseUrl：请求的基础地址，如果没有参数中没有指定@Url地址，真实的网络地址是baseUrl + @GET注解的value相对地址。

client：发起网络请求的OkhttpClient对象。

addConverterFactory：添加网络请求的转换工厂类，可以处理网络请求过程中Request或者Response，例如可以把Response中的数据流转换成字符串。

addCallAdapterFactory：设置网络请求的返回类型。demo中直接返回自定义的ResponseWrapper，所以刚刚的接口文件返回的类型就只能是ResponseWrapper。

接下来看看我自定义的StringConvertFactory：

/**
 * Created by li.zhipeng on 2018/8/29.
 *
 *      把得到的数据response转换成String
 */public class StringConvertFactory extends Converter.Factory {    @Override
    public Converter<ResponseBody, String> responseBodyConverter(Type type, Annotation[] annotations, Retrofit retrofit) {        return new Converter<ResponseBody, String>() {            @Override
            public String convert(@NonNull ResponseBody value) throws IOException {                return value.string();
            }
        };
    }
}

很简单，把response的内容取出来，返回String字符串。

再看看ResponseWrapperCallAdapterFactory：

/**
 * Created by li.zhipeng on 2018/8/29.
 *
 *  把得到网络请求结果String，转换成ResponseWrapper
 */public class ResponseWrapperCallAdapterFactory extends CallAdapter.Factory  {    @Override
    public CallAdapter<String, ResponseWrapper> get(@NonNull final Type returnType, @NonNull Annotation[] annotations, @NonNull Retrofit retrofit) {        return new CallAdapter<String, ResponseWrapper>() {            @Override
            public Type responseType() {                return returnType;
            }            @Override
            public ResponseWrapper adapt(@NonNull Call<String> call) {                try {                    return new ResponseWrapper(call.execute().body());
                } catch (IOException e) {
                    e.printStackTrace();
                }                return new ResponseWrapper("error");
            }
        };
    }
}

这里主要是实现adapt方法，对返回值类型进行转换，这里ResponseWrapper就是一个包装类，把得到的String保存起来。值得注意的是，我们在这里直接发起了同步的网络请求，所以别忘了实际使用中，不能在主线程发起网络请求。

看一下没什么卵用的ResponseWrapper：

/**
 * Created by li.zhipeng on 2018/8/29.
 * <p>
 * 网络请求包装类
 */public class ResponseWrapper {

    public String response;    public ResponseWrapper(String response) {        this.response = response;
    }

}

最后在MainActivity中发起网络请求：

Thread {
     val result = api.postData("www.baidu.com", "111").response
     runOnUiThread {
          val textView = findViewById<TextView>(R.id.textView)
          textView.text = result
     }
}.start()

看一下运行结果：

Screenshot_2018-08-29-12-12-34.png

我们已经得到了请求的数据，Retrofit的基础使用就是这些，当然还有其他的api，这里简单介绍一下：

callFactory: 跟client一样，指定运行Okhttp网络请求的工厂类，OkhttpClient已经实现了Factory中的方法。

callAdapterFactories：同时设置多个CallAdapterFactoty。

converterFactories:同时设置多个ConvertFactoty.

callbackExecutor：执行callback的线程池，用的很少。Android默认是主线程。

validateEagerly：是否一次在创建接口文件代理时，解析所有的接口方法。

作者：珠穆朗玛小王子
链接：https://www.jianshu.com/p/72d0ae123b30