詳解Go語言中配置文件使用與日志配置

更新時間：2022年06月01日 09:02:42 作者：劍客阿良_ALiang

這篇文章主要為大家詳細講解一下Go語言中調(diào)整項目目錄結(jié)構(gòu)、增加配置文件使用和增加日志配置的方法，文中示例代碼講解詳細，需要的可以參考一下

項目結(jié)構(gòu)調(diào)整

說先對項目目錄結(jié)構(gòu)調(diào)整一下，按照我自己的開發(fā)習慣，增加了幾個目錄。

項目結(jié)構(gòu)如下圖：

解釋一下目錄結(jié)構(gòu)

app/constants：主要放置一些常量
app/controllers：控制層，熟悉java的不多說。
app/errors：異常定義目錄
app/pojo：結(jié)構(gòu)體定義文件，主要是接口請求的結(jié)構(gòu)體和接口返回的結(jié)構(gòu)體，或者自定義的結(jié)構(gòu)體。
app/router：路由文件
app/services：服務實現(xiàn)邏輯目錄
app/utils：工具文件目錄
config/log：日志配置文件目錄，后面會講到怎么使用。
config/toml：配置文件使用，后面會講到怎么使用。
main.go作為程序的主入口。

配置文件使用

在我們項目結(jié)構(gòu)中，經(jīng)常會使用到配置文件。配置文件里面會記錄像mysql用戶名、端口、redis配置信息等等內(nèi)容。下面先配置一下toml_config.go，來對config.toml配置文件讀取。

下面是toml_config.go的內(nèi)容

package toml
 
import (
    "fmt"
    "github.com/spf13/viper"
)
 
type TomlConfig struct {
    AppName string
    Log     LogConfig
}
 
// 日志保存地址
type LogConfig struct {
    Path  string
    Level string
}
 
var c TomlConfig
 
func init() {
    // 設置文件名
    viper.SetConfigName("config")
    // 設置文件類型
    viper.SetConfigType("toml")
    // 設置文件路徑，可以多個viper會根據(jù)設置順序依次查找
    viper.AddConfigPath(".")
    viper.AutomaticEnv()
    err := viper.ReadInConfig()
    if err != nil {
        panic(fmt.Errorf("fatal error config file: %s", err))
    }
 
    viper.Unmarshal(&c)
}
func GetConfig() TomlConfig {
    return c
}

需要安裝幾個庫，命令如下：

go get github.com/natefinch/lumberjack
go get go.uber.org/zap/zapcore

注意，在go文件中，init方法在加載該文件所在包的時候會默認執(zhí)行。

我們看一下配置的內(nèi)容，主要是日志級別和存放地址。

驗證的話，等下面日志配置好了一起看一下。

日志配置

下面繼續(xù)配置一下日志，也可以看到配置文件里面配置的日志級別和存放地址都是日志的配置項。

主要在config/log下的logger.go文件，配置了日志相關內(nèi)容。

logger.go的內(nèi)容如下

package log
 
import (
    "os"
 
    "github.com/natefinch/lumberjack"
    "go.uber.org/zap"
    "go.uber.org/zap/zapcore"
)
 
type Field = zap.Field
 
var (
    Logger  *zap.Logger
    String  = zap.String
    Any     = zap.Any
    Int     = zap.Int
    Float32 = zap.Float32
)
 
// logpath 日志文件路徑
// loglevel 日志級別
func InitLogger(logpath string, loglevel string) {
    // 日志分割
    hook := lumberjack.Logger{
        Filename:   logpath, // 日志文件路徑，默認 os.TempDir()
        MaxSize:    100,     // 每個日志文件保存100M，默認 100M
        MaxBackups: 30,      // 保留30個備份，默認不限
        MaxAge:     7,       // 保留7天，默認不限
 
        Compress: true, // 是否壓縮，默認不壓縮
    }
    write := zapcore.AddSync(&hook)
    // 設置日志級別
    // debug 可以打印出 info debug warn
    // info  級別可以打印 warn info
    // warn  只能打印 warn
    // debug->info->warn->error
    var level zapcore.Level
    switch loglevel {
    case "debug":
        level = zap.DebugLevel
    case "info":
        level = zap.InfoLevel
    case "error":
        level = zap.ErrorLevel
    case "warn":
        level = zap.WarnLevel
    default:
        level = zap.InfoLevel
    }
    encoderConfig := zapcore.EncoderConfig{
        TimeKey:        "time",
        LevelKey:       "level",
        NameKey:        "logger",
        CallerKey:      "linenum",
        MessageKey:     "msg",
        StacktraceKey:  "stacktrace",
        LineEnding:     zapcore.DefaultLineEnding,
        EncodeLevel:    zapcore.LowercaseLevelEncoder,  // 小寫編碼器
        EncodeTime:     zapcore.ISO8601TimeEncoder,     // ISO8601 UTC 時間格式
        EncodeDuration: zapcore.SecondsDurationEncoder, //
        EncodeCaller:   zapcore.FullCallerEncoder,      // 全路徑編碼器
        EncodeName:     zapcore.FullNameEncoder,
    }
    // 設置日志級別
    atomicLevel := zap.NewAtomicLevel()
    atomicLevel.SetLevel(level)
 
    var writes = []zapcore.WriteSyncer{write}
    // 如果是開發(fā)環(huán)境，同時在控制臺上也輸出
    if level == zap.DebugLevel {
        writes = append(writes, zapcore.AddSync(os.Stdout))
    }
    core := zapcore.NewCore(
        zapcore.NewConsoleEncoder(encoderConfig),
        // zapcore.NewJSONEncoder(encoderConfig),
        zapcore.NewMultiWriteSyncer(writes...), // 打印到控制臺和文件
        // write,
        level,
    )
    // 開啟開發(fā)模式，堆棧跟蹤
    caller := zap.AddCaller()
    // 開啟文件及行號
    development := zap.Development()
    // 設置初始化字段,如：添加一個服務器名稱
    filed := zap.Fields(zap.String("application", "test-gin"))
    // 構(gòu)造日志
    Logger = zap.New(core, caller, development, filed)
    Logger.Info("Logger init success")
}

需要安裝依賴包，命令如下

go get github.com/spf13/viper

在main.go文件增加logger的初始化加載，看看配置文件和日志是否都生效了。

main.go增加下面的代碼

看一下執(zhí)行的日志

2022-05-31T21:27:54.964+0800 info D:/goProject/learn-gin/config/log/logger.go:90 Logger init success {"application": "test-gin"}
2022-05-31T21:27:54.964+0800 info D:/goProject/learn-gin/main.go:31 hahahah {"application": "test-gin"}
2022-05-31T21:27:54.964+0800 info D:/goProject/learn-gin/main.go:32 config {"application": "test-gin", "config": {"AppName":"learn-gin","Log":{"Path":"logs/learn.log","Level":"debug"}}}

可以看到配置文件內(nèi)容的打印，還有日志的打印效果，OK，舒服了。