Awesome

JavaCQ SDK Tool

前言

本插件将酷Q扩展可以间接使用Java进行开发
本文档适用于有一定Java基础的开发者阅读
以下提供详细步骤，推荐使用maven进行开发
文档不够详细的部分可以源码，源码的注释也是非常全的
视频教学：待续~ 酷Q帖子：https://cqp.cc/t/37318

开发环境

1. 电脑上已安装32位 JDK(JRE) 1.6以上版本
   注：酷Q未提供64位版本，所以JRE必须为32位，否则JRE无法正常加载
2. 下载 酷Q 和 JavaCQ SDK Tool 插件 ，安装并启用工具插件
   注：启用时发生依赖DLL链接错误，多半因为JVM相关 VC库 未安装
3. Java开发工具：MyEclipse、Eclipse、Intelij IDEA等 主流开发工具均可开发

JCQ Tool 目录结构

根目录 (例：酷Q/data/app/com.sobte.cqp.jcq/)

小提示

jar插件同名文件夹下创建lib，可以使用独立lib（可在json中修改此位置）
优先级：独立lib > 全局lib > JCQ自带lib
每个插件都是独立的，互不影响，各插件加载类时优先级越高的最先加载
全局lib 和 独立lib 根据需求使用 注意类加载优先级

配置文件

JCQ Tool 配置文件

JavaVM 相关

JVM内存限制

32位虽然可控内存空间有4GB,但是具体的操作系统会给一个限制，这个限制一般是2GB-3GB 一般来说Windows系统下为1.5G-2G，Linux系统下为2G-3G，而64bit以上的处理器就不会有限制了

JavaCQ 相关

JSON 文件介绍

正常插件是由以下两部分组成的

• json:此文件用于描述插件信息
• jar :此文件是插件所有class打包而成

JSON文件是用于存储插件信息的文本文件 下面介绍下Json基本信息，详情查看Demo中json注释

整体部分

{  
    "ret"        : 1,   // 返回码，固定为1
    "apiver"     : 9,   // Api版本，本SDK为9
    "name"       : "name",  // 应用的名称
    "version"    : "1.0.0",    // 应用文本版本号 例：1.0.0
    "version_id" : 1,        // 应用顺序版本（每次发布时至少+1）
    "author"     : "author",    // 应用作者
    //"path"       : "lib",    // 应用lib加载处，默认插件同名文件夹目录下lib文件夹，此目录可以填相对路径和绝对路径，相对：应用同名文件夹
    //"class"      : "com.example.Demo", // 应用加载主类，注意必须填写全类名，默认使用appid加载，如需使用则删除前面注释
    "description": "", // 应用描述
    "event"      : [],  //  事件列表，同一事件类型可重复定义（发布前请删除无用事件）
    "menu"       : [],  // 设置菜单
    "status"     : [],  // 悬浮窗状态 (暂无实际功能，后期加入)
    "auth"       : []   // 应用权限
}  

事件部分

{
	// 这是事件部分json，其他部分与上面一致
	"event":
	[  
		// 这里列举私聊事件为例，其他参考Demo中的json
		{  
			"id"      : 1,                      // 事件ID，保持唯一即可
			"type"    : 21,                     // 事件类型，事件类型，用于区分各函数的功能  
			"name"    : "私聊消息处理",          // 事件名称
			"function": "privateMsg",           // 事件对应主类中的函数  
			"priority": 30000                   // 事件优先级 (参见 cqp.im/deveventpriority)  
		}  
	]  
}

菜单部分

{
	// 这是事件部分json，其他部分与上面一致
	"event":
	[  
	    // 菜单会在管理器中被调用
		{
            "name": "设置A", //菜单名称
            "function": "menuA" //菜单对应主类中的函数
        }
	]  
}

最后必须将文件名改为 [appid].json 并和你的jar插件放置到app目录下

使用Demo开发

如果有一定Java基础，则可以转到下文的快速开发

1. 下载 Demo ，导入到开发工具中
2. 参考上方json介绍，根据自己需求修改json文件，文件名需和 appid 相同
3. 查看项目中lib目录，导入其中所需jar文件
4. 打开包中的应用主类，这里建议包到主类的全类名尽量和 appid 保持一致
   注：酷Q是事件驱动的模式，json中定义的事件，在主类中实现事件
5. 根据自己的需求 编写，修改 所需代码，相关CQ类说明在文档下方

    // 群消息事件，详情参考Demo中的主类
    public int groupMsg(int subType, int msgId, long fromGroup, long fromQQ, String fromAnonymous, String msg, int font) {
        // 以下是群消息要执行的代码
        CQ.sendGroupMsg(fromGroup, msg + "Java插件");
        return 0;
    }

6. 在json中，指定主类
   注：如不设置则利用appid加载，最后一个单词自动大写查找 例：appid(com.example.demo) 则加载类 com.example.Demo
7. 然后使用开发工具进行编译打包成jar
8. 将jar依赖lib导入放置到，全局lib或单独lib中，jcq-coolq和commons-codec，工具自带了，可以不用导入
   注：导入的依赖jar，尽量保证版本一致，避免不必要的错误
9. 将打包好的jar和json，一起复制到 app 目录下
10. 启动或重启酷Q即可运行插件
    注：因为JRE不能重新加载，重新加载插件需重启酷Q，重启插件无效
11. 触发事件开始体验自己的插件吧，喵呜~

快速开发

此步骤面向一定Java基础的开发者

1. 待续，暂未完成....

Maven 导入

    <groupId>org.meowy.cqp</groupId>
    <artifactId>jcq-coolq</artifactId>
    <version>1.3.0</version>

JCQ-CoolQ 常用类说明

JCQ JavaDoc http://sobte.gitee.io/jcq-wiki/
其中包括JCQ所有类的注释

CoolQ 类
酷Q操作的核心类

CQCode 类
CQ码 ，用于辅助开发加快开发效率，以下方法均返回 CQ码 文本

支持赞助作者

可以加入交流群赞助：427984429