9e11f8f007
按"同一能力只保留一个主入口、框架不替上层吞错、安全路径默认 fail-closed"原则, 收敛历史双轨 API。自定义 CacheService/Storage 实现需同步更新签名(编译失败即迁移信号)。 cache: - CacheService.Get/Exists 改为 (bool, error):命中 (true,nil)、未命中 (false,nil)、 Redis 未就绪/命令错误/反序列化失败返回 (false,err) - 删除 cache.GetE/cache.ExistsE/CacheGetter/CacheExistChecker/redisCache.GetE/redisCache.ExistsE (不保留 deprecated wrapper) - 新增包级 cache.Get/cache.Exists(带 error);GetWithPrefix 改为 (bool,error) jwt: - TokenBlacklist.IsBlacklisted 改为 (bool, error),删除 IsBlacklistedE - IsTokenRevoked 改为 (bool, error) - ParseToken 默认从 fail-open 改为 fail-closed:黑名单后端不可检查时返回 ErrBlacklistUnavailable 拒绝该 Token(无 Redis 部署不再支持可靠撤销) - 删除 ParseTokenFailClosed(主 API 已 fail-closed) - 保留 ParseTokenWithBlacklistPolicy + BlacklistPolicy/BlacklistFailOpen/BlacklistFailClosed 供显式 fail-open(仅无 Redis 或低安全场景) storage: - Storage.Exists 改为 (bool, error):存在 (true,nil)、不存在 (false,nil)、 未初始化/路径非法/穿越/后端错误返回 (false,err) - LocalStorage.Exists 区分 os.IsNotExist 与其他 Stat 错误 - OSSStorage.Exists 区分 OSS 404/NoSuchKey 与鉴权/网络错误 - 包级 storage.Exists 同步签名,未初始化返回 ErrStorageNotInitialized - 新增 ErrReadTooLarge:Local/OSSStorage.Get 读取超 maxReadBytes 上限原误用 ErrInvalidPath(语义不贴切),改为 ErrReadTooLarge ratelimit: - NewRedisRateLimiter 加 opts ...RedisRateLimiterOption,新增 WithFailClosed(bool) 替代原 NewRedisRateLimiterFailClosed - RedisRateLimit/CustomRedisRateLimit/RedisRateLimitWithIdentifier 同步加 opts 参数 - 删除 NewRedisRateLimiterFailClosed/RedisRateLimitFailClosed/CustomRedisRateLimitFailClosed - UploadRedisRateLimit 由 fail-open 改为 fail-closed(资源敏感操作,Redis 故障时拒绝) 测试与文档: - cache_m10_internal_test.go 重写 4 个 M10 测试为 Get/Exists 契约测试,新增 mock 编译覆盖 - jwt_test.go 改 4 处;jwt_c9c_internal_test.go 改 IsTokenRevoked 2-value - examples/full/main_test.go 加 miniredis 注入(ParseToken fail-closed 后认证需 Redis) - middleware_test.go 改 5 处 FailClosed 调用为 WithFailClosed(true);auth_test.go 加 Redis - storage 测试改 6 处 Exists/Get 断言为新签名/错误类型 - README/GUIDE 同步示例为新签名;CHANGELOG 新增 Breaking 升级说明与迁移示例 验证:go build / go vet / go test -race -count=1 ./... 全绿。 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
xlgo 示例
两个可运行示例,帮助快速上手 xlgo。
minimal — 最小 HTTP 服务
不依赖 MySQL / Redis / Storage,纯 HTTP + 健康检查。第一次接触 xlgo 从这里开始。
go run ./examples/minimal
访问 http://localhost:8081/health(健康检查)与 http://localhost:8081/api/v1/(示例路由)。
full — 完整业务 API
包含 MySQL + Redis + JWT + 一个 user CRUD(登录发 token、认证路由、创建/查询用户)。
运行前需准备:
- MySQL(修改
examples/full/config.yaml的database配置) - Redis(修改
examples/full/config.yaml的redis配置)
go run ./examples/full
启动后自动迁移 user 表,并初始化示例用户 alice/secret(密码以 bcrypt 哈希保存)。接口:
| 方法 | 路径 | 说明 | 认证 |
|---|---|---|---|
| POST | /api/v1/login | 登录,返回 token | 否 |
| GET | /api/v1/users/:id | 查询用户 | 是(Bearer token) |
| POST | /api/v1/users | 创建用户 | 是(Bearer token) |
登录示例:
curl -X POST http://localhost:8082/api/v1/login \
-H "Content-Type: application/json" \
-d '{"username":"alice","password":"secret"}'
创建用户示例:
curl -X POST http://localhost:8082/api/v1/users \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <token>" \
-d '{"username":"bob","password":"s3cret"}'
示例代码为演示用途,已演示 bcrypt 密码哈希与登录校验;生产环境仍需配合
validation包完善入参校验、密码强度策略与用户注册流程。