跳转至

转换器

如果你想要网络请求直接返回对应的Bean或者说POJO类你就要创建自定义的转换器, 来使用JSON解析框架处理你的数据(当然你可能是使用的protocol等其他数据格式)

在Net中转换器(Convert)负责数据解析的工作, 自定义转换器即实现Convert接口即可

你的业务可能需要请求参数加密或者拼接一串特殊含义的参数, 或者响应信息需要解密. 请不要尝试封装Post或者Get等请求函数(这是蠢材做法), 自定义拦截器和转换器可以应对任何项目需求.

  • 数据解密
  • 解析JSON
  • 判断请求是否成功


创建转换器

一般情况我们可以直接继承DefaultConvert

class GsonConvert : DefaultConvert(code = "code", message = "msg", success = "200") {
    val gson = GsonBuilder().serializeNulls().create()

    override fun <S> String.parseBody(succeed: Type): S? {
        return gson.fromJson(this, succeed)
    }
}

class MoshiConvert : DefaultConvert(code = "code", message = "msg", success = "200") {
    val moshi = Moshi.Builder().build()

    override fun <S> String.parseBody(succeed: Type): S? {

        return moshi.adapter<S>(succeed).fromJson(this)
    }
}

class FastJsonConvert : DefaultConvert(code = "code", message = "msg", success = "200") {

    override fun <S> String.parseBody(succeed: Type): S? {
        return JSON.parseObject(this, succeed)
    }
}
  • 请自己手动添加Moshi或者Gson的依赖
  • Moshi支持Kotlin构造参数默认值, 但是如果Json中字段为null依然会覆盖默认值为null
  • 推荐使用官方的序列化框架: kotlinx.Serialization, 可以解析返回List, 支持Kotlin构造参数默认值, 可以非空覆盖
转换器参数 描述
code 即后端定义的成功码字段名
message 即后端定义的错误消息字段名
success 即成功码的值等于指定时才算网络请求成功


注意解析器(Gson或者Moshi)的对象记得定义为类成员, 这样可以不会导致每次解析都要创建一个新的对象, 减少内存消耗


设置转换器

转换器分为全局和单例, 单例可以覆盖全局的转换器, 一般情况下设置一个全局即可

initNet("http://182.92.97.186/") {
    converter(JsonConvert())
}

scopeNetLife {
    tv_fragment.text = Get<String>("api"){
        convert(JsonConvert())
    }.await()
}

自定义转换器

DefaultConvert 实际上也只是实现Convert接口的一个抽象类

当你对DefaultConvert有更多需求或者功能扩展的话可以重写DefaultConvert的convert函数, 或直接实现Convert接口

源码如下 

abstract class DefaultConvert(
    val success: String = "0",
    val code: String = "code",
    val message: String = "msg"
) : Converter {

    override fun <S> convert(
        succeed: Type,
        request: Request,
        response: Response,
        cache: Boolean
    ): S? {
        val body = response.body().string()
        response.log = body  // 日志记录响应信息
        val code = response.code()
        when {
            code in 200..299 -> { // 请求成功
                val jsonObject = JSONObject(body) // 获取JSON中后端定义的错误码和错误信息
                if (jsonObject.getString(this.code) == success) { // 对比后端自定义错误码
                    return if (succeed === String::class.java) body as S else body.parseBody(succeed)
                } else { // 错误码匹配失败, 开始写入错误异常
                    throw ResponseException(code, jsonObject.getString(message), request, body)
                }
            }
            code in 400..499 -> throw RequestParamsException(code, request) // 请求参数错误
            code >= 500 -> throw ServerResponseException(code, request) // 服务器异常错误
            else -> throw ParseError(request)
        }
    }

    abstract fun <S> String.parseBody(succeed: Type): S?
}

DefaultConvert对于的核心逻辑

  1. 判断服务器错误码
  2. 判断后端自定义错误码
  3. 如果判断错误则创建一个包含错误信息的异常
  4. 如果都判断成功则开始解析数据

根据需要你可以在这里加上常见的日志打印, 解密数据, 跳转登录界面等逻辑


转换器允许返回null, 如果你有任何认为不支持或者需要中断请求的操作可以在转换器中抛出任何异常, 推荐你的自定义异常继承NetException