Net可以通过自定义转换器支持任何数据类型转换, 甚至`List>`等嵌套泛型对象 例如请求动作Post`指定泛型为Model`, 则转换器NetConverter中的函数`onConvert返回值必须为Model`, 如果转换失败或者发生异常都算请求错误 > 注意如果你在转换器里面返回null. 那么指定的泛型也应当是可空类型, 例如`Post("api")` ```kotlin scopeNetLife { val userList = Get>("list") { converter = GsonConverter() }.await() } ```
如果你要返回映射好的数据模型对象, 那么肯定要求创建转换器的. 本框架由于低耦合原则不自带解析框架 [常用的Json转换器-代码示例](https://github.com/liangjingkanji/Net/tree/master/sample/src/main/java/com/drake/net/sample/converter) ## 默认返回数据类型 Net支持请求返回的数据类型取决于你的转换器(也就是支持返回任何对象), 默认情况不创建转换器也支持返回以下数据类型 | 函数 | 描述 | |-|-| | String | 字符串 | | ByteArray | 字节数组 | | ByteString | 内部定义的一种字符串对象 | | Response | 最基础的响应 | | File | 文件对象, 这种情况其实应当称为[下载文件](download-file.md) | 使用示例 ```kotlin scopeNetLife { Get("api").await().headers("响应头名称") // 返回响应头 } ``` ??? summary "默认使用的是: [NetConverter.DEFAULT](https://github.com/liangjingkanji/Net/blob/master/net/src/main/java/com/drake/net/convert/NetConverter.kt)" ```kotlin val DEFAULT = object : NetConverter { override fun onConvert( succeed: Type, response: Response ): R? { return when (succeed) { String::class.java -> response.body?.string() as R ByteString::class.java -> response.body?.byteString() as R ByteArray::class.java -> response.body?.bytes() as R Response::class.java -> response as R File::class.java -> response.file() as R else -> throw ConvertException( response, "The default converter does not support this type" ) } } } ``` 假设这里没有你需要的数据类型请[自定义转换器](#_3)(例如返回Json或Protocol) ## 设置转换器 转换器分为全局和单例, 单例可以覆盖全局的转换器. 如果不设置转换器就会采用默认的转换器 === "全局" ```kotlin hl_lines="2" NetConfig.initialize("https://github.com/liangjingkanji/Net/", this) { setConverter(SerializationConverter()) } ``` === "单例" ```kotlin hl_lines="3" scopeNetLife { tvFragment.text = Get("api"){ converter = SerializationConverter() }.await() } ``` ## Json解析库转换器 一般业务我们可以直接继承[JSONConverter](https://github.com/liangjingkanji/Net/blob/master/net/src/main/java/com/drake/net/convert/JSONConvert.kt) 使用自己的JSON解析器解析数据, 完全自定义需求可以直接实现[NetConverter](https://github.com/liangjingkanji/Net/blob/master/net/src/main/java/com/drake/net/convert/NetConverter.kt)(比如直接转换IO流) === "Gson" ```kotlin class GsonConvert : JSONConvert(code = "code", message = "msg", success = "200") { val gson = GsonBuilder().serializeNulls().create() override fun String.parseBody(succeed: Type): S? { return gson.fromJson(this, succeed) } } ``` === "kotlin-serialization" ```kotlin class SerializationConverter( val success: String = "0", val code: String = "code", val message: String = "msg" ) : NetConverter { private val jsonDecoder = Json { ignoreUnknownKeys = true // JSON和数据模型字段可以不匹配 coerceInputValues = true // 如果JSON字段是Null则使用默认值 } override fun onConvert(succeed: Type, response: Response): R? { try { // 此处是为了继承默认转换器支持的返回类型 return NetConverter.onConvert(succeed, response) } catch (e: ConvertException) { val code = response.code when { code in 200..299 -> { // 请求成功 val bodyString = response.body?.string() ?: return null val kType = response.request.kType() ?: return null return try { val json = JSONObject(bodyString) // 获取JSON中后端定义的错误码和错误信息 if (json.getString(this.code) == success) { // 对比后端自定义错误码 bodyString.parseBody(kType) } else { // 错误码匹配失败, 开始写入错误异常 val errorMessage = json.optString( message, NetConfig.app.getString(com.drake.net.R.string.no_error_message) ) throw ResponseException(response, errorMessage) } } catch (e: JSONException) { // 固定格式JSON分析失败直接解析JSON bodyString.parseBody(kType) } } code in 400..499 -> throw RequestParamsException(response, code.toString()) // 请求参数错误 code >= 500 -> throw ServerResponseException(response, code.toString()) // 服务器异常错误 else -> throw ConvertException(response) } } } fun String.parseBody(succeed: KType): R? { return jsonDecoder.decodeFromString(Json.serializersModule.serializer(succeed), this) as R } } ``` SerializationConverter就是仿照JSONConverter代码实现 === "FastJson" ```kotlin class FastJsonConvert : JSONConvert(code = "code", message = "msg", success = "200") { override fun String.parseBody(succeed: Type): S? { return JSON.parseObject(this, succeed) } } ``` === "Moshi" ```kotlin class MoshiConvert : JSONConvert(code = "code", message = "msg", success = "200") { val moshi = Moshi.Builder().build() override fun String.parseBody(succeed: Type): S? { return moshi.adapter(succeed).fromJson(this) } } ``` 1. 使用转换器时请添加其依赖: [GSON](https://github.com/google/gson) | [kotlin-serialization](https://github.com/Kotlin/kotlinx.serialization) | [FastJson](https://github.com/alibaba/fastjson) | [Moshi](https://github.com/square/moshi) 2. 推荐使用 `kotlinx.Serialization`, 其可解析[任何泛型](kotlin-serialization.md) 3. Sample有完整代码示例 以上转换器示例是建立在数据结构为以下表格的固定格式下, 如果有特殊的业务可能需要自行修改 | 转换器参数 | 描述 | |-|-| | code | 即后端定义的`成功码`字段名 | | message | 即后端定义的`错误消息`字段名 | | success | 即`成功码`的值等于指定时才算网络请求成功 | 比如截图中的意为, 当返回的Json中包含state字段且值为ok时请求才算是真正成功才会返回数据, 否则都会抛出异常. 其中message为错误信息字段名 假设简单的指定名称不能满足你复杂的业务逻辑, 请复制`JSONConvert`源码到你项目中修改或者直接自己实现`NetConverter` > 注意解析器(Gson或者Moshi)的解析对象记得定义为类成员, 这样可以不会导致每次解析都要创建一个新的解析对象, 减少内存消耗
## 自定义转换器 通过实现`NetConverter`接口可以编写自己的逻辑网络请求返回的数据, `NetConvert.DEFAULT`为默认的转换器支持返回File/String/Response等 框架中自带一个`JSONConverter`可以作为参考或者直接使用. 其可以转换JSON数据. ??? summary "JSONConverter 源码" ```kotlin /** * 常见的JSON转换器实现, 如果不满意继承实现自定义的业务逻辑 * * @param success 后端定义为成功状态的错误码值 * @param code 错误码在JSON中的字段名 * @param message 错误信息在JSON中的字段名 */ abstract class JSONConvert( val success: String = "0", val code: String = "code", val message: String = "msg" ) : NetConverter { override fun onConvert(succeed: Type, response: Response): R? { try { // 此处是为了继承默认转换器支持的返回类型 return NetConverter.onConvert(succeed, response) } catch (e: ConvertException) { val code = response.code when { code in 200..299 -> { // 请求成功 val bodyString = response.body?.string() ?: return null return try { val json = JSONObject(bodyString) // 获取JSON中后端定义的错误码和错误信息 if (json.getString(this.code) == success) { // 对比后端自定义错误码 bodyString.parseBody(succeed) } else { // 错误码匹配失败, 开始写入错误异常 val errorMessage = json.optString( message, NetConfig.app.getString(com.drake.net.R.string.no_error_message) ) throw ResponseException(response, errorMessage) } } catch (e: JSONException) { // 固定格式JSON分析失败直接解析JSON bodyString.parseBody(succeed) } } code in 400..499 -> throw RequestParamsException(response, code.toString()) // 请求参数错误 code >= 500 -> throw ServerResponseException(response, code.toString()) // 服务器异常错误 else -> throw ConvertException(response) } } } /** * 反序列化JSON * * @param succeed JSON对象的类型 * @receiver 原始字符串 */ abstract fun String.parseBody(succeed: Type): R? } ``` JSONConvert的核心逻辑 1. 判断服务器的错误码 1. 判断后端自定义的错误码 1. 如果判断发生错误则抛出一个包含错误信息的异常 1. 如果都判断成功则开始解析数据并return数据对象 在转换器中根据需要你可以在这里加上常见的解密数据, token失效跳转登录, 限制多端登录等逻辑. 日志信息输出请阅读: [日志记录器](log-recorder.md) 如果是错误信息建议抛出异常, 就可以在全局异常处理器中统一处理, 请阅读:[全局错误处理](error-handle.md)