SSE 事件处理方法

可以直接在自定义 SSE 控制器中添加 SSE 的事件消息处理方法（当然也可以在 SSE 拦截器中添加），然后通过@SSEDataMessage注解、@SSEEventMessage注解、@SSEIdMessage注解、@SSERetryMessage注解来修饰自定义的方法，而这些方法根据所标注的注解可以接受和处理不同类型名称的事件消息。

如@SSEDataMessage注解修饰的方法就能处理名称为data的事件消息，@SSEEventMessage注解修饰的方法能处理event事件消息

@SSEDataMessage
public void onSSEData(EventSource eventSource, @SSEName String name, @SSEValue String value) {
    // 处理事件消息名称为 data 的事件
    // 声明的方法名和处理的事件消息名称没有关系，方法名可以是 onData、onSseData、onMessage、xxx、以及任何名称都可以
    // @SSEName 注解修饰的参数 name 为事件消息名称 (同 eventSource.name())
    // @SSEValue 注解修饰的参数 value 为事件消息的值
    eventSource.sse(); // 获取 SSE 控制器
    eventSource.request(); // 获取 Forest 请求对象
    eventSource.response(); // 获取 Forest 响应对象
    eventSource.rawData(); // 获取事件消息的原始数据
    eventSource.name(); // 获取事件消息的名称，如 data、event、id 等
    eventSource.value(); // 获取事件消息的值，返回字符串类型数据
    // 获取事件消息的值，并将消息转换为指定的自定义类型
    eventSource.value(MyUser.class);
    // 获取事件消息的值，并将消息转换为指定的自定义泛型类型
    eventSource.value(new TypeReference<List<MyUser>>() {});
}

@SSEEventMessage
public void onSSEEvent(EventSource eventSource, @SSEName String name, @SSEValue String value) {
    // 处理事件消息名称为 event 的事件
}

@SSEIdMessage
public void onSSEId(EventSource eventSource, @SSEName String name, @SSEValue String value) {
    // 处理事件消息名称为 id 的事件
}

@SSERetryMessage
public void onSSERetry(EventSource eventSource, @SSEName String name, @SSEValue String value) {
    // 处理事件消息名称为 retry 的事件
}

SSE 消息名称

还可以使用@SSEMessage注解为事件处理方法指定要监听的、非固定的事件消息名称

// 等价于 @SSEDataMessage 注解
@SSEMessage("data")
public void onSSEData(EventSource eventSource, @SSEName String name, @SSEValue String value) {
    // 处理事件消息名称为 data 的事件
    // 声明的方法名和处理的事件消息名称没有关系，方法名可以是 onData、onSseData、onMessage、xxx、以及任何名称都可以
    // @SSEName 注解修饰的参数 name 为事件消息名称 (同 eventSource.name())
    // @SSEValue 注解修饰的参数 value 为事件消息的值
}

// 等价于 @SSEEventMessage 注解
@SSEMessage("event")
public void onSSEEvent(EventSource eventSource, @SSEName String name, @SSEValue String value) {
    // 处理事件消息名称为 event 的事件
}

// 等价于 @SSEIdMessage 注解
@SSEMessage("id")
public void onSSEId(EventSource eventSource, @SSEName String name, @SSEValue String value) {
    // 处理事件消息名称为 id 的事件
}

// 等价于 @SSERetryMessage 注解
@SSEMessage("retry")
public void onSSERetry(EventSource eventSource, @SSEName String name, @SSEValue String value) {
    // 处理事件消息名称为 retry 的事件
}

// 监听非标准的 SSE 事件消息名称
@SSEMessage("push")
public void onSSEPush(EventSource eventSource, @SSEName String name, @SSEValue String value) {
    // 处理事件消息名称为 push 的事件
}

// 通过字符串模板引用变量，来指定要监听的 SSE 事件消息名称
@SSEMessage("{sseMsgName}")
public void onSSEPush(EventSource eventSource, @SSEName String name, @SSEValue String value) {
    // 要处理事件的消息名通过变量{sseMsgName}指定
}

SSE 参数

事件处理方法的参数数量、以及类型都不是固定的，也可以无序排列

// EventSource 类型参数
@SSEDataMessage
public void onData1(EventSource eventSource) {
    // 处理事件消息名称为 data 的事件
    // 可以只有 EventSource 一个参数
    // 而这个参数也不是必须的
}

// 消息名称和消息值作为参数
@SSEMessage("data")
public void onData2(@SSEName String name, @SSEValue String value) {
    // 可以只有 @SSEName 和 @SSEValue 修饰的参数
    // 来获取时间的名称和值
}

// 匹配消息值为自定义类型的参数
@SSEMessage("data")
public void onData3(@SSEValue MyUser myUser) {
    // 参数可以是自定义类型的对象
    // 当事件消息的值可以被正常反序列化为自定义类型的时候，调用该方法
    // 次参数需要用 @SSEValue 注解修饰
}

// 将请求对象和响应对象作为参数
@SSEMessage("data")
public void onData4(ForestRequest request, ForestResponse response) {
    // 也可以获取 Forest 请求对象和响应对象作为参数
}

// 任意排列组合的参数
@SSEMessage("event")
public void onEvent(ForestRequest request, @SSEValue String value, EventSource eventSource) {
    // 也可以对这些参数进行任意的排列组合
}

SSE 事件匹配

除了 SSE 事件消息名称，事件方法还可以通过值的前缀、后缀、以及正则表达式等方式来根据条件动态匹配想要监听的 SSE 事件

// 前缀匹配
@SSEDataMessage(valuePrefix = "close")
public void onDataClose(EventSource eventSource, @SSEValue String value) {
    // 在监听到名称为 data 的消息，并且值能匹配给定前缀"close"时才会执行
}

// 后缀匹配
@SSEEventMessage(valuePostfix = "open")
public void onEventOpen(EventSource eventSource, @SSEValue String value) {
    // 在监听到名称为 event 的消息，并且值能匹配给定后缀"open"时才会执行
}

// 正则匹配
@SSEMessage(name = "event", valueRegex = "\\{.*name.*\\}")
public void onEvent(@SSEValue Contact contact) {
    // 在监听到名称为 event 的消息，并且值和给定正则表达式匹配成功后才会执行
}