Retrofit 妙用，拒绝重复代码！ android后端

文章图片

由于后台返回统一数据结构，比如 code, data, message; 使用过 Retrofit 的同学一定定义过类似 BaseResponse 这种类，但是 BaseResponse 的处理逻辑都大同小异，每次都写着实让人很烦，有没有什么好的方式解决这一痛点呢？本文讲介绍一种优雅的方式来解决这一问题。
背景
当我们打开 Retrofit 的官方文档时，官方的例子是这样的：

public interface GitHubService { @GET("users/{user}/repos") Call> listRepos(@Path("user") String user); }

而到了我们自己的项目，大多情况确实这样的：

public interface UserService { @GET("/users") Call>> getAllUsers(); }

而不同的公司，有不同的数据结构，不过都是大同小异，比如 code, data, message 或者 status, data, message, 每次都要写什么 code == 0 之类的代码，无聊不说，主要一点技术含量都没有。。。
如果我们要是能把 BaseResponse 去掉，岂不美哉？就像下面的定义一样：

public interface UserService { @GET("/users") Call> getAllUsers(); }

如果是 Kotlin 就更爽了，直接 suspend 方法走起。

interface UserService { @GET("/users") suspend fun getAllUsers() : List }

1.Convert.Factory 中被忽略的参数

public interface Converter { abstract class Factory { // 参数 annotations 是 Method 上的注解 public @Nullable Converter responseBodyConverter( Type type, Annotation[] annotations, Retrofit retrofit) { return null; } } }public final class GsonConverterFactory extends Converter.Factory { // Retrofit 官方的 Converter.Factory 并没有使用 annotations 这个参数 @Override public Converter responseBodyConverter( Type type, Annotation[] annotations, Retrofit retrofit) { TypeAdapter adapter = gson.getAdapter(TypeToken.get(type)); return new GsonResponseBodyConverter<>(gson, adapter); } }

从上面的代码不难看出，在实现 Convert.Factory 的时候， Retrofit 官方的实现并没有使用 annotations 这个参数，而这个参数恰恰是移除 BaseResponse的关键。
2.实现方式
其实实现方案很简单，就是给 Method 再加一个自定义注解，然后对应实现一个 Converter.Factory, 再这个 Converter.Factory 类中判断 Method 是否存在我们自定义的注解，如果有就将数据进行转换，最后交给 Gson 进行解析。
项目地址：Convex
https://github.com/ParadiseHe...
实现细节
数据转换接口：

interface ConvexTransformer { // 将原始的 InputStream 转换成具体业务数据的 InputStream // 相当于获取 code, data, message 的数据流转换成只有 data 的数据流 @Throws(IOException::class) fun transform(original: InputStream): InputStream }

自定义注解：

@Target(AnnotationTarget.CLASS, AnnotationTarget.FUNCTION) @Retention(AnnotationRetention.RUNTIME) annotation class Transformer(val value: KClass)// 有了这个自定义注解，我们就可以给 Method 添加这个注解了 interface UserService { @GET("xxx") @Transformer(XXXTransformer::class) fun xxxMethod() : Any }

Convert.Factory 实现类：

class ConvexConverterFactory : Converter.Factory() { override fun responseBodyConverter( type: Type, annotations: Array, retrofit: Retrofit ): Converter? { // 获取 Method 上的 Transformer 注解 // 从而确定使用那个具体的 ConvexTransformer 类 return annotations .filterIsInstance() .firstOrNull()?.value ?.let { transformerClazz -> // 获取可以处理当前返回值的 Converter // ConvexConverterFactory 只做数据流转，具体数据序列化 // 交给类似 GsonConverterFactory retrofit.nextResponseBodyConverter( this, type, annotations )?.let { converter -> // 如果有能处理返回值的 Converter 创建代理的 ConvexConveter ConvexConverter(transformerClazz, converter) } } } }class ConvexConverter constructor( private val transformerClazz: KClass, private val candidateConverter: Converter ) : Converter {@Suppress("UNCHECKED_CAST") @Throws(IOException::class) override fun convert(value: ResponseBody): T? { // 从 Convex 中获取 ConvexTransformer // Convex 是一个 ServiceRegistry, 用于存储 ConvexTransformer // 如果没有 ConvexTransformer 便会通过反射创建对应的 ConvexTransformer // 并保存进 Convex 中等待下次使用 return Convex.getConvexTransformer(transformerClazz.java) .let { transformer -> // 转换数据流，这里就是将 code, data, message 数据流转换成 data 数据流 transformer.transform(value.byteStream()).let { responseStream -> ResponseBody.create(value.contentType(), responseStream.readBytes()) } }?.let { responseBody -> // 使用具体 Converter 将 data 数据流转换成具体的 data candidateConverter.convert(responseBody) as T? } } }

3.Convex 使用
添加依赖

dependencies { implementation "org.paradisehell.convex:convex:1.0.0" }

实现 ConvexTransformer

private class TestConvexTransformer : ConvexTransformer { @Throws(IOException::class) override fun transform(original: InputStream): InputStream { TODO("Return the business data InputStream.") } }

将 ConvexConverterFactory 加入 Retrofit 中

Retrofit.Builder() .baseUrl("https://test.com/") // ConvexConverterFactory 一定放在最前面 .addConverterFactory(ConvexConverterFactory()) .addConverterFactory(GsonConverterFactory.create()) .build()

定义 Service 接口

interface XXXService { @GET("/users") // 使用 Transformer 注解，添加具体的 ConvexTransformer 实现类 @Transformer(TestConvexTransformer::class) suspend fun getAllUsers() : List }

4.例子
首先非常感谢 WanAndroid 提供的免费 API。
https://www.wanandroid.com/bl...

// 1. 定义 BaseResponse // 用于处理后台返回的数据进行反序列化，拿到最终的 data 数据 data class BaseResponse( @SerializedName("errorCode") val errorCode: Int = 0, @SerializedName("errorMsg") val errorMsg: String? = null, @SerializedName("data") val data: T? = null )// 2. 实现 ConvexTransformer // 用户将后台返回的数据流转为具体的 data 数据 class WanAndroidConvexTransformer : ConvexTransformer { private val gson = Gson()@Throws(IOException::class) override fun transform(original: InputStream): InputStream { // 先反序列化为 BaseResponse val response = gson.fromJson>( original.reader(), object : TypeToken>() { }.type ) // 判断 Response 是否成功 // 成功则将 data 数据转换成 InputStream, 最后由具体 Converter 处理 if (response.errorCode == 0 && response.data != null) { return response.data.toString().byteInputStream() } throw IOException( "errorCode : " + response.errorCode + " ; errorMsg : " + response.errorMsg ) } }// 3. 定义模型数据 data class Article( @SerializedName("id") val id: Int = 0, @SerializedName("link") val link: String? = null, @SerializedName("author") val author: String? = null, @SerializedName("superChapterName") val superChapterName: String? = null )// 4. 定义 Service interface WanAndroidService { @GET("/article/top/json") // 为改方法指定 ConvexTransformer, 这样就可以将 BaseResponse 转换成 data 了 @Transformer(WanAndroidConvexTransformer::class) suspend fun getTopArticles(): List }// 5. 定义 Retrofit private val retrofit by lazy { Retrofit.Builder() .baseUrl("https://wanandroid.com/") // 一定将 ConvexConverterFactory 放在所有 Converter.Factory 的前面 .addConverterFactory(ConvexConverterFactory()) .addConverterFactory(GsonConverterFactory.create()) .build() }private val wanAndroidService by lazy { retrofit.create(WanAndroidService::class.java) }// 6. 执行 Service 方法 lifecycleScope.launch(Main) { val result = withContext(IO) { // 需要进行 try catch 操作, 因为请求失败会抛出异常 runCatching { wanAndroidService.getTopArticles() }.onSuccess { return@withContext it }.onFailure { it.printStackTrace() return@withContext it } } // 打印数据 // 成功打印数据列表，失败打印 Exeception printlin(result) }

小结
完美，以后定义 Method 再也不用写 BaseResponse 了，BaseResponse 终于可以统一处理了。
而且这种方案还支持多种不同的数据类型，因为不同的 Method 可以指定不同的 ConvexTransformer, 而到具体的业务处理根本不用关系 BaseResponse 是如何处理的，因为具体的业务代码拿到的都是具体的 Data 数据。
不得不佩服 Retrofit 的设计，Converter.Factory 留出了 annotations 这个参数，可扩展性简直强到爆，致敬 Square, Salute~~
Android高级开发系统进阶笔记、最新面试复习笔记PDF，我的GitHub
文末 【Retrofit 妙用，拒绝重复代码！】您的点赞收藏就是对我最大的鼓励！
欢迎关注我，分享Android干货，交流Android技术。
对文章有何见解，或者有何技术问题，欢迎在评论区一起留言讨论！