优雅使用Retrofit,在协程时代遨游安卓网络请求(一)下

简介: 优雅使用Retrofit,在协程时代遨游安卓网络请求(一)

三:重写CallAdapter


  所谓的CallAdapter,就是对原来的Call进行适配,对方法的返回值进行扩展,废话不多说,直接看代码。


internal class ApexResponseCallDelegate<T>(private val proxyCall: Call<T>) :
    Call<NetworkResult<T>> {
    override fun enqueue(callback: Callback<NetworkResult<T>>) =
        proxyCall.enqueue(object : Callback<T> {
            override fun onResponse(call: Call<T>, response: Response<T>) {
                //得到响应,将被代理的Call的响应包装成NetworkResult后返回给代理者
                callback.onResponse(
                    this@ApexResponseCallDelegate,
                    Response.success(
                        //将Retrofit中的Response转成NetworkResult
                        response.toNetworkResult()
                    )
                )
            }
            override fun onFailure(call: Call<T>, t: Throwable) {
                //失败了,将被代理的Call的异常包装成NetworkResult后返回给代理者
                callback.onResponse(
                    this@ApexResponseCallDelegate,
                    //将Exception转成NetworkResult
                    Response.success(t.toExceptionResult())
                )
            }
        })
    //下面都是不变的代理方法
    override fun isExecuted(): Boolean = proxyCall.isExecuted
    override fun cancel() = proxyCall.cancel()
    override fun isCanceled(): Boolean = proxyCall.isCanceled
    override fun request(): Request = proxyCall.request()
    override fun timeout(): Timeout = proxyCall.timeout()
    override fun clone(): Call<NetworkResult<T>> =
        ApexResponseCallDelegate(proxyCall.clone())
    override fun execute(): Response<NetworkResult<T>> = throw NotImplementedError()
}
//相关的扩展方法如下:
fun <T> Response<T>.toNetworkResult(): NetworkResult<T> =
   try {
        if (isSuccessful) {
            toSuccessResult()
        } else {
            toServerErrorResult()
        }
    } catch (t: Throwable) {
        t.toExceptionResult()
    }
fun <T> Response<T>.toSuccessResult(): Success<T> {
    return Success(this)
}
fun <T> Response<T>.toServerErrorResult(): ServerError<T> {
    return ServerError(this)
}
fun <T> Throwable.toExceptionResult(): NetworkResult.Failure.Exception<T> {
    return NetworkResult.Failure.Exception(this)
}

  代码特别多,有一点需要注意的是,无论被代理的Call的网络请求是成功还是失败,最终返回的都是Response.success。这一点确保了我们定义的方法,无论如何都不会对外抛出异常,无论网络请求成功还是失败,都会当做某种“成功”来处理,你可以理解成“网络请求结束”,原本网络请求失败的结果,已经被包裹在NetworkResult里面了。

  下面是CallAdapter本体,以及附属的工厂类


class ApexCallAdapterFactory @Inject constructor() : CallAdapter.Factory() {
    class ApexCallAdapter constructor(
        private val resultType: Type
    ) : CallAdapter<Type, Call<NetworkResult<Type>>> {
        override fun responseType() = resultType
        override fun adapt(call: Call<Type>): Call<NetworkResult<Type>> =
            ApexResponseCallDelegate(call)
    }
    override fun get(
        returnType: Type,
        annotations: Array<out Annotation>,
        retrofit: Retrofit
    ): ApexCallAdapter? = when (getRawType(returnType)) {
        Call::class.java -> {
            //判断方法返回值
            val callType = getParameterUpperBound(0, returnType as ParameterizedType)
            //只有返回值是NetworkResult的才会使用本Adapter
            when (getRawType(callType)) {
                NetworkResult::class.java -> {
                    val resultType = getParameterUpperBound(0, callType as ParameterizedType)
                    ApexCallAdapter(resultType)
                }
                else -> null
            }
        }
        else -> null
    }
}

  代码也挺多的,本质上是定义了一个Adapter以及工厂类,工厂类的get用于判断当前的方法是否适合使用工厂类对应的Adapter(因为Retrofit允许同时存在多个Adapter以应对不同的返回值,因此我们需要判断方法返回值是否是NetworkResult)

  最后的最后,在Retrofit的构造方法中,添加我们自己实现的Adapter工厂类即可,Retrofit就会识别出我们定义的NetworkResult并正确的返回结果啦,记得要把方法改成suspend


Retrofit.Builder()
    .baseUrl(baseUrl)
    .addCallAdapterFactory(callAdapterFactory)
    .client(okHttpClient)
    .build()
//请求结果
val result=friendService.requestFriend(FriendService.FriendRequestParam(nextPage))
when(result){
    //判断类型
    is Success->{}
    is Exception->{}
}

  每次都要手写when代码着实有些蛋疼,让我们给NetworkResult扩充一些方法,自动帮我们完成判断的逻辑


/**
 * 网络请求成功时操作
 */
inline fun <reified T> NetworkResult<T>.ifSuccess(action: (NetworkResult.Success<T>) -> Unit): NetworkResult<T> {
    if (this is NetworkResult.Success) action(this)
    return this
}
/**
 * 网络请求中,服务器已响应但HTTP协议出现错误时(例如404,502)操作
 */
inline fun <reified T> NetworkResult<T>.ifServerError(action: (NetworkResult.Failure.ServerError<T>) -> Unit): NetworkResult<T> {
    if (this is NetworkResult.Failure.ServerError) action(this)
    return this
}
/**
 * 网络请求中,出现异常时(例如解析JSON异常,超时异常,连接网络失败异常等)操作
 */
inline fun <reified T> NetworkResult<T>.ifException(action: (NetworkResult.Failure.Exception<T>) -> Unit): NetworkResult<T> {
    if (this is NetworkResult.Failure.Exception) action(this)
    return this
}
/**
 * 网络请求失败(包括[ifServerError]和[ifException]两种情况)
 */
inline fun <reified T> NetworkResult<T>.ifFailure(action: (errorMsg: String) -> Unit): NetworkResult<T> {
    ifServerError {
        //errorBodyString()方法在下篇文章中会提到
        action(it.errorBodyString())
    }.ifException {
        //exceptionMessage()方法在下篇文章中会提到
        action(it.exceptionMessage())
    }
    return this
}

  接下来使用起来就是这样了(切记在协程作用域中调用本方法哦,因为是suspend方法)


searchRepository.search(SearchService.SearchRequestBody(key)).ifSuccess {
    //成功时
}.ifFailure {
    //失败时
}.ifServerError {
    //服务器内部错误时
}.ifException {
    //发生了异常时
}

文章到这里已经结束了,第一篇中我们实现了一套CallAdapter,
这套adpter的意义是消除了原来的回调式代码,让回调风格代码“拉平”了,
变成了我们熟悉的同步代码,下一篇我将解决几个项目中遇到的常见问题。

相关文章
|
22天前
|
安全 网络安全 Android开发
安卓与iOS开发:选择的艺术网络安全与信息安全:漏洞、加密与意识的交织
【8月更文挑战第20天】在数字时代,安卓和iOS两大平台如同两座巍峨的山峰,分别占据着移动互联网的半壁江山。它们各自拥有独特的魅力和优势,吸引着无数开发者投身其中。本文将探讨这两个平台的特点、优势以及它们在移动应用开发中的地位,帮助读者更好地理解这两个平台的差异,并为那些正在面临选择的开发者提供一些启示。
113 56
|
13天前
|
安全 网络安全 数据安全/隐私保护
网络安全与信息安全:关于网络安全漏洞、加密技术、安全意识等方面的知识分享安卓与iOS开发中的线程管理比较
【8月更文挑战第30天】本文将探讨网络安全与信息安全的重要性,并分享关于网络安全漏洞、加密技术和安全意识的知识。我们将了解常见的网络攻击类型和防御策略,以及如何通过加密技术和提高安全意识来保护个人和组织的信息安全。
|
13天前
|
安全 网络安全 Android开发
探索安卓开发之旅:从新手到专家网络安全与信息安全:防范网络威胁,保护数据安全
【8月更文挑战第29天】在这篇技术性文章中,我们将踏上一段激动人心的旅程,探索安卓开发的世界。无论你是刚开始接触编程的新手,还是希望提升技能的资深开发者,这篇文章都将为你提供宝贵的知识和指导。我们将从基础概念入手,逐步深入到安卓开发的高级主题,包括UI设计、数据存储、网络通信等方面。通过阅读本文,你将获得一个全面的安卓开发知识体系,并学会如何将这些知识应用到实际项目中。让我们一起开启这段探索之旅吧!
|
21天前
|
Java Android开发 Kotlin
Android项目架构设计问题之要在Glide库中加载网络图片到ImageView如何解决
Android项目架构设计问题之要在Glide库中加载网络图片到ImageView如何解决
23 0
|
21天前
|
Java Android开发 开发者
Android项目架构设计问题之使用Retrofit2作为网络库如何解决
Android项目架构设计问题之使用Retrofit2作为网络库如何解决
29 0
|
3月前
|
缓存 网络协议 安全
Android网络面试题之Http基础和Http1.0的特点
**HTTP基础:GET和POST关键差异在于参数传递方式(GET在URL,POST在请求体),安全性(POST更安全),数据大小限制(POST无限制,GET有限制),速度(GET较快)及用途(GET用于获取,POST用于提交)。面试中常强调POST的安全性、数据量、数据类型支持及速度。HTTP 1.0引入了POST和HEAD方法,支持多种数据格式和缓存,但每个请求需新建TCP连接。**
40 5
|
3月前
|
缓存 JSON 网络协议
Android面试题:App性能优化之电量优化和网络优化
这篇文章讨论了Android应用的电量和网络优化。电量优化涉及Doze和Standby模式,其中应用可能需要通过用户白名单或电池广播来适应限制。Battery Historian和Android Studio的Energy Profile是电量分析工具。建议减少不必要的操作,延迟非关键任务,合并网络请求。网络优化包括HTTPDNS减少DNS解析延迟,Keep-Alive复用连接,HTTP/2实现多路复用,以及使用protobuf和gzip压缩数据。其他策略如使用WebP图像格式,按网络质量提供不同分辨率的图片,以及启用HTTP缓存也是有效手段。
64 9
|
3月前
|
安全 网络协议 算法
Android网络基础面试题之HTTPS的工作流程和原理
HTTPS简述 HTTPS基于TCP 443端口,通过CA证书确保服务器身份,使用DH算法协商对称密钥进行加密通信。流程包括TCP握手、证书验证(公钥解密,哈希对比)和数据加密传输(随机数加密,预主密钥,对称加密)。特点是安全但慢,易受特定攻击,且依赖可信的CA。每次请求可能复用Session ID以减少握手。
45 2
|
3月前
|
缓存 网络协议 Android开发
Android网络面试题之Http1.1和Http2.0
HTTP/1.1 引入持久连接和管道机制提升效率,支持分块传输编码和更多请求方式如PUT、PATCH。Host字段指定服务器域名,RANGE用于断点续传。HTTP/2变为二进制协议,实现多工处理,头信息压缩和服务器推送,减少延迟并优化资源加载。HTTP不断发展,从早期的简单传输到后来的高效交互。
41 0
Android网络面试题之Http1.1和Http2.0
|
3月前
|
JSON Java API
【Android】使用 Retrofit2 发送异步网络请求的简单案例
**摘要:** Retrofit是Android和Java的HTTP客户端库,简化了RESTful API交互。它通过Java接口定义HTTP请求,并提供注解管理参数、HTTP方法等。要使用Retrofit,首先在AndroidManifest.xml中添加`INTERNET`权限,然后在`build.gradle`中引入Retrofit和Gson依赖。创建服务器响应数据类和描述接口的接口,如`Result`和`Api`。通过Retrofit.Builder配置基础URL并构建实例,之后调用接口方法创建Call对象并发送异步请求。
103 1