Files
xlgo-core/examples
杭州明婳科技 ffcb1a77b9 docs: 注释/文档一致性审查修复(A/B/C 三档共 23 项)
对 60 个非测试源文件做文档/注释/代码一致性审查,修复 23 项。全部为注释/文档
改动 + 1 处死代码删除,无运行逻辑变更,无 breaking change。

A 档·实质错误(10 项,会误导下游):
- app.go: closeResources 三连契约注释统一修正--failAfterInit 走
  rollbackReplacedResources 不走 closeResources,closeResources 仅供 doShutdown 复用
- database/manager.go: RandomPicker 注释从过时的 rand.Intn/issue 54899 改为 crypto/rand
- model/base.go: datetime(0) 与“亚秒精度”矛盾,改为 datetime(6)
- cache/keybuilder.go: 三处示例下划线分隔符改为冒号(与默认分隔符 : 一致)
- repository/repository.go: Delete 接口注释从绝对“软删除”改为条件性;
  UpdateFields 示例移除把字段名当 WHERE 条件的误用写法
- middleware/csrf.go: CSRFToken 注释从“用于 API 模式”改为 Cookie/双重提交模式说明
- examples/full/main.go: POST /users 补上“需 Authorization”标注;删除 _ = app 死代码
- utils/random.go: RandInt/RandInt64 补 min==max 边界说明(对齐 RandIntSecure 写法)

B 档·导出符号注释缺失/不完整(6 项):
- ws/ws.go: 5 个 Type* 常量、4 个 Err* 变量补注释
- console/console.go: 5 个 Level 常量补注释
- jwt/jwt.go: 2 个 Blacklist 常量补注释
- router/router.go: 包级 GroupWithMiddlewareGroup 补注释
- middleware/ratelimit.go: NewRateLimiter 补 panic 条件与 Stop 生命周期说明

C 档·描述不完整(7 项):
- utils/strings.go Substr、convert.go CalcPageCount/CalcOffset、datetime.go
  StartOfMonth/EndOfMonth、file.go CopyFile、validator.go IsChinese、crypto.go HashFile
  补全边界/默认行为/返回值语义
- response/error.go: WithDetail 补 nil 接收者行为说明

验证:go build / go vet / go test -race 全绿。

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-07-12 18:47:12 +08:00
..
2026-06-22 23:21:59 +08:00
2026-07-08 19:36:43 +08:00

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.yamldatabase 配置)
  • Redis(修改 examples/full/config.yamlredis 配置)
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 包完善入参校验、密码强度策略与用户注册流程。