详解Go语言中配置文件使用与日志配置


Posted in Golang onJune 01, 2022

只是简单的把GET和POST接口的使用测试了一下。

我还是想按照正常的项目结构调整一下,这篇笔记主要是三个部分:调整项目目录结构、增加配置文件使用、增加日志配置,很常规而且也是每个项目都需要用到的。

项目地址:github地址 

项目结构调整

说先对项目目录结构调整一下,按照我自己的开发习惯,增加了几个目录。

项目结构如下图:

详解Go语言中配置文件使用与日志配置

解释一下目录结构

  • app/constants:主要放置一些常量
  • app/controllers:控制层,熟悉java的不多说。
  • app/errors:异常定义目录
  • app/pojo:结构体定义文件,主要是接口请求的结构体和接口返回的结构体,或者自定义的结构体。
  • app/router:路由文件
  • app/services:服务实现逻辑目录
  • app/utils:工具文件目录
  • config/log:日志配置文件目录,后面会讲到怎么使用。
  • config/toml:配置文件使用,后面会讲到怎么使用。
  • main.go作为程序的主入口。

配置文件使用

在我们项目结构中,经常会使用到配置文件。配置文件里面会记录像mysql用户名、端口、redis配置信息等等内容。下面先配置一下toml_config.go,来对config.toml配置文件读取。

详解Go语言中配置文件使用与日志配置

下面是toml_config.go的内容

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会根据设置顺序依次查找
    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方法在加载该文件所在包的时候会默认执行。

我们看一下配置的内容,主要是日志级别和存放地址。

验证的话,等下面日志配置好了一起看一下。

详解Go语言中配置文件使用与日志配置

日志配置

下面继续配置一下日志,也可以看到配置文件里面配置的日志级别和存放地址都是日志的配置项。

主要在config/log下的logger.go文件,配置了日志相关内容。

详解Go语言中配置文件使用与日志配置

logger.go的内容如下

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}
    // 如果是开发环境,同时在控制台上也输出
    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,
    )
    // 开启开发模式,堆栈跟踪
    caller := zap.AddCaller()
    // 开启文件及行号
    development := zap.Development()
    // 设置初始化字段,如:添加一个服务器名称
    filed := zap.Fields(zap.String("application", "test-gin"))
    // 构造日志
    Logger = zap.New(core, caller, development, filed)
    Logger.Info("Logger init success")
}

需要安装依赖包,命令如下

go get github.com/spf13/viper

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

main.go增加下面的代码

详解Go语言中配置文件使用与日志配置

看一下执行的日志

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

可以看到配置文件内容的打印,还有日志的打印效果,OK,舒服了。

小结

这有几个点要注意下:

1、init()和main()方法是golang默认的两个方法,不需要我们调用,程序执行会自动寻找项目中的这俩方法。如果引入了一个包,会优先执行引入包的init方法,再执行自己包内的init方法。

2、如果go项目构建是报错:missing go.sum entry for module providing package xxxxx

执行一下命令:

go build -mod=mod

到此这篇关于详解Go语言中配置文件使用与日志配置的文章就介绍到这了,更多相关Go语言日志配置内容请搜索三水点靠木以前的文章或继续浏览下面的相关文章希望大家以后多多支持三水点靠木!


Tags in this post...

Golang 相关文章推荐
Go语言使用select{}阻塞main函数介绍
Apr 25 Golang
goland 恢复已更改文件的操作
Apr 28 Golang
golang协程池模拟实现群发邮件功能
May 02 Golang
golang内置函数len的小技巧
Jul 25 Golang
Go语言实现Base64、Base58编码与解码
Jul 26 Golang
go使用Gin框架利用阿里云实现短信验证码功能
Aug 04 Golang
Golang表示枚举类型的详细讲解
Sep 04 Golang
Go语言读取txt文档的操作方法
Jan 22 Golang
Golang 1.18 多模块Multi-Module工作区模式的新特性
Apr 11 Golang
golang连接MySQl使用sqlx库
Apr 14 Golang
Golang ort 中的sortInts 方法
Apr 24 Golang
go goth封装第三方认证库示例详解
Aug 14 Golang
详解Go语言中Get/Post请求测试
Golang实现可重入锁的示例代码
May 25 #Golang
Go web入门Go pongo2模板引擎
May 20 #Golang
Go语言入门exec的基本使用
May 20 #Golang
Golang并发工具Singleflight
May 06 #Golang
深入理解 Golang 的字符串
May 04 #Golang
Golang入门之计时器
May 04 #Golang
You might like
PHP数组操作简单案例分析
2016/10/15 PHP
完美解决在ThinkPHP控制器中命名空间的问题
2017/05/05 PHP
php高清晰度无损图片压缩功能的实现代码
2018/12/09 PHP
php curl发送请求实例方法
2019/08/01 PHP
PHP rsa加密解密算法原理解析
2020/12/09 PHP
jQuery 白痴级入门教程
2009/11/11 Javascript
JS获取页面窗口大小的代码解读
2011/12/01 Javascript
jquery插件实现鼠标经过图片右侧显示大图的效果(类似淘宝)
2013/02/04 Javascript
Javascript控制input输入时间格式的方法
2015/01/28 Javascript
javasript实现密码的隐藏与显示
2015/05/08 Javascript
基于jQuery实现点击最后一行实现行自增效果的表格
2016/01/12 Javascript
关于cookie的初识和运用(js和jq)
2016/04/07 Javascript
JS中artdialog弹出框控件之提交表单思路详解
2016/04/18 Javascript
JS实现的二叉树算法完整实例
2017/04/06 Javascript
Three.js利用性能插件stats实现性能监听的方法
2017/09/25 Javascript
jQuery判断网页是否已经滚动到浏览器底部的实现方法
2017/10/27 jQuery
VUE-Table上绑定Input通过render实现双向绑定数据的示例
2018/08/27 Javascript
一次Webpack配置文件的分离实战记录
2018/11/30 Javascript
原生JS实现贪吃蛇小游戏
2020/03/09 Javascript
解决vue做详情页跳转的时候使用created方法 数据不会更新问题
2020/07/24 Javascript
Python中字典和集合学习小结
2017/07/07 Python
Python利用multiprocessing实现最简单的分布式作业调度系统实例
2017/11/14 Python
python将图片转base64,实现前端显示
2020/01/09 Python
keras 如何保存最佳的训练模型
2020/05/25 Python
利用Pycharm + Django搭建一个简单Python Web项目的步骤
2020/10/22 Python
python语言time库和datetime库基本使用详解
2020/12/25 Python
AmazeUI 评论列表的实现示例
2020/08/13 HTML / CSS
台湾深度自由行旅游平台:Tripbaa趣吧
2017/10/10 全球购物
《老山界》教学反思
2014/04/08 职场文书
真诚的求职信
2014/07/04 职场文书
审计局班子四风对照检查材料思想汇报
2014/10/07 职场文书
2015年医院工作总结范文
2015/04/09 职场文书
幼儿园教师师德承诺书
2015/04/28 职场文书
全家福照片寄语怎么写?
2019/04/02 职场文书
古诗之感恩老师
2019/10/24 职场文书
使用Ajax实现进度条的绘制
2022/04/07 Javascript