docs(middleware): 完善JWT中间件函数的注释说明

Author: dengmengmian

internal/pkg/middleware/AuthMiddleware.go

@@ -21,7 +21,8 @@ import (
 	"github.com/gin-gonic/gin"
 )
 
-// 初始化jwt中间件
+// InitAuth 初始化JWT中间件，配置认证、授权、登录、登出等处理函数
+// InitAuth initializes JWT middleware and configures authentication, authorization, login, logout handlers
 func InitAuth() (*jwt.GinJWTMiddleware, error) {
 	authMiddleware, err := jwt.New(&jwt.GinJWTMiddleware{
 		Realm:           config.Conf.Jwt.Realm,                                 // jwt标识
@@ -43,7 +44,8 @@ func InitAuth() (*jwt.GinJWTMiddleware, error) {
 	return authMiddleware, err
 }
 
-// 有效载荷处理
+// payloadFunc 处理JWT有效载荷，将用户数据转换为Claims格式
+// payloadFunc handles JWT payload and converts user data to Claims format
 func payloadFunc(data interface{}) jwt.MapClaims {
 	if v, ok := data.(map[string]interface{}); ok {
 		var user model.Admin
@@ -57,7 +59,8 @@ func payloadFunc(data interface{}) jwt.MapClaims {
 	return jwt.MapClaims{}
 }
 
-// 解析Claims
+// identityHandler 解析JWT Claims，提取用户身份信息
+// identityHandler parses JWT Claims and extracts user identity information
 func identityHandler(c *gin.Context) interface{} {
 	claims := jwt.ExtractClaims(c)
 	// 此处返回值类型map[string]interface{}与payloadFunc和authorizator的data类型必须一致, 否则会导致授权失败还不容易找到原因
@@ -67,7 +70,8 @@ func identityHandler(c *gin.Context) interface{} {
 	}
 }
 
-// 校验token的正确性, 处理登录逻辑
+// login 校验用户登录凭据，验证用户名和密码的正确性
+// login validates user login credentials and verifies username and password
 func login(c *gin.Context) (interface{}, error) {
 	var req vo.RegisterAndLoginRequest
 	// 请求json绑定
@@ -101,7 +105,8 @@ func login(c *gin.Context) (interface{}, error) {
 	}, nil
 }
 
-// 用户登录校验成功处理
+// authorizator 处理用户登录校验成功后的授权逻辑，将用户信息保存到上下文
+// authorizator handles authorization logic after successful login validation and saves user info to context
 func authorizator(data interface{}, c *gin.Context) bool {
 	if v, ok := data.(map[string]interface{}); ok {
 		userStr := v["user"].(string)
@@ -115,16 +120,18 @@ func authorizator(data interface{}, c *gin.Context) bool {
 	return false
 }
 
-// 用户登录校验失败处理
+// unauthorized 处理用户登录校验失败的情况，返回本地化的错误信息
+// unauthorized handles user login validation failure and returns localized error messages
 func unauthorized(c *gin.Context, code int, message string) {
 	common.Log.Debugf("JWT认证失败, 错误码: %d, 错误信息: %s", code, message)
 	// 使用本地化的JWT认证失败消息，并包含具体的错误信息
 	localizedMsg := fmt.Sprintf("%s: %s", common.Msg(c, common.MsgJWTAuthFail), message)
 	response.Unauthorized(c, localizedMsg)
 }
 
-// 登录成功后的响应
-func loginResponse(c *gin.Context, code int, token string, expires time.Time) {
+// loginResponse 处理用户登录成功后的响应，返回JWT令牌和过期时间
+// loginResponse handles the response after successful user login and returns JWT token and expiration time
+func loginResponse(c *gin.Context, _code int, token string, expires time.Time) {
 	msg := common.Msg(c, common.MsgLoginSuccess)
 	response.Success(c,
 		gin.H{
@@ -134,14 +141,16 @@ func loginResponse(c *gin.Context, code int, token string, expires time.Time) {
 		msg)
 }
 
-// 登出后的响应
-func logoutResponse(c *gin.Context, code int) {
+// logoutResponse 处理用户登出后的响应，返回本地化的成功消息
+// logoutResponse handles the response after user logout and returns a localized success message
+func logoutResponse(c *gin.Context, _code int) {
 	msg := common.Msg(c, common.MsgLogoutSuccess)
 	response.Success(c, nil, msg)
 }
 
-// 刷新token后的响应
-func refreshResponse(c *gin.Context, code int, token string, expires time.Time) {
+// refreshResponse 处理刷新JWT令牌后的响应，返回新的令牌和过期时间
+// refreshResponse handles the response after JWT token refresh and returns new token and expiration time
+func refreshResponse(c *gin.Context, _code int, token string, expires time.Time) {
 	msg := common.Msg(c, common.MsgRefreshTokenSuccess)
 	response.Success(c,
 		gin.H{