如何使用 Gson 反序列化包含 Compose Color 的 JSON？

2024-03-09 09:55:47

使用 Gson 反序列化 Compose Color：深入解析

引言

在 Android 开发中，Gson 库是 JSON 序列化和反序列化的常用工具。当需要使用 Gson 反序列化包含 Compose Color 的 JSON 时，可能会遇到一些挑战。本文将深入探讨如何使用自定义类型适配器解决这一问题，并提供示例代码和最佳实践。

问题陈述

Compose Color 是一种内联值类，代表颜色值。当尝试使用 Gson 反序列化包含 Color 的 JSON 时，可能会遇到以下问题：

自定义 Color 类型的适配器无法正常工作。
使用 Long 作为适配器会导致错误：Expected a long but was androidx.compose.ui.graphics.Color。

解决方案

由于 Color 是一个不可变的内联值类，因此无法使用传统的适配器对其进行反序列化。为了解决这个问题，可以使用以下步骤：

1. 创建自定义类型适配器

class ColorTypeAdapter : TypeAdapter<Color>() {
    override fun write(out: JsonWriter?, value: Color?) {
        out?.value(value?.value?.toString())
    }

    override fun read(reader: JsonReader): Color {
        val hexValue = reader.nextString()
        return Color(hexValue.toLong(radix = 16))
    }
}

此适配器将 Color 转换为一个字符串，该字符串表示其十六进制值，并在反序列化时将其转换回 Color。

2. 注册自定义适配器

val gson = GsonBuilder()
    .registerTypeAdapter(Color::class.java, ColorTypeAdapter())
    .create()

3. 反序列化 JSON

val json = "{color: \"#FFFFFF\"}"
val colors = gson.fromJson(json, Colors::class.java)

示例代码

data class Colors(val color: Color)

fun main() {
    val gson = GsonBuilder()
        .registerTypeAdapter(Color::class.java, ColorTypeAdapter())
        .create()

    val json = "{color: \"#FFFFFF\"}"
    val colors = gson.fromJson(json, Colors::class.java)

    println(colors.color) // Color(0xFFFFFFFF)
}