Kotlin + Retrofit + RxJava简单封装使用详解

本文介绍了Kotlin + Retrofit + RxJava简单封装使用详解,分享给大家,具体如下:

实例化Retrofit

object RetrofitUtil {

  val CONNECT_TIME_OUT = 30//连接超时时长x秒
  val READ_TIME_OUT = 30//读数据超时时长x秒
  val WRITE_TIME_OUT = 30//写数据接超时时长x秒

  val retrofit: Retrofit by lazy {
    Log.d("RetrofitUtil", "retrofit init lazy")
    Retrofit.Builder()
        .baseUrl("http://gank.io/api/")  //本文以GitHub API为例
        .addConverterFactory(GsonConverterFactory.create())
        .addCallAdapterFactory(RxJava2CallAdapterFactory.create())
        .client(getOkHttpClient())
        .build()
  }

  private fun getOkHttpClient(): OkHttpClient {
    val builder = OkHttpClient.Builder()
    builder.connectTimeout(CONNECT_TIME_OUT.toLong(), TimeUnit.SECONDS)
        .writeTimeout(WRITE_TIME_OUT.toLong(), TimeUnit.SECONDS)
        .readTimeout(READ_TIME_OUT.toLong(), TimeUnit.SECONDS)
    if (BuildConfig.DEBUG) {
      builder.addInterceptor(HttpLoggingInterceptor().setLevel(HttpLoggingInterceptor.Level.BODY))
    } else {
      builder.addInterceptor(HttpLoggingInterceptor().setLevel(HttpLoggingInterceptor.Level.NONE))
    }
    // 设置请求头
    builder.addInterceptor { chain ->
      val time = (System.currentTimeMillis() / 1000).toString() + ""
      val requestBuilder = chain.request().newBuilder()
      requestBuilder.addHeader("time", time)
      chain.proceed(requestBuilder.build())
    }
    return builder.build()
  }
}

返回数据封装

class Response<T> {
  var error: Boolean = false
  var results: T? = null
}

demo中用了gank.io的开发api,之前一般项目的返回格式是code + message + T的格式。

api接口错误/异常统一处理类

class ApiException : Exception {
  var code: Int = 0//错误码
  var msg: String? = null//错误信息

  constructor(throwable: Throwable, code: Int) : super(throwable) {
    this.code = code
  }

  constructor(code: Int, msg: String) {
    this.code = code
    this.msg = msg
  }
}

定义ExceptionFunction处理onErrorResumeNext:

class ExceptionFunction<T> : Function<Throwable, Observable<T>> {
  override fun apply(@NonNull throwable: Throwable): Observable<T> {
    Log.e("ExceptionFunction", throwable.message)
    return Observable.error(ExceptionEngine().handleException(throwable))
  }
}

/**
 * 错误/异常处理工具
 */
class ExceptionEngine {

  val UN_KNOWN_ERROR = 1000//未知错误
  val ANALYTIC_SERVER_DATA_ERROR = 1001//解析(服务器)数据错误
  val CONNECT_ERROR = 1002//网络连接错误
  val TIME_OUT_ERROR = 1003//网络连接超时

  fun handleException(e: Throwable): ApiException {
    val ex: ApiException
    if (e is ApiException) {  //服务器返回的错误
      return e
    } else if (e is HttpException) {       //HTTP错误
      ex = ApiException(e, e.code())
      ex.msg = "网络错误:" + ex.code
      return ex
    } else if (e is JsonParseException
        || e is JSONException
        || e is ParseException || e is MalformedJsonException) { //解析数据错误
      ex = ApiException(e, ANALYTIC_SERVER_DATA_ERROR)
      ex.msg = "解析错误"
      return ex
    } else if (e is ConnectException) {//连接网络错误
      ex = ApiException(e, CONNECT_ERROR)
      ex.msg = "连接失败"
      return ex
    } else if (e is SocketTimeoutException) {//网络超时
      ex = ApiException(e, TIME_OUT_ERROR)
      ex.msg = "网络超时"
      return ex
    } else { //未知错误
      ex = ApiException(e, UN_KNOWN_ERROR)
      ex.msg = e.message
      return ex
    }
  }
}

封装请求处理

object Rx {

  /**
   * Rxlifecycle绑定生命周期
   */
  fun <T, E> get(observable: Observable<Response<T>>, lifecycleProvider: LifecycleProvider<E>): Observable<T> {

    // 请求绑定生命周期,防止内存泄漏,同时返回回调之后页面已销毁造成的空指针错误
    if (lifecycleProvider is RxAppCompatActivity) {
      val rxAppCompatActivity = lifecycleProvider as RxAppCompatActivity
      observable.compose(rxAppCompatActivity.bindUntilEvent(ActivityEvent.DESTROY))
    } else if (lifecycleProvider is RxFragment) {
      val rxFragment = lifecycleProvider as RxFragment
      observable.compose(rxFragment.bindUntilEvent(FragmentEvent.DESTROY))
    }

    return observable
        .compose(HandleResult())
        .onErrorResumeNext(ExceptionFunction())
  }

  /**
   * 部分后台请求
   */
  fun <T> get(observable: Observable<Response<T>>): Observable<T> {

    return observable
        .compose(HandleResult())
        .onErrorResumeNext(ExceptionFunction())
  }

  private class HandleResult<T> : ObservableTransformer<Response<T>, T> {
    override fun apply(upstream: Observable<Response<T>>): ObservableSource<T> {
      return upstream.flatMap { response -> createResult(response) }
          .subscribeOn(Schedulers.io())
          .unsubscribeOn(Schedulers.io())
          .observeOn(AndroidSchedulers.mainThread())
    }
  }

  private fun <T> createResult(response: Response<T>): Observable<T> {
    return Observable.create({ subscriber ->
      if (response.error)
        throw ApiException(-1, "服务器异常") // 一般来说,自己的服务器异常会返回相应的code和message
      else
        response.results?.let {
          subscriber.onNext(response.results!!)
        } ?: subscriber.onComplete()
    })
  }

}

定义HttpObserver统一处理返回

abstract class HttpObserver<T> : Observer<T> {

  /**
   * 标记是否为特殊情况
   */
  private var resultNull: Boolean = true

  override fun onComplete() {
    // 特殊情况:当请求成功,但T == null时会跳过onNext,仍需当成功处理
    if (resultNull)
      onSuccess(null)
  }

  override fun onSubscribe(d: Disposable) {
    // 可在此处加上dialog
  }

  override fun onError(e: Throwable) {
    if (e is ApiException) {
      onError(e.code, e.msg)
    } else {
      onError(0, e.message)
    }
  }

  override fun onNext(t: T) {
    resultNull = false
    onSuccess(t)
  }

  abstract fun onSuccess(t: T?)

  /**
   * 统一处理失败,比如登录失效等
   *
   * @param code
   * @param msg
   */
  open fun onError(code: Int, msg: String?) {

  }

}

Api

class Result {
  var _id: String? = null
  var createdAt: String? = null
  var desc: String? = null
  var publishedAt: String? = null
  var source: String? = null
  var type: String? = null
  var url: String = ""
  var isUsed: Boolean = false
  var who: String? = null
  var images: List<String>? = null
  /**
   * 妹子小图
   */
  fun meiziSmallUrl(): String {
    val meizi = url
    return meizi.replace("large", "small")
  }
}

interface Apiservice {
  @GET("data/{type}/10/{page}")
  fun getGank(@Path("type") type: String, @Path("page") page: Int): Observable<Response<List<Result>>>
}

object Api {
  val apiservice: Apiservice by lazy {
    Log.d("Api", "apiservice create lazy")
    RetrofitUtil.retrofit.create(Apiservice::class.java)
  }
}

使用

override fun loadData() {
    Rx.get(Api.apiservice.getGank(getType(), mIntPage), this).subscribe(object : HttpObserver<List<Result>>() {
      override fun onSuccess(t: List<Result>?) {
        //getDataSuccess(t)
      }

      override fun onError(code: Int, msg: String?) {
        super.onError(code, msg)
        //getDataFailed()
      }
    })
  }

使用了Rxlifecycle绑定生命周期来处理可能发生的内存泄漏问题,Fragment跟Activity需要继承Rx相应的基类。

练手项目

Meizikt Gank.io Android客户端,使用Kotlin + Retrofit2 + RxJava

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持我们。

(0)

相关推荐

  • Android中的Retrofit+OkHttp+RxJava缓存架构使用

    RxJava如何与Retrofit结合 先扔出build.gradle文件的内容 dependencies { compile fileTree(dir: 'libs', include: ['*.jar']) testCompile 'junit:junit:4.12' compile 'com.android.support:appcompat-v7:23.2.0' compile 'io.reactivex:rxjava:1.1.0' compile 'io.reactivex:rxand

  • RxJava2和Retrofit2封装教程(整洁、简单、实用)

    前言 RxJava2与Retrofit2是老搭档了,之前写了一篇<RxJava和Retrofit2的统一处理单个请求>,是用的Rxjava1.0,本次使用Rxjava2.0与Retrofit2进行封装,一样整洁.简单.实用.Rxjava2相比Rxjava1优化和改动不少了东西,网上有很多大神写的文章,这里就不粘贴复制了.封装的过程有什么问题.疑问,请在下方留言. 下面话不多说了,来一起看看详细的介绍吧 封装教程如下: 核心网络请求: package com.lin.netrequestdemo

  • RxJava+Retrofit+OkHttp实现文件上传

    背景 在实际运用中上传是一个必不可少的功能,所以我们在封装二的基础上加入上传的功能,同时需要附带上传进度! 效果 实现 1.定义service接口 注意:Multipart是指定大文件上传过程中的标示,一般上传图片的过程中我们需要附带信息,所以我们需要用到@part指定传递的数值,MultipartBody.Part是指定传递的文件: /*上传文件*/ @Multipart @POST("AppYuFaKu/uploadHeadImg") Observable<BaseResul

  • Retrofit+Rxjava实现文件上传和下载功能

    Retrofit简介: 在Android API4.4之后,Google官方使用了square公司推出的okHttp替换了HttpClient的请求方式.后来square公司又推出了基于okHttp的网络请求框架:Retrofit. 什么是 RxJava? RxJava 是一个响应式编程框架,采用观察者设计模式.所以自然少不了 Observable 和 Subscriber 这两个东东了. RxJava 是一个开源项目,地址:https://github.com/ReactiveX/RxJava

  • Retrofit Rxjava实现图片下载、保存并展示实例

    首先我们看一下Retrofit常规的用法,在不使用Rxjava的情况下,我们默认返回的是Call. public interface ServiceApi { //下载文件 @GET Call<ResponseBody> downloadPicFromNet(@Url String fileUrl); } 但是如果我们要配合Rxjava使用,那么就要按照如下方式来重新定义我们的方法: @GET Observable<ResponseBody> downloadPicFromNet(

  • RxJava2.x+ReTrofit2.x多线程下载文件的示例代码

    写在前面: 接到公司需求:要做一个apk升级的功能,原理其实很简单,百度也一大堆例子,可大部分都是用框架,要么就是HttpURLConnection,实在是不想这么干.正好看了两天的RxJava2.x+ReTrofit2.x,据说这俩框架是目前最火的异步请求框架了.固本文使用RxJava2.x+ReTrofit2.x实现多线程下载文件的功能. 如果对RxJava2.x+ReTrofit2.x不太了解的请先去看相关的文档. 大神至此请无视. 思路分析: 思路及其简洁明了,主要分为以下四步 1.获取

  • RxJava+Retrofit+OkHttp实现多文件下载之断点续传

    背景 断点续传下载一直是移动开发中必不可少的一项重要的技术,同样的Rxjava和Retrofit的结合让这个技术解决起来更加的灵活,我们完全可以封装一个适合自的下载框架,简单而且安全! 效果 实现 下载和之前的http请求可以相互独立,所以我们单独给download建立一个工程moudel处理 1.创建service接口 和以前一样,先写接口 注意:Streaming是判断是否写入内存的标示,如果小文件可以考虑不写,一般情况必须写:下载地址需要通过@url动态指定(不适固定的),@head标签是

  • 详解RxJava2 Retrofit2 网络框架简洁轻便封装

    前言 RxJava2.Retrofit2火了有一段时间了,前段时间给公司的项目引入了这方面相关的技术,在此记录一下相关封装的思路. 需求 封装之前要先明白需要满足哪些需求. RxJava2衔接Retrofit2 Retrofit2网络框架异常的统一处理 兼容fastjson(可选) RxJava2内存泄漏的处理 异步请求加入Loading Dialog 依赖 implementation 'io.reactivex.rxjava2:rxandroid:2.0.1' implementation

  • 基于Retrofit2+RxJava2实现Android App自动更新

    本文实例为大家分享了Retrofit2 RxJava2实现Android App自动更新,具体内容如下 功能解析 自动更新可以说已经是App的标配了,很多第三方平台也都支持这个功能,最近手头上的项目需要加入这个App自动更新,考虑到项目里有用到Retrofit2和RxJava2,于是打算使用它俩自己实现这个功能. 分析App自动更新,可以分为以下三个功能点: 1.APK文件的下载 2.下载进度的实时更新显示 3.下载完成后的自动安装 其中比较难的一点是下载进度的实时更新显示,更难的是如何优雅的进

  • Kotlin结合Rxjava+Retrofit实现极简网络请求的方法

    前言 因为最近正在写的项目集成了两个网络请求框架(Volley and Retrofit)对比之下也是选择了Retrofit.既然选择那自然要让自己以后开发更加省力(就是懒).于是我在Retrofit中加入了Rxjava,这也是当下蛮流行的一个请求框架.然后又利用了Kotlin的一些新特性,使网络请求变得特别简单,代码量特别少. Kotlin镇楼 RxJava RxJava学习是一个曲折漫长的过程,但一旦掌握,妙用无穷. 通过这里了解更多:http://www.jb51.net/article/

随机推荐