使用Moshi更好地兼容Kotlin空安全

空安全是Kotlin的重要优势,但是使用Gson等Json库时,不能很好的兼容这个特性

Gson不支持空安全检查

有DTO定义如下:

data class Dto(
  val foo: String, // non-null
  val bar: String // non-null
)

现在将下面的Json反序列化

{"foo": "value"}
val dto = Gson().fromJson(json, Dto::class.java) //此时捕获抛出异常
//...
dto.bar.length // 由于bar实际是null,所以会抛出NPE

Kotlin通过Nullable类型声明,将很大一部分NPE提前消灭在编译期。Gson通过反射进行反序列化,此时无法区分字节码来自Java还是Kotlin,所以还是按照Java的解析规则去解析。Json的key为Null在Java中是正常的,所以无法早创建DTO时进行空安全检查,将NPE的风险流到了后面。

Moshi支持空安全检查

Moshi可以更好地兼容Kotlin的特性,包括控安全检查。

Kotlin models are now supported via the moshi-kotlin extension.
KotlinJsonAdapterFactory is the best way to use Kotlin with Moshi. It
honors default values and is null-safe. Kotlin users that don’t use
this factory should write custom adapters for their JSON types.
Otherwise Moshi cannot properly initialize delegated properties of the
objects it decodes.

Moshi通过KotlinJsonAdapterFactory可以更好地处理KClass,当进行反序列化为KClass时,如果filed是Nullable类型,则可以填入Null,如果是NonNull类型,则在填入Null时会立即抛出异常,将NPE暴露在早期

使用KotlinJsonAdapterFactory需要引入moshi-kotlin

compile "com.squareup.moshi:moshi:$moshiVerion"
compile "com.squareup.moshi:moshi-kotlin:$moshiVerion"

在moshi的build过程中,添加KotlinJsonAdapterFactory

val moshi = Moshi.Builder()
    .add(KotlinJsonAdapterFactory())
    .build()
val dto = moshi.adapter(Dto::class.java).fromJson("json")

同样针对上面的Json进行反序列化:

val moshi = Moshi.Builder().add(KotlinJsonAdapterFactory()).build()

// 因为bar不能为null,但是json中又不存在bar,所以此时会抛出异常
val dto = moshi.adapter(Dto::class.java).fromJson(json)

你可能感兴趣的:(Kotlin)