llms.txt: machine-readable documentation index. Markdown version of this page is also available.

Simple Robot 5.x Help

走马观花

构建Application

val application = launchSimpleApplication { // 配置... }
var applicationAsync = Applications.launchApplicationAsync( Simple.INSTANCE, appConfigurer -> { // 配置 ... }); // 异步结果可转化为 CompletableFuture var future = applicationAsync.asFuture(); // ...
var application = Applications.launchApplicationBlocking( Simple.INSTANCE, appConfigurer -> { // 配置 ... }); // ...
var applicationAsync = Applications.launchApplicationAsync( Simple.INSTANCE, appConfigurer -> { // 配置 ... }); // 异步结果可转化为 CompletableFuture, // 进而转化为响应式类型 var future = applicationAsync.asFuture(); var mono = Mono.fromFuture(future); // ...

在 Spring Boot 启动类上添加 @EnableSimbot 后,starter 会创建 Application 。具体用法参见 启用 simbot。

事件监听

任意事件

application.listeners { register { // this: EventListenerContext println("收到事件: $event") EventResult.of(42) } // 不需要返回 EventResult 的扩展函数 process { // this: EventListenerContext println("收到事件: $event") } }
var eventListenerRegistrar = application.getEventDispatcher(); eventListenerRegistrar.register( EventListeners.async(context -> { System.out.println("收到事件: " + context.getEvent()); return CompletableFuture.completedFuture( EventResult.of(42) ); }) );
var eventListenerRegistrar = application.getEventDispatcher(); eventListenerRegistrar.register( EventListeners.block(context -> { System.out.println("收到事件: " + context.getEvent()); return EventResult.of(42); }) );
var eventListenerRegistrar = application.getEventDispatcher(); eventListenerRegistrar.register( EventListeners.nonBlock(context -> { System.out.println("收到事件: " + context.getEvent()); // EventResult.of 包裹任意响应式或可收集类型, // 也支持 CompletableFuture return EventResult.of(Mono.just("Value")); }) );

在 Spring 管理的 @Component 中声明监听方法。

@Listener suspend fun onEvent(event: Event) { println("收到事件: $event") }
@Listener public CompletableFuture<?> onEvent(Event event) { System.out.println("收到事件: " + event); return CompletableFuture.completedFuture(42); }
@Listener public void onEvent(Event event) { System.out.println("收到事件: " + event); }
@Listener public Mono<?> onEvent(Event event) { System.out.println("收到事件: " + event); return Mono.just(42); }

指定类型事件

这里以 ChatGroupMessageEvent (聊天群消息事件) 为例。

application.listeners { listen<ChatGroupMessageEvent> { event -> // this: EventListenerContext println("收到事件: $event") EventResult.empty() } // 不需要返回 EventResult 的扩展函数 process<ChatGroupMessageEvent> { event -> // this: EventListenerContext println("收到事件: $event") } }
var eventListenerRegistrar = application.getEventDispatcher(); eventListenerRegistrar.register( EventListeners.async( ChatGroupMessageEvent.class, (context, event) -> { System.out.println("收到事件: " + event); return CompletableFuture.completedFuture( EventResult.of(42) ); } ) );
var eventListenerRegistrar = application.getEventDispatcher(); eventListenerRegistrar.register( EventListeners.block( ChatGroupMessageEvent.class, (context, event) -> { System.out.println("收到事件: " + context.getEvent()); return EventResult.of(42); } ) );
var eventListenerRegistrar = application.getEventDispatcher(); eventListenerRegistrar.register( EventListeners.nonBlock( ChatGroupMessageEvent.class, (context, event) -> { System.out.println("收到事件: " + context.getEvent()); // EventResult.of 包裹任意响应式或可收集类型, // 也支持 CompletableFuture return EventResult.of(Mono.just(42)); } ) );

将监听方法的参数换成具体的事件类型。

@Listener suspend fun onEvent(event: ChatGroupMessageEvent) { println("收到事件: $event") }
@Listener public CompletableFuture<?> onEvent(ChatGroupMessageEvent event) { System.out.println("收到事件: " + event); return CompletableFuture.completedFuture(42); }
@Listener public void onEvent(ChatGroupMessageEvent event) { System.out.println("收到事件: " + event); }
@Listener public Mono<?> onEvent(ChatGroupMessageEvent event) { System.out.println("收到事件: " + event); return Mono.just(42); }

注解式条件过滤

@Filter 默认对提取的纯文本进行正则全文匹配。例如,消息 你好 @某用户 提取后可能带有尾随空格,添加 @ContentTrim 可在匹配前清理首尾空白。

@Listener @Filter("你好") @ContentTrim suspend fun onEvent(event: ChatGroupMessageEvent) { println("收到事件: $event") }
@Listener @Filter("你好") @ContentTrim public CompletableFuture<?> onEvent(ChatGroupMessageEvent event) { System.out.println("收到事件: " + event); return CompletableFuture.completedFuture(42); }
@Listener @Filter("你好") @ContentTrim public void onEvent(ChatGroupMessageEvent event) { System.out.println("收到事件: " + event); }
@Listener @Filter("你好") @ContentTrim public Mono<?> onEvent(ChatGroupMessageEvent event) { System.out.println("收到事件: " + event); return Mono.just(42); }

信息获取

以下片段中的 event 为 ChatGroupMessageEvent 。可以在监听方法内读取消息内容和所在群。异步或响应式监听器可返回 groupInfo ,使调度器能够等待结果。

println(event.id) println(event.time) println(event.messageContent.plainText) val group = event.content() println(group.id) println(group.name)
System.out.println(event.getId()); System.out.println(event.getTime()); System.out.println(event.getMessageContent().getPlainText()); var groupInfo = event.getContentAsync().thenAccept(group -> { System.out.println(group.getId()); System.out.println(group.getName()); });
System.out.println(event.getId()); System.out.println(event.getTime()); System.out.println(event.getMessageContent().getPlainText()); var group = event.getContent(); System.out.println(group.getId()); System.out.println(group.getName());
System.out.println(event.getId()); System.out.println(event.getTime()); System.out.println(event.getMessageContent().getPlainText()); var groupInfo = Mono.from(event.getContentReactive()).doOnNext(group -> { System.out.println(group.getId()); System.out.println(group.getName()); });

通过 event.messageContent.messages 或 Java 的 event.getMessageContent().getMessages() 可以读取完整消息链。

回复/发送消息

先回复当前消息,再向事件所在的群发送一条消息。异步或响应式监听器可以返回 sent ,让调度器等待发送完成。

event.reply("你也好") event.content().send("你好呀")
var sent = event.replyAsync("你也好") .thenCompose(receipt -> event.getContentAsync()) .thenCompose(group -> group.sendAsync("你好呀"));
event.replyBlocking("你也好"); event.getContent().sendBlocking("你好呀");
var sent = Mono.from(event.replyReactive("你也好")) .then(Mono.from(event.getContentReactive())) .flatMap(group -> Mono.from(group.sendReactive("你好呀")));

有关如何传入 发送与回复选项 ,请参阅消息指南。

组件协同

安装多个组件,并监听它们的事件。

这里以 QGGuildEvent (QQ频道事件) 和 OneBotEvent (OneBot协议事件) 为例。

@Component class MyHandles1 { @Listener suspend fun onQGEvent(event: QGGuildEvent) { println("QQ频道: $event"); } @Listener suspend fun onOBEvent(event: OneBotEvent) { println("OB协议: $event"); } }
@Component public class MyHandles { @Listener public void onQGEvent(QGGuildEvent event) { System.out.println("QQ频道: " + event); } @Listener public void onOBEvent(OneBotEvent event) { System.out.println("OB协议: " + event); } }
19 November 2026