Guía de migración

De la versión v2 , solo JDK 17+ y SpringBoot 3.0.0+
Para más detalles, consulte la Guía de migración del Documento del Proyecto V2

Inicio rápido

Dependencias para introducir

Al introducir dependencia, reemplace la versión de latest como la última versión de Maven Central .

Aturdir

< dependency >
    < groupId >com.mikuacgroupId >
    < artifactId >shiroartifactId >
    < version >latestversion >
dependency >

Gradle Kotlin DSL

implementation( " com.mikuac:shiro:latest " )

Gradle Groovy DSL

implementation ' com.mikuac:shiro:latest '

Enchufe ejemplar -in

Llamada de nota

Escriba el archivo de configuración application.yaml o consulte el archivo de configuración avanzado

 server :
  port : 5000

 @ Shiro
@ Component
public class ExamplePlugin {
    // 更多用法详见 @MessageHandlerFilter 注解源码

    // 当机器人收到的私聊消息消息符合 cmd 值 "hi" 时，这个方法会被调用。
    @ PrivateMessageHandler
    @ MessageHandlerFilter ( cmd = "hi" )
    public void fun1 ( Bot bot , PrivateMessageEvent event , Matcher matcher ) {
        // 构建消息
        String sendMsg = MsgUtils . builder (). face ( 66 ). text ( "Hello, this is shiro demo." ). build ();
        // 发送私聊消息
        bot . sendPrivateMsg ( event . getUserId (), sendMsg , false );
    }

    // 如果 at 参数设定为 AtEnum.NEED 则只有 at 了机器人的消息会被响应
    @ GroupMessageHandler
    @ MessageHandlerFilter ( at = AtEnum . NEED )
    public void fun2 ( GroupMessageEvent event ) {
        // 以注解方式调用可以根据自己的需要来为方法设定参数
        // 例如群组消息可以传递 GroupMessageEvent, Bot, Matcher 多余的参数会被设定为 null
        System . out . println ( event . getMessage ());
    }

    // 同时监听群组及私聊消息 并根据消息类型（私聊，群聊）回复
    @ AnyMessageHandler
    @ MessageHandlerFilter ( cmd = "say hello" )
    public void fun3 ( Bot bot , AnyMessageEvent event ) {
        bot . sendMsg ( event , "hello" , false );
    }
}

Reescribir el método principal

El complemento escrito por el método de anotación no necesita definir la plugin-list
El archivo de configuración del servidor resources/application.yaml agrega el siguiente contenido
La lista de plug MESSAGE_BLOCK se ejecuta en orden.

Escriba el archivo de configuración application.yaml o consulte el archivo de configuración avanzado

 server :
  port : 5000
shiro :
  plugin-list :
    - com.example.bot.plugins.ExamplePlugin

 @ Component
public class ExamplePlugin extends BotPlugin {

    @ Override
    public int onPrivateMessage ( Bot bot , PrivateMessageEvent event ) {
        if ( "hi" . equals ( event . getMessage ())) {
            // 构建消息
            String sendMsg = MsgUtils . builder ()
                    . face ( 66 )
                    . text ( "hello, this is shiro example plugin." )
                    . build ();
            // 发送私聊消息
            bot . sendPrivateMsg ( event . getUserId (), sendMsg , false );
        }
        // 返回 MESSAGE_IGNORE 执行 plugin-list 下一个插件，返回 MESSAGE_BLOCK 则不执行下一个插件
        return MESSAGE_IGNORE ;
    }

    @ Override
    public int onGroupMessage ( Bot bot , GroupMessageEvent event ) {
        if ( "hi" . equals ( event . getMessage ())) {
            // 构建消息
            String sendMsg = MsgUtils . builder ()
                    . at ( event . getUserId ())
                    . face ( 66 )
                    . text ( "hello, this is shiro example plugin." )
                    . build ();
            // 发送群消息
            bot . sendGroupMsg ( event . getGroupId (), sendMsg , false );
        }
        // 返回 MESSAGE_IGNORE 执行 plugin-list 下一个插件，返回 MESSAGE_BLOCK 则不执行下一个插件
        return MESSAGE_IGNORE ;
    }

}

Cliente

SHIRO se desarrolla con el protocolo estándar OneBot-V11, que es compatible con todos los clientes de protocolo OneBot que admiten el WebSocket inverso

proyecto	describir	Observación
Llonebot	Hacer que su NTQQ admite el protocolo OneBot11 para el desarrollo de robot QQ
Lagrange.core	Implementación del protocolo NTQQ
Go-cqhttp	Implementación nativa de OneBot Golang basada en Mirai y Miraigo	Detener el mantenimiento
Openshamrock	Marco de robot basado en el estándar OneBot basado en Xposed