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日志并进行多维度分析。
相关文章
|
11天前
|
搜索推荐 前端开发 数据可视化
【优秀python web毕设案例】基于协同过滤算法的酒店推荐系统,django框架+bootstrap前端+echarts可视化,有后台有爬虫
本文介绍了一个基于Django框架、协同过滤算法、ECharts数据可视化以及Bootstrap前端技术的酒店推荐系统,该系统通过用户行为分析和推荐算法优化,提供个性化的酒店推荐和直观的数据展示,以提升用户体验。
|
18天前
|
开发框架 缓存 前端开发
基于SqlSugar的开发框架循序渐进介绍(23)-- Winform端管理系统中平滑增加对Web API对接的需求
基于SqlSugar的开发框架循序渐进介绍(23)-- Winform端管理系统中平滑增加对Web API对接的需求
|
28天前
|
开发框架 JSON API
震撼发布!Python Web开发框架下的RESTful API设计全攻略,让数据交互更自由!
【7月更文挑战第22天】在Python Web开发中,设计高效的RESTful API涉及选择框架(如Flask或Django)、明确资源及使用HTTP方法(GET, POST, PUT, DELETE)来操作数据。响应格式通常是JSON,错误处理也很重要。示例展示了使用Flask创建图书管理API,包括版本控制、文档化、安全性和性能优化是最佳实践。这样的API使数据交互更顺畅。
58 2
|
4天前
|
存储 Ubuntu Apache
如何在 Ubuntu VPS 上配置 Apache 的日志记录和日志轮转
如何在 Ubuntu VPS 上配置 Apache 的日志记录和日志轮转
15 6
|
4天前
|
存储 Ubuntu 应用服务中间件
如何在 Ubuntu VPS 上配置 Nginx 的日志记录和日志轮转
如何在 Ubuntu VPS 上配置 Nginx 的日志记录和日志轮转
10 4
|
3天前
|
机器学习/深度学习 JSON API
【Python奇迹】FastAPI框架大显神通:一键部署机器学习模型,让数据预测飞跃至Web舞台,震撼开启智能服务新纪元!
【8月更文挑战第16天】在数据驱动的时代,高效部署机器学习模型至关重要。FastAPI凭借其高性能与灵活性,成为搭建模型API的理想选择。本文详述了从环境准备、模型训练到使用FastAPI部署的全过程。首先,确保安装了Python及相关库(fastapi、uvicorn、scikit-learn)。接着,以线性回归为例,构建了一个预测房价的模型。通过定义FastAPI端点,实现了基于房屋大小预测价格的功能,并介绍了如何运行服务器及测试API。最终,用户可通过HTTP请求获取预测结果,极大地提升了模型的实用性和集成性。
13 1
|
4天前
|
开发框架 JSON .NET
ASP.NET Core 标识(Identity)框架系列(三):在 ASP.NET Core Web API 项目中使用标识(Identity)框架进行身份验证
ASP.NET Core 标识(Identity)框架系列(三):在 ASP.NET Core Web API 项目中使用标识(Identity)框架进行身份验证
|
6天前
|
PHP 数据库 开发者
探索PHP的现代演变:从Web开发到框架创新
【8月更文挑战第13天】本文将深入探讨PHP语言自诞生以来的发展历程,特别是它在Web开发领域的演进和在现代框架中的创新。我们将回顾PHP的历史,分析其在不同阶段面临的挑战及解决方案,并讨论PHP如何适应新的编程范式和技术需求,以及这些变化对开发者社区的影响。
18 2
|
6天前
|
安全 前端开发 Java
Web端系统开发解决跨域问题——以Java SpringBoot框架配置Cors为例
在Web安全上下文中,源(Origin)是指一个URL的协议、域名和端口号的组合。这三个部分共同定义了资源的来源,浏览器会根据这些信息来判断两个资源是否属于同一源。例如,https://www.example.com:443和http://www.example.com虽然域名相同,但由于协议和端口号不同,它们被视为不同的源。同源(Same-Origin)是指两个URL的协议、域名和端口号完全相同。只有当这些条件都满足时,浏览器才认为这两个资源来自同一源,从而允许它们之间的交互操作。
Web端系统开发解决跨域问题——以Java SpringBoot框架配置Cors为例
|
6天前
|
JSON 缓存 监控
go语言后端开发学习(五)——如何在项目中使用Viper来配置环境
Viper 是一个强大的 Go 语言配置管理库,适用于各类应用,包括 Twelve-Factor Apps。相比仅支持 `.ini` 格式的 `go-ini`,Viper 支持更多配置格式如 JSON、TOML、YAML
go语言后端开发学习(五)——如何在项目中使用Viper来配置环境