Kotlin学习手记——Json解析

Posted 2022-12-06 川峰

Kotlin中解析Json有那么几种方式：

• Gson
• Moshi
• kotlinx.serialization

其中Gson是原来经常使用的Google的解析库，用这个在kotlin中使用已经不适合，会有很多情况不支持，如空类型 默认值等。然后就是moshi，这个是square出品的，还有就是Kotlin自带的kotlinx.serialization，不过kotlin自带的居然不支持java类。显然对于android开发者来说，如果你使用kotlin一般都是java和kotlin混合使用的，所以首选的还是moshi这个库。如果是纯kotlin的话，还是选官方自带的比较好。

这里补充一个比较不错的库：klaxon 这个也是用来解析json的kotlin库，貌似支持的功能也比较丰富，后面有空再详细了解一下吧。这里先看一下moshi。

moshi的话，使用可以看官网：https://github.com/square/moshi
这里有一篇更详细的中文使用介绍：新一代Json解析库Moshi使用及原理解析

这里主要简单记录一下moshi的使用方式，首先gradle需要添加依赖：

dependencies 
    ...
    //moshi
    implementation("com.squareup.moshi:moshi:1.11.0")
    kapt("com.squareup.moshi:moshi-kotlin-codegen:1.11.0")

还需要应用kotlin的apt插件，否则kapt()方法找不到

apply plugin: 'kotlin-kapt'

moshi官方提供了两种方式，一是反射方式，二是通过注解处理器，可以选其一，也可以都用。我上面的依赖是采用的注解处理器的方式，因为采用反射方式的话，需要引入一个额外的依赖库：

implementation("com.squareup.moshi:moshi-kotlin:1.11.0")

但是使用反射库会依赖导入一个2.5M大小的jar包，这么大。。这还得了！所以我们肯定不会选这种方式了。。。

然后就是代码，只需要在data class上面添加注解：

@JsonClass(generateAdapter = true)
data class Person(val name: String, val age: Int = 18)

序列化和反序列化：

	val moshi = Moshi.Builder().build()
	val jsonAdapter = moshi.adapter(Person::class.java)
	
	val json = jsonAdapter.toJson(Person("张三", 25))
	//val json = jsonAdapter.toJson(Person("张三"))
	Log.e(TAG, "json : $json") //"name":"张三", "age": 25
	
	val person = jsonAdapter.fromJson(""""name":"张三"""")
	Log.e(TAG, "name: $person?.name") //张三
	Log.e(TAG, "age: $person?.age") //18

还有很多高级的用法，具体参考官网介绍。

上面的data类给定了默认值，moshi在序列化和反序列化时，是识别这个值的，如果没有给定值就采用默认值。

moshi更好的支持空类型安全，如果把上面的数据类的默认参数去掉：

@JsonClass(generateAdapter = true)
data class Person(val name: String, val age: Int)

 //这行会直接报空类型异常
 val person = jsonAdapter.fromJson(""""name":"张三"""")

 Log.e(TAG, "name: $person?.name")
 Log.e(TAG, "age: $person?.age")

moshi进行json反序列化为KClass时，如果filed是Nullable类型，则可以填入Null，如果是NonNull类型，则在填入Null时会立即抛出异常，将NPE风险暴露在早期，如果是java的话，则会到调用 person.name 的时候才会暴露。

也就是说，如果后台接口少返回了我们定义的data类中的非空类型的属性字段，在生成对象的时候就会报异常，而不是具体使用的时候。

moshi还支持属性延时初始化：

@JsonClass(generateAdapter = true)
data class PersonWithInits(val name: String, val age: Int)
    val firstName by lazy 
        name.split(" ")[0]
    
    //@Transient
    val lastName = name.split(" ")[1]



fun main()
    val moshi = Moshi.Builder().build()
    val jsonAdapter = moshi.adapter(PersonWithInits::class.java)

    println(jsonAdapter.toJson(PersonWithInits("Hello world", 18))) // "name":"Hello world","age":18
    
    val personWithInits = jsonAdapter.fromJson(""""name":"Hello world","age":20, "lastName":"tom"""")
    println(personWithInits?.firstName) // Hello 
    println(personWithInits?.lastName) // world firstName和lastName是以name为准

最后记录一个AS插件 JsonToKotlinClass ，类似于原来的GsonFormat插件，可以类似的根据Json字符串生成Kotlin的 data class，不过我还没有使用。