如何确保AnalyticsCustomEvent的params Map包含必填元素？

针对你的需求，在无法将AnalyticsCustomEvent转为抽象类的前提下，有两种简洁的实现方式来确保所有实现类的params自动包含必填元素，避免重复代码：

方案一：利用Kotlin接口默认方法（推荐） #

如果允许修改AnalyticsCustomEvent接口的定义，可以通过新增抽象方法+默认实现的方式，让params自动合并必填参数和自定义参数：

1. 修改原接口 #

sealed interface AnalyticsEvent : Event {
    interface AnalyticsCustomEvent : AnalyticsEvent {
        var eventName: String
        
        // 新增抽象方法，由实现类提供自定义参数
        fun getCustomParams(): Map<String, Any>?

        // 默认实现params，自动合并必填参数与自定义参数
        override val params: Map<String, Any>?
            get() {
                // 定义你的必填参数集合
                val requiredParams = mapOf(
                    EventParamNames.REQUIRED_FIELD_1 to "fixed_value_1",
                    EventParamNames.REQUIRED_FIELD_2 to AppContext.getGlobalValue()
                )
                // 合并必填参数和自定义参数（自定义参数会覆盖同名必填参数，按需调整逻辑）
                return requiredParams + (getCustomParams() ?: emptyMap())
            }
    }

    interface AnalyticsEComerceEvent : AnalyticsEvent {
        var eCommerceEvent: Any
    }
}

2. 实现类简化写法 #

实现类只需实现getCustomParams提供自身的业务参数，无需再处理params的合并逻辑：

class AddAllProductsToCartClickedEventAnalyticsDelegate(
    orderId: String,
    productIds: List<String>,
) : AnalyticsEvent.AnalyticsCustomEvent {

    override var eventName: String = "add_all_products"

    override fun getCustomParams(): Map<String, Any> = mapOf(
        EventParamNames.PRODUCT_ID to orderId,
        EventParamNames.PRODUCTS to productIds,
    )
}

方案二：工具函数合并参数（无需修改原接口） #

如果架构限制完全不能修改原AnalyticsCustomEvent接口，可以通过工具函数统一处理参数合并：

1. 定义参数合并工具函数 #

object AnalyticsParamUtils {
    fun mergeWithRequiredParams(customParams: Map<String, Any>?): Map<String, Any>? {
        val requiredParams = mapOf(
            EventParamNames.REQUIRED_FIELD_1 to "fixed_value_1",
            EventParamNames.REQUIRED_FIELD_2 to AppContext.getGlobalValue()
        )
        return if (customParams == null) requiredParams else requiredParams + customParams
    }
}

2. 实现类中调用工具函数 #

每个实现类在赋值params时，只需将自身业务参数传入工具函数即可：

class AddAllProductsToCartClickedEventAnalyticsDelegate(
    orderId: String,
    productIds: List<String>,
) : AnalyticsEvent.AnalyticsCustomEvent {

    override var eventName: String = "add_all_products"

    override val params: Map<String, Any>? = AnalyticsParamUtils.mergeWithRequiredParams(
        mapOf(
            EventParamNames.PRODUCT_ID to orderId,
            EventParamNames.PRODUCTS to productIds,
        )
    )
}

两种方案都能实现“必填参数统一维护、实现类无需重复编写”的目标，方案一更优雅，方案二更灵活（无需修改原接口），可根据你的架构限制选择。

内容的提问来源于stack exchange，提问作者Fyodor Sherstobitov