RxRetrofit 网络框架解析.docx

1、RxRetrofit 网络框架解析RxRetrofit 网络框架解析前言网络请求在项目开发中必不可少，封装的好坏很大程度上影响的项目质量，本篇博文 草民-walid 与大家分享一下本人的愚见与rxretrofit框架讲解劣质请求框架的表现1.与业务逻辑严重耦合 2.存在很多复杂冗余代码 3.写法不够傻瓜 4.请求统一处理不佳 rxretrofit 框架介绍技术概要rxretrofit库采用了rxjava + retrofit 2.0 进行整合封装， retrofit2.0 与 rxjava 在之前文章中都有所介绍，相信大家也都会有所了解，rxjava 与 retrofit的思想就不和大家进行过

2、多的解读了，长话短说，我们开始吧依赖moduledependencies / . 省略部分依赖 / rxjava 相关库 compile io.reactivex:rxandroid:1.2.1 compile io.reactivex:rxjava:1.1.10 /retrofit 相关库 compile com.squareup.okhttp3:logging-interceptor:3.4.1 compile com.squareup.retrofit2:retrofit:2.1.0 compile com.squareup.retrofit2:converter-gson:2.1.0

3、compile com.squareup.retrofit2:adapter-rxjava:2.1.0 compile com.google.code.gson:gson:2.7目录结构简单介绍下文件的作用，这里没有优先级，直接从上至下 ：RetrofitParams ： 配置参数，包括超时时间、转换器、拦截器等ExceptionCode ： http异常代码ServerResultException： 自定义server异常ICodeVerify : codehi合法校验接口，用于服务器code异常校验IHttpCallback : rxjava 订阅callbackIHttpCancelL

4、istener : http 请求取消接口IHttpResult : http数据返回接口，统一规范SimpleHttpCallback : IHttpResult的实现类RxRetrogitLog : log 日志工具类HttpManager : http网络请求管理HttpSubscriber : http 订阅处理根据目录结构大家对项目应该有了一个整体的认识。代码解析库中的代码整体比较简单，草民这里挑出两个重要的类来进行介绍吧HttpManager/* * Author : walid * Data : 2016-08-18 15:58 * Describe : http 管理类 */p

5、ublic class HttpManager private Retrofit retrofit; private ICodeVerify codeVerify; private HttpManager() RxJavaPlugins.getInstance().registerErrorHandler(new RxJavaErrorHandler() Override public void handleError(Throwable e) RxRetrogitLog.e(RxJavaPlugins Error = + e); ); public static HttpManager ge

6、tInstance() return HttpManager.SingletonHolder.instance; private static class SingletonHolder static HttpManager instance = new HttpManager(); public void create(String baseUrl, ICodeVerify codeVerify, RetrofitParams params) this.codeVerify = codeVerify; Converter.Factory converterFactory = params.g

7、etConverterFactory(); CallAdapter.Factory callAdapterFactory = params.getCallAdapterFactor(); retrofit = new Retrofit.Builder().baseUrl(baseUrl) .addConverterFactory(converterFactory != null ? converterFactory : GsonConverterFactory.create(new GsonBuilder().create() .addCallAdapterFactory(callAdapte

8、rFactory != null ? callAdapterFactory : RxJavaCallAdapterFactory.create() .client(createClient(params) .build(); private OkHttpClient createClient(RetrofitParams params) OkHttpClient.Builder builder = new OkHttpClient.Builder(); / 设置超时 int connectTimeoutSeconds = params.getConnectTimeoutSeconds(); i

9、f (connectTimeoutSeconds 0) builder.connectTimeout(connectTimeoutSeconds, TimeUnit.SECONDS); int readTimeoutSeconds = params.getReadTimeoutSeconds(); if (readTimeoutSeconds 0) builder.readTimeout(readTimeoutSeconds, TimeUnit.SECONDS); int writeTimeoutSeconds = params.getWriteTimeoutSeconds(); if (wr

10、iteTimeoutSeconds 0) builder.writeTimeout(writeTimeoutSeconds, TimeUnit.SECONDS); / Log信息拦截器 builder.addInterceptor(new HttpLoggingInterceptor().setLevel(HttpLoggingInterceptor.Level.BODY); ArrayList interceptors = params.getInterceptors(); if (interceptors != null & interceptors.size() 0) for (Inte

11、rceptor interceptor : interceptors) builder.addInterceptor(interceptor); return builder.build(); public ApiType getApiService(Class type) return retrofit.create(type); public T, Result extends IHttpResult HttpSubscriber toSubscribe(Observable observable, Context context, IHttpCallback listener) retu

12、rn toSubscribe(observable, new HttpSubscriber(context, listener); public T, Result extends IHttpResult HttpSubscriber toSubscribe(Observable observable, Context context, IHttpCallback listener, boolean isShowToast) return toSubscribe(observable, new HttpSubscriber(context, listener, isShowToast); pu

13、blic T, Result extends IHttpResult HttpSubscriber toSubscribe(Observable observable, HttpSubscriber httpSubscriber) Observable observableNew = observable.map(new Func1() Override public T call(Result result) if (result = null) throw new IllegalStateException(数据为空); RxRetrogitLog.d(result.toString();

14、 int code = result.getCode(); if (!codeVerify.checkValid(result.getCode() throw new ServerResultException(code, codeVerify.formatCodeMessage(code, result.getMsg(); return result.getData(); ); observableNew.subscribeOn(Schedulers.io() .unsubscribeOn(Schedulers.io() .observeOn(AndroidSchedulers.mainTh

15、read() .subscribe(httpSubscriber); return httpSubscriber; 重要处理：create rxretrofit库的初始化，建议在Application中进行初始化，通过参数可以清晰的得知，传入了baseurl、code校验与params，从而设置OkHttpClient。getApiService 获取api的实例对象。toSubscribe 订阅网络请求，调用此方法进行网络请求，在网络请求发起时创建了HttpSubscriber对象，进行rxjava的事件订阅，进行统一处理。HttpSubscriber/* * Author : walid

16、* Data : 2016-08-18 15:59 * Describe : http 观察者(订阅者) */public class HttpSubscriber extends Subscriber implements IHttpCancelListener private static final String TAG = HttpSubscriber; /对应HTTP的状态码 private static final int UNAUTHORIZED = 401; private static final int FORBIDDEN = 403; private static fin

17、al 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; private Context context; priva

18、te IHttpCallback httpCallback; private boolean showError; public HttpSubscriber(Context context, IHttpCallback httpCallback) this(context, httpCallback, true); public HttpSubscriber(Context context, IHttpCallback httpCallback, boolean showError) this.context = context; this.httpCallback = httpCallba

19、ck; this.showError = showError; / 订阅开始时调用 Override public void onStart() / 加载成功 Override public void onCompleted() Log.d(TAG, onCompleted); / 对错误进行统一处理 Override public void onError(Throwable e) Throwable throwable = e; /获取最根源的异常 while (throwable.getCause() != null) e = throwable; throwable = throwab

20、le.getCause(); /HTTP错误 if (e instanceof HttpException) HttpException httpException = (HttpException) e; switch (httpException.code() /权限错误，需要实现 case UNAUTHORIZED: case FORBIDDEN: callError(ExceptionCode.PERMISSION_ERROR, 权限错误); break; /均视为网络错误 case NOT_FOUND: case REQUEST_TIMEOUT: case GATEWAY_TIMEO

21、UT: case INTERNAL_SERVER_ERROR: case BAD_GATEWAY: case SERVICE_UNAVAILABLE: default: callError(ExceptionCode.HTTP_EXCEPTION, 网络错误,请检查网络后再试); break; else if (e instanceof JsonParseException | e instanceof JSONException | e instanceof ParseException) /均视为解析错误 callError(ExceptionCode.PARSE_ERROR, 数据解析异

22、常); else if (e instanceof SocketTimeoutException) callError(ExceptionCode.SOCKET_TIMEOUT_EXCEPTION, 网络请求超时); else if (e instanceof ServerResultException) ServerResultException apiException = (ServerResultException) e; callError(apiException.getCode(), apiException.getMessage(); else if (e instanceof

23、 CnnectException) callError(ExceptionCode.CONNECT_EXCEPTION, 连接服务器失败); else callError(ExceptionCode.UNKNOWN_ERROR, 服务器正在开小灶,请稍后再试); RxRetrogitLog.e(e.getMessage(); private void callError(int code, String message) if (showError) Toast.makeText(context, message, Toast.LENGTH_SHORT).show(); if (httpCal

24、lback != null) httpCallback.onError(code, message); / 将onNext方法中的返回结果交给Activity或Fragment自己处理 Override public void onNext(T t) if (httpCallback = null) return; httpCallback.onNext(t); / 取消ProgressDialog的时候，取消对observable的订阅，同时也取消了http请求 Override public void onCancel() if (!this.isUnsubscribed() this.u

25、nsubscribe(); 重要处理：onNext 请求成功回调callback。onError 请求失败进行统一处理。onCancel 对网络请求进行取消订阅，可以在activity destroy中进行取消操作。rxretrofit 框架使用前面说了那么多，有的人要吐槽了，bb这么多没有用的，说了半天我还不知道如何使用呢？xx个逼的，草民只是想让大家不仅仅是一个使用者，更想让大家多多的懂得其中的原理，好吧！代码我介绍的也不够完整，在此做个鬼脸，草民惭愧了，下面和大家分享重头戏，使用篇初始化建议初始化在Application中public class App extends Applicat

26、ion Override public void onCreate() super.onCreate(); / LOG 日志开关 RxRetrogitLog.DEBUG = true; RetrofitParams params = new RetrofitParams(); / 拦截器设置 ArrayList interceptors = new ArrayList(); interceptors.add(new ParamsInterceptor(); params.setInterceptors(interceptors); / data 转换器 GsonBuilder builder

27、= new GsonBuilder().setDateFormat(yyyy-MM-dd HH:mm:ss); params.setConverterFactory(GsonConverterFactory.create(builder.create(); / 连接超时时间 params.setConnectTimeoutSeconds(10); / 读取超时时间 params.setReadTimeoutSeconds(10); / 写超时时间 params.setWriteTimeoutSeconds(10); / 创建httpClient HttpManager.getInstance(

28、).create(ApiConstants.URL, new SeaCodeVerify(), params); api 声明public interface IInsApi / 险种 list GET(/api/ins/list) ObservableHttpResultList list(Query(platform) String platform);请求调用public class MainActivity extends AppCompatActivity TextView tvContent; Override protected void onCreate(Bundle save

29、dInstanceState) super.onCreate(savedInstanceState); setContentView(R.layout.activity_main); tvContent = (TextView) findViewById(R.id.tv_content); HttpManager httpManager = HttpManager.getInstance(); / 发起请求 httpManager.toSubscribe(httpManager.getApiService(IInsApi.class).list(ANDROID), this, new SimpleHttpCallbackList() Override public void onNext(List insuranceVos) tvContent.setText(Datas = n + insuranceVos.toString(); , true); 整个框架的使用就这几个最lo