关于kotlin serialization集成到retrofit的一些研究

前几天,我一直在找retrofit集成kotlin serialization的资料,才发现,网上的资料是真的少,如果你有幸看到这篇文章,就默默记下来。
关于为什么要急kotlin serialization的问题,相信如果你用gson发现每个属性必须要赋值才能调用到无参构造方法将默认值赋值,这个你使用kotlin 的data class时候,相信对代码追求完美的你会很难受

而使用kotlin serialization,就可以很开心的使用kotlin的特性来使用,另外在闲扯两句kotlin serialization的优势,首先,它是kotlin官方出的一套框架,结合kotlin的使用堪称完美,其次,相信你们也会关注它的解析效率,关于这个,大家都知道程序运行时,使用反射有影响效率,而它使用的是编译插件的方式, 网上的资料也都很多,有兴趣的同学可以自己去测试。

好了,现在直接上干货,在我一开始接触到这个kotlin serialization的时候,我发现每个数据类需要加上@Serializable这个注解,
就比如

@Serializable
data class InfoEntity<T>(val result:T?, val msg:String, val code:String)

@Serializable
data class ResultEntity(val name:String,val phone:String,val age:Int)

关于InfoEntity<ResultEntity>这个数据类的解析方式:

val json = Json(JsonConfiguration.Stable.copy(unquoted = true))
val result = json.parse(serializerByTypeToken(type),value.string()) as InfoEntity<ResultEntity>

看到这里,我相信你已经看懂啦,其实type 转换成KSerializer<Any>的方法呢,
就是serializerByTypeToken(type)方法,然后就可以愉快的使用json.parse方法解析啦
下面的东西就简单啦,retrofit的转换类ResponseBodyConverter啦

import kotlinx.serialization.json.Json
import kotlinx.serialization.json.JsonConfiguration
import kotlinx.serialization.serializerByTypeToken
import okhttp3.ResponseBody
import retrofit2.Converter
import java.io.IOException
import java.lang.reflect.Type

class JsonResponseBodyConverter<T> internal constructor(
    private val type: Type
) : Converter<ResponseBody, T> {
    private val json = Json(JsonConfiguration.Stable.copy(unquoted = true))

    @Suppress("UNCHECKED_CAST")
    @Throws(IOException::class)
    override fun convert(value: ResponseBody): T = value.use {
        json.parse(serializerByTypeToken(type),value.string()) as T
    }
}

这里呢,也要提一句github上的项目[retrofit2-kotlinx-serialization-converter],如果没有特殊的需求,可以直接引用

implementation 'com.jakewharton.retrofit:retrofit2-kotlinx-serialization-converter:0.4.0'

val contentType = MediaType.get("application/json")
val retrofit = Retrofit.Builder()
    .baseUrl("https://example.com/")
    .addConverterFactory(Json.asConverterFactory(contentType))
    .build()

其实如果打开源码,其实也是使用serializerByTypeToken(type)转换成KSerializer<Any>然后用json.parse解析

这里可以自定义将string的类型转换为Date时间类

//{"id":10,"time":"11/01/2001 10:24:14.145"}
@Serializable
data class Result(
    val id: Int,
    @Serializable(with=DateSerializer::class) val time: Date
)

@Serializer(forClass = Date::class)
object DateSerializer: KSerializer<Date> {
    private val df: DateFormat = SimpleDateFormat("dd/MM/yyyy HH:mm:ss.SSS")

    override val descriptor: SerialDescriptor =
        StringDescriptor.withName("WithCustomDefault")

    override fun serialize(encoder: Encoder, obj: Date) {
        encoder.encodeString(df.format(obj))
    }

    override fun deserialize(decoder: Decoder): Date {
        return df.parse(decoder.decodeString())
    }
}

今天就讲到这里啦,其他更多自定义介绍可以直接去github的介绍里面看
https://github.com/Kotlin/kotlinx.serialization/blob/master/docs/custom_serializers.md

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,524评论 5 460
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,869评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,813评论 0 320
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,210评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,085评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,117评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,533评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,219评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,487评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,582评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,362评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,218评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,589评论 3 299
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,899评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,176评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,503评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,707评论 2 335

推荐阅读更多精彩内容