《网络(四):Retrofit2 + Rxjava2 +Okhttp3封装与使用》

在使用Retrofit/Okhttp时会发现有一部分代码是重复出现的,所以对重复的这部分代码进行简单封装,提高开发效率也让网络请求调用更加的方便(无需再写重复的部分代码)。

1、封装分析

Retrofit网络框架中的网络的请求部分交给了Okhttp来处理,Retrofit通过接口方式封装了请求的参数、通过注解方式告知Okhttp需要调用的是GET\POST还是其他的请求网络方法;所以一个网络请求过程中,我需要同时创建Retrofit和OkhttpClient两个对象;首先需创建OkhttpClient、因为OkhttpClient是Retrofit的一个成员(它们之间就是简单的依赖关系)。

OkhttpClient的创建(建造者模式)

   client = new OkHttpClient.Builder()
                .sslSocketFactory(SSLHelper.getSSLCertifcation(this))
                .hostnameVerifier(new UnSafeHostnameVerifier())
                .addInterceptor(loggingInterceptor)
                .connectTimeout(mTimeOut, TimeUnit.SECONDS)
                .readTimeout(mTimeOut, TimeUnit.SECONDS)
                .writeTimeout(mTimeOut, TimeUnit.SECONDS)
                .build();

以上我们为通过构造者模式创建了OkhttpClient对象client,配置https所需要的证书环境、添加了日志拦截器(当然还可以添加通用的请求头信息)、配置网的请求超时时长和读写超时时长。这些参数对于一个客户端网络请求而言都是通用的,所以OkhttpClient对象的创建过程完全可以进行内部封装了。

Retrofit的创建(建造者模式)

 retrofit = new Retrofit.Builder()
                .baseUrl(baseUrl)
                .addConverterFactory(GsonConverterFactory.create())
                .client(client)
                .build();

Retrofit对象的创建也是通过构造者模式,以上配置的服务器地址baeUrl、gosn转换和之前创建的OkhttpClient对象,正常情况下一个客户端可能对应多个服务器进行数据交互,所以baseUrl可能是多个的,这里我们暂且认为一个客户端对应着一个服务器,因为一个客户端对应多个服务器后台,一般会通过一个中间服务器(中台系统)我目前接触的项目也是这样的。

image.png

所以Retrofit 的创建也可以完全进行封装(偷个笑),那么单例模式就可以搞定我们的需求了,应为retrofit是通用的(唯一的),又得是全局性的(一个项目中很多地方都得用到网络请求),所以采用单例模式在适合不过了。

2、封装代码


/**
 * Created by zhouds
 * Created time  2018/10/4.
 * Description:
 * Version: V 1.0
 */
public class RetrofitManager {
    /**
     *  baseUrl  在application中赋值
     */
    public static String baseUrl;
    /**
     * token
     */
    public static String userToken = "4234345dfgd754df";
    /**
     * 超时时间
     */
    private static final int DEFAULT_TIME_OUT = 15;
    private static RetrofitManager mRetrofitManager;
    private static HttpLoggingInterceptor loggingInterceptor;
    private static OkHttpClient okHttpClient;
    private Retrofit mRetrofit;

    //静态块,类加载时初始化OkHttpClient对象
    static {
        initOkHttpClient();
    }

    private RetrofitManager() {
        if (TextUtils.isEmpty(baseUrl)){
            new Throwable("baseUrl is Empty").printStackTrace();
        }
        mRetrofit = new Retrofit.Builder()
                .baseUrl(baseUrl+"ForAnd/")
                .addConverterFactory(GsonConverterFactory.create())
                .addCallAdapterFactory(RxJava2CallAdapterFactory.create())
                .client(okHttpClient)
                .build();
    }

    public static synchronized RetrofitManager getInstance() {
        if (mRetrofitManager == null) {
            synchronized (RetrofitManager.class) {
                if (mRetrofitManager == null) {
                    mRetrofitManager = new RetrofitManager();
                }
            }
        }
        return mRetrofitManager;
    }


    /**
     *  获取单例OkHttpClient
     *
     * @return
     */
    @SuppressWarnings("deprecated")
    private static OkHttpClient initOkHttpClient() {
        //添加公共参数拦截器
        HttpCommonInterceptor interceptor = new HttpCommonInterceptor.Builder()
                .addHeaderParams("paltform", "android")
                .addHeaderParams("userToken", userToken)
                .build();

        //日志
        loggingInterceptor = new HttpLoggingInterceptor(new HttpLoggingInterceptor.Logger() {
            @Override
            public void log(String message) {
                //打印retrofit日志
                Log.i("RetrofitLog", "retrofitBack = " + message);
            }
        });
        //日志等级
        loggingInterceptor.setLevel(HttpLoggingInterceptor.Level.BODY);

        if (okHttpClient == null) {
            synchronized (OkHttpClient.class) {
                if (okHttpClient == null) {
                    okHttpClient = new OkHttpClient.Builder()
                            //http + ssl
                            .sslSocketFactory(SSLHelper.getSSLCertifcation(MyApplicaiton.getContext()))
                            .hostnameVerifier(new UnSafeHostnameVerifier())
                            //打印拦截器日志
                            .addNetworkInterceptor(loggingInterceptor)
                            //设置连接超时时间
                            .connectTimeout(DEFAULT_TIME_OUT, TimeUnit.SECONDS)
                            //设置读取超时时间
                            .readTimeout(DEFAULT_TIME_OUT, TimeUnit.SECONDS)
                            // 设置写入超时时间
                            .writeTimeout(DEFAULT_TIME_OUT, TimeUnit.SECONDS)
                            .build();
                }
            }
        }
        return okHttpClient;
    }

    /**
     * 创建相应的服务接口
     */
    public <T> T create(Class<T> reqServer) {
        return mRetrofit.create(reqServer);
    }
}

1)可以把baseUrl放置到AppAplication的中

 @Override
    public void onCreate() {
        super.onCreate();
        context = this;
        LitePal.initialize(this);
        //网络baseUrl初始化
        RetrofitManager.baseUrl = IPutils.getIP2();
        //热更新初始化
        initHotFix();
        //其他初始化...
    }

2)HttpCommonInterceptor 是定义的拦截器

/**
 * Created by zhouds
 * Created time  2018/11/5.
 * Description: 自定义拦截器、添加请求头
 * Version: V 1.0
 */
public class HttpCommonInterceptor implements Interceptor {
    private Map<String, String> mHeaderParamsMap = new HashMap<>();

    public HttpCommonInterceptor() {
    }

    @Override
    public Response intercept(Chain chain) throws IOException {
        Request oldRequest = chain.request();
        // 新的请求
         Request.Builder requestBuilder = oldRequest.newBuilder();
         requestBuilder.method(oldRequest.method(), oldRequest.body());
        // 添加公共参数,添加到header中
        if (mHeaderParamsMap.size() > 0) {
            for (Map.Entry<String, String> params : mHeaderParamsMap.entrySet()) {
                requestBuilder.header(params.getKey(), params.getValue());
            }
        }
        Request newRequest = requestBuilder.build();
        return chain.proceed(newRequest);
    }

    public static class Builder {
        HttpCommonInterceptor mHttpCommonInterceptor;

        public Builder() {
            mHttpCommonInterceptor = new HttpCommonInterceptor();
        }

        public Builder addHeaderParams(String key, String value) {
            mHttpCommonInterceptor.mHeaderParamsMap.put(key, value);
            return this;
        }

        public Builder addHeaderParams(String key, int value) {
            return addHeaderParams(key, String.valueOf(value));
        }

        public Builder addHeaderParams(String key, float value) {
            return addHeaderParams(key, String.valueOf(value));
        }

        public Builder addHeaderParams(String key, long value) {
            return addHeaderParams(key, String.valueOf(value));
        }

        public Builder addHeaderParams(String key, double value) {
            return addHeaderParams(key, String.valueOf(value));
        }

        public HttpCommonInterceptor build() {
            return mHttpCommonInterceptor;
        }
    }
}

3)对外提供create方法用于创建接口类型的代理对象

  public <T> T create(Class<T> reqServer) {
        return mRetrofit.create(reqServer);
    }

4)为了支持Rxjava的使用添加配置

 .addCallAdapterFactory(RxJava2CallAdapterFactory.create())


//同时需要在gradel中添加配置
//retrofit2 配合Rxjava 使用
compile 'com.squareup.retrofit2:adapter-rxjava2:2.3.0'

3、使用

普通方式
1)定义接口

public interface ItemsBiz {

    @GET("items.action")
    Call<Items>getItems();
    
    @GET("items.action")
    Observable<Items>getItemsRx();
}

2)通过RetrofitManager来生成ItemsBiz 对象

 private void doGet() {
        //ItemsBiz itemsBiz = retrofit.create(ItemsBiz.class);
        ItemsBiz itemsBiz =  RetrofitManager.getInstance().create(ItemsBiz.class);
        Call<Items> call = itemsBiz.getItems();
        call.enqueue(new Callback<Items>() {
            @Override
            public void onResponse(Call<Items> call, Response<Items> response) {
                textShow.setText(gson.toJson(response.body()));
            }

            @Override
            public void onFailure(Call<Items> call, Throwable t) {
                t.printStackTrace();
            }
        });
    }

结合Rxjava方式

 RetrofitManager.getInstance().create(ItemsBiz.class).getItemsRx().subscribe(new Consumer<Items>() {
            @Override
            public void accept(Items items) throws Exception {
                
            }
        });

至此Retrofit的封装和基本使用就介绍完毕了。网上也看到把一个接口定义到一个业务Loader中,并在Loader中进行代理对象的生成和具体方法调用,向外部提供相关网请求方法。

业务Loader

1)定义一个顶层Loader

/**
 * Created by zhouds
 * Created time  2018/10/6.
 * Description:
 * Version: V 1.0
 */
public class ObjectLoader {
    /**
     * * @param observable * @param <T> * @return
     */
    protected <T> Observable<T> observe(Observable<T> observable) {
        return observable
                .subscribeOn(Schedulers.io())
                .unsubscribeOn(Schedulers.io())
                .observeOn(AndroidSchedulers.mainThread());
    }
}
这里封装了一个通用方法,用于设置Rxjava中子线程与主线程之间切换。

2)定义具体的业务Loader

/**
 * Created by zhouds
 * Created time  2018/10/6.
 * Description:
 * Version: V 1.0
 */
public class ItemLoader extends ObjectLoader{
    private ItemService itemService;

    /**
     * 2、初始化:调用RetrofitManager获得retrofit单例,并creat接口
     */
    public ItemLoader(){
        itemService = RetrofitManager.getInstance().create(ItemService.class);
    }

    /**
     * 1、定义retrofig 接口
     */
    public interface ItemService{

        /**
         * @param count
         * @return
         */
        @GET("itemList.action")
        Observable<List<Items>> getItemsQurey(@Query("count")Integer count);


        /**
         * @param count
         * @return
         */
        @GET("query.action")
        Observable<List<Customer>> getQueryCustomer(@Query("count")Integer count);
    }

    /*----3、供外部调用的方法(结合Rxjava)----*/

    /**
     * 查询
     *
     * @param count
     * @return
     */
    public Observable<List<Items>> getItems( Integer count ){
        return observe(itemService.getItemsQurey(count));
    }

    /**
     * 查询
     *
     * @param count
     * @return
     */
    public Observable<List<Customer>> getCustomers(Integer count){
        return observe(itemService.getQueryCustomer(count));
    }
}

3)初始化Loader

 itemLoader = new ItemLoader();

4)使用

 private void rxRetrofit2() {
        itemLoader.getCustomers(3).flatMap(new Function<List<Customer>, ObservableSource<Customer>>() {
            @Override
            public ObservableSource<Customer> apply(List<Customer> customers) throws Exception {
                return Observable.fromIterable(customers);
            }
        }).filter(new Predicate<Customer>() {
            @Override
            public boolean test(Customer customer) throws Exception {
                return customer.getId() == 1;
            }
        }).subscribe(new Consumer<Customer>() {
            @Override
            public void accept(Customer customer) throws Exception {
                textShow.setText(gson.toJson(customer));
            }
        });
    }

itemLoader.getCustomers(3)执行了网络查询并返回被观察者,此时我们不需要关系接口对象的创建和内部具体调用了什么方法,这些操作全部封装在了Loader业务中;getCustomers方法之后调用的都是Rxjava的相关操作符,对数据进行处理,flatMap对List集合数据进行转换成一个个对象,filter对数据进行过滤获取我们想要的数据,最终通过subscribe订阅被观察者,观察接收数据并展示出来。

下一篇《网络(五)》将整理一下 Retrofit2请求webservice接口(即xml的组装和xml的解析)

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,294评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,493评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,790评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,595评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,718评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,906评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,053评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,797评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,250评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,570评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,711评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,388评论 4 332
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,018评论 3 316
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,796评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,023评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,461评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,595评论 2 350

推荐阅读更多精彩内容