Skip to content

JSON 序列化概觀 ​

Kotlin 序列化讓您能夠輕鬆地在 Kotlin 物件與 JSON 之間相互轉換。 Json 類別是實現此功能的主要工具,它為 JSON 的產生與剖析方式提供了極大的彈性。 您可以設定 Json 執行個體以處理特定的 JSON 行為,或在處理基本任務時使用其預設執行個體。

透過 Json 類別,您可以:

在開始之前,請從序列化程式庫匯入以下宣告:

kotlin
import kotlinx.serialization.*
import kotlinx.serialization.json.*

以下是一個使用預設 Json 執行個體展示 Kotlin 中 JSON 序列化運作方式的簡單範例:

kotlin
// 從序列化程式庫匯入宣告
import kotlinx.serialization.*
import kotlinx.serialization.json.*

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

fun main() {
    // 使用預設的 Json 執行個體
    val json = Json

    // 建立 User 物件
    val user = User("Alice", 30)

    // 將 User 物件轉換為 JSON 字串
    val jsonString = json.encodeToString(user)
    println(jsonString)
    // {"name":"Alice","age":30}

    // 將 JSON 字串轉換回 User 物件
    val deserializedUser = json.decodeFromString<User>(jsonString)
    println(deserializedUser)
    // User(name=Alice, age=30)
}

除了使用預設設定外,您還可以針對特定使用案例自訂 Json 執行個體,例如忽略未知的索引鍵:

kotlin
// 從序列化程式庫匯入宣告
import kotlinx.serialization.*
import kotlinx.serialization.json.*

@Serializable
data class Project(val name: String)

// 設定 Json 執行個體以忽略未知索引鍵
val customJson = Json {
    ignoreUnknownKeys = true
}

fun main() {
    val data = customJson.decodeFromString<Project>("""
        {"name":"kotlinx.serialization","language":"Kotlin"}
    """)
    println(data)
    // Project(name=kotlinx.serialization)
}

後續步驟 ​