ZBLOG

go-zero框架的 jwt-go api设计

在使用 Go-Zero 框架设计一个基于 JWT 的 API 时,你可以遵循一些最佳实践,确保代码结构清晰且易于维护。以下是一个简单的示例,展示如何设计一个包含用户注册、登录和受保护资源的 JWT 认证 API。

项目结构

首先,我们可以设计项目目录结构如下:

  1. myapp/
  2. ├── main.go
  3. ├── handler/
  4. ├── user.go
  5. ├── model/
  6. └── user.go
  7. └── middleware/
  8. └── auth.go

1. 用户模型(model/user.go

  1. package model
  2. type User struct {
  3. Username string `json:"username"`
  4. Password string `json:"password"`
  5. }

2. JWT 逻辑(middleware/auth.go

这里我们将创建用于生成和验证 JWT 的逻辑。

  1. package middleware
  2. import (
  3. "github.com/dgrijalva/jwt-go"
  4. "time"
  5. )
  6. var jwtSecret = []byte("your_secret_key") // 替换为自己的密钥
  7. // GenerateToken 创建JWT Token
  8. func GenerateToken(username string) (string, error) {
  9. claims := jwt.MapClaims{
  10. "username": username,
  11. "exp": time.Now().Add(time.Hour * 72).Unix(), // 设置过期时间为72小时
  12. }
  13. token := jwt.NewWithClaims(jwt.SigningMethodHS256, claims)
  14. return token.SignedString(jwtSecret)
  15. }
  16. // ValidateToken 验证JWT Token并返回解析后的token信息
  17. func ValidateToken(tokenStr string) (*jwt.Token, error) {
  18. return jwt.Parse(tokenStr, func(token *jwt.Token) (interface{}, error) {
  19. if _, ok := token.Method.(*jwt.SigningMethodHMAC); !ok {
  20. return nil, jwt.ErrSignatureInvalid
  21. }
  22. return jwtSecret, nil
  23. })
  24. }

3. 用户处理逻辑(handler/user.go

处理用户的注册和登录请求。

  1. package handler
  2. import (
  3. "net/http"
  4. "github.com/gin-gonic/gin"
  5. "myapp/middleware"
  6. "myapp/model"
  7. )
  8. var users = make(map[string]string) // 存储用户信息(仅供示例,不建议在生产环境中使用此方式)
  9. // Register 注册用户接口
  10. func Register(c *gin.Context) {
  11. var user model.User
  12. if err := c.ShouldBindJSON(&user); err != nil || user.Username == "" || user.Password == "" {
  13. c.JSON(http.StatusBadRequest, gin.H{"error": "Invalid input"})
  14. return
  15. }
  16. users[user.Username] = user.Password // 保存用户数据(实际应使用数据库)
  17. c.JSON(http.StatusOK, gin.H{"message": "User registered successfully!"})
  18. }
  19. // Login 登录接口,生成JWT Token并返回给客户端。
  20. func Login(c *gin.Context) {
  21. var user model.User
  22. if err := c.ShouldBindJSON(&user); err != nil || user.Username == "" || user.Password == "" {
  23. c.JSON(http.StatusBadRequest, gin.H{"error": "Invalid input"})
  24. return
  25. }
  26. if password, exists := users[user.Username]; exists && password == user.Password {
  27. token, err := middleware.GenerateToken(user.Username)
  28. if err != nil {
  29. c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
  30. return
  31. }
  32. c.JSON(http.StatusOK, gin.H{"token": token})
  33. } else {
  34. c.JSON(http.StatusUnauthorized, gin.H{"error": "Unauthorized"})
  35. }
  36. }
  37. // ProtectedHandler 一个受保护的API接口,需要提供有效的Token才能访问。
  38. func ProtectedHandler(c *gin.Context) {
  39. c.JSON(http.StatusOK, gin.H{"message": "Welcome to the protected route!"})
  40. }

4. 主程序入口(main.go

在主程序中设置路由,并添加身份验证中间件。

  1. package main
  2. import (
  3. "github.com/gin-gonic/gin"
  4. "myapp/handler"
  5. )
  6. func main() {
  7. router := gin.Default()
  8. router.POST("/register", handler.Register)
  9. router.POST("/login", handler.Login)
  10. authGroup := router.Group("/protected")
  11. authGroup.Use(authMiddleware()) // 添加身份验证中间件来保护路由。
  12. authGroup.GET("/", handler.ProtectedHandler)
  13. router.Run(":8080")
  14. }
  15. // authMiddleware 验证请求中的JWT Token。
  16. func authMiddleware() gin.HandlerFunc {
  17. return func(c *gin.Context) {
  18. tokenString := c.Request.Header.Get("Authorization")
  19. if len(tokenString) < 7 || tokenString[:7] != "Bearer " {
  20. c.AbortWithStatusJSON(http.StatusUnauthorized, gin.H{"error": "Unauthorized"})
  21. return
  22. }
  23. tokenStr := tokenString[7:]
  24. token, err := middleware.ValidateToken(tokenStr)
  25. if err != nil || !token.Valid {
  26. c.AbortWithStatusJSON(http.StatusUnauthorized, gin.H{"error": "Unauthorized"})
  27. return
  28. }
  29. c.Next()
  30. }
  31. }

编译与运行

  1. 保存以上代码到相应文件。
  2. 在终端中执行以下命令启动服务器:
    1. go run main.go handler/user.go middleware/auth.go model/user.go
  3. 启动后,可以通过 Postman 或 curl 测试 API。
  • 注册用户
  1. curl -X POST http://localhost:8080/register -H 'Content-Type: application/json' -d '{"username":"test","password":"pass"}'
  • 登录获取 Token
  1. curl -X POST http://localhost:8080/login -H 'Content-Type: application/json' -d '{"username":"test","password":"pass"}'

如果成功,会返回一个包含 Token 的 JSON 响应。

  • 访问受保护的 API
  1. curl -X GET http://localhost:8080/protected -H 'Authorization: Bearer your_token_here'

替换 your_token_here 为之前获得的 Token。

总结

以上是一个简单的基于 Go-Zero 框架实现 JWT 身份认证 API 的设计方案。这个基础示例可以根据具体需求扩展,例如连接数据库进行用户管理、配置更多中间件、增加日志记录等功能。如果你有更多具体问题或需要进一步定制,请告诉我!


内容由零声教学AI助手提供,问题来源于学员提问

本站部分文章来源于网络,版权归原作者所有,如有侵权请联系站长删除。
转载请注明出处:https://golang.0voice.com/?id=22332

分享:
扫描分享到社交APP
上一篇
下一篇
发表列表
游客 游客
此处应有掌声~
评论列表

还没有评论,快来说点什么吧~

联系我们

在线咨询: 点击这里给我发消息

微信号:3007537140

上班时间: 10:30-22:30

关注我们
x

注册

已经有帐号?