@

前言

Retrofit 从 2.6.0 版本开始, 内置了对 Kotlin Coroutines 的支持. 我们统一处理异常及响应状态码, 使用DSL 让代码更加漂亮整洁

先导包:

//协程
implementation "org.jetbrains.kotlinx:kotlinx-coroutines-core:1.4.3"
implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-android:1.4.3' // Retrofit
implementation "com.squareup.retrofit2:retrofit:2.9.0"
implementation "com.squareup.retrofit2:converter-gson:2.9.0"
implementation "com.squareup.okhttp3:logging-interceptor:4.2.0"

一、准备工作

1.BaseResp

统一的返回实体, 包含 code, msg, data; 这种服务器响应结构比较常见

data class BaseResp<T>(
// 响应状态码
var code: Int = -1,
// 响应信息
var msg: String = "",
// 数据实体
var data: T? = null
)

2.Api

这里是一个验证码请求接口, 使用的 Json 提交参数

interface Api {
@POST("api/getCode")
suspend fun getCode(@Body body: RequestBody): BaseResp<JsonObject?>
}

3.ApiManager

使用 枚举单例模式; 包括 初始化 Retrofit, OkHttpClient, 添加请求Token, 请求日志打印.

/**
* Retrofit 管理类;
*/
enum class ApiManager {
INSTANCE;
private val retrofit: Retrofit
val mApi: Api
private val mMediaTypeJson: MediaType? init {
retrofit = Retrofit.Builder()
.baseUrl("https://... 服务器地址")
.client(initOkhttpClient())
.addConverterFactory(GsonConverterFactory.create())
.build()
mApi = retrofit.create(Api::class.java)
mMediaTypeJson = "application/json; charset=utf-8".toMediaTypeOrNull()
} private fun initOkhttpClient(): OkHttpClient {
return OkHttpClient.Builder()
.retryOnConnectionFailure(true) //重试
.connectTimeout(20, TimeUnit.SECONDS)
.readTimeout(20, TimeUnit.SECONDS)
.writeTimeout(20, TimeUnit.SECONDS)
.addNetworkInterceptor(initTokenInterceptor())
.addInterceptor(initLogInterceptor())
.build()
} private fun initTokenInterceptor(): Interceptor = object : Interceptor {
override fun intercept(chain: Interceptor.Chain): Response {
// 为请求添加 Token
val token: String = SpUtils.getToken()
val originalRequest = chain.request()
return if (token.isNullOrEmpty()) {
chain.proceed(originalRequest)
}else {
token = "Bearer $token"
val updateRequest = originalRequest.newBuilder().header("token", token).build()
chain.proceed(updateRequest)
}
}
} /*
* 日志拦截器
* */
private fun initLogInterceptor(): HttpLoggingInterceptor {
if(!BuildConfig.DEBUG){ //生产环境不打日志
return HttpLoggingInterceptor()
} val interceptor = HttpLoggingInterceptor(object : HttpLoggingInterceptor.Logger {
override fun log(message: String) {
Log.i("Retrofit_network", message)
}
})
interceptor.level = HttpLoggingInterceptor.Level.BODY
return interceptor
} // 请求数据转 Json 形式;
open fun getJsonBody(data: Any): RequestBody {
val strEntity = mGson.toJson(data)
return strEntity.toRequestBody(mMediaTypeJson)
}
}

二、开始使用

1.简单使用

以下代码在 Activity 中;

lifecycleScope.launch {
val param = ApiManager.INSTANCE.getJsonBody(mapOf("phone" to "13333333333", "codeType" to "1"))
val data = ApiManager.INSTANCE.mApi.getCode(param).data
binding.tvTitle.text = data.toString()
}

是不是非常简单, 协程内除了准备参数 就只剩两行代码.

上面代码并没有处理异常, 及请求失败的情况. 下面我们就开始封装请求

2.DSL

class RetrofitDSL<T> {
internal lateinit var api: (suspend () -> BaseResp<T?>)
private set
internal var onSuccess: ((BaseResp<T?>) -> Unit)? = null
private set
internal var onFailed: ((msg: String?, code: Int) -> Unit)? = null
private set
internal var onComplete: (() -> Unit)? = null
private set /**
* 获取数据
* @param block (T) -> Unit
*/
fun api(block: suspend () -> BaseResp<T?>) {
this.api = block
} /**
* 获取数据成功
* @param block (T) -> Unit
*/
fun onSuccess(block: (BaseResp<T?>) -> Unit) {
this.onSuccess = block
} /**
* 获取数据失败
* @param block (msg: String, errorCode: Int) -> Unit
*/
fun onFailed(block: (msg: String?, code: Int) -> Unit) {
this.onFailed = block
} /**
* 访问完成
* @param block () -> Unit
*/
fun onComplete(block: () -> Unit) {
this.onComplete = block
}
}

看到 onSuccess, onFailed 是不是有熟悉的感觉!

3.扩展函数

我们需要创建一个 .kt 文件; 为 协程作用域 添加扩展函数

fun <T> CoroutineScope.retrofit(
dsl: RetrofitDSL<T>.() -> Unit
) {
launch {
val retrofitDsl = RetrofitDSL<T>()
retrofitDsl.dsl()
try {
val result = retrofitDsl.api()
when(val code = result.code){
200 -> retrofitDsl.onSuccess?.invoke(result)
... // 其他响应码
else -> retrofitDsl.onFailed?.invoke(result.msg, code)
}
} catch (e: Exception) {
retrofitDsl.onFailed?.invoke(e.message, -10)
}
... // 其他异常类型
finally {
retrofitDsl.onComplete?.invoke()
}
}
}

这里 只写了 Exception; 需要判断多种异常的话, 往 catch 后面加就行了. 同样, 响应码也随便加, 想怎么处理就怎么处理.

4.请求发起

以下代码在 ViewModel 中;

// 注意: <JsonObject> 与 Api 中配置的请求响应结果类型一致 BaseResp<JsonObject?>
viewModelScope.retrofit<JsonObject> {
api { ApiManager.INSTANCE.mApi.getCode(param) }
onSuccess { // it = BaseResp<JsonObject?>
_number.set(it.data?.getAsJsonPrimitive("code")?.asString)
}
onFailed { msg, _ ->
Toast.makeText(getApplication(), msg, Toast.LENGTH_SHORT).show()
}
onComplete {
Toast.makeText(getApplication(), "完事了", Toast.LENGTH_SHORT).show()
}
}

onSuccess, onFailed, onComplete 都可以不写, 想写谁就写谁;

// 不关心请求结果的话; 一个 api 就够了
viewModelScope.retrofit<JsonObject> {
api { ApiManager.INSTANCE.mApi.getCode(param) }
}

总结

好吧, 没有总结

Kotlin Coroutine(协程): 四、+ Retrofit的更多相关文章

  1. Kotlin Coroutine(协程): 一、样例

    @ 目录 前言 一.直接上例子 1.延时任务. 2.异步任务 3.并行任务: 4.定时任务: 总结 前言 你还在用 Hanlder + Message? 或者 AsyncTask? 你还在用 Rxja ...

  2. Kotlin Coroutine(协程): 二、初识协程

    @ 目录 前言 一.初识协程 1.runBlocking: 阻塞协程 2.launch: 创建协程 3.Job 4.coroutineScope 5.协程取消 6.协程超时 7.async 并行任务 ...

  3. Kotlin Coroutine(协程): 三、了解协程

    @ 目录 前言 一.协程上下文 1.调度器 2.给协程起名 3.局部变量 二.启动模式 CoroutineStart 三.异常处理 1.异常测试 2.CoroutineExceptionHandler ...

  4. python并发编程之gevent协程(四)

    协程的含义就不再提,在py2和py3的早期版本中,python协程的主流实现方法是使用gevent模块.由于协程对于操作系统是无感知的,所以其切换需要程序员自己去完成. 系列文章 python并发编程 ...

  5. Coroutine(协程)模式与线程

    概念 协程(Coroutine)这个概念最早是Melvin Conway在1963年提出的,是并发运算中的概念,指两个子过程通过相互协作完成某个任务,用它可以实现协作式多任务,协程(coroutine ...

  6. Android中的Coroutine协程原理详解

    前言 协程是一个并发方案.也是一种思想. 传统意义上的协程是单线程的,面对io密集型任务他的内存消耗更少,进而效率高.但是面对计算密集型的任务不如多线程并行运算效率高. 不同的语言对于协程都有不同的实 ...

  7. coroutine协程

    如果你接触过lua这种小巧的脚本语言,你就会经常接触到一个叫做协程的神奇概念.大多数脚本语言都有对协程不同程度的支持.但是大多编译语言,如C/C++,根本就不知道这样的东西存在.当然也很多人研究如何在 ...

  8. [Unity-22] Coroutine协程浅析

    1.概念解释 协程并非一个独立的线程.在Unity中.全部的语句都是在一个线程中运行的,也就是说.Unity是单线程的(详细的能够參见http://blog.csdn.net/alexander_xf ...

  9. Coroutine 协程

    https://en.wikipedia.org/wiki/Coroutine Coroutines are computer program components that generalize s ...

随机推荐

  1. openresty 学习笔记三:连接redis和进行相关操作

    openresty 学习笔记三:连接redis和进行相关操作 openresty 因其非阻塞的调用,令服务器拥有高性能高并发,当涉及到数据库操作时,更应该选择有高速读写速度的redis进行数据处理.避 ...

  2. GO语言异常处理01---恐慌的报出与处理

    package main import ( "fmt" "math" ) /*自己报出恐慌的语法*/ func main021() { fmt.Println( ...

  3. Usb-type-C端口实现的挑战与设计方案

    Usb-type-C端口实现的挑战与设计方案 USB Type-C port implementation challenges and design solutions USB from 1.1 t ...

  4. Python_Selenium之浏览器封装_去掉浏览器受到自动化控制横条显示及去掉是否记住密码弹窗

    封装如下: from selenium import webdriverfrom common.config_utils import configfrom selenium.webdriver.ch ...

  5. 基于kerberos的hadoop安全集群搭建

    目录 前置条件 kerberos相关 给hadoop各组件创建kerberos账号 将这些账号做成keytab core-site.xml HDFS datanode的安全配置 证书生成和安装 hdf ...

  6. Manacher(马拉车)————O(n)回文子串

    Manacher 一.背景 1975年,Manacher发明了Manacher算法(中文名:马拉车算法),是一个可以在O(n)的复杂度中返回字符串s中最长回文子串长度的算法,十分巧妙. 让我们举个栗子 ...

  7. Java安全之反序列化回显与内存马

    Java安全之反序列化回显与内存马 0x00 前言 按照我个人的理解来说其实只要能拿到Request 和 Response对象即可进行回显的构造,当然这也是众多方式的一种.也是目前用的较多的方式.比如 ...

  8. 老板防止我上班摸鱼,给我装了个chrome插件

    <铁柱幻想的摸鱼生活> 9:30:到达公司,开开电脑,收拾一下办公桌 9:40:吃个早餐,接杯水(一定要多喝水,一个肾结石同事的出院后的衷心建议) 10:00:打开"技术网站&q ...

  9. 学习Qt Charts-创建一个简单的折线图

    一.Qt Charts Qt Charts是基于Qt Graphics View实现的一个图表的组件,可以用来在QT GUI程序中添加现在风格的.可交互的.以数据为中心的图表,可以用作QWidget或 ...

  10. hive学习笔记之三:内部表和外部表

    欢迎访问我的GitHub https://github.com/zq2599/blog_demos 内容:所有原创文章分类汇总及配套源码,涉及Java.Docker.Kubernetes.DevOPS ...