Go语学习笔记 - 配置文件使用、日志配置 | Web框架Gin(二)

本文涉及的产品
日志服务 SLS,月写入数据量 50GB 1个月
简介: Go语学习笔记 - 配置文件使用、日志配置 | Web框架Gin(二)

接着上一篇的文章构建的项目:Go语学习笔记 - 环境安装、接口测试 | Web框架Gin(一)_剑客阿良_ALiang的博客-CSDN博客


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


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


项目地址:github地址


项目结构调整

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


项目结构如下图:

image.png



解释一下目录结构


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配置文件读取。


image.png

下面是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方法在加载该文件所在包的时候会默认执行。


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


image.png


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


日志配置

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


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


image.png


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增加下面的代码


image.png


看一下执行的日志


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

本笔记主要解决我几个强迫症问题,但是没解决完,后面再说。


相关实践学习
日志服务之使用Nginx模式采集日志
本文介绍如何通过日志服务控制台创建Nginx模式的Logtail配置快速采集Nginx日志并进行多维度分析。
相关文章
|
28天前
|
JSON 中间件 Go
go语言后端开发学习(四) —— 在go项目中使用Zap日志库
本文详细介绍了如何在Go项目中集成并配置Zap日志库。首先通过`go get -u go.uber.org/zap`命令安装Zap,接着展示了`Logger`与`Sugared Logger`两种日志记录器的基本用法。随后深入探讨了Zap的高级配置,包括如何将日志输出至文件、调整时间格式、记录调用者信息以及日志分割等。最后,文章演示了如何在gin框架中集成Zap,通过自定义中间件实现了日志记录和异常恢复功能。通过这些步骤,读者可以掌握Zap在实际项目中的应用与定制方法
go语言后端开发学习(四) —— 在go项目中使用Zap日志库
|
12天前
|
JSON 运维 Go
Go 项目配置文件的定义和读取
Go 项目配置文件的定义和读取
|
10天前
|
jenkins 持续交付
jenkins学习笔记之三:使用jenkins共享库实现日志格式化输出
jenkins学习笔记之三:使用jenkins共享库实现日志格式化输出
jenkins学习笔记之三:使用jenkins共享库实现日志格式化输出
|
13天前
|
Java Go
go如何读取yaml配置文件?
本文介绍了如何在Go项目中利用YAML文件进行配置管理,以简化变量更改及维护工作。首先,通过`go get gopkg.in/yaml.v3`命令安装YAML处理库。接着,展示了如何创建并解析YAML配置文件,包括定义结构体映射YAML字段、读取文件内容以及错误处理等步骤。此外,还提供了通过Go代码生成YAML文件的方法。使用`gopkg.in/yaml.v3`库能够有效提升项目的可维护性和开发效率。
go如何读取yaml配置文件?
|
13天前
|
Cloud Native JavaScript API
一文读懂云原生 go-zero 微服务框架
一文读懂云原生 go-zero 微服务框架
|
25天前
|
存储 JSON 前端开发
一文搞懂 Go 1.21 的日志标准库 - slog
一文搞懂 Go 1.21 的日志标准库 - slog
28 2
|
8天前
|
监控 Go 开发者
掌握Go语言中的日志管理
【8月更文挑战第31天】
8 0
|
8天前
|
存储 JSON 监控
FastAPI日志之谜:如何揭开Web应用监控与调试的面纱?
【8月更文挑战第31天】在现代Web开发中,日志记录对于监控应用状态、诊断问题和了解用户行为至关重要。FastAPI框架提供了强大的日志功能,使开发者能轻松集成日志记录。本文将详细介绍如何在FastAPI中设置和利用日志,包括基础配置、请求响应日志、错误处理和结构化日志等内容,帮助提升应用的可维护性和性能。
36 0
|
1月前
|
Go API 数据库
[go 面试] 分布式事务框架选择与实践
[go 面试] 分布式事务框架选择与实践
|
11天前
|
Prometheus 监控 Cloud Native
Web服务器的日志分析与监控
【8月更文第28天】Web服务器日志提供了关于服务器活动的重要信息,包括访问记录、错误报告以及性能数据。有效地分析这些日志可以帮助我们了解用户行为、诊断问题、优化网站性能,并确保服务的高可用性。本文将介绍如何使用日志分析和实时监控工具来监测Web服务器的状态和性能指标,并提供具体的代码示例。
78 0