kotlin 的官方序列化庫幔欧,通過自動生成代碼來避免反射匙铡。只需要在 kotlin 類上標(biāo)記 @serializable
注解就可以撵摆,內(nèi)置標(biāo)準(zhǔn)集合的序列化方法诞挨。 支持 JSON莉撇,CBOR, Protobuf格式
提供的注解
-
@Serializable
注解 用于標(biāo)記kotlin的類惶傻,為類生成序列化serializer
方法棍郎。 -
@Optional
注解 用于標(biāo)記屬性參數(shù),被標(biāo)記的屬性需要提供默認(rèn)數(shù)據(jù)银室⊥康瑁可選參數(shù),如果序列化數(shù)據(jù)中有就使用數(shù)據(jù)提供的蜈敢,沒用就使用默認(rèn)的 -
@Serialname
注解 用于標(biāo)記屬性參數(shù)辜荠,重新定義序列化時的參數(shù)名 -
@Transient
注解 用于標(biāo)記屬性參數(shù), 被標(biāo)記的參數(shù)不參與序列化
JSON 參數(shù)
JSON 類的定義:
class JSON(
private val unquoted: Boolean = false,
private val indented: Boolean = false,
private val indent: String = " ",
internal val strictMode: Boolean = true,
val updateMode: UpdateMode = UpdateMode.OVERWRITE,
val encodeDefaults: Boolean = true
): ......
- unquoted 參數(shù): 無引號模式抓狭,無符號模式下 序列化過程中key值和value值是沒有引號包圍的如:
"{a:1}"
[一般用于測試] - indented 是否縮進(jìn): 用于多行 JSON 輸出模式
- indent 縮進(jìn)字符: 換行縮進(jìn)字符
- strictMode 參數(shù): 嚴(yán)格模式下伯病, JSON 轉(zhuǎn)化過程不允許有類中沒有規(guī)定的key值,類序列化過程不允許 NaN 和 無盡浮點(diǎn)數(shù)
- updateMode 參數(shù): 更新模式[針對集合]否过,
BANNED
禁止出現(xiàn)重復(fù)午笛,OVERWRITE
覆蓋數(shù)據(jù)惭蟋,UPDATE
合并
內(nèi)置對象 JSON.plain
, JSON.indented
药磺, JSON.nonstrict
告组,JSON.unquoted
val plain = JSON()
val unquoted = JSON(unquoted = true)
val indented = JSON(indented = true)
val nonstrict = JSON(strictMode = false)
使用方式
import kotlinx.serialization.Optional
import kotlinx.serialization.SerialName
import kotlinx.serialization.Serializable
import kotlinx.serialization.Transient
import kotlinx.serialization.json.JSON
import kotlinx.serialization.list
import org.junit.Test
class SerializeTest {
@Serializable
data class Data(val a: Int, @Optional val b: String = "er", @Transient val c: Int = 5, @SerialName("d") val dd: Float = 7.1f)
@Test fun testSerialize(){
System.out.println(JSON.stringify(Data.serializer(), Data(42)))
System.out.println(JSON.indented.stringify(Data.serializer().list, listOf(Data(42))))
val obj = JSON.unquoted.parse(Data.serializer(), "{a:2, d: 3.4}")
System.out.print(obj)
/*
{"a":42,"b":"er","d":7.1} // 默認(rèn)格式
[
{
"a": 42,
"b": "er",
"d": 7.1
}
]// 縮進(jìn)格式
Data(a=2, b=er, c=5, dd=3.4)
*/
}
}