Skip to content

Commit 6b9f1f3

Browse files
committed
docs: 添加v1.12.0版本ChangeLog
- 新增完整的版本变更记录文档 - 包含v1.12.0版本的所有功能改进和问题修复 - 遵循语义化版本规范和Keep a Changelog格式 - 提供详细的版本历史记录和贡献指南
1 parent c31c100 commit 6b9f1f3

File tree

1 file changed

+118
-0
lines changed

1 file changed

+118
-0
lines changed

CHANGELOG.md

Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
# ChangeLog
2+
3+
所有重要的项目变更都会记录在此文件中。
4+
5+
本项目遵循 [语义化版本](https://semver.org/lang/zh-CN/) 规范。
6+
7+
## [v1.12.0] - 2024-12-31
8+
9+
### ✨ 新增功能
10+
- 新增 `RedisConnectionException` 异常类,专门处理Redis连接问题
11+
- 新增 `handleSingleDeviceToken()` 公共方法,统一处理单设备登录逻辑
12+
- 新增 `validateRedisParams()` 参数验证方法,提高代码复用性
13+
- 新增 `RedisHandler::isAvailable()` 方法,检查Redis可用性
14+
- 增强单元测试,添加边界条件和异常情况测试
15+
16+
### 🔧 优化改进
17+
- **Redis错误处理优化**: 完善Redis连接检查和异常捕获机制
18+
- **代码重复提取**: 从3处重复代码减少到1个公共方法,减少约30行重复代码
19+
- **参数验证统一化**: 统一TTL和token参数验证逻辑
20+
- **键名生成优化**: 新增 `generateKey()` 方法,统一键名生成逻辑
21+
- **安全执行机制**: 新增 `safeExecute()` 方法,统一Redis操作错误处理
22+
23+
### 🐛 问题修复
24+
- 修复Redis连接失败时的错误处理
25+
- 修复参数验证不完善的问题
26+
- 修复单设备登录逻辑中的潜在问题
27+
28+
### 📝 文档改进
29+
- 完善PHPDoc注释,提高代码可读性
30+
- 优化参数和返回值的详细描述
31+
- 增强异常情况的说明
32+
33+
### 🔄 兼容性
34+
- 保持PHP 7.1+版本兼容性
35+
- 保持向后兼容性,不影响现有API
36+
- 所有现有功能保持不变
37+
38+
### 📊 统计信息
39+
- **4个文件** 被修改
40+
- **240行** 新增代码
41+
- **36行** 删除代码
42+
- **1个新文件** 创建
43+
44+
---
45+
46+
## [v1.11.0] - 2024-12-30
47+
48+
### 🔧 问题修复
49+
- 修复ES系列和PS系列算法无法正常使用的问题
50+
- 修正注释,仅提示已支持的算法
51+
52+
### 📝 文档改进
53+
- 更新README文档,优化算法说明
54+
55+
---
56+
57+
## [v1.10.0] - 2024-12-29
58+
59+
### 🔧 问题修复
60+
- 修复token参数隐式可空类型问题,避免弃用警告
61+
- 关闭默认支持get请求获取令牌功能
62+
63+
### ✨ 新增功能
64+
- 增加GET方式获取令牌的支持
65+
- 添加令牌过期错误码定义
66+
67+
---
68+
69+
## [v1.9.0] - 2024-12-28
70+
71+
### 🔧 问题修复
72+
- 修复获取当前用户信息返回类型问题,支持数组和对象返回
73+
74+
---
75+
76+
## [v1.8.0] - 2024-12-27
77+
78+
### ✨ 新增功能
79+
- 初始版本发布
80+
- 支持多种JWT签名算法
81+
- 支持单设备登录
82+
- 支持Redis缓存
83+
- 完整的令牌生命周期管理
84+
85+
### 🎯 核心特性
86+
- JSON Web Token (JWT) 认证
87+
- 支持对称和非对称加密算法
88+
- access_token + refresh_token 双令牌机制
89+
- 多客户端支持(WEB、MOBILE、APP等)
90+
- Redis缓存管理
91+
- 完善的错误处理机制
92+
93+
---
94+
95+
## 版本说明
96+
97+
### 版本号规则
98+
- **主版本号**: 当有不兼容的API修改时
99+
- **次版本号**: 当添加向下兼容的功能时
100+
- **修订号**: 当进行向下兼容的问题修复时
101+
102+
### 更新日志格式
103+
- **✨ 新增功能**: 新的功能特性
104+
- **🔧 优化改进**: 现有功能的优化
105+
- **🐛 问题修复**: 问题的修复
106+
- **📝 文档改进**: 文档的更新和改进
107+
- **🔄 兼容性**: 兼容性相关说明
108+
- **📊 统计信息**: 代码变更统计
109+
110+
### 贡献指南
111+
如果您想要贡献代码,请确保:
112+
1. 遵循现有的代码风格
113+
2. 添加适当的测试用例
114+
3. 更新相关文档
115+
4. 遵循语义化版本规范
116+
117+
### 📄 许可证
118+
本项目采用 MIT 许可证 - 详见 [LICENSE](LICENSE) 文件

0 commit comments

Comments
 (0)