# 命名规则
>[danger] 当前文档为 `1.x` 版本的文档。simple-robot 1.x 版本已经被认定为过时且停止维护,请前往 `2.x` 版本文档:https://www.yuque.com/simpler-robot/simpler-robot-doc
>[danger] 可参考新的说明章节: [组件如何升级核心](./组件如何升级核心.md)
首先先说明,以下所有的规则,均为我的个人推荐,不强制,但是我本人会根据以下规则进行命名版本号。
然后,版本号应当是一串可以有`.`的数字,以及一个可以有的后缀,并且他们之间使用`-`连接
例如:`0.5`、`0.5.22`、`1-BETA`、`1.0.2-ALPHA`
## 核心框架
核心框架作为所有组件的前置依赖,他的命名规则很简单,就是普通的版本号加一个可有可无的后缀。
例如:`0.9`、`0.8.02-BETA`
后缀可有可无,一般为`BETA`这种免责性质的后缀,比如`BETA`就是说:‘这只是测试版,没有大量数据证明他没有太多的bug,所以使用起来请小心’这样子的。
<br>
## 组件框架
组件框架需要依赖核心框架,但是核心框架的版本也是在不断地升级,而且功能还很有可能出现部分偏差。
**推荐** 组件框架使用以下的命名规则:
组件框架版本号+后缀+核心框架版本号
组件版本号与核心版本号使用`-`连接,组件版本号在前,核心版本号在后。
例如:`0.5.02-BETA-0.9-BETA`
这就是说,组件框架版本为`0.5.02-BETA`,核心框架版本号为`0.9-BETA`
例如:`1.25.22-1.2-BETA`
这就是说,组件框架版本为`1.25.22`,核心框架版本号为`1.2-BETA`
## 语义化规范
我了解到语义化规范的时候已经比较晚了,所以在比较早的版本中,例如核心1.5.x以前的版本,我都没有很好的去遵守语义化规范,导致很多版本之间是不兼容的。
从**核心1.6.x**版本开始,我会尽可能的做到遵守语义化规范,始得在小版本号相同的情况下不同版本能够向下兼容。
## 语义化规范的一些小修改
虽然说是要遵守语义化规范,但是此框架相对来说,变动可能会比较频繁,所以在普通的语义化规范基础上,我会对此规范做一些小小的私人方面的修改。
一般来讲,核心版本号的格式为:`x.y.z`
其中,x、y、z均为逐步递增的大于等于0的整数。
x为大版本号,一般会在有重大改版的情况下发生递增。
y为小版本号,一般会在出现功能删减、增加或者存在版本不兼容更新的情况下发生递增。(当然,并不一定会不兼容,具体是否向下兼容需要看具体情况。)
z为当前小版本中的更新版本,一般会在bug修复、无功能增减的情况下对系统进行优化等情况下发生递增。在y(小版本)不变的情况下,z版本较大的版本可以向下兼容。
<br>
也就是说,在核心更新而组件并未更新的时候,可以视y、z的版本情况手动添加核心依赖以实现核心更新。
- 前言
- 简单介绍
- 我该如何阅读文档
- 视频教程
- 安装与使用
- 开源协议
- 免责&捐助
- 注意事项
- 版本命名规则简介
- 主要功能版本历史
- 功能指引
- 通用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反馈
- 更新计划总览