MVP-Dagger2-Rxjava2
Android Http 网络请求封装,使用 Kotlin+Moshi+Coroutines+retrofit 等封装处理 Http 请求,支持多个域名多态数据返回。封装要达到的目的特性就一个:简洁的同步代码风格处理网络异步请求!
GitHub 封装演示代码:https://github.com/AnyLifeZLB/Android-Architecture
为什么要使用以下技术栈:
- 协程 Coroutines 而不是 rxjava:rxjava 是个好东西但不是官方的,学习成本也高,后期官方推荐 kotlin,引入协程简洁优雅处理网络请求
- Moshi 而不是 Gson: Moshi 天生支持 Kotlin 空安全,使用 CodeGen 生成代码比 Gson 反射注解效率高
- Retrofit 而不是直接 OKHTTP :因为 Retrofit 使用注解+动态代理来优雅的封装调度 OKHTTP 去执行
- 哪怕是使用自家的 OkHttp,哪怕底层调用的始终是 OkHttpClient,也需要依赖一个抽象的 retrofit2.Call 接口,依赖于抽象,而不是依赖于具体
- 同步的方式写异步请求。简洁,简洁,目标只有一个:使用快捷方便简洁 !
封装能达到的效果/目标
- 多域名 Host,多个环境,多态返回数据处理
- 使用最新稳定的技术方案实现快捷稳定的请求交互
- 封装各种 Http 异常处理,服务器返回的各种异常 json 数据
1.关于 Retrofit
Retrofit 的设计非常插件化而且轻量级,接口设计真的是非常高内聚而且低耦合,精妙的设计是极佳的研究素材。Retrofit 底层请求 默认由 OKHTTP 执行, Retrofit 主要负责调度;其中 Retrofit 中定义了 4 个接口:
Callback
接口
这个接口就是 retrofit 请求数据返回的接口,只有两个方法- void onResponse(Response
response); void onFailure(Throwable t);
Converter
这个接口主要的作用就是将 HTTP 返回的数据解析成 Java 对象,主要有 Xml、Gson、protobuf 等等,你可以在创建 Retrofit 对象时添加你需要使用的 Converter 实现(看上面创建 Retrofit 对象的代码)Call
这个接口主要的作用就是发送一个 HTTP 请求,Retrofit 默认的实现是 OkHttpCall,你可以根据实际情况实现你自己的 Call 类,这个设计和 Volley 的 HttpStack 接口设计的思想非常相似,子类可以实现基于 HttpClient 或 HttpUrl Connection 的 HTTP 请求工具,这种设计非常的插件化,而且灵活 CallAdapter
网络请求执行器(Call)的适配器 CallAdapter 用于对原始 Call 进行再次封装,如 Call到 Observable 或者本 SDK 中的 HttpResult
- void onResponse(Response
2.协程 Coroutines
「协程 Coroutines」源自 Simula 和 Modula-2 语言,这个术语早在 1958 年就被 Melvin Edward Conway 发明并用于构建汇编程序,说明协程是一种编程思想,并不局限于特定的语言; 协程设计的初衷是为了解决并发问题,让 「协作式多任务」 实现起来更加方便。
在 Android 中使用协程的环境分为下面五种环境:
- 网络请求
- 回调处理
- 数据库操作
- 文件操作
- 其他耗时操作
3.数据返回封装
字段 | 说明 |
---|---|
code | 业务返回状态码,注意业务状态码不要和标准 Http 状态码混淆 |
message | 返回补充说明信息 |
data[T] | 期待正常返回的业务数据 |
假设公司各个业务服务器返回的 Http Json 数据格式都差不多三个大字段 code[int] + msg[str] +data[T] ,名称允许自定义不同 这里我们统一约定称含有三个类似字段为包装数据 Http wrapper data 定义为 HttpWrapper.kt,每个 Http 请求正常都会含有这三个字段, data 字段很自然的我们会使用范型 T 来表示,这也是 Http 请求回来实际参与业务处理的部分 .
- [code] 本字段表示业务服务是否获取了期待的数据,一般 0 或 200 表示成功,其他值表示没有获取正常期望的业务数据如权限不足 另外,这个业务 code 要和标准 Http 请求响应的编码区分清除,标准 Http 2xx 表示成功,4xx 表示客户端错误,5xx 是服务器错误 强烈建议业务 code 的返回值不要和标准 Http 请求响应的编码有重合避开[2xx,5xx]范围
- [msg] msg 是对业务 code 的补充说明,可以简单的是 OK 或者对应的异常提示信息
如果你的 App 请求的业务服务器返回 json 不包含类似这三字段结构也没关系:不是标准的 HttpWrapper 了,不需要实现 HttpWrapper impl,相应的判断需要使用的时候进行补齐。
//不是标准的 HttpWrapper
viewModelScope.launch {
when (val result = EuropeanaApiService.getService().getEuropData()) {
is HttpResult.Success -> {
if(result.data.success){
Log.e("Success", MoshiUtils.toJson(result.data.items)) //多一层链路.item
}else{
Log.e("code is not ok","")
}
}
is HttpResult.Failure -> {
Log.e("Failure", result.message + " ----- " + result.code)
}
}
}
而有标准 HttpWrapper 结构就能写法上更简洁,少了一层判断和一层数据拆箱 result.data.items
//标准的 HttpWrapper
viewModelScope.launch {
when (val result = ExceptionApiService.getService().status404()) {
is HttpResult.Success -> {
Log.e("Success", MoshiUtils.toJson(result.data))
}
is HttpResult.Failure -> {
Log.e("Failure", result.message + " ----- " + result.code)
}
}
}
在 HttpResponseCall<> 类中我们根据 http 请求是否成功,4xx,5xx 分别对应处理返回 HttpResult
- Success
成功获取期待的数据 data 范型 T - Failure(msg,code) 包含了业务错误和 Http 请求异常(timeout,networkerror)
更多请移步 GitHub 下载代码查看,欢迎建议改进。
4.Moshi 解析空安全处理,默认值情况
这个情况非常多,大部分的闪退和异常源于数据的异常,比如某个必有字段没有返回,导致异常 还有就是有些字段需要设置后端没有返回的时候的默认值
5.LiveData 还是 Flow ?
为了简单演示,Demo 中使用的是 LiveData,如果你的项目都用 Kotlin 编写了,建议迁移到 Flow
从 LiveData 迁移到 Kotlin 数据流:https://juejin.cn/post/6979008878029570055
5.接入使用
参考文档
- Retrofit 2.0 源码分析 https://www.jianshu.com/p/0c055ad46b6c
- 从架构角度看 Retrofit https://www.jianshu.com/p/f57b7cdb1c99