Go語(yǔ)言中配置文件使用與日志配置的方法

本文小編為大家詳細(xì)介紹“Go語(yǔ)言中配置文件使用與日志配置的方法”，內(nèi)容詳細(xì)，步驟清晰，細(xì)節(jié)處理妥當(dāng)，希望這篇“Go語(yǔ)言中配置文件使用與日志配置的方法”文章能幫助大家解決疑惑，下面跟著小編的思路慢慢深入，一起來(lái)學(xué)習(xí)新知識(shí)吧。

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

說(shuō)先對(duì)項(xiàng)目目錄結(jié)構(gòu)調(diào)整一下，按照我自己的開(kāi)發(fā)習(xí)慣，增加了幾個(gè)目錄。

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

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

• app/constants：主要放置一些常量

• app/controllers：控制層，熟悉java的不多說(shuō)。

• app/errors：異常定義目錄

• app/pojo：結(jié)構(gòu)體定義文件，主要是接口請(qǐng)求的結(jié)構(gòu)體和接口返回的結(jié)構(gòu)體，或者自定義的結(jié)構(gòu)體。

• app/router：路由文件

• app/services：服務(wù)實(shí)現(xiàn)邏輯目錄

• app/utils：工具文件目錄

• config/log：日志配置文件目錄，后面會(huì)講到怎么使用。

• config/toml：配置文件使用，后面會(huì)講到怎么使用。

• main.go作為程序的主入口。

配置文件使用

在我們項(xiàng)目結(jié)構(gòu)中，經(jīng)常會(huì)使用到配置文件。配置文件里面會(huì)記錄像mysql用戶(hù)名、端口、redis配置信息等等內(nèi)容。下面先配置一下toml_config.go，來(lái)對(duì)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() {
    // 設(shè)置文件名
    viper.SetConfigName("config")
    // 設(shè)置文件類(lèi)型
    viper.SetConfigType("toml")
    // 設(shè)置文件路徑，可以多個(gè)viper會(huì)根據(jù)設(shè)置順序依次查找
    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
}

需要安裝幾個(gè)庫(kù)，命令如下：

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

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

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

驗(yàn)證的話(huà)，等下面日志配置好了一起看一下。

日志配置

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

主要在config/log下的logger.go文件，配置了日志相關(guān)內(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 日志級(jí)別
func InitLogger(logpath string, loglevel string) {
    // 日志分割
    hook := lumberjack.Logger{
        Filename:   logpath, // 日志文件路徑，默認(rèn) os.TempDir()
        MaxSize:    100,     // 每個(gè)日志文件保存100M，默認(rèn) 100M
        MaxBackups: 30,      // 保留30個(gè)備份，默認(rèn)不限
        MaxAge:     7,       // 保留7天，默認(rèn)不限
 
        Compress: true, // 是否壓縮，默認(rèn)不壓縮
    }
    write := zapcore.AddSync(&hook)
    // 設(shè)置日志級(jí)別
    // debug 可以打印出 info debug warn
    // info  級(jí)別可以打印 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,  // 小寫(xiě)編碼器
        EncodeTime:     zapcore.ISO8601TimeEncoder,     // ISO8601 UTC 時(shí)間格式
        EncodeDuration: zapcore.SecondsDurationEncoder, //
        EncodeCaller:   zapcore.FullCallerEncoder,      // 全路徑編碼器
        EncodeName:     zapcore.FullNameEncoder,
    }
    // 設(shè)置日志級(jí)別
    atomicLevel := zap.NewAtomicLevel()
    atomicLevel.SetLevel(level)
 
    var writes = []zapcore.WriteSyncer{write}
    // 如果是開(kāi)發(fā)環(huán)境，同時(shí)在控制臺(tái)上也輸出
    if level == zap.DebugLevel {
        writes = append(writes, zapcore.AddSync(os.Stdout))
    }
    core := zapcore.NewCore(
        zapcore.NewConsoleEncoder(encoderConfig),
        // zapcore.NewJSONEncoder(encoderConfig),
        zapcore.NewMultiWriteSyncer(writes...), // 打印到控制臺(tái)和文件
        // write,
        level,
    )
    // 開(kāi)啟開(kāi)發(fā)模式，堆棧跟蹤
    caller := zap.AddCaller()
    // 開(kāi)啟文件及行號(hào)
    development := zap.Development()
    // 設(shè)置初始化字段,如：添加一個(gè)服務(wù)器名稱(chēng)
    filed := zap.Fields(zap.String("application", "test-gin"))
    // 構(gòu)造日志
    Logger = zap.New(core, caller, development, filed)
    Logger.Info("Logger init success")
}

需要安裝依賴(lài)包，命令如下

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，舒服了。

小結(jié)

這有幾個(gè)點(diǎn)要注意下：

1、init()和main()方法是golang默認(rèn)的兩個(gè)方法，不需要我們調(diào)用，程序執(zhí)行會(huì)自動(dòng)尋找項(xiàng)目中的這倆方法。如果引入了一個(gè)包，會(huì)優(yōu)先執(zhí)行引入包的init方法，再執(zhí)行自己包內(nèi)的init方法。

2、如果go項(xiàng)目構(gòu)建是報(bào)錯(cuò)：missing go.sum entry for module providing package xxxxx

執(zhí)行一下命令：

go build -mod=mod

讀到這里，這篇“Go語(yǔ)言中配置文件使用與日志配置的方法”文章已經(jīng)介紹完畢，想要掌握這篇文章的知識(shí)點(diǎn)還需要大家自己動(dòng)手實(shí)踐使用過(guò)才能領(lǐng)會(huì)，如果想了解更多相關(guān)內(nèi)容的文章，歡迎關(guān)注億速云行業(yè)資訊頻道。