Android 利用RxJava和Retrofit搭建网络请求组件——基础配置及部分源码解析

开门见山，本文主要记录利用RxJava和Retrofit设计网络请求组件的基本配置，需要做如下准备

一.定义网络请求方法的接口文件：ApiService(名字随意哈)
接口文件定义了各个请求方法，请求方式及参数类型均以注解形式标识，示例文件仅描述了两种常用的请求方式（POST 和 GET）及参数注解方式,相关注意事项已经做了标识

/**
 * 重要的事情说三遍：ApiService 必须是接口,ApiService 必须是接口,ApiService 必须是接口
 * Created by cuiyan on 16-10-18.
*/
public interface ApiService {
    /*************************GET 请求方式*************************/
   
    /**
    * ApiConstants.QQ_SPORT_API 请求接口地址api（相对路径）
    * 域名部分会在构建Retrofit时设置
    * 返回Observable对象(内部包装了Call实例)，订阅(subscribe)执行时会调用Call.execute()方法发送网络请求。
    */
    @GET(ApiConstants.QQ_SPORT_API)
    Observable getQQSportNews(@Query("baid") String baid, @Query("apikey") String apiKey);

    @GET(ApiConstants.QQ_SPORT_API)
    Observable getQQSportNews1(@QueryMap Map paramsMap);

    /*************************POST 请求方式*************************/

    /**
    * @Body 注解参数均表示以实体形式提交请求数据
    */
    @POST(ApiConstants.QQ_SPORT_API)
    Observable getQQSportNews2(@Body NewsResult bodyParam);

    /**
    * @Field 或 @FieldMap 注解参数均表示以表单形式提交参数，相应的，
    * 请求方法必须添加 @FormUrlEncoded 注解
    */
    @FormUrlEncoded
    @POST(ApiConstants.QQ_SPORT_API)
    Observable getQQSportNews3(@Field("baid") String baid, @Field("apikey") String   apiKey);

    @FormUrlEncoded
    @POST(ApiConstants.QQ_SPORT_API)
    Observable getQQSportNews4(@FieldMap Map paramsMap);
}

二.ApiService实例构建，这一步工作内容比较多，包括Retrofit构建及配置，代码如下：

public class BaseServiceUtil {
    private static final int DEFAULT_TIMEOUT = 10;
   
    /**
     @param serviceClass 网络请求接口描述文件类，步骤一中的ApiService.class或其他类似class
     @return S S实例，即ApiService实例
    */
    public static synchronized  S createService(Class serviceClass) {
        return createService(serviceClass, null);
    }

    public static  S createService(Class serviceClass, String baseUrl) {
        CommonInterceptor interceptor = new CommonInterceptor();
        OkHttpClient.Builder clientBuilder = new OkHttpClient.Builder()
                .connectTimeout(DEFAULT_TIMEOUT, TimeUnit.SECONDS)
                .readTimeout(DEFAULT_TIMEOUT, TimeUnit.SECONDS);
        Retrofit.Builder retrofitBuilder = new Retrofit.Builder()
                .addConverterFactory(GsonConverterFactory.create())
                .addCallAdapterFactory(RxJava2CallAdapterFactory.create());
        if (!TextUtils.isEmpty(baseUrl)) {
            retrofitBuilder.baseUrl(baseUrl);
        } else {
            retrofitBuilder.baseUrl(BuildConfig.BASE_URL);
        }
        clientBuilder.interceptors().clear();
        clientBuilder.interceptors().add(interceptor);

    // 设置证书
//        try {
//            clientBuilder.sslSocketFactory(RqbTrustManager.getInstance().getSSLSocketFactory("BKS", R.raw.rqb_ssl));
//        } catch (Exception e) {
//            e.printStackTrace();
//        }
        OkHttpClient client = clientBuilder.build();
        Retrofit retrofit = retrofitBuilder.client(client).build();
        return retrofit.create(serviceClass);
    }
}

这个工具类的功能是生成ApiService实例，利用ApiService实例就可以获取包装了Call实例的Observable对象喽。通过代码可以看到，中间环节做了不少工作，重点如下：
1.通过OkHttpClient.Builder生成OkHttpClient实例并设置超时时间及拦截器interceptor(此处重点)

2.通过Retrofit.Builder及OkHttpClient 实例生成Retrofit实例。构建过程中Retrofit.Builder设置了Gson转换器，通过addCallAdapterFactory方法设置了RxJava2CallAdapterFactory(很重要)，既然重要就看一看这个方法

/**
 * Add a call adapter factory for supporting service method return types other than {@link Call}.
 */
 public Builder addCallAdapterFactory(CallAdapter.Factory factory) {
     adapterFactories.add(checkNotNull(factory, "factory == null"));
     return this;
 }

api的描述翻译过来大概就是:添加了call adapter factory后，service中的方法可以返回除了Call以外的其他类型对象。而service 对应的就是我们的ApiService。也就是说只有设置了RxJava2CallAdapterFactory之后，
我们才能在ApiService中返回Observable对象
3.通过Retrofit实例生成ApiService实例，有了这个实例就能调用其定义的方法拿到Observable对象

interceptor之所以是我们重点关注的对象，是因为我们可以通过interceptor拦截请求，并做一些处理，例如添加header、添加公共参数等
RxJava2CallAdapterFactory这个类在另一片文章 Android 利用RxJava和Retrofit搭建网络请求组件——监听回调及部分源码解析中有所提及，它是Retrofit支持RxJava观察者模式的核心，我们再重温一下RxJava2CallAdapterFactory的核心方法

@Override 
public Object adapt(Call call) {

    ************************************************重点*****************************************************
    Observable> responseObservable = isAsync ? new CallEnqueueObservable<>(call) : new CallExecuteObservable<>(call);
    *********************************************************************************************************
   
    Observable observable;
    if (isResult) {
        observable = new ResultObservable<>(responseObservable);
    } else if (isBody) {
        observable = new BodyObservable<>(responseObservable);
    } else {
        observable = responseObservable;
    }

    if (scheduler != null) {
        observable = observable.subscribeOn(scheduler);
    }

    if (isFlowable) {
        return observable.toFlowable(BackpressureStrategy.LATEST);
    }

    if (isSingle) {
        return observable.singleOrError();
    }

    if (isMaybe) {
        return observable.singleElement();
    }

    if (isCompletable) {
        return observable.ignoreElements();
    }
    return observable;
}

看到没有，adapt方法返回了observable对象，这个observable对象的生成过程在Android 利用RxJava和Retrofit搭建网络请求组件——监听回调及部分源码解析中也有所提及，可看一下源码，不再赘述。说来说去，虽然知道它生成了observable对象，但怎么生成的？好吧，不卖关子了，简单介绍一下，就看看Retrofit生成ApiService实例做了些什么好了，直接看前文提到的Retrofit的create方法

public  T create(final Class service) {
    Utils.validateServiceInterface(service);
    if (validateEagerly) {
      eagerlyValidateMethods(service);
    }
    return (T) Proxy.newProxyInstance(service.getClassLoader(), new Class[] { service },
    new InvocationHandler() {
          private final Platform platform = Platform.get();

          @Override public Object invoke(Object proxy, Method method, @Nullable Object[] args)
          throws Throwable {
            // If the method is a method from Object then defer to normal invocation.
            if (method.getDeclaringClass() == Object.class) {
              return method.invoke(this, args);
             }
            if (platform.isDefaultMethod(method)) {
              return platform.invokeDefaultMethod(method, service, proxy, args);
            }
            ServiceMethod serviceMethod =
            (ServiceMethod) loadServiceMethod(method);
            OkHttpCall