设为首页 加入收藏

TOP

[系列] go-gin-api 路由中间件 - 日志记录(三)(一)
2019-09-06 00:25:54 】 浏览:30
Tags:系列 go-gin-api 路由 中间件 -日志 记录

概述

首先同步下项目概况:

上篇文章分享了,规划项目目录和参数验证,其中参数验证使用的是 validator.v8 版本,现已更新到 validator.v9 版本,最新代码查看 github 即可。

这篇文章咱们分享:路由中间件 - 日志记录。

日志是特别重要的一个东西,方便我们对问题进行排查,这篇文章我们实现将日志记录到文本文件中。

这是我规划的,需要记录的参数:

- request 请求数据
    - request_time
    - request_method
    - request_uri
    - request_proto
    - request_ua
    - request_referer
    - request_post_data
    - request_client_ip
    
- response 返回数据
    - response_time
    - response_code
    - response_msg
    - response_data
    
- cost_time 花费时间

Gin 框架中自带 Logger 中间件,我们了解下框架中自带的 Logger 中间件是否满足我们的需求?

gin.Logger()

我们先使用 gin.Logger() 看看效果。

在 route.go SetupRouter 方法中增加代码:

engine.Use(gin.Logger())

运行后多请求几次,日志输出在命令行中:

[GIN] 2019/08/30 - 21:24:16 | 200 |     178.072µs |             ::1 | GET      /ping
[GIN] 2019/08/30 - 21:24:27 | 200 |     367.997µs |             ::1 | POST     /product
[GIN] 2019/08/30 - 21:24:28 | 200 |    2.521592ms |             ::1 | POST     /product

先解决第一个问题,怎么将日志输出到文本中?

在 route.go SetupRouter 方法中增加代码:

f, _ := os.Create(config.AppAccessLogName)
gin.DefaultWriter = io.MultiWriter(f)
engine.Use(gin.Logger())

运行后多请求几次,日志输出在文件中:

[GIN] 2019/08/30 - 21:36:07 | 200 |     369.023µs |             ::1 | GET      /ping
[GIN] 2019/08/30 - 21:36:08 | 200 |      27.585µs |             ::1 | GET      /ping
[GIN] 2019/08/30 - 21:36:10 | 200 |      14.302µs |             ::1 | POST     /product

虽然记录到文件成功了,但是记录的参数不是我们想要的样子。

怎么办呢?

我们需要自定义一个日志中间件,按照我们需要的参数进行记录。

自定义 Logger()

middleware/logger/logger.go

package logger

import (
    "bytes"
    "encoding/json"
    "fmt"
    "github.com/gin-gonic/gin"
    "go-gin-api/app/config"
    "go-gin-api/app/util"
    "log"
    "os"
)

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)
}

func SetUp() gin.HandlerFunc {
    return func(c *gin.Context) {
        bodyLogWriter := &bodyLogWriter{body: bytes.NewBufferString(""), ResponseWriter: c.Writer}
        c.Writer = bodyLogWriter

        //开始时间
        startTime := util.GetCurrentMilliTime()

        //处理请求
        c.Next()

        responseBody := bodyLogWriter.body.String()

        var responseCode int
        var responseMsg  string
        var responseData interface{}

        if responseBody != "" {
            response := util.Response{}
            err := json.Unmarshal([]byte(responseBody), &response)
            if err == nil {
                responseCode = response.Code
                responseMsg  = response.Message
                responseData = response.Data
            }
        }

        //结束时间
        endTime := util.GetCurrentMilliTime()

        if c.Request.Method == "POST" {
            c.Request.ParseForm()
        }

        //日志格式
        accessLogMap := make(map[string]interface{})

        accessLogMap["request_time"]      = startTime
        accessLogMap["request_method"]    = c.Request.Method
        accessLogMap["request_uri"]       = c.Request.RequestURI
        accessLogMap["request_proto"]     = c.Request.Proto
        accessLogMap["request_ua"]        = c.Request.UserAgent()
        accessLogMap["request_referer"]   = c.Request.Referer()
        accessLogMap["request_post_data"] = c.Request.PostForm.Encode()
        accessLogMap["request_client_ip"] = c.ClientIP()

        accessLogMap["response_time"] = endTime
        access  
		
[系列] go-gin-api 路由中间件 - 日志记录(三)(一) https://www.cppentry.com/bencandy.php?fid=78&id=250174

首页 上一页 1 2 下一页 尾页 1/2/2
】【打印繁体】【投稿】【收藏】 【推荐】【举报】【评论】 【关闭】 【返回顶部
上一篇golang json 成结构体 下一篇golang 执行 command