retrofit+rxjava

Android Retrofit2+RexJava2+OK3网络

2017-11-28  本文已影响448人  libilang
1eb0eafdd2bd3cdf9b50ce0c9895521b.jpg

前言

android时下最流行的网络框架莫过于 retrofit + rexjava +ok3
本文记录下我的网络架构转型记录。我项目里面采用的是OK3作网络连接层，但是资源的下载我是用的rexjava+OK3单独写的一套下载util，想法就是单独调用解耦分离。我采用的就是 retrofit2 + rexjava2 +ok3这样的一个组合方式。Retrofit实质上就是对okHttp的封装，使用面向接口的方式进行网络请求，利用动态生成的代理类封装了网络接口请求的底层,其将请求返回javaBean，对网络认证 REST API进行了很好对支持。

  1. 关于Retrofit 大家可以看下官网的介绍，A type-safe HTTP client for Android and Java。是一个Android和Java安全的httpclient。
  2. Retrofit2比Retrofit1在效率的提升是很高效的主要在硬性依赖和抽象。在Retrofit2中提供okhttp以及okio依赖,OkHttp的类型基本上已经以更好更简洁的 API 替代 Retrofit 1.0 的一些接口。好了暂时介绍这些，大家可以去看Jake Wharton的retrofit2的介绍以及工作原理。

REST

REST(REpresentational State Transfer)指的是一组架构约束条件和原则。满足这些约束条件和原则的应用程序或设计就是RESTful：

（1）资源（Resources）每一个URI代表一种资源；

（2）表现层（Representation）客户端和服务器之间，传递这种资源的某种表现层；

（3）状态转化（State Transfer）客户端通过四个HTTP动词，对服务器端资源进行操作，实现"表现层状态转化"。

Retrofit2+Rexjava+Okhttp

在Android gradle中添加retrofithe rexjava okhttp添加依赖。

`

implementation "io.reactivex.rxjava2:rxjava:2.1.1"//RxJava2.0所需依赖
implementation 'io.reactivex.rxjava2:rxandroid:2.0.1'//Rxandroid2.0线程调度依赖
implementation 'com.squareup.retrofit2:retrofit:2.3.0'//Retrofit2.0所需依赖
implementation 'com.squareup.retrofit2:converter-gson:2.3.0'//结果转为实体类所需依赖
implementation 'com.squareup.retrofit2:adapter-rxjava2:2.3.0'
implementation 'com.squareup.okhttp3:logging-interceptor:3.9.0'//OKHttp优化策略依赖

`

OkHttpClientHelper

首先我们设计出okhttpclient对象为创建Retrofit提供关联对象OkHttpClientHelper,还有缓存对象CacheHelper，这里只是贴出相关的代码吧。

private OkHttpClientHelper() {
    cache = CacheHelper.getInstance().getCache();
}

 //单例模式
 public static OkHttpClientHelper getInstance() {
    if (clientHelper == null) {
        synchronized (OkHttpClientHelper.class) {
            if (clientHelper == null) {
                clientHelper = new OkHttpClientHelper();
            }
        }
    }
    return clientHelper;
}



//创建OKHttpClicent对象 配置header头信息等
public OkHttpClient getOkHttpClient() {
    loggingInterceptor.setLevel(HttpLoggingInterceptor.Level.BODY);
    if (mClient == null) {
        mClient = new OkHttpClient.Builder()
                .connectTimeout(TIMEOUT, TimeUnit.SECONDS)
                .readTimeout(TIMEOUT, TimeUnit.SECONDS)
                .writeTimeout(TIMEOUT, TimeUnit.SECONDS)
                .cache(cache)      //设置缓存
                .addInterceptor(loggingInterceptor)     //配置拦截器log信息
                .addInterceptor(new Interceptor() {
                    @Override
                    public Response intercept(Chain chain) throws IOException {
                        Request request = chain.request()//配置添加header信息
                                .newBuilder()
                                .addHeader("source-terminal", "Android")  //操作系统名称（ios,android）//设备型号
                                .addHeader("device-model", Build.MODEL)         //设备型号
                                .addHeader("os-version", Build.VERSION.RELEASE) //操作系统版本号
                                //添加cookie 这里需要全局观察下用户信息--比如cookie可以是uid也可以是usertoken等
                                .addHeader("Cookie", "add cookies here")  //这里可以添加cookie 也可以在设计的webview中设置cookie的存储
                                .build();
                        if (API.mode == API.Mode.debug || API.mode == API.Mode.prerelease) {
                            Logger.e("header=>source-terminal", "Android--" + request.url());
                            Logger.e("header=>device-model", Build.MODEL);
                            Logger.e("header=>os-version", Build.VERSION.RELEASE);
                            Logger.e("header=>Cookie", "");
                        }
                        return chain.proceed(request);
                    }
                })
                .build();
    }
    return mClient;
}

相信在看这篇文章的朋友对okhttp应该是很了解了，那么就不多过解释，创建okclient对象，设置缓存，设置超时读写时间，添加拦截器，添加请求头信息。返回的我们需要的client对象.

RetrofitHelper

上面有了okclient对象，现在我们可以设计我们的Retrofit实例，
名字就叫RetrofitHelper。在构造方法中我们就获取到
okhttpclient对象，在OkHttpClientHelper的构造方法中我们又
获取到 CacheHelper的实例，这样的好处方便扩展维护吧。

`
private RetrofitHelper() {
    mClient = OkHttpClientHelper.getInstance().getOkHttpClient();
}

//单例模式 对象唯一
public static RetrofitHelper getInstance() {
    if (helper == null) {
        synchronized (RetrofitHelper.class) {
            if (helper == null) {
                helper = new RetrofitHelper();
            }
        }
    }
    return helper;
}

`

现在我们需要创建Retrofit对象，Retrofit2和1是有一些区别的。

具体的区别大家可以去看下square公司开发者作者Jake Wharton的介绍用 Retrofit 2 简化 HTTP 请求)

`

//构造Retrofit对象 设置基础域名
public Retrofit getRetrofit() {
    if (mRetrofit == null) {
        mRetrofit = new Retrofit.Builder()
                .baseUrl(API.DOMAIN)                                       //域名访问地址 这里只是为了方便demo单独写一个，最好的方式是在builderconfig里面配置，只要修改一下Build Varilant 就可以切换生产环境
                .addConverterFactory(ResponseConverterFactory.create())    // 转换器 添加gson支持 在和后台配合开发的过程中 设计返回数据模型解决解析异常
                .addCallAdapterFactory(RxJava2CallAdapterFactory.create())  //添加RxJava支持
                .client(mClient)                                           //关联ok3 设置client
                .build();
    }
    return mRetrofit;
}

我们调用的方式就比较简单了，直接设置service

//获取服务service对象 对应每一个接口都是一个微服务
public static <T> T getService(Class<T> classz) {
    return RetrofitHelper.getInstance()
            .getRetrofit()
            .create(classz);
}

`
在调用返回的地方设置T泛型方便我们使用;添加Rxjava支持,在使用RxJava过程中会发现RxJava2和RxJava1在语法上有一些区别，推荐阅读学习这个Rexjavagithub;在添加Converter的时候（Convert objects to and from their representation in HTTP.）可以添加多种序列化Factory，但是GsonConverterFactory必须放在最后,否则会抛出异常，我们配合后台在开发的过程中通常都会设计好返回的数据规范格式。所以这里我们自己做一下数据的解析处理和加解密的操作。这里就不多介绍了，在demo中的我写了三个类型，GSON FastJson 加解密JSON类型。有需要的朋友可以针对性看一下就可以了。

ApiService

 api服务注解方式 这个是官方给开发者学习使用的类型

方法注解包含 :
@GET、@POST、@PUT、@DELETE、
@PATH、@HEAD、@OPTIONS、@HTTP。
标记注解包含:
@FormUrlEncoded、@Multipart、@Streaming。
参数注解包含:
@Query,@QueryMap、@Body、@Field，@FieldMap、@Part，@PartMap。
其他注解包含:
@Path、@Header,@Headers、@Url

 这里举一个我们的例子
  @GET("/v1/resource/search/{searchname}?suggest=true")
Observable<SearchDataList.DataBean> getSearchVideo(@Path("searchname") String searchname, @Query("rank") String rank, @Query("size") String size);

NetWorkUtil

 网络调用方法util,demo里我只写了一中方法，最近工作比较忙，扩充类型等有时间再去弄了。rexjava2订阅绑定设置io
 
 ‘
public class NetWorkUtil {
//对应HTTP的状态码
private static final int UNAUTHORIZED = 401;
private static final int FORBIDDEN = 403;
private static final int NOT_FOUND = 404;
private static final int REQUEST_TIMEOUT = 408;
private static final int INTERNAL_SERVER_ERROR = 500;
private static final int BAD_GATEWAY = 502;
private static final int SERVICE_UNAVAILABLE = 503;
private static final int GATEWAY_TIMEOUT = 504;

//Post方式
public static <T> void requestPost(Observable observable, final OnResultListener resultListener) {

    setSubscriber(observable, new Observer<T>() {

        @Override
        public void onSubscribe(Disposable d) {

        }

        @Override
        public void onNext(T t) {
            if (resultListener != null) {//找一些接口试一下就好了
                resultListener.onSuccess(t);
            }
 //                if (t instanceof BaseResponseBean) {
 //                    //后台可配置code码 根据不同的code可以做相应的操作 比如后台强制抛出错误等等 这里我注释掉，给大家个样板而已
 //                    BaseResponseBean success = (BaseResponseBean) t;
 //                    if (success.code == 0) {
 //                        if (resultListener != null) {
 //                            resultListener.onSuccess(success.data);
 //                        }
 //                    } else {
 //                        if (resultListener != null) {
 //                            resultListener.onError(success.errormessage);
 //                        }
 //                    }
 //                } else {
 //                    if (resultListener != null) {
 //                        resultListener.onError("数据异常了");
 //                    }
 //                }
        }

        @Override
        public void onError(Throwable error) {
            if (error != null && resultListener != null) {
                resultListener.onError(error.getMessage());
            } else if (resultListener != null) {
                resultListener.onError("兄弟 网络不给力啊");
                return;
            }
            String e = error.getMessage();
            if (error instanceof HttpException) {//HTTP错误
                HttpException httpException = (HttpException) error;
                switch (httpException.code()) {
                    case UNAUTHORIZED:
                    case FORBIDDEN:
                    case NOT_FOUND:
                    case REQUEST_TIMEOUT:
                    case GATEWAY_TIMEOUT:
                    case INTERNAL_SERVER_ERROR:
                    case BAD_GATEWAY:
                    case SERVICE_UNAVAILABLE:
                    default:
                        //Toast.makeText(App.getInstance(), "网络异常", Toast.LENGTH_SHORT).show();
                        break;
                }
            } else if (error instanceof SocketTimeoutException) {
            } else if (error instanceof JsonParseException || error instanceof JSONException || error instanceof ParseException) {
            } else if (error instanceof ResultException) {//服务器返回的错误
            } else if (error instanceof ConnectException) {
            } else {//未知错误
            }
            resultListener.onError("兄弟 网络不给力啊");
        }

        @Override
        public void onComplete() {
 //    Logger.d("request", "读取完成");
        }
    });

}

//Get方式
public static void requestGet(Observable observable, final OnResultListener resultListener) {
    requestPost(observable, resultListener);
}

//订阅事件
public static <T> void setSubscriber(Observable<T> observable, Observer<T> subscriber) {
    observable.subscribeOn(Schedulers.io())
            .observeOn(AndroidSchedulers.mainThread())
            .subscribe(subscriber);
}

//网络访问回调接口
public interface OnResultListener<T> {

    void onSuccess(T t);

    void onError(String msg);
}
}

 ’

可以看到我们在apiservice里面定义了一个服务（接口方法）返回Observable泛型内容是我们想要的对象。在上面NetWorkUtil里面调用方法中，rexjava2的方法就大家自行学习了。在这里面有共用的网络错误类型。已经在retrofit帮助类里面设置ConverterFactory里面定义解析失败的类型。到此就全部描述完这个工作流程。下面举一个具体调用的示例。（为什么没有封装成mvp模式呢，我觉得我们不是为了设计模式而设计模式，在部分需求以及开发中我觉得采用适当的设计模式有助于项目开发和维护提升性能，但是在单独的网络层中，我觉得自己做自己的事情更加解耦性）

`

public void getData() {
    //简单好用，看log就明白了
    Observable<SearchDataList.DataBean> searchVideo = RetrofitHelper.getService(ApiService.class).getSearchVideo("秋冬编发大全", "0", "20");
    //这个直接返回来数据对象
    NetWorkUtil.requestGet(searchVideo, new NetWorkUtil.OnResultListener() {
        @Override
        public void onSuccess(Object o) {
            SearchDataList.DataBean bean = (SearchDataList.DataBean) o;
            setdata(bean);
        }

        @Override
        public void onError(String msg) {

        }
    });
}

`

到这里就差不多介绍完了下面给出git链接 下载看这里 觉得还行记得star 感谢各位，语言组织不好还请谅解。。。各位看官小手抖一抖双击666

258387103fc76f4e361b43d2167db2e5.jpg
上一篇下一篇

猜你喜欢

热点阅读