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

简介: 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

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


相关实践学习
通过日志服务实现云资源OSS的安全审计
本实验介绍如何通过日志服务实现云资源OSS的安全审计。
相关文章
|
3月前
|
算法 Java Go
【GoGin】(1)上手Go Gin 基于Go语言开发的Web框架,本文介绍了各种路由的配置信息;包含各场景下请求参数的基本传入接收
gin 框架中采用的路优酷是基于httprouter做的是一个高性能的 HTTP 请求路由器,适用于 Go 语言。它的设计目标是提供高效的路由匹配和低内存占用,特别适合需要高性能和简单路由的应用场景。
314 4
|
3月前
|
监控 安全 程序员
Python日志模块配置:从print到logging的优雅升级指南
从 `print` 到 `logging` 是 Python 开发的必经之路。`print` 调试简单却难维护,日志混乱、无法分级、缺乏上下文;而 `logging` 支持级别控制、多输出、结构化记录,助力项目可维护性升级。本文详解痛点、优势、迁移方案与最佳实践,助你构建专业日志系统,让程序“有记忆”。
324 0
|
4月前
|
消息中间件 缓存 NoSQL
Redis各类数据结构详细介绍及其在Go语言Gin框架下实践应用
这只是利用Go语言和Gin框架与Redis交互最基础部分展示;根据具体业务需求可能需要更复杂查询、事务处理或订阅发布功能实现更多高级特性应用场景。
330 86
|
4月前
|
缓存 Java 应用服务中间件
Spring Boot配置优化:Tomcat+数据库+缓存+日志,全场景教程
本文详解Spring Boot十大核心配置优化技巧,涵盖Tomcat连接池、数据库连接池、Jackson时区、日志管理、缓存策略、异步线程池等关键配置,结合代码示例与通俗解释,助你轻松掌握高并发场景下的性能调优方法,适用于实际项目落地。
723 5
|
10月前
|
SQL Java 数据库连接
微服务——SpringBoot使用归纳——Spring Boot使用slf4j进行日志记录—— application.yml 中对日志的配置
在 Spring Boot 项目中,`application.yml` 文件用于配置日志。通过 `logging.config` 指定日志配置文件(如 `logback.xml`),实现日志详细设置。`logging.level` 可定义包的日志输出级别,例如将 `com.itcodai.course03.dao` 包设为 `trace` 级别,便于开发时查看 SQL 操作。日志级别从高到低为 ERROR、WARN、INFO、DEBUG,生产环境建议调整为较高级别以减少日志量。本课程采用 yml 格式,因其层次清晰,但需注意格式要求。
1000 0
|
安全 BI 网络安全
EventLog Analyzer 如何满足等保合规要求?密码有效期、产品日志保留、配置备份三大核心问题全面解答
EventLog Analyzer(ELA)助力企业满足网络安全等级保护要求,支持配置自动/手动备份、日志180天留存及密码策略管理,提升合规性与安全运营效率。
167 0
|
6月前
|
存储 Linux Apache
在CentOS上配置SVN至Web目录的自动同步
通过上述配置,每次当SVN仓库中提交新的更改时,`post-commit`钩子将被触发,SVN仓库的内容会自动同步到指定的Web目录,从而实现代码的连续部署。
211 16
|
6月前
|
人工智能 负载均衡 监控
使用 Go 和 Gin 实现高可用负载均衡代理服务器
本文基于Go语言和Gin框架,实现了一个企业级负载均衡代理服务器,支持动态路由、健康检查、会话保持等功能。具备高可用性与高性能,单节点支持100k+ QPS,延迟达亚毫秒级,并提供完整的压力测试方案与优化建议。
213 7
|
6月前
|
JSON 安全 Go
Go语言项目工程化 —— 日志、配置、错误处理规范
本章详解Go语言项目工程化核心规范,涵盖日志、配置与错误处理三大关键领域。在日志方面,强调其在问题排查、性能优化和安全审计中的作用,推荐使用高性能结构化日志库zap,并介绍日志级别与结构化输出的最佳实践。配置管理部分讨论了配置分离的必要性,对比多种配置格式如JSON、YAML及环境变量,并提供viper库实现多环境配置的示例。错误处理部分阐述Go语言显式返回error的设计哲学,讲解标准处理方式、自定义错误类型、错误封装与堆栈追踪技巧,并提出按调用层级进行错误处理的建议。最后,总结各模块的工程化最佳实践,助力构建可维护、可观测且健壮的Go应用。
|
7月前
|
存储 NoSQL MongoDB
Docker中安装MongoDB并配置数据、日志、配置文件持久化。
现在,你有了一个运行在Docker中的MongoDB,它拥有自己的小空间,对高楼大厦的崩塌视而不见(会话丢失和数据不持久化的问题)。这个MongoDB的数据、日志、配置文件都会妥妥地保存在你为它精心准备的地方,天旋地转,它也不会失去一丁点儿宝贵的记忆(即使在容器重启后)。
905 4