本框架用于尝试一种Plugin内部的分层结构，以获得代码复用等优势。不一定适合刚接触mirai插件开发的人，因为本框架引入了若干新的概念，同时也要求开发者对mirai-console原有的开发所需概念有足够了解。
使用本框架的插件项目：
flowchart LR
classDef pluginColor fill:#096,stroke:#333,stroke-width:3px;
classDef botLogicColor fill:#f96,stroke:#333,stroke-width:4px;
classDef functionColor fill:#9f6,stroke:#333,stroke-width:2px;
subgraph MusicProject ["Music插件项目"]
subgraph MusicPluginPackageA ["Plugin包A: 可打包出一个Plugin"]
MusicPluginA:::pluginColor
MusicBotLogicA("MusicBotLogicA: 对应指令语法A"):::botLogicColor
MusicPluginA --> |持有| MusicBotLogicA
end
subgraph MusicPluginPackageB ["Plugin包B: 可打包出一个Plugin"]
MusicPluginB:::pluginColor
MusicBotLogicB("MusicBotLogicB: 对应指令语法B"):::botLogicColor
MusicPluginB --> |持有| MusicBotLogicB
end
subgraph MusicFunctionPackage ["Share-Function包: 提供数个音乐Function"]
MusicFunction("音乐功能"):::functionColor
end
end
MusicProject --> |依赖| BaseClass
MusicBotLogicA --> |持有| MusicFunction
MusicBotLogicB --> |持有| MusicFunction
subgraph AmiyaProject ["Amiya插件项目"]
subgraph AmiyaFunctionPackage ["Function包: 提供数个阿米娅特有Function"]
AmiyaChatFunction("阿米娅聊天功能"):::functionColor
end
subgraph AmiyaPluginPackage ["Plugin包: 可打包出一个Plugin"]
AmiyaPlugin:::pluginColor
AmiyaBotLogic:::botLogicColor
AmiyaPlugin --> |持有| AmiyaBotLogic
end
end
AmiyaProject --> |依赖| BaseClass
AmiyaBotLogic --> |持有| WeiboFunction
AmiyaBotLogic --> |持有| AmiyaChatFunction
AmiyaBotLogic --> |持有| MusicFunction
subgraph frameworkCore ["framework核心包: 提供基类和工具类"]
BaseClass("基类")
FileRepository("config和data工具")
FileHelper("缓存文件读写工具")
CosPermission("总权限（cos-perm）检查工具")
end
FileRepository --> |使用| ConsolefileApi
FileHelper --> |使用| ConsolefileApi
BaseClass --> |依赖| ConsoleBaseClass
CosPermission --> |使用| ConsolePermManager
BaseClass("基类") --> |调用| CosPermission
subgraph starterSubProject ["starterFunction包: 提供数个样例Function"]
WeiboFunction("微博功能"):::functionColor
RemindFunction("报时功能"):::functionColor
end
starterSubProject --> |依赖| BaseClass
WeiboFunction --> |读config| FileRepository
WeiboFunction --> |写图片缓存| FileHelper
subgraph exampleSubProject ["examplePlugin包: 可打包出一个Plugin"]
ExamplePlugin:::pluginColor
ExampleBotLogic:::botLogicColor
ExamplePlugin --> |持有| ExampleBotLogic
end
exampleSubProject --> |依赖| BaseClass
ExampleBotLogic --> |持有| WeiboFunction
ExampleBotLogic --> |持有| RemindFunction
ConsolePluginManager("miraiConsole.PluginManager")
ConsolePluginManager --> |加载| AmiyaPlugin
ConsolePluginManager --> |加载| ExamplePlugin
ConsolePluginManager --> |加载| MusicPluginA
ConsolePluginManager --> |加载| MusicPluginB
subgraph miraiGroup1 ["miraiConsoleApi"]
ConsolefileApi("miraiConsole.fileApi")
ConsoleBaseClass("miraiConsole.BaseClass: Command,EventHandler,JvmPlugin...")
ConsolePermManager("miraiConsole.PermissionManager")
end
Plugin持有一个对应的BotLogic。保持Plugin只处理和mirai对接工作，需满足继承JvmPlugin等约束。本框架的Function层只接触BotLogic。
BotLogic负责的具体的逻辑包括：
- 定义本Plugin对应的唯一CharacterName和CharacterCosPermission。即使用本框架的Plugin的推荐设计思路是：一个Plugin对应某个Character的角色扮演功能集合。（类似市场上智能助手app的拟人化）
- 持有若干Function, （onEnable时）将它们初始化（with CharacterName），并注册为Command/ListenHost。
负责一类业务功能，由若干子功能组成。子功能的被调用形式有：
- 子功能被调用于一个被@SubCommand注解的方法，且包在一个CompositeCommand里（见CompositeCommandFunctionComponent），等待被注册。
- 子功能被调用于一个被@EventHandler注解的方法，等待被注册。
- 子功能被调用于一个Timer，等待被启用。
实际使用时，还有如下技巧：
- 同一个子功能的被调用形式可以不止一种，也就是说可以既写一个被@SubCommand注解的方法调用该子功能，又写一个@EventHandler注解的方法调用该子功能。需求来源
- 在Function外自定义一个CompositeCommand（见AllCompositeCommandProxy），然后通过点运算调用的方式，调用子功能。需求来源
对于开发者，Function即是实现了跨插件复用业务功能。同时，也允许具体Plugin自定义实际注册Command时的指令语法（见AllCompositeCommandProxy）。
本框架设计的权限管理的最小单位是启用或禁用(character, botId, groupId)三元组。也就是仅支持控制某组(botId, groupId)启用/禁用某个Character的所有功能；不支持单独控制某组(botId, groupId)启用/禁用某个Character中的一部分Functions；这是权衡用户理解和管理成本后的结果。需求来源
启用(character, botId, groupId)，可以理解为：botId在groupId里扮演character，扮演行为即为提供对应插件内的所有功能。
在一个console里放入AmiyaPlugin和PrinzEugenPlugin，登录两个bot，两个bot均加在同一个群(id:111111)。配置后，在这同一个群里，AmiyaBot(id:222222)只回应AmiyaPlugin的Command/EventHandler，启用AmiyaPlugin的Timer，且使用AmiyaPlugin的配置；PrinzEugenBot(id:333333)同理，只回应PrinzEugenPlugin的Command/EventHandler，启用PrinzEugenPlugin的Timer，且使用PrinzEugenPlugin的配置。
grantedPermissionMap:
'hundun.fleet.example.prinzeugen:*':
- 'm111111.*' #群111111可使用prinzeugen插件指令
'hundun.fleet.example.prinzeugen.cos:INSTANCE':
- m111111.333333 #Bot333333在群111111扮演prinzeugen插件角色（欧根），即响应相关的Command/EventHandler/Timer
'hundun.fleet.example.amiya:*':
- 'm111111.*' #群111111可使用amiya插件指令
'hundun.fleet.example.amiya.cos:INSTANCE':
- m111111.222222 #Bot222222在群111111扮演amiya插件角色（阿米娅），即响应相关的Command/EventHandler/Timer
- 群11111发出一条AmiyaCommand。
- 由于command权限配置，群11111的群员确实有AmiyaCommand的权限。
- AmiyaCommand方法将会被调用两次，两次的CommandSender.getBot()分别是两个bot。
- 对于bot==PrinzEugen(id:333333)，由于cos权限配置，其跳出了AmiyaCommand方法。
- 对于bot==Amiya(id:222222)，由于cos权限配置，其可执行AmiyaCommand方法的后续代码。
- AmiyaCommand方法里执行resolveConfig，一定是在AmiyaPlugin的目录下。
- 群11111发出一条MessageEvent。
- AmiyaEventHandler方法将会被调用两次，两次的Event.getBot()分别是两个bot。
- 对于bot==PrinzEugen(id:333333)，由于cos权限配置，其跳出了AmiyaEventHandler方法。
- 对于bot==Amiya(id:222222)，由于cos权限配置，其可执行AmiyaEventHandler方法的后续代码。
- AmiyaEventHandler方法里执行resolveConfig，一定是在AmiyaPlugin的目录下。
- Console发出一条AmiyaCommand。
- 由于command权限配置，console确实有AmiyaCommand的权限。
- AmiyaCommand方法将会被调用1次，其中CommandSender instanceOf ConsoleCommandSender。
- 对于ConsoleCommandSender，由于cos权限配置，其可执行AmiyaCommand方法的后续代码。
- AmiyaCommand方法里执行resolveConfig，一定是在AmiyaPlugin的目录下。
来自ZacaFleetBot项目的拆分方案。故框架的大部分来自原项目。
- 原本数个Character共享ZacaFleetBot的core包，拆分后是数个插件项目依赖本项目的core包。
- 试着采用社区建议，不再依赖Spring和MongoDB。