# mod-CQ码工具
[![](https://img.shields.io/badge/simple--robot-module-green)](https://github.com/ForteScarlet/simple-robot-core) [![](https://img.shields.io/maven-central/v/io.github.ForteScarlet.simple-robot-module/mod-cqcodeutils)](https://search.maven.org/artifact/io.github.ForteScarlet.simple-robot-module/mod-cqcodeutils)
>[success] 核心`1.16.0`之后默认集成了此模组。
## **介绍**
核心中本身存在一个CQ码工具类`CQCodeUtil`,以及其衍生类,例如`CQCode`封装类、`CQCodeTypes`枚举类等。但是这些类目前来看都有些略显冗余,因此我计划使用一个新的CQ码工具包来支持一些简单的操作:
- 或许是靠单纯的字符串拼接等来获取CQ码而不是对象之间的转化
- 也或许是用一个简单的封装类来取代`CQCode`封装类,同时实现其相互转化
- 又或许是在其他非simple-robot项目中临时使用,单纯作为一个工具类
这是一个简易的,主要**以字符串操作**为主的CQ码操作工具类。
>[info] **其内容会随着版本一点点的增加或变更,因此此章节可能会跟随版本升级不定期更新,并且文档内容以最新版为准。**
>[info] **如果出现了文档与实际代码不符的情况,以实际代码及其注释为准。**
## **使用**
### 1. **依赖导入**
#### **Maven**
```xml
<dependency>
<groupId>io.github.ForteScarlet.simple-robot-module</groupId>
<artifactId>mod-cqcodeutils</artifactId>
<version>${version}</version> <!-- 参考版本:1.5.0-1.15 -->
</dependency>
```
#### **gradle**
```gradle
compile group: 'io.github.ForteScarlet.simple-robot-module', name: 'mod-cqcodeutils', version: '${version}'
```
<br><br>
### **2. 开始使用**
请查看此章节的各**子章节**以得到更多使用说明。
你可以从左侧列表或者此页面最下方的的**下一篇**处查看其他子章节页面。
<br><br>
# 注意事项
此模组是以核心的`1.11.x`为基础开始开发的,其版本命名规则类似于组件的命名规则(即`${模组版本}-${核心版本系}`),但是此模组理论上任何版本都可以用,毕竟主要是以字符串操作为主。尽管在CQCode与KQCode相互转化的时候可能因为版本差异出现问题,但是其他功能均为独立的。
因此此模组在核心的早期版本也可以进行使用。
- 前言
- 简单介绍
- 我该如何阅读文档
- 视频教程
- 安装与使用
- 开源协议
- 免责&捐助
- 注意事项
- 版本命名规则简介
- 主要功能版本历史
- 功能指引
- 通用API与功能
- 国际化语言
- 异常
- 消息监听
- @Listen
- @OnListen模板
- @Filter
- 消息参数截取
- @Spare
- @Constr
- @Ignore
- @ListenBreak
- @ListenBreakPlugin
- @ListenBody
- 监听响应
- 成功判定与返回值
- 监听上下文
- 动态参数
- 监听消息API
- 异步监听 @Async
- 限流监听 @Limit
- 自定义Http送信器
- 枚举与类型
- 送信器
- SENDER
- SETTER
- GETTER
- 返回值
- 其他位置
- 日志与日志拦截
- 异常处理
- 依赖注入
- 自定义依赖获取
- 批量依赖载入
- 注意事项
- 常量
- 定时任务
- 自定义过滤
- 拦截器
- 拦截器总定义
- 上下文对象总定义
- 监听消息拦截
- 送信器拦截
- 监听函数拦截
- CAT码
- CQ码
- CQCode
- CQ码工具类
- CQ扩展工具类
- AppendList拼接链
- 高级内容
- 阻断机制
- 截断机制
- 自定义枚举类型
- 枚举工厂
- byName注解
- 自定义注解
- 配置
- 文件配置
- 注解配置
- 参数配置
- 多配置
- 多账号
- 自定义账号管理器
- 小心!
- 核心版本与组件如何升级核心
- 核心版本迭代指南
- 核心
- 更新日志
- jar包与依赖
- 监听消息类结构图
- 快速启动
- 模组与扩展
- 模组开发
- 现有模组
- 通用模组-延时任务
- 通用模组-CQ码工具
- 转义器
- CQ码操作工具类
- CQ码模板-CodeTemplate
- CQ码载体-KQCode
- CQ码构建器
- MQ码工具类
- 通用模组-redis-bot管理器
- 通用模组-Debugger
- Debugger-common模块
- Debugger-server模块
- Debugger-client模块
- 通用模组-钉钉机器人
- 组件-Mirai(JVM)
- 快速开始(1.13+)
- springboot-starter
- 注意事项
- 配置
- 额外的内容
- 快速回复
- 额外监听
- CQ码解析
- 组件-酷Q(QQ)-CQ HTTP API(基本失效)
- 快速开始(推荐)
- 快速开始(1.7.x以下,不推荐)
- 快速开始(Springboot启动器)
- 启动器、启动接口与配置类
- 配置
- 文件配置
- 注意事项
- 更新日志
- 额外的内容
- 自定义额外监听
- CQ送信器
- 元事件
- 监听消息类结构图
- 组件-酷Q(QQ)-JCQ(失效)
- 快速开始
- 更新日志
- 额外的内容
- JCQ日志
- 配置
- 注意事项
- 监听消息类结构图
- 组件-酷Q(QQ)-HTTP TO CQ(失效)
- 快速开始(核心1.7.x及以下)
- 启动器、启动接口与配置类
- 配置
- 文件配置
- 注意事项
- 更新日志
- 监听消息类结构图
- 组件-酷Q(QQ)-LEMOC (失效)
- 快速开始(核心1.7.x及以下)
- 配置
- 注意事项
- 更新日志
- 监听消息类结构图
- Springboot快速启动器
- 常见问题汇总
- BUG反馈
- 更新计划总览