初步实现审计
This commit is contained in:
98
internal/app/middleware/audit.go
Normal file
98
internal/app/middleware/audit.go
Normal file
@@ -0,0 +1,98 @@
|
||||
// Package middleware 存放 gin 中间件
|
||||
package middleware
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"encoding/json"
|
||||
"io"
|
||||
"strconv"
|
||||
|
||||
"git.huangwc.com/pig/pig-farm-controller/internal/app/service/audit"
|
||||
"github.com/gin-gonic/gin"
|
||||
)
|
||||
|
||||
// --- 审计日志相关上下文键 ---
|
||||
const (
|
||||
ContextAuditActionType = "auditActionType"
|
||||
ContextAuditTargetResource = "auditTargetResource"
|
||||
ContextAuditDescription = "auditDescription"
|
||||
)
|
||||
|
||||
// AuditLogMiddleware 创建一个Gin中间件,用于在请求结束后记录用户操作审计日志
|
||||
func AuditLogMiddleware(auditService audit.Service) gin.HandlerFunc {
|
||||
return func(c *gin.Context) {
|
||||
// 使用自定义的 response body writer 来捕获响应体
|
||||
blw := &bodyLogWriter{body: bytes.NewBufferString(""), ResponseWriter: c.Writer}
|
||||
c.Writer = blw
|
||||
|
||||
// 首先执行请求链中的后续处理程序(即业务控制器)
|
||||
c.Next()
|
||||
|
||||
// --- 在这里,请求已经处理完毕 ---
|
||||
|
||||
// 从上下文中尝试获取由控制器设置的业务审计信息
|
||||
actionType, exists := c.Get(ContextAuditActionType)
|
||||
if !exists {
|
||||
// 如果上下文中没有 actionType,说明此接口无需记录审计日志,直接返回
|
||||
return
|
||||
}
|
||||
|
||||
// 获取其他审计信息
|
||||
description, _ := c.Get(ContextAuditDescription)
|
||||
targetResource, _ := c.Get(ContextAuditTargetResource)
|
||||
|
||||
// 判断操作状态
|
||||
status := "success"
|
||||
resultDetails := ""
|
||||
if c.Writer.Status() >= 400 {
|
||||
status = "failed"
|
||||
// 尝试从捕获的响应体中解析错误信息
|
||||
var errResp struct {
|
||||
Error string `json:"error"`
|
||||
}
|
||||
if err := json.Unmarshal(blw.body.Bytes(), &errResp); err == nil {
|
||||
resultDetails = errResp.Error
|
||||
} else {
|
||||
resultDetails = "HTTP Status: " + strconv.Itoa(c.Writer.Status())
|
||||
}
|
||||
}
|
||||
|
||||
// 调用审计服务记录日志(异步)
|
||||
auditService.LogAction(
|
||||
c,
|
||||
actionType.(string),
|
||||
description.(string),
|
||||
targetResource,
|
||||
status,
|
||||
resultDetails,
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
// bodyLogWriter 是一个自定义的 gin.ResponseWriter,用于捕获响应体
|
||||
// 这对于在操作失败时记录详细的错误信息非常有用
|
||||
type bodyLogWriter struct {
|
||||
gin.ResponseWriter
|
||||
body *bytes.Buffer
|
||||
}
|
||||
|
||||
func (w bodyLogWriter) Write(b []byte) (int, error) {
|
||||
w.body.Write(b)
|
||||
return w.ResponseWriter.Write(b)
|
||||
}
|
||||
|
||||
func (w bodyLogWriter) WriteString(s string) (int, error) {
|
||||
w.body.WriteString(s)
|
||||
return w.ResponseWriter.WriteString(s)
|
||||
}
|
||||
|
||||
// ReadBody 用于安全地读取请求体,并防止其被重复读取
|
||||
func ReadBody(c *gin.Context) ([]byte, error) {
|
||||
bodyBytes, err := io.ReadAll(c.Request.Body)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
// 将读取的内容放回 Body 中,以便后续的处理函数可以再次读取
|
||||
c.Request.Body = io.NopCloser(bytes.NewBuffer(bodyBytes))
|
||||
return bodyBytes, nil
|
||||
}
|
||||
@@ -5,18 +5,16 @@ import (
|
||||
"net/http"
|
||||
"strings"
|
||||
|
||||
"git.huangwc.com/pig/pig-farm-controller/internal/app/service/audit"
|
||||
"git.huangwc.com/pig/pig-farm-controller/internal/app/service/token"
|
||||
"git.huangwc.com/pig/pig-farm-controller/internal/infra/repository"
|
||||
"github.com/gin-gonic/gin"
|
||||
)
|
||||
|
||||
const (
|
||||
// ContextUserIDKey 是存储在 gin.Context 中的用户ID的键名
|
||||
ContextUserIDKey = "userID"
|
||||
"gorm.io/gorm"
|
||||
)
|
||||
|
||||
// AuthMiddleware 创建一个Gin中间件,用于JWT身份验证
|
||||
// 它依赖于 TokenService 来解析和验证 token
|
||||
func AuthMiddleware(tokenService token.TokenService) gin.HandlerFunc {
|
||||
// 它依赖于 TokenService 来解析和验证 token,并使用 UserRepository 来获取完整的用户信息
|
||||
func AuthMiddleware(tokenService token.TokenService, userRepo repository.UserRepository) gin.HandlerFunc {
|
||||
return func(c *gin.Context) {
|
||||
// 从 Authorization header 获取 token
|
||||
authHeader := c.GetHeader("Authorization")
|
||||
@@ -41,8 +39,21 @@ func AuthMiddleware(tokenService token.TokenService) gin.HandlerFunc {
|
||||
return
|
||||
}
|
||||
|
||||
// 将解析出的用户ID存储在 context 中,以便后续的处理函数使用
|
||||
c.Set(ContextUserIDKey, claims.UserID)
|
||||
// 根据 token 中的用户ID,从数据库中获取完整的用户信息
|
||||
user, err := userRepo.FindByID(claims.UserID)
|
||||
if err != nil {
|
||||
if err == gorm.ErrRecordNotFound {
|
||||
// Token有效,但对应的用户已不存在
|
||||
c.AbortWithStatusJSON(http.StatusUnauthorized, gin.H{"error": "授权用户不存在"})
|
||||
return
|
||||
}
|
||||
// 其他数据库查询错误
|
||||
c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"error": "获取用户信息失败"})
|
||||
return
|
||||
}
|
||||
|
||||
// 将完整的用户对象存储在 context 中,以便后续的处理函数使用
|
||||
c.Set(audit.ContextUserKey, user)
|
||||
|
||||
// 继续处理请求链中的下一个处理程序
|
||||
c.Next()
|
||||
|
||||
Reference in New Issue
Block a user