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日志并进行多维度分析。
目录
打赏
0
0
0
0
9
分享
相关文章
Go语言Web开发框架实践:路由、中间件、参数校验
Gin框架以其极简风格、强大路由管理、灵活中间件机制及参数绑定校验系统著称。本文详解其核心功能:1) 路由管理,支持分组与路径参数;2) 中间件机制,实现全局与局部控制;3) 参数绑定,涵盖多种来源;4) 结构体绑定与字段校验,确保数据合法性;5) 自定义校验器扩展功能;6) 统一错误处理提升用户体验。Gin以清晰模块化、流程可控及自动化校验等优势,成为开发者的优选工具。
Go语言Web开发框架实践:使用 Gin 快速构建 Web 服务
Gin 是一个高效、轻量级的 Go 语言 Web 框架,支持中间件机制,非常适合开发 RESTful API。本文从安装到进阶技巧全面解析 Gin 的使用:快速入门示例(Hello Gin)、定义 RESTful 用户服务(增删改查接口实现),以及推荐实践如参数校验、中间件和路由分组等。通过对比标准库 `net/http`,Gin 提供更简洁灵活的开发体验。此外,还推荐了 GORM、Viper、Zap 等配合使用的工具库,助力高效开发。
|
5月前
|
【02】客户端服务端C语言-go语言-web端PHP语言整合内容发布-优雅草网络设备监控系统-2月12日优雅草简化Centos stream8安装zabbix7教程-本搭建教程非docker搭建教程-优雅草solution
【02】客户端服务端C语言-go语言-web端PHP语言整合内容发布-优雅草网络设备监控系统-2月12日优雅草简化Centos stream8安装zabbix7教程-本搭建教程非docker搭建教程-优雅草solution
139 20
Go语言中几种流行的Web框架,如Beego、Gin和Echo,分析了它们的特点、性能及适用场景,并讨论了如何根据项目需求、性能要求、团队经验和社区支持等因素选择最合适的框架
本文概述了Go语言中几种流行的Web框架,如Beego、Gin和Echo,分析了它们的特点、性能及适用场景,并讨论了如何根据项目需求、性能要求、团队经验和社区支持等因素选择最合适的框架。
721 1
Flask学习笔记(六):基于Flask的摄像头-web显示代码(可直接使用)
这篇文章是关于如何使用Flask框架结合OpenCV库,通过电脑摄像头实现视频流在网页上的实时显示,并提供了单摄像头和多摄像头的实现方法。
319 2
Flask学习笔记(六):基于Flask的摄像头-web显示代码(可直接使用)
Pytorch学习笔记(七):F.softmax()和F.log_softmax函数详解
本文介绍了PyTorch中的F.softmax()和F.log_softmax()函数的语法、参数和使用示例,解释了它们在进行归一化处理时的作用和区别。
893 1
Pytorch学习笔记(七):F.softmax()和F.log_softmax函数详解
使用Go语言和Gin框架构建RESTful API:GET与POST请求示例
使用Go语言和Gin框架构建RESTful API:GET与POST请求示例
Flask学习笔记(一):Flask Web框架
本文介绍了Flask Web框架的基本概念、安装方法、初始化参数、程序编写、静态文件显示和配置信息加载等基础知识。
134 0
Tensorboard可视化学习笔记(一):如何可视化通过网页查看log日志
关于如何使用TensorBoard进行数据可视化的教程,包括TensorBoard的安装、配置环境变量、将数据写入TensorBoard、启动TensorBoard以及如何通过网页查看日志文件。
890 0
PHP转Go系列 | ThinkPHP与Gin框架之Redis延时消息队列技术实践
【9月更文挑战第7天】在从 PHP 的 ThinkPHP 框架迁移到 Go 的 Gin 框架时,涉及 Redis 延时消息队列的技术实践主要包括:理解延时消息队列概念,其能在特定时间处理消息,适用于定时任务等场景;在 ThinkPHP 中使用 Redis 实现延时队列;在 Gin 中结合 Go 的 Redis 客户端库实现类似功能;Go 具有更高性能和简洁性,适合处理大量消息。迁移过程中需考虑业务需求及系统稳定性。
231 0
AI助理
登录插画

登录以查看您的控制台资源

管理云资源
状态一览
快捷访问

你好,我是AI助理

可以解答问题、推荐解决方案等