热门标签 | HotTags
当前位置:  开发笔记 > 前端 > 正文

详解RxJava2Retrofit2网络框架简洁轻便封装

前言 RxJava2、Retrofit2火了有一段时间了,前段时间给公司的项目引入了这方面相关的技术,在此记录一下相关封装的思路。 需求

前言

RxJava2、Retrofit2火了有一段时间了,前段时间给公司的项目引入了这方面相关的技术,在此记录一下相关封装的思路。

需求

封装之前要先明白需要满足哪些需求。

  1. RxJava2衔接Retrofit2
  2. Retrofit2网络框架异常的统一处理
  3. 兼容fastjson(可选)
  4. RxJava2内存泄漏的处理
  5. 异步请求加入Loading Dialog

依赖

implementation 'io.reactivex.rxjava2:rxandroid:2.0.1'
 implementation 'io.reactivex.rxjava2:rxjava:2.1.3'
 implementation 'com.squareup.retrofit2:retrofit:2.3.0'
 implementation 'com.squareup.retrofit2:adapter-rxjava2:2.3.0'
 implementation 'com.squareup.okhttp3:okhttp:3.9.0'
 implementation 'com.trello.rxlifecycle2:rxlifecycle-components:2.2.0'
 implementation 'com.alibaba:fastjson:1.1.59.android'//可选其它框架比如Gson

RxJava2衔接Retrofit2

先封装一个网络框架的管理类,方便调用

public class RxHttp {
 private final String BASE_URL = "https://github.com/";
 private Map mRetrofitMap = new HashMap<>();
 private RxHttp() {

 }

 /**
  * 单例模式
  * @return
  */
 public static RxHttp getInstance() {
  return RxHttpHolder.sInstance;
 }

 private static class RxHttpHolder{
  private final static RxHttp sInstance = new RxHttp();
 }

 public Retrofit getRetrofit(String serverUrl) {
  Retrofit retrofit;
  if (mRetrofitMap.containsKey(serverUrl)) {
   retrofit = mRetrofitMap.get(serverUrl);
  } else {
   retrofit = createRetrofit(serverUrl);
   mRetrofitMap.put(serverUrl, retrofit);
  }
  return retrofit;
 }

 public SyncServerService getSyncServer(){
  return getRetrofit(BASE_URL).create(SyncServerService.class);
 }

 /**
  *
  * @param baseUrl baseUrl要以/作为结尾 eg:https://github.com/
  * @return
  */
 private Retrofit createRetrofit(String baseUrl) {
  OkHttpClient client = new OkHttpClient().newBuilder()
    .readTimeout(30, TimeUnit.SECONDS)
    .connectTimeout(30, TimeUnit.SECONDS)
    .retryOnConnectionFailure(true)
    .build();

  return new Retrofit.Builder()
    .baseUrl(baseUrl)
    .addConverterFactory(FastJsonConverterFactory.create())
    .addCallAdapterFactory(RxJava2CallAdapterFactory.create())
    .client(client)
    .build();
 }

}

Restful风格接口

public interface SyncServerService {
 @GET("service/mobile/IsLatestVersion.ashx")
 Observable> getLatestVersion(@Query("SoftwareID") String SoftwareID,
             @Query("ClientVersion") String ClientVersion);
}

服务端返回的基本类型,在导入类的时候特别需要注意区分该Response类型

public class Response {
 public int ret;//约定 -1为server返回数据异常 200为正常范围
 public String msg;
 public T data;

 public int getRet() {
  return ret;
 }

 public void setRet(int ret) {
  this.ret = ret;
 }

 public String getMsg() {
  return msg;
 }

 public void setMsg(String msg) {
  this.msg = msg;
 }

 public T getData() {
  return data;
 }

 public void setData(T data) {
  this.data = data;
 }
}

fastjson的支持

由于项目中采用了fastjson,square尚未实现对fastjson的支持,但是保留了代码的扩展,这边可以自己封装一下fastjson的转换器。

public class FastJsonConverterFactory extends Converter.Factory {
 private final SerializeConfig mSerializeConfig;
 private FastJsonConverterFactory(SerializeConfig serializeConfig) {
  this.mSerializeCOnfig= serializeConfig;
 }

 public static FastJsonConverterFactory create() {
  return create(SerializeConfig.getGlobalInstance());
 }

 public static FastJsonConverterFactory create(SerializeConfig serializeConfig) {
  return new FastJsonConverterFactory(serializeConfig);
 }

 @Override
 public Converter<&#63;, RequestBody> requestBodyConverter(Type type, Annotation[] parameterAnnotations, Annotation[] methodAnnotations, Retrofit retrofit) {
  return new FastJsonRequestBodyConverter<>(mSerializeConfig);
 }

 @Override
 public Converter responseBodyConverter(Type type, Annotation[] annotations, Retrofit retrofit) {
  return new FastJsonResponseBodyConvert<>(type);
 }
}

final class FastJsonRequestBodyConverter implements Converter {
 private final MediaType MEDIA_TYPE = MediaType.parse("application/json; charset=UTF-8");
 private SerializeConfig mSerializeConfig;
 public FastJsonRequestBodyConverter(SerializeConfig serializeConfig) {
  this.mSerializeCOnfig= serializeConfig;
 }

 @Override
 public RequestBody convert(T value) throws IOException {
  return RequestBody.create(MEDIA_TYPE, JSON.toJSONBytes(value, mSerializeConfig));
 }
}
final class FastJsonResponseBodyConvert implements Converter {
 private Type mType;
 public FastJsonResponseBodyConvert(Type type) {
  this.mType = type;
 }

 @Override
 public T convert(ResponseBody value) throws IOException {
  return JSON.parseObject(value.string(), mType);
 }
}

数据返回统一处理

public abstract class BaseObserver implements Observer> {
 @Override
 public final void onNext(@NonNull Response result) {
  if (result.getRet() == -1) {
   onFailure(new Exception(result.getMsg()), result.getMsg());//该异常可以汇报服务端
  } else {
   onSuccess(result.getData());
  }
 }

 @Override
 public void onError(@NonNull Throwable e) {
  onFailure(e, RxExceptionUtil.exceptionHandler(e));
 }

 @Override
 public void onComplete() {
 }

 @Override
 public void onSubscribe(@NonNull Disposable d) {
 }

 public abstract void onSuccess(T result);
 public abstract void onFailure(Throwable e, String errorMsg);
}

下面加入了异常处理类

public class RxExceptionUtil {
 public static String exceptionHandler(Throwable e){
  String errorMsg = "未知错误";
  if (e instanceof UnknownHostException) {
   errorMsg = "网络不可用";
  } else if (e instanceof SocketTimeoutException) {
   errorMsg = "请求网络超时";
  } else if (e instanceof HttpException) {
   HttpException httpException = (HttpException) e;
   errorMsg = convertStatusCode(httpException);
  } else if (e instanceof ParseException || e instanceof JSONException
    || e instanceof com.alibaba.fastjson.JSONException) {
   errorMsg = "数据解析错误";
  } 
  return errorMsg;
 }

 private static String convertStatusCode(HttpException httpException) {
  String msg;
  if (httpException.code() >= 500 && httpException.code() <600) {
   msg = "服务器处理请求出错";
  } else if (httpException.code() >= 400 && httpException.code() <500) {
   msg = "服务器无法处理请求";
  } else if (httpException.code() >= 300 && httpException.code() <400) {
   msg = "请求被重定向到其他页面";
  } else {
   msg = httpException.message();
  }
  return msg;
 }
}

异步请求加入Loading Dialog

这个时候我们可以根据自己项目中统一封装的dialog自行扩展BaseObserver

public abstract class ProgressObserver extends BaseObserver{
 private MaterialDialog mMaterialDialog;
 private Context mContext;
 private String mLoadingText;
 public ProgressObserver(Context context){
  this(context, null);
 }

 public ProgressObserver(Context context, String loadingText){
  mCOntext= context;
  mLoadingText = loadingText;
 }

 @Override
 public void onSubscribe(@NonNull Disposable d) {
  if (!d.isDisposed()) {
   mMaterialDialog = new MaterialDialog.Builder(mContext).content(mLoadingText == null &#63; "正在加载中..."
     : mLoadingText).isProgress(true).build();
   mMaterialDialog.show();
  }
 }

 @Override
 public void onComplete() {
  if (mMaterialDialog != null) {
   mMaterialDialog.dismiss();
  }
 }

 @Override
 public void onError(@NonNull Throwable e) {
  super.onError(e);
  if (mMaterialDialog != null) {
   mMaterialDialog.dismiss();
  }
 }

}

加入调度类,方便调用线程切换和解决内存泄漏的问题

public class RxSchedulers {
 public static  ObservableTransformer observableIO2Main(final Context context) {
  return upstream -> {
   Observable observable = upstream.subscribeOn(Schedulers.io())
     .observeOn(AndroidSchedulers.mainThread());
   return composeContext(context, observable);
  };
 }

 public static  ObservableTransformer observableIO2Main(final RxFragment fragment) {
  return upstream -> upstream.subscribeOn(Schedulers.io())
    .observeOn(AndroidSchedulers.mainThread()).compose(fragment.bindToLifecycle());
 }

 private static  ObservableSource composeContext(Context context, Observable observable) {
  if(context instanceof RxActivity) {
   return observable.compose(((RxActivity) context).bindUntilEvent(ActivityEvent.DESTROY));
  } else if(context instanceof RxFragmentActivity){
   return observable.compose(((RxFragmentActivity) context).bindUntilEvent(ActivityEvent.DESTROY));
  }else if(context instanceof RxAppCompatActivity){
   return observable.compose(((RxAppCompatActivity) context).bindUntilEvent(ActivityEvent.DESTROY));
  }else {
   return observable;
  }
 }
}

讲了那么多,那么如何使用这个封装呢?下面来看下如何使用。

RxHttp.getInstance().getSyncServer().getLatestVersion("1", "1.0.0")
    .compose(RxSchedulers.observableIO2Main(this))
    .subscribe(new ProgressObserver(this) {
     @Override
     public void onSuccess(String result) {
      Toast.makeText(MainActivity.this, result, Toast.LENGTH_SHORT).show();
     }

     @Override
     public void onFailure(Throwable e, String errorMsg) {
     }
    });

是不是封装后的代码显得更为简洁一点呢?以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。


推荐阅读
  • 本文探讨了 RESTful API 和传统接口之间的关键差异,解释了为什么 RESTful API 在设计和实现上具有独特的优势。 ... [详细]
  • 深入理解Cookie与Session会话管理
    本文详细介绍了如何通过HTTP响应和请求处理浏览器的Cookie信息,以及如何创建、设置和管理Cookie。同时探讨了会话跟踪技术中的Session机制,解释其原理及应用场景。 ... [详细]
  • 本文总结了在使用Ionic 5进行Android平台APK打包时遇到的问题,特别是针对QRScanner插件的改造。通过详细分析和提供具体的解决方法,帮助开发者顺利打包并优化应用性能。 ... [详细]
  • 本文详细介绍了IBM DB2数据库在大型应用系统中的应用,强调其卓越的可扩展性和多环境支持能力。文章深入分析了DB2在数据利用性、完整性、安全性和恢复性方面的优势,并提供了优化建议以提升其在不同规模应用程序中的表现。 ... [详细]
  • QUIC协议:快速UDP互联网连接
    QUIC(Quick UDP Internet Connections)是谷歌开发的一种旨在提高网络性能和安全性的传输层协议。它基于UDP,并结合了TLS级别的安全性,提供了更高效、更可靠的互联网通信方式。 ... [详细]
  • 本文基于对相关论文和开源代码的研究,详细介绍了LOAM(激光雷达里程计与建图)的工作原理,并对其关键技术进行了分析。 ... [详细]
  • 本文详细记录了在基于Debian的Deepin 20操作系统上安装MySQL 5.7的具体步骤,包括软件包的选择、依赖项的处理及远程访问权限的配置。 ... [详细]
  • 资源推荐 | TensorFlow官方中文教程助力英语非母语者学习
    来源:机器之心。本文详细介绍了TensorFlow官方提供的中文版教程和指南,帮助开发者更好地理解和应用这一强大的开源机器学习平台。 ... [详细]
  • 探讨如何高效使用FastJSON进行JSON数据解析,特别是从复杂嵌套结构中提取特定字段值的方法。 ... [详细]
  • 本文介绍了如何在具备多个IP地址的FTP服务器环境中,通过动态地址端口复用和地址转换技术优化网络配置。重点讨论了2Mb/s DDN专线连接、Cisco 2611路由器及内部网络地址规划。 ... [详细]
  • 本文介绍如何使用 Sortable.js 库实现元素的拖拽和位置交换功能。Sortable.js 是一个轻量级、无依赖的 JavaScript 库,支持拖拽排序、动画效果和多种插件扩展。通过简单的配置和事件处理,可以轻松实现复杂的功能。 ... [详细]
  • 如何在WPS Office for Mac中调整Word文档的文字排列方向
    本文将详细介绍如何使用最新版WPS Office for Mac调整Word文档中的文字排列方向。通过这些步骤,用户可以轻松更改文本的水平或垂直排列方式,以满足不同的排版需求。 ... [详细]
  • 360SRC安全应急响应:从漏洞提交到修复的全过程
    本文详细介绍了360SRC平台处理一起关键安全事件的过程,涵盖从漏洞提交、验证、排查到最终修复的各个环节。通过这一案例,展示了360在安全应急响应方面的专业能力和严谨态度。 ... [详细]
  • Android LED 数字字体的应用与实现
    本文介绍了一种适用于 Android 应用的 LED 数字字体(digital font),并详细描述了其在 UI 设计中的应用场景及其实现方法。这种字体常用于视频、广告倒计时等场景,能够增强视觉效果。 ... [详细]
  • RecyclerView初步学习(一)
    RecyclerView初步学习(一)ReCyclerView提供了一种插件式的编程模式,除了提供ViewHolder缓存模式,还可以自定义动画,分割符,布局样式,相比于传统的ListVi ... [详细]
author-avatar
mobiledu2502869017
这个家伙很懒,什么也没留下!
PHP1.CN | 中国最专业的PHP中文社区 | DevBox开发工具箱 | json解析格式化 |PHP资讯 | PHP教程 | 数据库技术 | 服务器技术 | 前端开发技术 | PHP框架 | 开发工具 | 在线工具
Copyright © 1998 - 2020 PHP1.CN. All Rights Reserved | 京公网安备 11010802041100号 | 京ICP备19059560号-4 | PHP1.CN 第一PHP社区 版权所有