# 注意事项
>[danger] 当前文档为 `1.x` 版本的文档。simple-robot 1.x 版本已经被认定为过时且停止维护,请前往 `2.x` 版本文档:https://www.yuque.com/simpler-robot/simpler-robot-doc
>[info] 我将在这里声明一些注意事项。
## 知识储备
>[success] 首先,这是基于Java写的,所以理所应当的,你应当至少能够熟练书写java基础语法代码,并且懂得如何使用注解与枚举。
>[success] 此项目不仅仅是基于Java,同时是基于Java8的。至于为什么强调这一点,是因为假如你由于种种原因想要阅读源代码,你至少需要了解java中的Lambda表达式、Stream流、LocalDate日期、反射、动态代理等知识。
>[success] 然后,此项目最终的组件框架一般来讲都会部署到Maven仓库,所以你需要懂得如何使用Maven构建一个Java项目。
>[success] 最后,假如你想要加入QQ群水个群、问个问题,欢迎。但是首先你要先明白:平和待人,态度友好,问的问题也不是那种一看就是没过脑子的问题,总会有人乐意帮助你。但是假如态度恶劣,问问题不过脑子,张口就是一个但凡看个文档或者百个度就能解决的问题,你是很难得到帮助的。
<br>
## 版本选择
在选择版本的时候,我建议你尽可能选择高版本。版本之间的一次大改动是从核心`1.0-BETA`开始的,在这之后每一次的版本更新都会修复很多影响使用的BUG。
但是在您选择版本的时候可能会发现我的版本号基本上都是携带`BETA`字样的。所有携带`BETA`字样的版本号均可能存在很多BUG与未完善的地方,但是依旧可用。如果您发现了什么可以优化的地方、恶性BUG、隐形BUG等,请加入QQ群聊告知我,我将会对其进行优化、修复。
<br>
对于版本号的命名,其并没有完全遵守语义化规范,也导致了一些问题。目前正在逐步遵守语义化规范。
<br>
## 文档的阅读
文档乍一看章节、分支很多,但是其实整体上只分为三个部分:`开头部分`、`通用部分`、`组件部分`。
`开头部分`就是前面这些没有子章节的部分,这部分文档会有一些文档的该项目的介绍、前言、免责、捐助、感谢、和整体方面的注意事项与引导。
`整体部分`中讲的大部分是核心框架中的核心功能的使用。这一部分的功能不会因为组件的变动而变动。只要`核心`版本号与文档中说明的一致便可以使用。`整体部分`中基本涵盖了整个框架中`90%`的核心功能,但是核心框架并不提供与插件对接代码的实现,所以剩下的那`10%`便是各个组件的对接功能的实现。
`组件部分`中一般是各个组件的与酷Q插件的链接配置说明(组件独立的说明)和部分代码实例和`demo`示例。
>[info] `整体部分`与`组件部分`中都包括其各自的版本更新日志。如果在使用中出现了功能异常、功能变更的问题,不妨先去看一下更新日志。
<br>
## 核心使用的外部依赖:
| 依赖 | 版本 | 介绍 |
| --- | --- | --- |
| com.alibaba.fastjson | `1.2.54` | 对JSON数据进行操作 |
| org.quartz-scheduler.quartz | `2.3.0` | 整合实现定时任务功能 |
| commons-beanutils.commons-beanutils | `1.9.3` | 对监听函数方法的执行提供帮助 |
| commons-io.commons-io | `2.6` | 对imgCQ的扩展提供帮助 |
| org.apache.httpcomponents.httpclient | `4.5` | 提供httpClient功能 |
| org.apache.httpcomponents.httpcore | `4.4.4` | 同上 |
| org.apache.httpcomponents.httpmime | `4.5` | 同上 |
| io.gitee.ForteScarlet.plusutils.console-plus | `1.2` | 为日志的输出提供彩色效果。(做个宣传,这个也是我做的o(* ̄▽ ̄*)ブ) |
| io.github.ForteScarlet.plusutils.simple-plusutils | `1.0` | 提供各种实用性的工具类、拓展类。(看看这个包路径,没错!这个也是我的项目~ (安利)) |
- 前言
- 简单介绍
- 我该如何阅读文档
- 视频教程
- 安装与使用
- 开源协议
- 免责&捐助
- 注意事项
- 版本命名规则简介
- 主要功能版本历史
- 功能指引
- 通用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反馈
- 更新计划总览