事件驱动架构

事件驱动架构指南.

触发条件

当用户需要实现异步处理、消息队列、事件发布订阅时，使用此 Skill。

核心组件

1. IEvent 事件基类

open class IEvent(
    open var delayMills: Int = 0,        // 延迟发送（毫秒）
    open var retryTime: Int = 1,          // 重试次数
    open var mqResend: Int = 0,           // 当前重投次数
    open val mqResendMax: Int = 2         // 最大重投次数
) {
    // 发送到指定目标
    fun sendTo(bridge: StreamBridge, destination: String? = null)

    // 是否可以重发
    fun canResend() = mqResend < mqResendMax
}

2. 事件定义示例

// 流水线构建开始事件
data class PipelineBuildStartEvent(
    val projectId: String,
    val pipelineId: String,
    val buildId: String,
    val userId: String,
    override var delayMills: Int = 0
) : IEvent()

// 广播事件（多个消费者）
data class PipelineBuildStartBroadCastEvent(
    val projectId: String,
    val pipelineId: String,
    val buildId: String
) : IEvent()

3. 事件发布

@Component
class PipelineEventDispatcher(
    private val streamBridge: StreamBridge
) {
    fun dispatch(event: PipelineBuildStartEvent) {
        event.sendTo(streamBridge, "pipeline-build-start")
    }
}

4. 事件消费

@Configuration
class DispatchMQConfiguration {

    @EventConsumer
    fun thirdAgentDispatchStartConsumer(
        @Autowired thirdPartyAgentListener: ThirdPartyBuildListener
    ) = ScsConsumerBuilder.build<PipelineAgentStartupEvent> { 
        thirdPartyAgentListener.handleStartup(it) 
    }

    @EventConsumer
    fun buildFinishConsumer(
        @Autowired listener: BuildFinishListener
    ) = ScsConsumerBuilder.build<PipelineBuildFinishEvent> {
        listener.onBuildFinish(it)
    }
}

事件类型

消息队列配置

# application.yml
spring:
  cloud:
    stream:
      bindings:
        pipeline-build-start:
          destination: pipeline.build.start
          group: ${spring.application.name}
        pipeline-build-finish:
          destination: pipeline.build.finish
          group: ${spring.application.name}

最佳实践

1. 幂等性：消费者必须支持重复消费
2. 延迟发送：使用 delayMills 实现延迟处理
3. 重试机制：利用 retryTime 和 canResend() 处理失败
4. 广播事件：跨服务通知使用 BroadCast 事件

相关文件

• common-event/src/main/kotlin/com/tencent/devops/common/event/pojo/IEvent.kt
• common-event/src/main/kotlin/com/tencent/devops/common/event/annotation/EventConsumer.kt