Как преобразовать JSON в Data Class в Kotlin с помощью GSON?

Правильный подход к парсингу JSON в Data Class с GSON в Kotlin

Ваш базовый подход абсолютно корректен. GSON отлично работает с Kotlin Data Class благодаря тому, что они компилируются в обычные Java-классы. Однако есть несколько важных нюансов и лучших практик, которые стоит учитывать.

1. Значения по умолчанию и отсутствующие поля

Если поле может отсутствовать в JSON, лучше задать значение по умолчанию. Это защитит от NullPointerException:

data class Todo(
    val userId: Int = 0,
    val id: Int = 0,
    val title: String = "",
    val completed: Boolean = false
)

В этом случае, если поле completed не пришло в JSON, GSON присвоит false. Но есть подвох: GSON по умолчанию не вызывает конструктор со значениями по умолчанию — он использует "unsafe" механизм создания объекта. Чтобы это исправить, используйте специальную настройку:

val gson = GsonBuilder()
    .registerTypeAdapterFactory(DataClassAdapterFactory())
    .create()

Или проще — сделайте поля nullable:

data class Todo(
    val userId: Int? = null,
    val id: Int? = null,
    val title: String? = null,
    val completed: Boolean? = null
)

2. Сериализованные имена (snake_case → camelCase)

Для маппинга имён полей используйте аннотацию @SerializedName:

data class Todo(
    @SerializedName("user_id")
    val userId: Int,
    @SerializedName("id")
    val id: Int,
    @SerializedName("title")
    val title: String,
    @SerializedName("completed")
    val completed: Boolean
)

Если весь JSON использует snake_case, можно задать глобальное правило через FieldNamingPolicy:

val gson = GsonBuilder()
    .setFieldNamingPolicy(FieldNamingPolicy.LOWER_CASE_WITH_UNDERSCORES)
    .create()

Тогда в Data Class пишите camelCase, а GSON автоматически преобразует:

data class Todo(
    val userId: Int,   // GSON ищет "user_id"
    val id: Int,       // ищет "id"
    val title: String, // ищет "title"
    val completed: Boolean // ищет "completed"
)

3. Лучшие практики

• Используйте Kotlin-совместимую версию GSON — последние версии (2.10+) лучше работают с Kotlin.
• Для вложенных JSON создавайте отдельные Data Class:

data class UserResponse(
    val id: Int,
    val name: String,
    val address: Address
)

data class Address(
    val street: String,
    val city: String
)

• Для списков используйте List или Array:

data class TodoList(
    val todos: List<Todo>
)

// Парсинг
val list = gson.fromJson(jsonArray, Array<Todo>::class.java).toList()

• Для nullable полей всегда указывайте тип как Type?:

data class Todo(
    val title: String? = null  // если поле может отсутствовать
)

4. Полный рабочий пример

import com.google.gson.GsonBuilder
import com.google.gson.FieldNamingPolicy
import com.google.gson.annotations.SerializedName

data class Todo(
    @SerializedName("user_id")
    val userId: Int = 0,
    val id: Int = 0,
    val title: String = "",
    val completed: Boolean = false
)

fun main() {
    val json = """
        {
            "user_id": 1,
            "id": 1,
            "title": "delectus aut autem",
            "completed": false
        }
    """.trimIndent()

    val gson = GsonBuilder()
        .setFieldNamingPolicy(FieldNamingPolicy.LOWER_CASE_WITH_UNDERSCORES)
        .create()

    val todo = gson.fromJson(json, Todo::class.java)
    println(todo) // Todo(userId=1, id=1, title=delectus aut autem, completed=false)
}

Итог: Ваш первоначальный подход верен. Добавьте значения по умолчанию для отсутствующих полей, используйте @SerializedName или FieldNamingPolicy для разных стилей именования, и всё будет работать отлично.

import kotlinx.serialization.Serializable
import kotlinx.serialization.json.Json
import kotlinx.serialization.decodeFromString

@Serializable
data class Todo(
    @SerialName("user_id")
    val userId: Int,
    val id: Int,
    val title: String,
    val completed: Boolean = false  // значение по умолчанию работает корректно
)

fun main() {
    val json = """
        {"user_id": 1, "id": 1, "title": "delectus", "completed": false}
    """.trimIndent()

    val todo = Json.decodeFromString<Todo>(json)
    println(todo)
}