在使用 Go-Zero 框架进行 JWT 认证时,通常会使用 jwt-go
或类似的库来生成和验证 JWT。以下是如何在 Go-Zero 框架中编译一个简单的 JWT API 的步骤。
环境准备
安装 Go:确保你的开发环境中已经安装了 Go。
创建项目:
mkdir myapp
cd myapp
go mod init myapp
安装依赖: 安装 Go-Zero 和 jwt-go 库:
go get github.com/zeromicro/go-zero
go get github.com/dgrijalva/jwt-go
示例代码
1. 创建用户结构体和 JWT 相关逻辑
// user.go
package main
import (
"github.com/dgrijalva/jwt-go"
"time"
)
type User struct {
Username string `json:"username"`
Password string `json:"password"`
}
// JWT 结构体用于包含签名密钥和过期时间等信息
type JWT struct {
SecretKey []byte // 签名密钥
}
// 生成 token 方法
func (j *JWT) 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(j.SecretKey)
}
// 验证 token 方法
func (j *JWT) 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 j.SecretKey, nil
})
}
2. 创建主程序并实现路由
// main.go
package main
import (
"net/http"
"github.com/gin-gonic/gin" // 使用 Gin 框架处理 HTTP 请求,你可以选择其他框架,如 net/http 等。
)
var jwtInstance = &JWT{SecretKey: []byte("your_secret_key")} // 替换为自己的密钥
func main() {
router := gin.Default()
router.POST("/login", loginHandler)
// 添加一个受保护的路由示例,通过token验证访问的API接口。
router.GET("/protected", authMiddleware(), protectedHandler)
router.Run(":8080")
}
// 登录处理函数,生成JWT令牌并返回给客户端。
func loginHandler(c *gin.Context) {
var user User
if err := c.ShouldBindJSON(&user); err != nil || user.Username == "" || user.Password == "" {
c.JSON(http.StatusBadRequest, gin.H{"error": "Invalid input"})
return
}
// 在这里应当有真实用户身份验证逻辑,此处仅作为示例。
if user.Username == "test" && user.Password == "pass" {
token, err := jwtInstance.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"})
}
}
// 身份验证中间件,在请求头中检查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 := jwtInstance.ValidateToken(tokenStr)
if err != nil || !token.Valid {
c.AbortWithStatusJSON(http.StatusUnauthorized, gin.H{"error": "Unauthorized"})
return
}
c.Next()
}
}
// 一个受保护的API接口,只有通过验证后的用户才能访问它。
func protectedHandler(c *gin.Context) {
c.JSON(http.StatusOK, gin.H{"message": "Welcome to the protected route!"})
}
编译与运行
- 保存以上代码到相应文件(如
main.go
和user.go
)。 - 在终端中执行以下命令启动服务器:
go run main.go user.go
- 启动后,可以通过 Postman 或 curl 测试 API。
- 登录获取 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 身份验证的方法。如果你有更多具体问题或者需要进一步定制,请告诉我!
内容由零声教学AI助手提供,问题来源于学员提问