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

本文涉及的产品
密钥管理服务KMS,1000个密钥,100个凭据,1个月
简介: 优雅使用Retrofit,在协程时代遨游安卓网络请求(二)

请求参数加密and响应报文解密


  为了数据安全,大多数请求和响应报文都是AES加密的,因此我们也需要Retrofit帮我们完成这部分逻辑,实际上这部分逻辑依然是交给Okhttp完成。和添加公参的过程类似,我们依然是新增拦截器,只不过这次还需要对响应报文进行解密处理。

  依然是废话不多说,看代码!


/**
 * 加解密拦截器基类
 */
abstract class BaseEncryptAndDecryptInterceptor : Interceptor{
    final override fun intercept(chain: Interceptor.Chain): Response {
        val originRequest = chain.request()
        return decryptResponse(chain.proceed(
            originRequest.body.run {
                //如果body为空,则直接往下传
                if (this == null) {
                    originRequest
                }
                //如果body不为空,则解密
                else {
                    originRequest.newBuilder().apply {
                        method(
                            originRequest.method,
                            encrypt(this@run)
                        )
                    }.build()
                }
            }
        ))
    }
    //加密参数
    @Throws(IOException::class)
    abstract fun encrypt(requestBody: RequestBody): RequestBody
    //解密响应报文
    @Throws(IOException::class)
    abstract fun decryptResponse(response: Response): Response
}

  使用起来也非常简单,只要实现了那两个抽象方法即可,RequestBody和Response都有一个类似克隆的方法,以便于返回一个全新的对象供修改。以下是笔者的实现(省略了部分代码,主要是具体加密部分,你可以替代为你们公司的密钥工具)。


override fun encrypt(requestBody: RequestBody): RequestBody {
    return requestBody.string()//1.转成String
        .encrypt()//2.加密
        .toRequestBody(requestBody.contentType())//3.转成requestBody,保留原来的contentType
}
override fun decryptResponse(response: Response): Response {
    //如果不成功则不尝试解密
    if (!response.isSuccessful) {
        return response
    }
    val responseBody = response.body ?: return response
    return response.newBuilder()
        .body(responseBody.encrypt())
        .build()
}

  讲了2个关于okhttp的拦截器的逻辑定制的做法,想必聪明的读者已经可以举一反三了,利用okhttp的拦截器我们可以实现很多客制化逻辑,例如重试逻辑等,发挥你的想象力,动手尝试吧!等等,好像我们还没有来到Retrofit层面呢。

  别急,下面即将带领你进入Retrofit的自定义注解+自定义注解逻辑的世界!


Retrofit自定义注解


  Retrofit给我们提供了好多有用的注解,但是Retrofit却没有给我们增加自定义注解的机会,所有Retrofit预设的注解的解析过程都是硬编码在一堆if-else语句里面的,也就是说:Retrofit并没有在这个层面增加类似CallAdapter的扩展性。

  那我们该怎么办呢?实则Retrofit官方早就已经想到了这一层了,于是在Retrofit构建OKhttp的Request的过程中,通过给Request新增一个tag,把方法通过tag传到这个Request上面,具体我们可以看源码,具体在Retrofit源码的RequestFactory.java中。


okhttp3.Request create(Object[] args) throws IOException {
    //...省略部分源码
    RequestBuilder requestBuilder =
        new RequestBuilder(
            httpMethod,
            baseUrl,
            relativeUrl,
            headers,
            contentType,
            hasBody,
            isFormEncoded,
            isMultipart);
    //...省略部分源码 
    //新增一个tag,把方法添加到tag里面去
    return requestBuilder.get().tag(Invocation.class, new Invocation(method, argumentList)).build();
}

  既然Retrofit给Request添加了一个tag,tag中包含了当前的方法,那么我们就可以通过解析request来拿到我们想要的注解,然后通过注解本身的信息,来完成一些逻辑定制了。

  同样的,让我们重新回到okhttp的拦截器中去,直接看代码!


/**
 * 返回某个Retrofit定义在方法上的注解,例如[POST],[GET]
 */
fun <T : Annotation> Request.getMethodAnnotation(annotationClass: Class<T>): T? {
    return tag(Invocation::class.java)?.method()?.getAnnotation(annotationClass)
}

  可恶,代码居然如此简单,实际上就是通过类型来找到某个tag,再通过tag来找到我们定义的方法,紧接着找到方法上面的注解即可!

  为了讲明白如何定制逻辑,我们先假设一个场景,我们有一部分的接口是需要给url后面接一个参数,例如?version=2,那么我们应该怎么做呢?只需要三步即可:

  1. 新增一个注解,包含一个属性versionCode


/**
 * 用于标记retrofit接口方法,声明当前请求的new_versioncode的值
 */
@Target(AnnotationTarget.FUNCTION)
annotation class VersionCode(
    //版本号,
    val versionCode: Int,
)
  1. 在Retrofit方法中使用该注解。


@POST("/friend/list")
@VersionCode(versionCode = 2)
suspend fun requestFriend(
    @Body friendRequestParam: FriendRequestParam
): NetworkResult<FriendBean>
  1. 在拦截器中获取到该注解,并修改Request


/**
 * 后台加密版本号控制,主要修改new_versioncode字段的值
 */
class VersionControlInterceptor @Inject constructor() : Interceptor {
    companion object {
        //需要添加的前缀
        private const val VERSION_CODE_PREFIX = "?versioncode="
    }
    override fun intercept(chain: Interceptor.Chain): Response {
        val originRequest = chain.request()
        val annotation = originRequest.getMethodAnnotation(VersionCode::class.java)
        return chain.proceed(
            //没加注解,跳过处理
            if (annotation == null)
                originRequest
            //在原url中拼接?new_versioncode=x字符串
            else
                originRequest.newBuilder()
                    .url("${originRequest.url}$VERSION_CODE_PREFIX${annotation.versionCode}")
                    .build()
        )
    }
}

  大功告成!我们通过查找request中的tag的方式找到原始的method,然后再通过method找到了我们需要的注解,这样就打通了Retrofit和okhttp在定制逻辑上的关系了,通过在接口方法上增加注解的方式,让逻辑定制更加直观!

很感谢你看到这里,这篇已经结束了,下一篇我将继续讲讲Retrofit的一些全局操作。


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