Kotlin数据类在Diia中的应用：DTO与实体类设计规范

Kotlin数据类在Diia中的应用：DTO与实体类设计规范

【免费下载链接】android-diia 项目地址: https://gitcode.com/GitHub_Trending/an/android-diia

你是否在Android开发中遇到过数据传输对象（DTO）与实体类设计混乱的问题？本文将通过Diia项目的实战案例，详解Kotlin数据类在DTO和实体类设计中的规范与最佳实践，帮助你写出更简洁、安全、可维护的代码。读完本文，你将掌握数据类的命名规范、注解使用、字段约束及序列化技巧。

数据类设计基础规范

Diia项目中广泛采用Kotlin数据类（Data Class）来实现DTO和实体类，其核心优势在于自动生成equals()、hashCode()、toString()等方法，减少样板代码。基础设计规范如下：

命名与文件组织

• DTO类名使用PascalCase，以Response、Request、Dto为后缀区分角色，如CategoryGroup.kt
• 实体类直接使用业务名称，如FaqItem、PaymentCardItem
• 文件存放于对应模块的model包下，如faq/src/main/java/ua/gov/diia/faq/model/

核心注解要求

所有DTO类必须添加Moshi序列化注解，确保JSON解析一致性：

@JsonClass(generateAdapter = true) // 生成Moshi适配器
data class CategoryGroup(
    @Json(name = "code") // 指定JSON字段映射
    val code: String,
    @Json(name = "title")
    val title: String,
    // 可选字段使用 nullable 类型
    @Json(name = "categoriesGroups")
    val categoriesGroups: List<String>?, 
)

代码来源：CategoryGroup.kt

DTO设计实战

数据传输对象（DTO）用于网络请求/响应、本地存储交互，在Diia项目中遵循"最小可用"原则，仅包含必要字段。

字段约束规范

1. 强制非空字段：核心业务参数使用非空类型（如String），必须在构造函数中初始化
2. 可选字段：非必需参数使用 nullable 类型（如List<String>?），避免默认值掩盖数据缺失问题
3. JSON映射：使用@Json注解显式指定字段映射，防止后端字段变更导致解析失败

典型DTO案例

支付模块的PaymentTemplateAndProcessCode.kt展示了复杂DTO设计：

@JsonClass(generateAdapter = true)
data class PaymentTemplateAndProcessCode(
    @Json(name = "templateId")
    val templateId: String,
    @Json(name = "processCode")
    val processCode: String,
    @Json(name = "amount")
    val amount: Double?, // 金额可为空，适配不同支付场景
    @Json(name = "currency")
    val currency: String = "UAH" // 提供默认值确保兼容性
)

实体类设计模式

实体类用于业务逻辑层，需满足不可变性和领域完整性。Diia项目中实体类主要有以下两种模式：

不可变数据实体

使用val声明所有字段，确保线程安全：

data class FaqItem(
    val id: String,
    val title: String,
    val content: String,
    val categoryId: String
)

示例来源：FaqItem.kt

密封层次结构

配合密封类实现有限状态集合，如菜单导航事件：

sealed class MenuHomeNavigation : NavigationEvent {
    data class ToSettings(override var isConsumed: Boolean = false) : MenuHomeNavigation()
    data class ToFAQ(override var isConsumed: Boolean = false) : MenuHomeNavigation()
    data class ToLogout(override var isConsumed: Boolean = false) : MenuHomeNavigation()
}

代码来源：MenuHomeNavigation.kt

常见问题与解决方案

1. 数据类继承限制

问题：Kotlin数据类无法继承其他数据类
解决方案：通过组合模式替代继承，如PaymentCardItem.kt：

// 基础接口定义通用行为
interface PaymentCardItem<T> {
    fun getType(): Int
}

// 数据类实现接口
data class SeeAllCardItem<T>(val moreCount: Int) : PaymentCardItem<T> {
    override fun getType() = TYPE_SEE_ALL
}

2. 多模块数据共享

问题：跨模块数据类引用导致依赖混乱
解决方案：提取公共数据类至core模块，如BaseResponse、ErrorDto

最佳实践总结

1. 优先使用数据类：网络交互、状态对象、事件传递等场景首选数据类
2. 控制字段数量：单个数据类字段不超过10个，避免"上帝对象"
3. 禁止开放可变API：不提供setter方法，如需修改使用copy()创建新实例
4. 单元测试覆盖：对DTO添加序列化测试，确保字段映射正确

通过遵循以上规范，Diia项目实现了数据模型的高度一致性。完整设计文档可参考core模块README，更多实战案例见payment/models/和documents模块。

点赞收藏本文，关注Diia技术团队，下期带来《Kotlin密封类在状态管理中的高级应用》。

【免费下载链接】android-diia 项目地址: https://gitcode.com/GitHub_Trending/an/android-diia