eventframework

基于 RocketMQ 的事件框架，提供简便的方式将普通 spring 事件发送到 RocketMQ 消息队列。并提供事件间关系、事件生产和事件消费关系视图。

使用

eventframework-client 使用

引入依赖：

<dependency>
    <artifactId>eventframework-client</artifactId>
    <groupId>com.orange.server</groupId>
    <version>1.2.2-SNAPSHOT</version>
</dependency>

注册监听器：

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
       http://www.springframework.org/schema/beans/spring-beans.xsd">

    <!-- 注册事件框架监听 spring 事件 -->
    <bean class="com.orange.eventframework.DefaultSpringEventListener" />

    <!-- 配置消费异常报警 -->
    <bean class="com.orange.eventframework.monitor.MailExceptionMonitorHandler">
        <property name="mailFrom" value="${ef.monitor.mail.from}"/>
        <property name="password" value="${ef.monitor.mail.password}"/>
        <property name="mailTo" value="${ef.monitor.mail.to}"/>
        <property name="smtpHost" value="${ef.monitor.mail.smtp.host}"/>
        <property name="smtpPort" value="${ef.monitor.mail.smtp.port}"/>
        <property name="smtpSocketFactoryPort" value="${ef.monitor.mail.smtp.socketFactoryPort}"/>
        <property name="validate" value="true"/>
    </bean>
</beans>

添加配置文件：

在 resources 目录下创建 orange.eventframework.properties 配置文件，内容如下：

# 应用名称（必填项）
orange.eventframework.appName=default

# 消息队列服务地址（必填项）
orange.eventframework.nameSrvAddr=localhost:9876

# 是否禁用事件框架（必填项）
orange.eventframework.disabled=true

# 业务数据默认生产者code，默认取 ${orange.eventframework.appName}
# orange.eventframework.defaultProducerCode=ef_default_producer

更多配置选项参考“配置参数说明”

创建事件：

/**
* 通过继承 AbstractEvent 即可创建一个异步事件
*/
public class DemoEvent extends AbstractEvent {

    private String id;

    public DemoEvent(String id) {
        this.id = id;
    }

    public DemoEvent() {
    }

    @Override
    public boolean enablePushToMQ() {
        // true： 允许将该事件发送到消息队列
        return true;
    }

    @Override
    public String key() {
        // 返回一个 key，便于搜索该消息
        return id;
    }
}

发布事件：

@Service
public class DemoEventService {

    @Resource
    private ApplicationEventPublisher eventPublisher;

    public void publishEvent(String id) {
        // 通过 spring 的事件框架发布事件
        eventPublisher.publishEvent(new DemoEvent(id));
    }
}

监听事件：

public class DemoMQEventListener extends AbstractMQEventListener {

    public DemoMQEventListener() {
        super(new LinkedList<String>() {
            {
                // 事件类的名称作为事件标识
                add(DemoEvent.class.getName());
            }
        });
    }

    @Override
    public String getDisplayName() {
        return "demo 事件监听器";
    }

    @Override
    public ConsumeStatus consumeMessage(MessageWrapper messageWrapper) {
        DemoEvent event = messageWrapper.getBody(DemoEvent.class);

        // 事件处理逻辑

        return ConsumeStatus.CONSUME_SUCCESS;
    }
}

eventframework-console 使用

启动事件框架控制台：

java -Dons.client.logRoot=/var/eventframework_console/logs \
    -Drocketmq.client.logUseSlf4j=true \
    -Dorange.eventframework.nameSrvAddr=localhost:9876 \
    -jar /var/eventframework_console/eventframework-console.jar \
    --elastic.search.nodes=localhost:9300

访问：http://localhost:8080/index.htm

配置参数说明

支持以下三种方式配置参数，优先级高的配置会覆盖优先级低的配置：

• resources 目录下的 orange.eventframework.properties 文件，优先级最低。
• 环境变量，优先级第二。
• 系统属性，优先级最高。（通过 -D 参数指定）

配置内容及默认值如下：

# 应用名称（必填项）
orange.eventframework.appName=default

# 消息队列服务地址（必填项）
orange.eventframework.nameSrvAddr=localhost:9876

# 是否禁用事件框架（必填项）
orange.eventframework.disabled=true
# 是否禁用事件消费者，默认为： false
orange.eventframework.disableConsumer=false
# 是否禁用事件生产者，默认为： false
orange.eventframework.disableProducer=false
# 是否禁用上传事件信息，默认为： true
orange.eventframework.disableUploadEventInfo=true

# 业务数据默认生产者code，默认取 ${orange.eventframework.appName}
# orange.eventframework.defaultProducerCode=ef_default_producer

# 消费者标识前缀（根据需要调整）
orange.eventframework.consumerCodePrefix=

#### 以下参数，保持默认配置，请勿随意改动 #####

# 事件信息采集器组Id
orange.eventframework.groupId=event_framework
# 事件信息上传的 topic
orange.eventframework.topic=ef_event
# 业务数据默认 topic
orange.eventframework.defaultDataTopic=ef_data

#### RocketMQ 客户端消费者配置 #####

# 最大消费次数（根据需要调整）
orange.eventframework.maxReconsumeTimes=3
# 消费线程数最小值
orange.eventframework.consumeThreadMin=1
# 消费线程数最大值
orange.eventframework.consumeThreadMax=5
# 最大拉取数量
orange.eventframework.pullBatchSize=10


#### RocketMQ 客户端生产者配置 #####

# 消息发送超时时间，单位：毫秒
orange.eventframework.sendMsgTimeout=3000
# 同步模式下，消息发送失败重试次数
orange.eventframework.retryTimesWhenSendFailed=2
# 异步模式下，消息发送失败重试次数
orange.eventframework.retryTimesWhenSendAsyncFailed=2
# 内部发送失败时，重试另一个 broker
orange.eventframework.retryAnotherBrokerWhenNotStoreOK=false

关于宿主机IP

宿主机IP 属性用于向 RocketMQ 汇报本机IP。首先取 ef.host.ip 属性作为宿主机IP；如果取不到，则去取 EF_HOST_IP 环境变量；否则会读取第一块网卡的IP作为宿主机IP。

通过 ef.host.ip 系统属性指定宿主机IP：

java -Def.host.ip=192.168.1.100 -jar demo.jar

通过 EF_HOST_IP 环境变量指定宿主机IP：

export EF_HOST_IP=192.168.1.100

版权

Apache License, Version 2.0 Copyright (C) 杭州数橙科技有限公司