從零封裝Gin框架實現日志初始化及切割歸檔功能
更新時間：2024年01月31日 10:52:08 作者：生活處處有BUG
這篇文章主要為大家介紹了從零封裝Gin框架實現日志初始化及切割歸檔功能示例詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進步,早日升職加薪
前言
本篇來講一下怎么將日志服務集成到項目中，它也是框架中必不可少的，平時代碼調試，線上 Bug 分析都離不開它。這里將使用 zap 作為日志庫，一般來說，日志都是需要寫入到文件保存的，這也是 zap 唯一缺少的部分，所以我將結合 lumberjack 來使用，實現日志切割歸檔的功能
安裝
go get -u go.uber.org/zap go get -u gopkg.in/natefinch/lumberjack.v2
定義日志配置項
新建 config/log.go 文件，定義 zap 和 lumberjack 初始化需要使用的配置項，大家可以根據自己的喜好去定制
package config
type Log struct {
Level string `mapstructure:"level" json:"level" yaml:"level"`
RootDir string `mapstructure:"root_dir" json:"root_dir" yaml:"root_dir"`
Filename string `mapstructure:"filename" json:"filename" yaml:"filename"`
Format string `mapstructure:"format" json:"format" yaml:"format"`
ShowLine bool `mapstructure:"show_line" json:"show_line" yaml:"show_line"`
MaxBackups int `mapstructure:"max_backups" json:"max_backups" yaml:"max_backups"`
MaxSize int `mapstructure:"max_size" json:"max_size" yaml:"max_size"` // MB
MaxAge int `mapstructure:"max_age" json:"max_age" yaml:"max_age"` // day
Compress bool `mapstructure:"compress" json:"compress" yaml:"compress"`
}config/config.go 添加 Log 成員屬性
package config
type Configuration struct {
App App `mapstructure:"app" json:"app" yaml:"app"`
Log Log `mapstructure:"log" json:"log" yaml:"log"`
}config.yaml 增加對應配置項
log: level: info # 日志等級 root_dir: ./storage/logs # 日志根目錄 filename: app.log # 日志文件名稱 format: # 寫入格式 可選json show_line: true # 是否顯示調用行 max_backups: 3 # 舊文件的最大個數 max_size: 500 # 日志文件最大大?。∕B） max_age: 28 # 舊文件的最大保留天數 compress: true # 是否壓縮
定義 utils 工具函數
新建 utils/directory.go 文件，編寫 PathExists 函數，用于判斷路徑是否存在
package utils
import "os"
func PathExists(path string) (bool, error) {
_, err := os.Stat(path)
if err == nil {
return true, nil
}
if os.IsNotExist(err) {
return false, nil
}
return false, err
}初始化 zap
zap 的具體使用說明可查看官方文檔
新建 bootstrap/log.go 文件，編寫：
package bootstrap
import (
"go.uber.org/zap"
"go.uber.org/zap/zapcore"
"gopkg.in/natefinch/lumberjack.v2"
"jassue-gin/global"
"jassue-gin/utils"
"os"
"time"
)
var (
level zapcore.Level // zap 日志等級
options []zap.Option // zap 配置項
)
func InitializeLog() *zap.Logger {
// 創(chuàng)建根目錄
createRootDir()
// 設置日志等級
setLogLevel()
if global.App.Config.Log.ShowLine {
options = append(options, zap.AddCaller())
}
// 初始化 zap
return zap.New(getZapCore(), options...)
}
func createRootDir() {
if ok, _ := utils.PathExists(global.App.Config.Log.RootDir); !ok {
_ = os.Mkdir(global.App.Config.Log.RootDir, os.ModePerm)
}
}
func setLogLevel() {
switch global.App.Config.Log.Level {
case "debug":
level = zap.DebugLevel
options = append(options, zap.AddStacktrace(level))
case "info":
level = zap.InfoLevel
case "warn":
level = zap.WarnLevel
case "error":
level = zap.ErrorLevel
options = append(options, zap.AddStacktrace(level))
case "dpanic":
level = zap.DPanicLevel
case "panic":
level = zap.PanicLevel
case "fatal":
level = zap.FatalLevel
default:
level = zap.InfoLevel
}
}
// 擴展 Zap
func getZapCore() zapcore.Core {
var encoder zapcore.Encoder
// 調整編碼器默認配置
encoderConfig := zap.NewProductionEncoderConfig()
encoderConfig.EncodeTime = func(time time.Time, encoder zapcore.PrimitiveArrayEncoder) {
encoder.AppendString(time.Format("[" + "2006-01-02 15:04:05.000" + "]"))
}
encoderConfig.EncodeLevel = func(l zapcore.Level, encoder zapcore.PrimitiveArrayEncoder) {
encoder.AppendString(global.App.Config.App.Env + "." + l.String())
}
// 設置編碼器
if global.App.Config.Log.Format == "json" {
encoder = zapcore.NewJSONEncoder(encoderConfig)
} else {
encoder = zapcore.NewConsoleEncoder(encoderConfig)
}
return zapcore.NewCore(encoder, getLogWriter(), level)
}
// 使用 lumberjack 作為日志寫入器
func getLogWriter() zapcore.WriteSyncer {
file := &lumberjack.Logger{
Filename: global.App.Config.Log.RootDir + "/" + global.App.Config.Log.Filename,
MaxSize: global.App.Config.Log.MaxSize,
MaxBackups: global.App.Config.Log.MaxBackups,
MaxAge: global.App.Config.Log.MaxAge,
Compress: global.App.Config.Log.Compress,
}
return zapcore.AddSync(file)
}定義全局變量 Log
在 global/app.go 中，添加 Log 成員屬性
package global
import (
"github.com/spf13/viper"
"go.uber.org/zap"
"jassue-gin/config"
)
type Application struct {
ConfigViper *viper.Viper
Config config.Configuration
Log *zap.Logger
}
var App = new(Application)測試
在 main.go 中調用日志初始化函數，并嘗試寫入日志
package main
import (
"github.com/gin-gonic/gin"
"jassue-gin/bootstrap"
"jassue-gin/global"
"net/http"
)
func main() {
// 初始化配置
bootstrap.InitializeConfig()
// 初始化日志
global.App.Log = bootstrap.InitializeLog()
global.App.Log.Info("log init success!")
r := gin.Default()
// 測試路由
r.GET("/ping", func(c *gin.Context) {
c.String(http.StatusOK, "log test")
})
// 啟動服務器
r.Run(":" + global.App.Config.App.Port)
}啟動 main.go ，生成 storage/logs/app.log 文件，表示日志初始化成功，文件內容顯示如下：
以上就是從零封裝Gin框架實現日志初始化及切割歸檔功能的詳細內容，更多關于Gin日志切割歸檔的資料請關注腳本之家其它相關文章！
相關文章
這篇文章主要介紹了golang 解析word文檔操作，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧2020-12-12
以alpine作為基礎鏡像構建Golang可執(zhí)行程序操作
這篇文章主要介紹了以alpine作為基礎鏡像構建Golang可執(zhí)行程序操作，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧2020-12-12
這篇文章主要為大家詳細介紹了Go語言對文件進行讀寫操作的方法，文中的示例代碼講解詳細，對我們學習Go語言有一定的幫助，需要的可以參考一下2022-05-05
這篇文章主要介紹了Golang通脈之類型定義，在Go語言中有一些基本的數據類型，如 string 、 整型 、 浮點型 、 布爾 等數據類型， Go語言中可以使用 type 關鍵字來定義自定義類型，下面和小編一起進入文章看具體內容吧2021-10-10
由于最近偏愛Ubuntu，在加上作為一門開源語言，在Linux上從源代碼開始搭建環(huán)境更讓人覺得有趣味性。讓我們直接先從Go語言的環(huán)境搭建開始2015-04-04
這篇文章主要介紹了Golang中interface{}轉為數組的操作，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧2021-04-04
這篇文章主要為大家介紹了go語言中基本數據類型應用詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步，早日升職加薪2022-07-07
這篇文章主要給大家介紹了關于如何利用Golang解析讀取Mysql備份文件的相關資料，文中通過示例代碼介紹的非常詳細，對大家學習或者使用Golang具有一定的參考學習價值，需要的朋友們下面來一起學習學習吧2019-12-12
當使用Go語言進行 HTTP 請求時,默認情況下,http.Client 會自動處理服務器返回的重定向響應（3xx 狀態(tài)碼）,本文將詳細介紹如何在 Go 中實現禁止 HTTP 請求的重定向、限制重定向次數以及添加自定義重定向策略,需要的朋友可以參考下2024-08-08
這篇文章主要介紹了Go語言中的方法、接口和嵌入類型詳解,本文分別對它們做了詳細講解,需要的朋友可以參考下2014-10-10