跳转至

自定义转换器

Net自定义转换器可支持任何数据类型, 甚至Bitmap

泛型和转换器关系

  1. 如果Post<Model>, 那么NetConverter.onConvert返回值必须为Model
  2. 如果Post<Model?>, 允许NetConverter.onConvert返回值为null
  3. 任何错误请在转换器中直接抛出异常
scopeNetLife {
    val userList = Get<List<UserModel>>(Api.PATH) {
        converter = GsonConverter()
    }.await()
}

Net由于低耦合原则不自带任何序列化框架

设置转换器

NetConfig.initialize(Api.HOST, this) {
    setConverter(SerializationConverter())
}
scopeNetLife {
   tv.text = Get<String>(Api.PATH){
        converter = SerializationConverter()
   }.await()
}

常见转换器

实现JSONConverter接口快速实现JSON解析, 或直接复制以下转换器示例

序列化框架 示例代码 描述
kotlin-serialization SerializationConverter Kotlin官方序列化框架
kotlin-serialization ProtobufConverter Kotlin官方序列化框架
gson GsonConverter 谷歌序列化框架
fastJson FastJsonConverter 阿里巴巴序列化框架
moshi MoshiConverter Square序列化框架

自定义转换器

转换器原理非常简单, 实现NetConverter接口返回一个对象(等于请求泛型)

建议保留默认支持的类型
class CustomizeConverter: NetConverter {

    override fun <R> onConvert(succeed: Type, response: Response): R? {
        try {
            return NetConverter.onConvert<R>(succeed, response)
        } catch (e: ConvertException) {
            // ... 仅自定义不支持的类型
            return 任何对象 as R
        }
    }
}

转换器中可以根据错误码抛出自定义异常

转换器异常链
// 非CancellationException/NetException及其子类的上抛ConvertException
try {
    return request.converter().onConvert<R>(type, this) as R
} catch (e: CancellationException) {
    throw e
} catch (e: NetException) {
    throw e
} catch (e: Throwable) {
    throw ConvertException(this, cause = e)
}
  1. 日志记录建议使用拦截器
  2. 转换器中抛出异常被全局错误处理捕获