ffcb1a77b9
对 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>
176 lines
4.4 KiB
Go
176 lines
4.4 KiB
Go
// Package main 是 xlgo 的完整示例:MySQL + Redis + JWT + 一个 user CRUD。
|
||
//
|
||
// 运行前需准备:
|
||
// - MySQL(config.yaml 中 database 配置)
|
||
// - Redis(config.yaml 中 redis 配置)
|
||
//
|
||
// 启动后会自动迁移 user 表。访问:
|
||
//
|
||
// POST /api/v1/login {"username":"alice","password":"secret"} → 返回 token
|
||
// GET /api/v1/users/:id (需 Authorization: Bearer <token>)
|
||
// POST /api/v1/users (需 Authorization: Bearer <token>,创建用户)
|
||
//
|
||
// 示例会在启动时初始化 alice/secret,密码以 bcrypt 哈希保存。
|
||
//
|
||
// 运行:
|
||
//
|
||
// go run ./examples/full
|
||
package main
|
||
|
||
import (
|
||
"context"
|
||
"errors"
|
||
"fmt"
|
||
"os"
|
||
|
||
xlgo "github.com/EthanCodeCraft/xlgo-core"
|
||
"github.com/EthanCodeCraft/xlgo-core/database"
|
||
"github.com/EthanCodeCraft/xlgo-core/jwt"
|
||
"github.com/EthanCodeCraft/xlgo-core/middleware"
|
||
"github.com/EthanCodeCraft/xlgo-core/repository"
|
||
"github.com/EthanCodeCraft/xlgo-core/response"
|
||
"github.com/EthanCodeCraft/xlgo-core/router"
|
||
"github.com/EthanCodeCraft/xlgo-core/validation"
|
||
"github.com/gin-gonic/gin"
|
||
"gorm.io/gorm"
|
||
)
|
||
|
||
// User 示例模型
|
||
type User struct {
|
||
gorm.Model
|
||
Username string `gorm:"uniqueIndex;size:64" json:"username"`
|
||
Password string `gorm:"size:128" json:"-"` // bcrypt 哈希,永不返回给客户端
|
||
UserType string `gorm:"size:32" json:"user_type"`
|
||
}
|
||
|
||
var userRepo *repository.BaseRepo[User]
|
||
|
||
func main() {
|
||
app := xlgo.NewFullStack(
|
||
xlgo.WithConfigPath("./examples/full/config.yaml"),
|
||
xlgo.WithModels(&User{}),
|
||
xlgo.WithMiddlewares(middleware.Logger(), middleware.CORS()),
|
||
xlgo.WithModules(router.ModuleFunc(registerRoutes)),
|
||
xlgo.WithHook(xlgo.Hook{
|
||
Name: "seed-example-user",
|
||
OnInit: func(*xlgo.App) error {
|
||
return ensureExampleUser(context.Background())
|
||
},
|
||
}),
|
||
)
|
||
|
||
if err := app.Run(); err != nil {
|
||
fmt.Printf("启动失败: %v\n", err)
|
||
os.Exit(1)
|
||
}
|
||
}
|
||
|
||
func registerRoutes(r *gin.RouterGroup) {
|
||
// 延迟初始化 repo:此时 App.Init 已完成,database.GetDB() 可用
|
||
userRepo = repository.NewBaseRepo[User](database.GetDB())
|
||
|
||
api := r.Group("/api/v1")
|
||
|
||
// 公开路由:登录
|
||
api.POST("/login", login)
|
||
|
||
// 认证路由
|
||
auth := api.Group("/", middleware.AuthRequired())
|
||
auth.GET("/users/:id", getUser)
|
||
auth.POST("/users", createUser)
|
||
}
|
||
|
||
func login(c *gin.Context) {
|
||
var req struct {
|
||
Username string `json:"username" binding:"required"`
|
||
Password string `json:"password" binding:"required"`
|
||
}
|
||
if err := c.ShouldBindJSON(&req); err != nil {
|
||
response.Fail(c, "参数错误")
|
||
return
|
||
}
|
||
|
||
u, err := userRepo.FindOne(c.Request.Context(), "username = ?", req.Username)
|
||
if err != nil {
|
||
response.Fail(c, "用户名或密码错误")
|
||
return
|
||
}
|
||
if !validation.CheckPassword(u.Password, req.Password) {
|
||
response.Fail(c, "用户名或密码错误")
|
||
return
|
||
}
|
||
|
||
token, err := jwt.GenerateToken(u.ID, u.Username, "user", u.UserType)
|
||
if err != nil {
|
||
response.ServerError(c, "生成 token 失败")
|
||
return
|
||
}
|
||
response.Success(c, gin.H{"token": token})
|
||
}
|
||
|
||
func getUser(c *gin.Context) {
|
||
id := c.Param("id")
|
||
// 示例简化:直接用 repo 查询,实际应转 uint
|
||
var uid uint
|
||
if _, err := fmt.Sscanf(id, "%d", &uid); err != nil {
|
||
response.Fail(c, "用户ID无效")
|
||
return
|
||
}
|
||
u, err := userRepo.FindByID(c.Request.Context(), uid)
|
||
if err != nil {
|
||
response.NotFound(c, "用户不存在")
|
||
return
|
||
}
|
||
response.Success(c, u)
|
||
}
|
||
|
||
func createUser(c *gin.Context) {
|
||
var req struct {
|
||
Username string `json:"username" binding:"required"`
|
||
Password string `json:"password" binding:"required"`
|
||
UserType string `json:"user_type"`
|
||
}
|
||
if err := c.ShouldBindJSON(&req); err != nil {
|
||
response.Fail(c, "参数错误")
|
||
return
|
||
}
|
||
|
||
hash, err := validation.HashPassword(req.Password)
|
||
if err != nil {
|
||
response.ServerError(c, "密码加密失败")
|
||
return
|
||
}
|
||
u := User{
|
||
Username: req.Username,
|
||
Password: hash,
|
||
UserType: req.UserType,
|
||
}
|
||
if u.UserType == "" {
|
||
u.UserType = "user"
|
||
}
|
||
if err := userRepo.Create(c.Request.Context(), &u); err != nil {
|
||
response.Fail(c, "创建失败: "+err.Error())
|
||
return
|
||
}
|
||
response.Success(c, u)
|
||
}
|
||
|
||
func ensureExampleUser(ctx context.Context) error {
|
||
_, err := userRepo.FindOne(ctx, "username = ?", "alice")
|
||
if err == nil {
|
||
return nil
|
||
}
|
||
if !errors.Is(err, gorm.ErrRecordNotFound) {
|
||
return err
|
||
}
|
||
hash, err := validation.HashPassword("secret")
|
||
if err != nil {
|
||
return err
|
||
}
|
||
return userRepo.Create(ctx, &User{
|
||
Username: "alice",
|
||
Password: hash,
|
||
UserType: "user",
|
||
})
|
||
}
|