シロ

OneBotプロトコルに基づくQQロボットラピッド開発フレームワーク

ドキュメント・ダウンロード・クイックスタート・貢献に参加する

移行ガイド

v2バージョンから、 JDK 17+とSpringBoot 3.0.0+のみ
詳細については、Project Document V2 Migration Guideを参照してください

クイックスタート

紹介する依存関係

依存関係を導入するときは、 latestバージョンの最新バージョンのMaven Centralとして置き換えてください。

メイベン

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

模範的なプラグイン

通話に注意してください

application.yaml構成ファイルを記述するか、上級構成ファイルを参照してください

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

親の方法を書き直します

注釈方式によって書かれたプラグインは、プラグインリストplugin-list定義する必要はありません
サーバー構成ファイルresources/application.yaml次のコンテンツを追加します
プラグMESSAGE_BLOCKリストは順番に実行されます。

application.yaml構成ファイルを記述するか、上級構成ファイルを参照してください

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

}

クライアント

Shiroは、OneBot-V11標準プロトコルとともに開発されています。

プロジェクト	説明する	述べる
llonebot	NTQQをQQロボット開発のためのOneBot11プロトコルをサポートさせる
lagrange.core	NTQQプロトコルの実装
go-cqhttp	MiraiとMiraigoに基づくOneBot Golangネイティブの実装	メンテナンスを停止します
Openshamrock	Xposedに基づくOneBot標準に基づくロボットフレームワーク