在使用 Go-Zero 框架设计一个基于 JWT 的 API 时，你可以遵循一些最佳实践，确保代码结构清晰且易于维护。以下是一个简单的示例，展示如何设计一个包含用户注册、登录和受保护资源的 JWT 认证 API。
项目结构
首先，我们可以设计项目目录结构如下：
myapp/
├── main.go
├── handler/
│ ├── user.go
├── model/
│ └── user.go
└── middleware/
└── auth.go
1. 用户模型（model/user.go）
package model
type User struct {
Username string `json:"username"`
Password string `json:"password"`
}
2. JWT 逻辑（middleware/auth.go）
这里我们将创建用于生成和验证 JWT 的逻辑。
package middleware
import (
"github.com/dgrijalva/jwt-go"
"time"
)
var jwtSecret = []byte("your_secret_key") // 替换为自己的密钥
// GenerateToken 创建JWT Token
func GenerateToken(username string) (string, error) {
claims := jwt.MapClaims{
"username": username,
"exp": time.Now().Add(time.Hour * 72).Unix(), // 设置过期时间为72小时
}
token := jwt.NewWithClaims(jwt.SigningMethodHS256, claims)
return token.SignedString(jwtSecret)
}
// ValidateToken 验证JWT Token并返回解析后的token信息
func ValidateToken(tokenStr string) (*jwt.Token, error) {
return jwt.Parse(tokenStr, func(token *jwt.Token) (interface{}, error) {
if _, ok := token.Method.(*jwt.SigningMethodHMAC); !ok {
return nil, jwt.ErrSignatureInvalid
}
return jwtSecret, nil
})
}
3. 用户处理逻辑（handler/user.go）
处理用户的注册和登录请求。
package handler
import (
"net/http"
"github.com/gin-gonic/gin"
"myapp/middleware"
"myapp/model"
)
var users = make(map[string]string) // 存储用户信息（仅供示例，不建议在生产环境中使用此方式）
// Register 注册用户接口
func Register(c *gin.Context) {
var user model.User
if err := c.ShouldBindJSON(&user); err != nil || user.Username == "" || user.Password == "" {
c.JSON(http.StatusBadRequest, gin.H{"error": "Invalid input"})
return
}
users[user.Username] = user.Password // 保存用户数据（实际应使用数据库）
c.JSON(http.StatusOK, gin.H{"message": "User registered successfully!"})
}
// Login 登录接口，生成JWT Token并返回给客户端。
func Login(c *gin.Context) {
var user model.User
if err := c.ShouldBindJSON(&user); err != nil || user.Username == "" || user.Password == "" {
c.JSON(http.StatusBadRequest, gin.H{"error": "Invalid input"})
return
}
if password, exists := users[user.Username]; exists && password == user.Password {
token, err := middleware.GenerateToken(user.Username)
if err != nil {
c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
return
}
c.JSON(http.StatusOK, gin.H{"token": token})
} else {
c.JSON(http.StatusUnauthorized, gin.H{"error": "Unauthorized"})
}
}
// ProtectedHandler 一个受保护的API接口，需要提供有效的Token才能访问。
func ProtectedHandler(c *gin.Context) {
c.JSON(http.StatusOK, gin.H{"message": "Welcome to the protected route!"})
}
4. 主程序入口（main.go）
在主程序中设置路由，并添加身份验证中间件。
package main
import (
"github.com/gin-gonic/gin"
"myapp/handler"
)
func main() {
router := gin.Default()
router.POST("/register", handler.Register)
router.POST("/login", handler.Login)
authGroup := router.Group("/protected")
authGroup.Use(authMiddleware()) // 添加身份验证中间件来保护路由。
authGroup.GET("/", handler.ProtectedHandler)
router.Run(":8080")
}
// authMiddleware 验证请求中的JWT Token。
func authMiddleware() gin.HandlerFunc {
return func(c *gin.Context) {
tokenString := c.Request.Header.Get("Authorization")
if len(tokenString) < 7 || tokenString[:7] != "Bearer " {
c.AbortWithStatusJSON(http.StatusUnauthorized, gin.H{"error": "Unauthorized"})
return
}
tokenStr := tokenString[7:]
token, err := middleware.ValidateToken(tokenStr)
if err != nil || !token.Valid {
c.AbortWithStatusJSON(http.StatusUnauthorized, gin.H{"error": "Unauthorized"})
return
}
c.Next()
}
}
编译与运行
- 保存以上代码到相应文件。
- 在终端中执行以下命令启动服务器：
go run main.go handler/user.go middleware/auth.go model/user.go - 启动后，可以通过 Postman 或 curl 测试 API。
- 注册用户：
curl -X POST http://localhost:8080/register -H 'Content-Type: application/json' -d '{"username":"test","password":"pass"}'
- 登录获取 Token：
curl -X POST http://localhost:8080/login -H 'Content-Type: application/json' -d '{"username":"test","password":"pass"}'
如果成功，会返回一个包含 Token 的 JSON 响应。
- 访问受保护的 API：
curl -X GET http://localhost:8080/protected -H 'Authorization: Bearer your_token_here'
替换 your_token_here 为之前获得的 Token。
总结
以上是一个简单的基于 Go-Zero 框架实现 JWT 身份认证 API 的设计方案。这个基础示例可以根据具体需求扩展，例如连接数据库进行用户管理、配置更多中间件、增加日志记录等功能。如果你有更多具体问题或需要进一步定制，请告诉我！
内容由零声教学AI助手提供，问题来源于学员提问
