gin框架之log处理

寒云暮雨 · · 15062 次点击 · · 开始浏览

这是一个创建于的文章，其中的信息可能已经有所发展或是发生改变。

我们在开发的过程中往往需要记录日志，记录日志可以帮我们追踪错误，追踪业务需求。那么gin中是如何记录日志的呢？


package main

import (
    "github.com/gin-gonic/gin"
    "io"
    "os"
)

func main() {
    // 记录到文件。
    f, _ := os.Create("gin.log")
    gin.DefaultWriter = io.MultiWriter(f)

    router := gin.Default()

    router.Run()
}

我们自定义了log的记录方式，但是这种方式国语简单，不利于我们收集错误信息。在这里为大家推荐一个记录日志的库github.com/sirupsen/logrus。logrus是目前Github上star数量最多的日志库.

logrus特性

完全兼容golang标准库日志模块：logrus拥有六种日志级别：debug、info、warn、error、fatal和panic，这是golang标准库日志模块的API的超集。如果您的项目使用标准库日志模块，完全可以以最低的代价迁移到logrus上。
可扩展的Hook机制：允许使用者通过hook的方式将日志分发到任意地方，如本地文件系统、标准输出、logstash、elasticsearch或者mq等，或者通过hook定义日志内容和格式等。
可选的日志输出格式：logrus内置了两种日志格式，JSONFormatter和TextFormatter，如果这两个格式不满足需求，可以自己动手实现接口Formatter，来定义自己的日志格式。
Field机制：logrus鼓励通过Field机制进行精细化的、结构化的日志记录，而不是通过冗长的消息来记录日志。
logrus是一个可插拔的、结构化的日志框架。


package main

import (
    "fmt"
    "github.com/gin-gonic/gin"
    "github.com/sirupsen/logrus"
    "os"
    "path"
    "time"
)

func Logger() *logrus.Logger {
    now := time.Now()
    logFilePath := ""
    if dir, err := os.Getwd(); err == nil {
        logFilePath = dir + "/logs/"
    }
    if err := os.MkdirAll(logFilePath, 0777); err != nil {
        fmt.Println(err.Error())
    }
    logFileName := now.Format("2006-01-02") + ".log"
    //日志文件
    fileName := path.Join(logFilePath, logFileName)
    if _, err := os.Stat(fileName); err != nil {
        if _, err := os.Create(fileName); err != nil {
            fmt.Println(err.Error())
        }
    }
    //写入文件
    src, err := os.OpenFile(fileName, os.O_APPEND|os.O_WRONLY, os.ModeAppend)
    if err != nil {
        fmt.Println("err", err)
    }

    //实例化
    logger := logrus.New()

    //设置输出
    logger.Out = src

    //设置日志级别
    logger.SetLevel(logrus.DebugLevel)

    //设置日志格式
    logger.SetFormatter(&logrus.TextFormatter{
        TimestampFormat: "2006-01-02 15:04:05",
    })
    return logger
}

func LoggerToFile() gin.HandlerFunc {
    logger := Logger()
    return func(c *gin.Context) {
        // 开始时间
        startTime := time.Now()

        // 处理请求
        c.Next()

        // 结束时间
        endTime := time.Now()

        // 执行时间
        latencyTime := endTime.Sub(startTime)

        // 请求方式
        reqMethod := c.Request.Method

        // 请求路由
        reqUri := c.Request.RequestURI

        // 状态码
        statusCode := c.Writer.Status()

        // 请求IP
        clientIP := c.ClientIP()

        //日志格式
        logger.Infof("| %3d | %13v | %15s | %s | %s |",
            statusCode,
            latencyTime,
            clientIP,
            reqMethod,
            reqUri,
        )
    }
}

func main() {
    // 记录到文件。

    router := gin.Default()
    router.Use(LoggerToFile())
    router.GET("/", func(context *gin.Context) {
        //Info级别的日志
        Logger().WithFields(logrus.Fields{
            "name": "hanyun",
        }).Info("记录一下日志", "Info")
        //Error级别的日志
        Logger().WithFields(logrus.Fields{
            "name": "hanyun",
        }).Error("记录一下日志", "Error")
        //Warn级别的日志
        Logger().WithFields(logrus.Fields{
            "name": "hanyun",
        }).Warn("记录一下日志", "Warn")
        //Debug级别的日志
        Logger().WithFields(logrus.Fields{
            "name": "hanyun",
        }).Debug("记录一下日志", "Debug")
    })
    router.Run()
}

我们在路由中间件中使用了自定的日志中间件