基础原理

领域事件及事件总线EventBus使用实践

2018-03-11  本文已影响546人  StruggleYang

@大鹏开源:别看我有点萌，我可以秒变大鹏😄

image

DDD 与领域事件

在过去的 30 多年，就已经有领域建模和设计的思潮；Eric Evans 将其定义为领域驱动设计（Domain-Driven Design，简称DDD）。领域模型是领域驱动的核心，而领域事件又作为领域模型中的重要模块，解决了开发者日常开发中的很多痛点，比如，代码藕合降低，拓展性增强。

领域模型不是高大上的东西，所有的领域模型抽象都来自于具体的业务及业务的需求,而脱离业务需求的应用设计是没有任何价值的！

比如在Today的新零售电商架构中:门店、采购、订单、供应商、物流、商品、台账等等都是应用设计中的不同领域模型，必然还存在或多或少的子域模型。而对于技术人员来说，这些抽象出来的领域，就代表应用架构存在若干子系统。

系统与系统间，势必会存在某些关联。比如说A领域“发生某件事情”、“当什么产生变化的时候”、“如果什么状态变更”...，都将可能成为B领域所要关心的事件。

事件总线的大体流程

image

以上eventbus示意图大致流程是这样的：

为什么要引入事件

在代码中通常这样去描述针对某些状态对应做什么事。

code match {
    case 0 => 
        // do A
    case 1 => 
        // do B
    case _ => 
        // do ...
}

当遇到某个状态，需要第三方系统作出应对，开发者可能不是那么愿意为此去加入冗长的代码甚至引入别人的 api ，而这与当前领域相关性也不会太大。领域事件帮助开发者更加优雅的解决了这个问题！

do A 就变成了 do event_A

降低耦合，高拓展性

高复用性

最终一致性与弱关联

通常需要保证数据的最终一致性，这对于事件消息来说还是很容易的，这得益于基于消息的重试机制。与主业务关系不大的业务，如：发邮件，发短信等,这种弱关联是可以在事件中获益！

如何实践事件总线

在 today 中台服务团队的各领域实践中，已经开始投产 eventbus ，并且效果可观，三方系统的订阅对接相当便捷.那这样的事件机制该如何去使用？

为了给第三方系统和本部门的业务开发人员提供一致性的开发体验，我们将事件总线从dapeng的框架中剥离出来, 单独提供了一套类库用于实现事件的发布以及订阅。

事件总线eventBus的核心库

"com.today" % "event-bus_2.12" % "0.1-SNAPSHOT"

事件内容及状态暂存支持

CREATE TABLE `common_event` (
  `id` bigint(20) NOT NULL  COMMENT '事件id',
  `event_type` varchar(255) DEFAULT NULL COMMENT '事件类型',
  `event_binary` blob DEFAULT NULL COMMENT '事件内容',
  `updated_at` timestamp NOT NULL DEFAULT current_timestamp() ON UPDATE current_timestamp() COMMENT '更新时间',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

这里以商品变价审核的状态变更为例，了解在开发中如何做事件发送与订阅.
具体来说,就是三步:

  1. 定义事件结构体
  2. 在服务接口方法中声明待发布的事件
  3. 通过EventBus发布事件
  4. 通过EventBus接受事件

下面具体说明一下每个步骤

作为事件消息发送者

消息的定义和声明

1.事件收发双方共同协定定义事件消息的内容, 一个领域的所有消息定义都在同一个独立的idl文件中. 这个idl文件应该放在发布者的API包中.

2.我们的事件对象需要定义一个事件 id (建议通过分布式取号服务来获取), 订阅者可以自己决定是否需要用这个事件 id 来做消息的幂等处理

==> goods_events.thrift

namespace java com.today.api.goods.events

/**
* 商品变价审核通过事件
**/
struct SkuPriceUpdateApprovedEvent {
    /**
    * 事件id
    **/
    1:i64 id,
    /**
    * sku_id
    **/
    2:i64 skuId
}

...more

声明事件

秉承代码及文档一致的理念，所有的服务都会在统一的文档站点进行开放展示，每个服务/每个接口的描述,包括出入参都一目了然.

== >goods_service.thrift

namespace java com.today.api.goods.service
/**
* 用户服务
**/
service GoodsAdminService{
/**
# 商品审核
## 事件
    1.SkuPriceUpdateApprovedEvent  商品变价审核通过事件
    2.SkuAttributeUpdateApprovedEvent  商品属性审核通过事件
**/
    i64 approveSku(/** 审核请求实体**/1:goods_request.ApproveSkuRequest request)
    (events="com.today.api.goods.events.SkuPriceUpdateApprovedEvent,com.today.api.goods.events.SkuAttributeUpdateApprovedEvent")
    ...more
}(group="goods")

注：如果想要了解更多有关文档站点的内容，请留意后期的 dapeng 文档站点专题

定义事件发布任务

==> goods_event_task.thrift

namespace java com.today.api.goods.service

/**
* 商品事件发布任务
**/
service GoodsScheduledService {
/**
# 事件发布
## 注意事项
    1.商品服务的事件发布任务
    2.不需在文档站点测试
**/
    void publishEventMsg()
}(group="Scheduler")

为发布任务服务提供以下实现模版

==> task/GoodsScheduledServiceImpl.scala

@ScheduledTask
class GoodsScheduledServiceImpl extends GoodsScheduledService{
  @Resource(name = "messageTask")
  var msgScheduler: MsgPublishTask = _

  @ScheduledTaskCron(cron = "*/2 * * * * ?")
  override def publishEventMsg(): Unit = {
    //EventBus已经处理了多节点同时触发的问题了
    msgScheduler.doPublishMessages()
  }
}

关键性的bean配置

<!--messageTask 事件发布任务bean-->
<bean id="messageTask" class="com.today.eventbus.scheduler.MsgPublishTask">
    <constructor-arg name="topic" value="${KAFKA_TOPIC}"/>
    <constructor-arg name="kafkaHost" value="${KAFKA_PRODUCER_HOST}"/>
    <constructor-arg name="tidPrefix" value="${KAFKA_TID_PREFIX}"/>
    <constructor-arg name="dataSource" ref="tx_goods_dataSource"/>
</bean>

==> config_user_service.properties

# event config
KAFKA_TOPIC=goods_1.0.0_event
KAFKA_PRODUCER_HOST=127.0.0.1:9092
KAFKA_TID_PREFIX=goods_0.0.1

事件的触发

==> commons/EventBus.scala

object EventBus extends AbstractEventBus {

  /**
    * 事件在触发后，可能存在领域内的订阅者，以及跨领域的订阅者
    * 领域内的订阅者可以通过实现该方法进行分发
    * 同时,也会将事件发送到其他领域的事件消息订阅者
    * @param event
    */
  override def dispatchEvent(event: Any): Unit = {}
  override def getInstance: EventBus.this.type = this
}

==> spring/services.xml

<bean id="eventBus" class="com.today.service.commons.EventBus" factory-method="getInstance">
    <property name="dataSource" ref="tx_goods_dataSource"/>
</bean>

EventBus.fireEvent(RegisteredEvent(event_id,user.id))

订阅你感兴趣的事件

对于领域内订阅者

EventBus 的 dispatchEvent 方法提供领域内订阅者的事件分发，以便本地订阅者可以订阅到关注的事件消息。这些领域内的订阅者，只需要在 dispatchEvent 中模式匹配进行分发。是不是已经是相当的简洁呢？

...
 override def dispatchEvent(event: Any): Unit = {
     event match {
      case e:SkuPriceUpdateApprovedEvent =>
        // do somthing 
      case _ =>
        LOGGER.info(" nothing ")
 }
...

对于跨领域的订阅者

依赖

<!--if => maven project-->
<dependency>
    <groupId>com.today</groupId>
    <artifactId>event-bus_2.12</artifactId>
    <version>0.1-SNAPSHOT</version>
</dependency>
<!--if => sbt project--> 
"com.today" % "event-bus_2.12" % "0.1-SNAPSHOT"

<bean id="postProcessor" class="com.today.eventbus.MsgAnnotationBeanPostProcessor"/>

// java
@KafkaConsumer(groupId = "goodsEventConsumer", topic = "goods_1.0.0_event",kafkaHostKey = "kafka.consumer.host"))
public class GoodsEventsConsumer {
    @KafkaListener(serializer = SkuAttributeUpdateApprovedEventSerializer.class)
    public void subscribeSkuAttributeUpdateApprovedEvent(SkuAttributeUpdateApprovedEvent event) {
        System.out.println(event.skuId);
        // do somthing
    }
    ...
}
//scala
serializer = classOf[RegisteredEventSerializer]
...

@KafkaConsumer

@KafkaListener

领域内消费事件与跨领域消费事件的异同

通过以上已经知道在事件中，存在领域内的订阅者消费事件消息，也可能存在跨领域的事件订阅者消费事件消息。这两者有何异同？

比如商品领域的商品变价审核通过后，广播了一个事件。将商品id发送给关注此事的领域，这与领域内部是没有关联的，甚至于发送者并不知道事件消息订阅者如何处理。而订阅者也只想得到这部分信息而已！

订阅业务数据库binlog消息

将订阅者 api 进行了有趣的拓展，和事件消息类似的。加入新的点子来做 binlog 的订阅处理。

  @BinlogListener
    public void binlogListener(List<BinlogEvent> events){
        // do somthing
    }

总结

总体来说，不论是事件的发送还是订阅，对于开发者而言都是易用的。并且没有多余的配置。对于第三方系统的支持也做的非常优秀，希望在日常开发中能够更加灵活的运用。尽量减少不必要的耦合！并能经受实践考验！

有关eventBus的具体实现细节，将由小伙伴 hz.lei 来进行剖析！

上一篇下一篇

猜你喜欢

热点阅读