3741398ab73098aea195c7c96742d1e5e7bdaeab - rocketmq-eventbridge

commit	3741398ab73098aea195c7c96742d1e5e7bdaeab	[log] [tgz]
author	changfeng <yongming.cym@alibaba-inc.com>	Fri May 13 15:57:09 2022 +0800
committer	shenlin <2011shenlin@gmail.com>	Tue Jun 07 14:47:52 2022 +0800
tree	c45823bcfa9ee4dee4036fd88ef9fbac9c470957
parent	a7854884d500e93d075d88c52c7bf92c004530bb [diff]

tree: c45823bcfa9ee4dee4036fd88ef9fbac9c470957

README.md

Apache RocketMQ EventBridge

RocketMQ EventBridge is a subproject of rocketmq to make it easier to build event-driven applications. In addition, rocketmq-eventbridge can route events between many services and applications based on the standard CloudEvents 1.0 specification. Users can use rocketmq-eventbridge to build loosely coupled and distributed event-driven architectures.

Architecture

Events are sent to the event bus in two ways: 1) Push events through the SDK or Webhook actively; 2) Pulled events by eventbridge passively. Events obtained in both ways will be stored on the event bus. EventBus is the core concept in EventBridge, which allows you to subscribe to the events, filter the events, and push to the specified target by creating the event rule. The event on the event bus is stored by rocketmq. Through rocketmq-connect, we can pull the event from the register source to the event bus, or push the events from the event bus to the registered target.

application 应用服务模块, 定义Application Service
adapter 适配层
- persistence 持久化相关, 一般存放Repository的实现(包含DO对象)
- api 暴露给外部的api接口提供者
- rpc 添加自己反转依赖的SPI, 以及SPI的实现适配
domain 领域设计的核心模块
- 每个聚合通过package隔离，定义于modelpackage下
- org.apache.rocketmq.eventbridge.domain.service` 存放当前子域下的所有领域服务
start 启动入口(多个子域被打包在同一个应用jar包中时, start模块会被排除)

Demo

Dependencies

rocketmq-connect
Mysql

Create EventBus

http://127.0.0.1:7001/bus/createEventBus

{
"eventBusName":"demo",
"description":"a demo bus."
}

Create EventSource

http://127.0.0.1:7001/source/createEventSource

{
"eventBusName":"demo",
"eventSourceName":"demo-source",
"description":"a demo bus."
}

Create EventRule

http://127.0.0.1:7001/rule/createEventRule

{
  "eventBusName":"demo",
  "eventRuleName":"demo",
  "description":"test",
  "filterPattern":"{}"
}

Create Target

This is a sample with DingTalk target.

http://127.0.0.1:7001/target/createEventTargets

{
    "eventBusName":"demo",
    "eventRuleName":"demo",
    "eventTargetRunners":[
        {
            "eventTargetName":"demo",
            "className":"acs.dingtalk",
            "config":{
            "WebHook":"https://oapi.dingtalk.com/robot/send?access_token=b43a54b702314415c2acdae97eda1e092528b7a9dddb31510a5b4430be2ef867",
            "SecretKey":"SEC53483bf496b8f9e0b4ab0ab669d422208e6ccfaedfd5120ea6b8426b9ecd47aa",
            "Body":"{\"template\":\"{\\\"text\\\":{\\\"content\\\":\\\"${content}\\\"},\\\"msgtype\\\":\\\"text\\\"}\",\"form\":\"TEMPLATE\",\"value\":\"{\\\"content\\\":\\\"$.data.body\\\"}\"}"
            }
        }
    ]
}

Put Events to EventBus

URL: http://127.0.0.1:7001/putEvents
Header: Content-Type:"application/cloudevents+json; charset=UTF-8"

{
    "specversion" : "1.0",
    "type" : "com.github.pull_request.opened",
    "source" : "https://github.com/cloudevents/spec/pull",
    "subject" : "123",
    "id" : "A234-1234-1234",
    "time" : "2018-04-05T17:31:00Z",
    "datacontenttype" : "application/json",
    "data" : {
        "body":"demo"
    },
    "aliyuneventbusname":"demo"
}

Use HttpSource to put events

EventBridge HttpSource allows you to put events to eventbus in the form of webhook.

Here is an example explaining how to put events using EventBridge HttpSource.

Create an EventBridge HttpSource
- eventSourceName: Name of EventSource
- eventBusName: Name of EventBus
- description: Description
- className: HttpEvent. This parameter is a fixed value and cannot be modified.
- config: HttpSource Config
- Type: Request type. Available values are ‘HTTP’, ‘HTTPS’ and ‘HTTP&HTTPS’.
- Method: Allowed HTTP request methods. The request will be filtered if the http request method type for accessing the webhook does not meet the configuration.
- SecurityConfig: Security configuration type. Available values are ‘none’, ‘ip’ and ‘referer’.
- Ip: IP security configuration. Http requests whose source ip is not in the configured network segment will be filtered if the security configuration is selected as ‘ip’.
- Referer: Referer security configuration. HTTP requests whose referer is not in this configuration will be filtered if the security configuration is selected as ‘referer’.

A webhook will be generated after the creation of HttpSource.

http://127.0.0.1:7001/source/createEventSource

{
  "eventSourceName": "httpEventSourceDemo",
  "eventBusName": "demo",
  "description": "http source demo",
  "className": "HttpEvent",
  "config": {
    "Type": "HTTP&HTTPS",
    "Method": ["GET", "POST"],
    "SecurityConfig": "ip",
    "Ip": ["10.0.0.0/8"],
    "Referer":[]
  }
}

Put event to EventBus

Http request to access this webhook will be converted into a CloudEvent and delivered to eventbus.

http://127.0.0.1/webhook/putEvents?token=43146d108b2123
Header: Content-Type:"application/json"

{
  "username": "testUser",
  "testData": "testData"
}

generated CloudEvent demo

{
  "datacontenttype": "application/json",
  "data": {
    "headers": {
      "Accecpt": "*/*",
      "Host": "127.0.0.1:7001",
      "Content-Type": "none"
    },
    "path": "/webhook/putEvents",
    "body": {
      "username": "testUser",
      "testData": "testData"
    },
    "httpMethod": "GET",
    "queryString": {}
  },
  "subject": "DemoBus/httpEventSourceDemo",
  "source": "httpEventSourceDemo",
  "type": "eventbridge:Events:HTTPEvent",
  "specversion": "1.0",
  "id": "75bc099b-130a-45a8-82e1-3f9a7f0d10f3",
  "time": "2022-05-12T17:20:30.264+08:00"
}