事件监听器

一个事件可以有多个事件监听器，这些事件监听器在执行时采用洋葱模型

创建Event Listener

比如，在模块 demo-student 中创建一个 Event Listener: echo，在响应事件时，将事件参数Hello World添加!后缀，并将新参数传入next方法

1. Cli命令

$ vona :create:bean eventListener echo --module=demo-student

2. 菜单命令

TIP

右键菜单 - [模块路径]: Vona Bean/Event Listener

Event Listener定义

1. 自动生成的代码骨架

type TypeEventData = unknown; // TypeEventEchoData;
type TypeEventResult = unknown; // TypeEventEchoResult;

@EventListener({ match: 'some-module:echo' })
export class EventListenerEcho
  extends BeanBase
  implements IEventExecute<TypeEventData, TypeEventResult> {
  async execute(_data: TypeEventData, next: NextEvent<TypeEventData, TypeEventResult>): Promise<TypeEventResult> {
    // next
    return next();
  }
}

• TypeEventData: 定义参数类型
• TypeEventResult: 定义结果类型
• match: 指定需要监听的事件

名称	类型	说明
match	string|regexp|(string|regexp)[]	指定需要监听的事件

2. 调整代码

+ import type { TypeEventEchoData, TypeEventEchoResult } from './event.echo.ts';

+ type TypeEventData = TypeEventEchoData;
+ type TypeEventResult = TypeEventEchoResult;

+ @EventListener({ match: 'demo-student:echo' })
export class EventListenerEcho
  extends BeanBase
  implements IEventExecute<TypeEventData, TypeEventResult> {
+ execute(data: TypeEventData, next: NextEventSync<TypeEventData, TypeEventResult>): TypeEventResult {
+   const dataNew = `${data}!`;
    // next
+   return next(dataNew);
  }
}

• TypeEventData: 定义参数类型
• TypeEventResult: 定义结果类型
• match: 指定需要监听的事件名demo-student:echo
• execute: 为了同时支持异步事件和同步事件，改为同步方法
  • next:类型改为NextEventSync
• dataNew: 生成新的事件参数值，并传入next方法

Event Listener顺序

针对同一个事件，可以关联多个 Event Listener。所以，VonaJS 提供了两个参数，用于控制 Event Listener 的执行顺序

1. dependencies

比如，还有一个 Event Listener demo-student:echo3，我们希望执行顺序如下：demo-student:echo3 > Current

@EventListener({
  match: 'demo-student:echo',
+ dependencies: 'demo-student:echo3',
})
class EventListenerEcho {}

2. dependents

dependents的顺序刚好与dependencies相反，我们希望执行顺序如下：Current > demo-student:echo3

@EventListener({
  match: 'demo-student:echo',
+ dependents: 'demo-student:echo3',
})
class EventListenerEcho {}

Event Listener 启用/禁用

可以控制 Event Listener 的启用/禁用

1. Enable

src/backend/config/config/config.ts

// onions
config.onions = {
  eventListener: {
    'demo-student:echo': {
+     enable: false,
    },
  },
};

2. Meta

可以让 Event Listener 在指定的运行环境生效

名称	类型	说明
flavor	string|string[]	参见: 运行环境与Flavor
mode	string|string[]	参见: 运行环境与Flavor

• 举例

@EventListener({
+ meta: {
+   flavor: 'normal',
+   mode: 'dev',
+ },
})
class EventListenerEcho {}

查看当前生效的Event Listener清单

可以直接输出当前生效的 Event Listener 清单

class ControllerStudent {
  @Web.get('test')
  test() {
+   this.bean.onion.eventListener.inspectEventListener('demo-student:echo');
  }
}

• this.bean.onion: 取得全局 Service 实例 onion
• .eventListener: 取得与 Event Listener 相关的 Service 实例
• .inspectEventListener: 输出当前生效的 Event Listener 清单，传入事件名demo-student:echo

当访问test API 时，会自动在控制台输出当前生效的 Event Listener 清单，效果如下：