Kotlin+RxJava2打造自定义Retrofit2解析器,基于Retrofit2.4.0版本

最近大半年都在做java后台和flutter的相关开发,对老本行Android原生开发难免变得生疏,更是没机会用kotlin练练手,于是想将之前用java实现过的retrofit2自定义转换器使用kotlin重写一遍练练手,再稍微熟悉下retrofit2源码。
P.S.平时看别人写文章没觉得,自己写起来感觉好难。如有纰漏,还请海涵。

源码地址:https://github.com/YXLCN/Retrofit2-Converter
,有需要的可以下载demo看看

最终实现效果如下图,成功时在 Consumer onNext 直接返回接口定义的泛型对象,失败则直接触发 Consumer onError 的回调。

@GET("/api/picture")
fun getWallPaperList(@Query("page") page: Int): CustomFlowable
使用效果图

本文的自定义converter是根据 RxJava2CallAdapterFactory 及 GsonConverterFactory 进行的依葫芦画瓢,原理比较简单,如果有地方写的不清楚可以参考下源码。

1、自定义Flowable

自定义Flowable的目的在于方便在converter里根据返回类型进行拦截判断,非必须的步骤,但是如果不使用自定义的Flowable或Observable,偶尔想正常使用Flowable或者Observable进行数据解析时需要进行特殊处理。所以最好自定义一个简单的Flowable。

class CustomFlowable<T> {

    var flowable: Flowable<T>

    constructor(flowable: Flowable<T>) {
        this.flowable = flowable
    }
}
2、自定义AdapterFactory及CallAdapter

重写AdapterFactory及CallAdapter的目的是修改 retrofit.create(xxx.class) 的方法返回的Observable
而在retrofit.create方法中,在loadServiceMethod方法中对ServiceMethod进行了缓存。所以对同一adapter和converter只会分配一次,后续从缓存中读取。

  ServiceMethod<?, ?> loadServiceMethod(Method method) {
    ServiceMethod<?, ?> result = serviceMethodCache.get(method);
    if (result != null) return result;

    synchronized (serviceMethodCache) {
      result = serviceMethodCache.get(method);
      if (result == null) {
        result = new ServiceMethod.Builder<>(this, method).build();
        serviceMethodCache.put(method, result);
      }
    }
    return result;
  }

AdapterFactory 继承于 CallAdapter.Factory,只需重写其中的 get 方法,根据返回类型判断是否返回CallAdapter。
由于之前接口定义的返回值类型为CustomFlowable<WallPaperModel>,是一个参数化类型。所以在调用getRawType获得最外层的类型后,判断为CustomFlowable则进行adapter的分配。
并根据 getParameterUpperBound 获取到泛型类型后传递给CallAdapter进行解析使用。
代码如下:

class RespAdapterFactory<T> : CallAdapter.Factory() {

    override fun get(
        returnType: Type,
        annotations: Array<Annotation>,
        retrofit: Retrofit
    ): CallAdapter<*, *>? {
        val rawType = getRawType(returnType)
        // 对返回类型非 CustomFlowable 的请求不分发 adapter
        if (rawType != CustomFlowable::class.java) {
            return null
        }

        val observableType = getParameterUpperBound(0, returnType as ParameterizedType)
        return CustomCallAdapter<BaseModel<T>>(observableType)
    }
}

自定义CallAdapter继承自Retrofit2的CallAdapter,只需重写其中的adapter方法。
在RxJava2CallAdapter的adapt方法中根据是否异步,存在CallExecuteObservable和CallEnqueueObservable两种方式,由于两者都是final类,直接复制一个出来即可,不需进行额外操作。我这里选择的非异步的方式。

class CustomCallAdapter<R>: CallAdapter<R, Any> {

    private var type: Type

    constructor(type: Type) {
        this.type = type
    }

    override fun adapt(call: Call<R>): Any {
        val observable = CallExecuteObservable(call) as Observable<Response<BaseModel<R>>>
        val bodyObservable = CustomBodyObservable(observable)
        // 由于接口定义的返回值为CustomFlowable,所以这里用 CustomFlowable 进行装饰
        return CustomFlowable(bodyObservable.toFlowable(BackpressureStrategy.LATEST))
    }

    override fun responseType(): Type {
        return type
    }
}

在CustomBodyObservable继承于Observable,配合继承于Observer的BodyObserver,在onNext方法中进行接口状态码的判断,进行统一的错误处理,请求的状态码异常时直接抛出错误,交由Consumer onError进行处理。

class CustomBodyObservable<T> : Observable<T> {
    private val responseObservable: Observable<Response<BaseModel<T>>>

    constructor(upstream: Observable<Response<BaseModel<T>>>) : super() {
        responseObservable = upstream
    }

    override fun subscribeActual(observer: Observer<in T>) {
        // 用 BodyObserver 装饰了原本的 observer,用于对异常情况进行统一处理
        responseObservable.subscribe(BodyObserver(observer))
    }

    private class BodyObserver<R> internal constructor(private val observer: Observer<in R>) :
        Observer<Response<BaseModel<R>>> {
        private var terminated = false

        override fun onSubscribe(disposable: Disposable) {
            observer.onSubscribe(disposable)
        }

        override fun onNext(response: Response<BaseModel<R>>) {
            Logger.i("BodyObserver onNext : ")
            val body = response.body()
            if (response.isSuccessful && body != null) {
                // 对异常情况进行统一处理
                if (body.mCode == 0) {
                    // 成功
                    Logger.i("onNext 请求成功, body.mResult : \n${body.mData}")
                    observer.onNext(body.mData!!)
                } else {
                    val apiErrorCode: Int = body.mCode
                    val apiErrorMessage: String? = body.mMessage
                    //业务失败
                    val t = DadaThrowable(apiErrorCode, apiErrorMessage)

                    try {
                        observer.onError(t)
                    } catch (inner: Throwable) {
                        Exceptions.throwIfFatal(inner)
                        RxJavaPlugins.onError(CompositeException(t, inner))
                    }
                }
            } else {
                terminated = true
                val t: Throwable = HttpException(response)
                try {
                    observer.onError(t)
                } catch (inner: Throwable) {
                    Exceptions.throwIfFatal(inner)
                    RxJavaPlugins.onError(CompositeException(t, inner))
                }
            }
        }

        override fun onComplete() {
            if (!terminated) {
                observer.onComplete()
            }
        }

        override fun onError(throwable: Throwable) {
            if (!terminated) {
                observer.onError(throwable)
            } else {
                // This should never happen! onNext handles and forwards errors automatically.
                val broken: Throwable = AssertionError(
                    "This should never happen! Report as a bug with the full stacktrace."
                )
                broken.initCause(throwable)
                RxJavaPlugins.onError(broken)
            }
        }
    }

    class DadaThrowable(val apiErrorCode: Int = -1, val apiErrorMessage: String? = "unknown error") :
        Throwable() {

        override val message: String
            get() = "$apiErrorCode, 错误原因 : $apiErrorMessage"
    }
}
3、自定义ConverterFactory及Converter

ConverterFactory和Converter都很简单,重写对应的方法,根据Retrofit的接口的返回类型对converter进行分配就行。Converter如下

class CustomBodyConverter<T>(private val type: Type) :  Converter<ResponseBody, BaseModel<T>> {

    override fun convert(value: ResponseBody): BaseModel<T> {
        try {
            val respString = value.string()
//            Logger.i("convert ---> respString : $respString")

            val model = BaseModel<T>()
            val jsonObject = JSONObject(respString)
            model.mMessage = jsonObject.getString("message")
            model.mCode = jsonObject.getInt("code")

            val result = jsonObject.getString("data")
            if (!TextUtils.isEmpty(result) && !"null".equals(result, true)) {
                when (type) {
                    JsonObject::class.java,
                    JSONObject::class.java -> {
                        Logger.i("convert ---> JSONObject ")
                        model.mData = JSONObject(result) as T
                    }
                    JsonArray::class.java -> {
                        Logger.i("convert ---> JsonArray ")
                    }
                    else -> {
                        model.mData = Gson().fromJson(result, this.type)
                    }
                }
            } else {
                val rawType: Class<*> = TypeUtil.getRawType(type)
                if (rawType == String.javaClass) {
                    model.mData  = "" as T
                } else {
                    model.mData  = Gson().fromJson<T>("{}", type)
                }
            }
            Logger.i("convert ---> model : $model")

            return model
        } catch (e: Exception) {
            e.printStackTrace()
            return BaseModel.unknownError(e)!!
        }
    }
}

至此,自定义converter基本完毕,retrofit2的源码不算太难,还支持高度定制,可以满足Android开发的各种需求了。

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