开发api日志功能

Author: coderps123

cmd/__debug_bin1184263457.exe cmd/__debug_bin423463636.execmd/__debug_bin1184263457.exe renamed to cmd/__debug_bin423463636.exe

@@ -0,0 +1,9 @@
+{
+    "level": "info",
+    "filename": "logs/app.log",
+    "maxSize": 100,
+    "maxBackups": 30,
+    "maxAge": 7,
+    "compress": true,
+    "console": true
+}

config/logger.json

@@ -0,0 +1,22 @@
+package handler
+
+import (
+	"ffly-baisc/internal/service"
+	"ffly-baisc/pkg/response"
+	"net/http"
+
+	"github.com/gin-gonic/gin"
+)
+
+// GetApiLogList 获取用户列表
+func GetApiLogList(c *gin.Context) {
+	var apiLogService service.ApiLogService
+
+	apiLogs, pagination, err := apiLogService.GetApiLogList(c)
+	if err != nil {
+		response.Error(c, http.StatusInternalServerError, "获取日志列表失败", err)
+		return
+	}
+
+	response.SuccessWithPagination(c, apiLogs, pagination, "日志列表获取成功")
+}

internal/handler/api_log.go

@@ -0,0 +1,86 @@
+package middleware
+
+import (
+	"bytes"
+	"io"
+	"strings"
+	"time"
+
+	"ffly-baisc/internal/model"
+	"ffly-baisc/internal/service"
+
+	"github.com/gin-gonic/gin"
+)
+
+type responseBodyWriter struct {
+	gin.ResponseWriter               // 原始的响应写入器
+	body               *bytes.Buffer // 用于保存响应体的缓冲区
+}
+
+func (w *responseBodyWriter) Write(b []byte) (int, error) {
+	w.body.Write(b)                  //  将数据写入缓冲区
+	return w.ResponseWriter.Write(b) //  将数据写入原始的 ResponseWriter
+}
+
+// ApiLog 记录API访问日志
+func ApiLog() gin.HandlerFunc {
+	return func(c *gin.Context) {
+		// 获取请求体
+		var reqBodyBytes []byte
+		if c.Request.Body != nil {
+			// 1. 一次性读取全部内容
+			reqBodyBytes, _ = io.ReadAll(c.Request.Body)
+			// 2. 创建新的缓冲区， 将已读取的请求体数据保存到一个可重复读取的缓冲区
+			newReader := bytes.NewBuffer(reqBodyBytes)
+			// 3. 替换原来的请求体
+			c.Request.Body = io.NopCloser(newReader)
+		}
+
+		responseBodyWriter := &responseBodyWriter{
+			ResponseWriter: c.Writer,        // 原始的 ResponseWriter
+			body:           &bytes.Buffer{}, // 初始化缓冲区
+		}
+		c.Writer = responseBodyWriter // 替换为自定义的 ResponseWriter
+
+		// 开始时间
+		startTime := time.Now()
+
+		// 处理请求
+		c.Next()
+
+		// 计算请求处理时间
+		duration := time.Since(startTime)
+
+		var typeStr string
+		if strings.Contains(c.Request.URL.Path, "/login") {
+			typeStr = "login"
+		} else {
+			typeStr = "operate"
+		}
+
+		// 创建日志记录
+		apiLog := &model.ApiLog{
+			UserID:       c.GetUint("userID"),
+			Username:     c.GetString("username"),
+			Method:       c.Request.Method,
+			Path:         c.Request.URL.Path,
+			Query:        c.Request.URL.RawQuery,
+			Body:         string(reqBodyBytes),
+			ResponseBody: responseBodyWriter.body.String(), // 获取响应体
+			ClientIP:     c.ClientIP(),
+			UserAgent:    c.Request.UserAgent(),
+			Type:         typeStr,
+			StatusCode:   c.Writer.Status(),
+			Duration:     duration.Milliseconds(), // 转换为毫秒
+		}
+
+		// 异步保存日志
+		go func(log *model.ApiLog) {
+			var service service.ApiLogService
+			// 创建日志
+			if err := service.CreateApiLog(log); err != nil {
+				// 记录日志失败
+			}
+		}(apiLog)
+	}
+}

internal/middleware/api_log.go

@@ -0,0 +1,21 @@
+package model
+
+type ApiLog struct {
+	UserID       uint   `json:"userId"`
+	Username     string `json:"username"`
+	Method       string `json:"method"`
+	Path         string `json:"path"`
+	Query        string `json:"query"`
+	Body         string `json:"body"`
+	UserAgent    string `json:"userAgent"`
+	ClientIP     string `json:"clientIp"`
+	StatusCode   int    `json:"statusCode"`
+	Duration     int64  `json:"duration"`
+	ResponseBody string `json:"responseBody"`
+	Type         string `json:"type"` // operate: 操作日志, login: 登录日志
+	BaseModel
+}
+
+func (log *ApiLog) TableName() string {
+	return "api_logs"
+}

internal/model/api_log.go

@@ -13,6 +13,9 @@ func InitRouter() {
 	gin.SetMode(gin.DebugMode) // 设置运行模式
 	r := gin.Default()
 
+	// 使用 ApiLog 中间件
+	r.Use(middleware.ApiLog())
+
 	// API v1
 	v1 := r.Group("/api/v1")
 	{
@@ -32,6 +35,8 @@ func InitRouter() {
 		routes.ResigterRoleRouter(authGroup)
 		// 注册权限路由
 		routes.ResigterPermissionRouter(authGroup)
+		// 注册 API 日志 路由
+		routes.ResigterApiLogRouter(authGroup)
 	}
 
 	r.Run(fmt.Sprintf(":%d", config.GlobalConfig.App.Port)) // 监听端口

internal/router/router.go

@@ -0,0 +1,14 @@
+package routes
+
+import (
+	"ffly-baisc/internal/handler"
+
+	"github.com/gin-gonic/gin"
+)
+
+func ResigterApiLogRouter(g *gin.RouterGroup) {
+	group := g.Group("/api_log")
+	{
+		group.GET("", handler.GetApiLogList)
+	}
+}

internal/router/routes/api_log.go

@@ -0,0 +1,33 @@
+package service
+
+import (
+	"ffly-baisc/internal/db"
+	"ffly-baisc/internal/model"
+	"ffly-baisc/pkg/pagination"
+
+	"github.com/gin-gonic/gin"
+)
+
+type ApiLogService struct{}
+
+// GetApiLogList 获取用户列表
+func (service *ApiLogService) GetApiLogList(c *gin.Context) ([]*model.ApiLog, *pagination.Pagination, error) {
+	var apiLogs []*model.ApiLog
+
+	// 查询权限列表
+	pagination, err := pagination.GetListByContext(db.DB.MySQL, &apiLogs, c)
+	if err != nil {
+		return nil, nil, err
+	}
+
+	return apiLogs, pagination, nil
+}
+
+// CreateApiLog 创建api日志
+func (service *ApiLogService) CreateApiLog(apiLog *model.ApiLog) error {
+	if err := db.DB.MySQL.Create(apiLog).Error; err != nil {
+		return err
+	}
+
+	return nil
+}

internal/service/api_log.go

@@ -114,13 +114,32 @@ create table if not exists `role_permissions` (
   references `permissions` (`id`) on delete cascade on update cascade -- 引用 permissions.id 并设置级联删除和更新
 ) engine=innodb auto_increment=1 comment='角色权限关联表';
 
+-- 创建日志表
+create table if not exists `api_logs` (
+  `id` bigint unsigned not null auto_increment comment 'ID',
+  `user_id` bigint unsigned not null comment '用户id',
+  `username` varchar(50) not null comment '用户名',
+  `path` varchar(255) not null comment '请求路径',
+  `method` varchar(10) not null comment '请求方法',
+  `query` text default null comment '请求参数',
+  `body` text default null comment '请求体',
+  `user_agent` varchar(255) not null comment '用户代理',
+  `client_ip` varchar(20) not null comment '客户端IP',
+  `status_code` int not null comment '状态码',
+  `duration` bigint not null comment '请求耗时(ms)',
+  `response_body` text default null comment '响应体',
+  `type` enum('operate', 'login') not null comment '日志类型, operate: 操作日志, login: 登录日志',
+  `created_at` timestamp not null default current_timestamp comment '创建时间',
+  `updated_at` timestamp not null default current_timestamp on update current_timestamp comment '更新时间',
+  `deleted_at` timestamp null default null comment '删除时间',
+  primary key (`id`)
+) engine=innodb auto_increment=1 comment='日志表';
 
+-- -- 修改表
+-- alter table `users` 
+-- add unique key `uk_username` (`username`),
+-- add unique key `uk_email` (`email`),
+-- add unique key `uk_phone` (`phone`);
 
--- 修改表
-alter table `users` 
-add unique key `uk_username` (`username`),
-add unique key `uk_email` (`email`),
-add unique key `uk_phone` (`phone`);
-
-alter table `permissions` 
-modify column `type` enum('menu', 'button') not null comment '权限类型, menu: 菜单, button: 按钮';
+-- alter table `permissions` 
+-- modify column `type` enum('menu', 'button') not null comment '权限类型, menu: 菜单, button: 按钮';