Guia de migração

Na versão v2 , apenas JDK 17+ e SpringBoot 3.0.0+
Para detalhes, consulte o Guia de migração do Documento do Projeto V2

Investir rápido

Dependências a serem introduzidas

Ao apresentar dependência, substitua a versão do latest como a versão mais recente do Maven Central .

Maven

< 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 '

Plugue exemplar -in

NOTA LIGUE

Escreva o arquivo de configuração application.yaml ou consulte o arquivo de configuração avançado

 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 );
    }
}

Reescrever o método pai

O plug-in escrito pelo método de anotação não precisa definir a plugin-list in
Os resources/application.yaml adiciona o seguinte conteúdo
A lista de plug MESSAGE_BLOCK é executada em ordem.

Escreva o arquivo de configuração application.yaml ou consulte o arquivo de configuração avançado

 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 é desenvolvido com o protocolo padrão OneBot-V11, que é compatível com todos os clientes do OneBot Protocol que suportam o WebSocket reverso

projeto	descrever	Observação
LLONEBOT	Faça seu NTQQ suportar o protocolo OneBot11 para o desenvolvimento de robôs QQ
Lagrange.core	Implementação do protocolo NTQQ
GO-CQHTTP	Implementação nativa de Onebot Golang com base em Mirai e Miraigo	Pare de manutenção
OpenShamrock	Estrutura de robô baseada no padrão OneBot com base no Xposed