Kotlin序列化：父接口加注解后子类是否需重复注解？如何简化？

我定义了一个密封接口用于统一支付响应的共有字段：

sealed interface CommonResponse {
    val success: Boolean
    val impUid: String
    val merchantUid: String
    val payMethod: String
    val pgProvider: String
    val pgType: String
}

为了实现序列化/反序列化，我编写了两个实现类，但每个类里都重复写了大量@SerialName注解：

@kotlinx.serialization.Serializable
data class SuccessResponse (
    override val success: Boolean,
    @SerialName("imp_uid")
    override val impUid: String,
    @SerialName("merchant_uid")
    override val merchantUid: String,
    @SerialName("pay_method")
    override val payMethod: String,
    @SerialName("pg_provider")
    override val pgProvider: String,
    @SerialName("pg_type")
    override val pgType: String,
    @SerialName("paid_at")
    val paidAt: String,
    val amount: String
): CommonResponse // 注：原代码中写的PaymentResponse应为笔误，实际应继承CommonResponse

@kotlinx.serialization.Serializable
data class FailureResponse (
    override val success: Boolean,
    @SerialName("imp_uid")
    override val impUid: String,
    @SerialName("merchant_uid")
    override val merchantUid: String,
    @SerialName("pay_method")
    override val payMethod: String,
    @SerialName("pg_provider")
    override val pgProvider: String,
    @SerialName("pg_type")
    override val pgType: String,
    @SerialName("error_message")
    val errorMessage: String
): CommonResponse // 注：原代码中写的PaymentResponse应为笔误，实际应继承CommonResponse

我想把@SerialName注解移到密封接口中，然后子类只重写属性即可，这种写法是否可行？有没有更优的简化方案？

你的写法完全可行 #

kotlinx.serialization 支持在密封接口的属性上直接标注@SerialName，子类重写这些属性时无需重复添加注解，序列化/反序列化过程会自动继承接口定义的序列化配置。

修正你代码中的笔误后，正确的实现如下：

密封接口（带序列化配置） #

@kotlinx.serialization.Serializable
sealed interface CommonResponse {
    val success: Boolean
    @SerialName("imp_uid")
    val impUid: String
    @SerialName("merchant_uid")
    val merchantUid: String
    @SerialName("pay_method") // 注意原代码此处写错为payMethod，需对应JSON字段名
    val payMethod: String
    @SerialName("pg_provider")
    val pgProvider: String
    @SerialName("pg_type")
    val pgType: String
}

简化后的SuccessResponse #

@kotlinx.serialization.Serializable
data class SuccessResponse(
    override val success: Boolean,
    override val impUid: String,
    override val merchantUid: String,
    override val payMethod: String,
    override val pgProvider: String,
    override val pgType: String,
    @SerialName("paid_at")
    val paidAt: String,
    val amount: String
) : CommonResponse

简化后的FailureResponse #

@kotlinx.serialization.Serializable
data class FailureResponse(
    override val success: Boolean,
    override val impUid: String,
    override val merchantUid: String,
    override val payMethod: String,
    override val pgProvider: String,
    override val pgType: String,
    @SerialName("error_message")
    val errorMessage: String
) : CommonResponse

额外注意事项 #

• 确保使用的kotlinx.serialization版本≥1.3.0，该版本开始完善了对密封接口的序列化支持。
• 密封接口的多态序列化无需额外配置SerializersModule，因为编译器能自动识别所有子类。

更优简化方案（可选） #

如果共有属性数量较多，也可以将其提取为独立的序列化数据类，通过组合的方式复用：

@kotlinx.serialization.Serializable
data class CommonPaymentProps(
    val success: Boolean,
    @SerialName("imp_uid")
    val impUid: String,
    @SerialName("merchant_uid")
    val merchantUid: String,
    @SerialName("pay_method")
    val payMethod: String,
    @SerialName("pg_provider")
    val pgProvider: String,
    @SerialName("pg_type")
    val pgType: String
)

@kotlinx.serialization.Serializable
sealed interface CommonResponse {
    val commonProps: CommonPaymentProps
}

@kotlinx.serialization.Serializable
data class SuccessResponse(
    override val commonProps: CommonPaymentProps,
    @SerialName("paid_at")
    val paidAt: String,
    val amount: String
) : CommonResponse

@kotlinx.serialization.Serializable
data class FailureResponse(
    override val commonProps: CommonPaymentProps,
    @SerialName("error_message")
    val errorMessage: String
) : CommonResponse

注意：这种方式会改变JSON结构（共有属性会被包裹在commonProps字段中），如果需要保持原JSON的扁平结构，建议使用第一种直接在密封接口定义属性的方案。

内容的提问来源于stack exchange，提问作者c-an