Go-gin-example 第三部分 编写一个简单的文件日志系统

文章目录

  • 本文目标
  • 新建`logging`包
    • file.go
    • 编写log文件
    • 当前目录结构
  • 接入自定义的log功能
  • 验证功能

本文目标

在上一节中，我们解决了 API’s 可以任意访问的问题，那么我们现在还有一个问题，就是我们的日志，都是输出到控制台上的，这显然对于一个项目来说是不合理的，因此我们这一节简单封装log库，使其支持简单的文件日志！

新建logging包

我们在pkg下新建logging目录，用来包含自定义logger相关的文件,新建file.go和log.go文件

file.go

用来创建记录log的相关目录和文件，其内容为：

package loggingimport ("fmt""log""os""time"
)// 适用枚举，将所有固定的量提前列出在这里，方便后期维护	我们这里将原来的var修改为const
const (LogSavePath = "runtime/logs/"LogSaveName = "log"LogFileExt  = "log"TimeFormat  = "20060102"
)// 返回log文件的前缀路径，算是一个具有仪式感的函数
func getLogFilePath() string {return fmt.Sprintf("%s", LogSavePath)
}// 获得log文件的整体路径，以当前日期作为.log文件的名字
func getLogFileFullPath() string {prefixPath := getLogFilePath()suffixPath := fmt.Sprintf("%s%s.%s", LogSaveName, time.Now().Format(TimeFormat), LogFileExt)return fmt.Sprintf("%s%s", prefixPath, suffixPath)
}// 打开日志文件，返回写入的句柄handle
func openLogFile(filePath string) *os.File {//根据文件目录是否存在进行判断_, err := os.Stat(filePath)switch {//目录不存在case os.IsNotExist(err):mkDir()//权限不够case os.IsPermission(err):log.Fatalf("Permission :%v", err)}//如果.log文件不存在，这里会创建一个handle, err := os.OpenFile(filePath, os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0644)if err != nil {log.Fatalf("Fail to OpenFile :%v", err)}return handle
}// 创建log目录
func mkDir() {//获得当前目录 dir: /home/wang2/gin-exampledir, _ := os.Getwd()//适用MKdirAll会直接创建所有依赖的父目录，减少报错的可能性err := os.MkdirAll(dir+"/"+getLogFilePath(), os.ModePerm)if err != nil {panic(err)}
}
  • os.Stat：返回文件信息结构描述文件。如果出现错误，会返回*PathError
    type PathError struct {Op   stringPath stringErr  error
}
  • os.IsNotExist：能够接受ErrNotExist、syscall的一些错误，它会返回一个布尔值，能够得知文件不存在或目录不存在
  • os.IsPermission：能够接受ErrPermission、syscall的一些错误，它会返回一个布尔值，能够得知权限是否满足
  • os.OpenFile：调用文件，支持传入文件名称、指定的模式调用文件、文件权限，返回的文件的方法可以用于 I/O。如果出现错误，则为*PathError。
    const (// Exactly one of O_RDONLY, O_WRONLY, or O_RDWR must be specified.O_RDONLY int = syscall.O_RDONLY // 以只读模式打开文件O_WRONLY int = syscall.O_WRONLY // 以只写模式打开文件O_RDWR   int = syscall.O_RDWR   // 以读写模式打开文件// The remaining values may be or'ed in to control behavior.O_APPEND int = syscall.O_APPEND // 在写入时将数据追加到文件中O_CREATE int = syscall.O_CREAT  // 如果不存在，则创建一个新文件O_EXCL   int = syscall.O_EXCL   // 使用O_CREATE时，文件必须不存在O_SYNC   int = syscall.O_SYNC   // 同步IOO_TRUNC  int = syscall.O_TRUNC  // 如果可以，打开时
)
  • os.Getwd：返回与当前目录对应的根路径名
  • os.MkdirAll：创建对应的目录以及所需的子目录，若成功则返回nil，否则返回error
  • os.ModePerm：const定义ModePerm FileMode = 0777

文件权限的知识补充：err := os.MkdirAll(“wang2/”+path, os.ModePerm)
这里的modePerm中Perm为permission的缩写
在Linux和Unix操作系统中，文件和目录的权限通常用八进制数表示，例如 0777。这个八进制数表示了文件或目录的权限位，以及哪些用户或用户组有权访问它。在 0777 中，每一位都有特定的含义：

  • 最高位（左边的0）表示特殊权限位，通常不使用，所以它通 常是0。
  • 下一个三位（中间的777）表示用户（文件的所有者）的权限。
  • 接下来的三位表示组（文件的所属组）的权限。
  • 最后三位表示其他人（不是文件所有者或所属组的用户）的权限。

每个三位权限位由三个位组成，它们可以是以下之一：

  • 4：读权限（R）：用户可以读取文件或列出目录中的内容。
  • 2：写权限（W）：用户可以编辑或写入文件，对于目录来说，用户可以在其中创建、删除或重命名文件。
  • 1：执行权限（X）：用户可以执行文件或进入目录。

编写log文件

log.go:

package loggingimport ("fmt""log""os""path/filepath""runtime"
)// 类型声明，基于int建立level，方便后续维护
type Level intvar (//传入写log文件的句柄F *os.File//默认的前缀DefaultPrefix = ""//这里的定义在后续的caller中被调用，该参数指定了要跳过的调用堆栈帧数，每个调用堆栈帧代表了代码中的一个函数调用。//以info写入log为例，我们这里调用caller的函数为setPrefix，Info调用setPrefix，适用Info进行写入的函数调用info。//                                     0                      1                    2//而我们想要得到的信息就是调用info的函数的信息。所以我们这里设置的跳过调用堆栈帧数为2DefaultCallerDepth = 2//提前定义logger记录器，方便维护阅读logger *log.LoggerlogPrefix = ""//结合level的定义，方便读取维护levelFlags = []string{"DEBUG", "INFO", "WARN", "ERROR", "FATAL"}
)// 实现枚举
const (DEBUG Level = iotaINFOWARNINGERRORFATAL
)// 自定义logger的初始化
func init() {//获取log文件目录filePath := getLogFileFullPath()//得到log文件句柄F = openLogFile(filePath)//创建一个新的日志记录器logger = log.New(F, DefaultPrefix, log.LstdFlags)
}func Debug(v ...interface{}) {setPrefix(DEBUG)logger.Println(v)
}// 这里先设置每条log的前缀部分，首先为log模式，这里为info；然后为具体到某个函数第几行出错；接下来为时间；最后为日志信息
func Info(v ...interface{}) {setPrefix(INFO)logger.Println(v)
}func Warn(v ...interface{}) {setPrefix(WARNING)logger.Println(v)
}func Error(v ...interface{}) {setPrefix(ERROR)logger.Println(v)
}func Fatal(v ...interface{}) {setPrefix(FATAL)logger.Fatalln(v)
}// 从进程中读取当前运行的函数信息
func setPrefix(level Level) {//获取文件名，具体行数，是否读取成功_, file, line, ok := runtime.Caller(DefaultCallerDepth)if ok { //获取成功logPrefix = fmt.Sprintf("[%s][%s:%d]", levelFlags[level], filepath.Base(file), line)} else { //获取失败，则前缀不加如具体的文件名和行号logPrefix = fmt.Sprintf("[%s]", levelFlags[level])}//将前缀写入log文件logger.SetPrefix(logPrefix)
}
  • log.New：创建一个新的日志记录器。out定义要写入日志数据的IO句柄。prefix定义每个生成的日志行的开头。flag定义了日志记录属性
    func New(out io.Writer, prefix string, flag int) *Logger {return &Logger{out: out, prefix: prefix, flag: flag}
}
  • log.LstdFlags：日志记录的格式属性之一，其余的选项如下
    const (Ldate         = 1 << iota     // the date in the local time zone: 2009/01/23Ltime                         // the time in the local time zone: 01:23:23Lmicroseconds                 // microsecond resolution: 01:23:23.123123.  assumes Ltime.Llongfile                     // full file name and line number: /a/b/c/d.go:23Lshortfile                    // final file name element and line number: d.go:23. overrides LlongfileLUTC                          // if Ldate or Ltime is set, use UTC rather than the local time zoneLstdFlags     = Ldate | Ltime // initial values for the standard logger
)

当前目录结构

gin-blog/
├── conf
│   └── app.ini
├── main.go
├── middleware
│   └── jwt
│       └── jwt.go
├── models
│   ├── article.go
│   ├── auth.go
│   ├── models.go
│   └── tag.go
├── pkg
│   ├── e
│   │   ├── code.go
│   │   └── msg.go
│   ├── logging
│   │   ├── file.go
│   │   └── log.go
│   ├── setting
│   │   └── setting.go
│   └── util
│       ├── jwt.go
│       └── pagination.go
├── routers
│   ├── api
│   │   ├── auth.go
│   │   └── v1
│   │       ├── article.go
│   │       └── tag.go
│   └── router.go
├── runtime

接入自定义的log功能

我们自定义的logging包，已经基本完成了，接下来让它接入到我们的项目之中吧。我们打开先前包含log包的代码，如下：

  1. 打开routers目录下的article.go、tag.go、auth.go。
    2。 将log包的引用删除，修改引用我们自己的日志包为github.com/kingsill/gin-example/pkg/logging。
  2. 将原本的log.Println(...)改为logging.Info(...)。

验证功能

修改文件后，重启服务，我们来试试吧！

获取到 API 的 Token 后，我们故意传错误 URL 参数给接口，如：http://127.0.0.1:8000/api/v1/articles?tag_id=0&state=9999999&token=eyJhbG..

然后我们到$GOPATH/gin-blog/runtime/logs查看日志：

$ tail -f log20180216.log
[INFO][article.go:79]2018/02/16 18:33:12 [state 状态只允许0或1]
[INFO][article.go:79]2018/02/16 18:33:42 [state 状态只允许0或1]
[INFO][article.go:79]2018/02/16 18:33:42 [tag_id 标签ID必须大于0]
[INFO][article.go:79]2018/02/16 18:38:39 [state 状态只允许0或1]
[INFO][article.go:79]2018/02/16 18:38:39 [tag_id 标签ID必须大于0]

日志结构一切正常，我们的记录模式都为Info，因此前缀是对的，并且我们是入参有问题，也把错误记录下来了，这样排错就很方便了！

至此，本节就完成了，这只是一个简单的扩展，实际上我们线上项目要使用的文件日志，是更复杂一些，开动你的大脑 举一反三吧！

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.mzph.cn/news/724741.shtml

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

k8s-kubeapps图形化管理 21

k8s-kubeapps图形化管理 21

结合harbor仓库 由于kubeapps不读取hosts解析&#xff0c;因此需要添加本地仓库域名解析&#xff08;dns解析&#xff09; 更改context为全局模式 添加repo仓库 复制ca证书 添加成功 图形化部署 更新部署应用版本 再次进行部署 上传nginx 每隔十分钟会自动进行刷新 在本地仓库…
阅读更多...
人人都写过的6个bug

人人都写过的6个bug

大家好&#xff0c;我是知微。 程序员写bug几乎是家常便饭&#xff0c;也是我们每个人成长过程中难以避免的一部分。 为了缓解这份“尴尬”&#xff0c;今天想和大家分享一些曾经都会遇到过的bug&#xff0c;让我们一起来看看这些“经典之作”。 1、数组越界 #include <…
阅读更多...
Python爬虫：http和https介绍及请求

Python爬虫：http和https介绍及请求

HTTP和HTTPS 学习目标&#xff1a; 记忆 http、https的概念和区别记忆 浏览器发送http请求的过程记忆 http请求头的形式记忆 http响应头的形式了解 http响应状态码 1 为什么要复习http和https 在发送请求&#xff0c;获取响应的过程中 就是发送http或https的请求&#xff0c…
阅读更多...
面试题--01

面试题--01

GC机制 GC机制又称垃圾回收机制&#xff0c;是Python解释器自带一种机&#xff0c;专门用来回收不可用的变量值所占用的内存空间 有三个核心&#xff0c;分别是引用计数、标记清除和分代回收 引用计数&#xff1a;一个变量值如果有一个变量名指向&#xff0c;那么在它身上就计…
阅读更多...
DMA 链表模式（LLI）深度解析

DMA 链表模式（LLI）深度解析

在进行一次 DMA 读或者写的时候&#xff0c;可以配置多个链表&#xff0c;从而当一个链表的数据传输完成时&#xff0c;会跳到下一个链表的起始地址&#xff0c;并继续传输数据&#xff0c;直到链表的下一个地址为 0。如果 DMA 使能了完成中断&#xff0c;则当 DMA 发送或者接收…
阅读更多...
c++ ponder库实现机制的理解

c++ ponder库实现机制的理解

Ponder是一个用于C的反射库&#xff0c;它允许在运行时查询和操作类型信息。反射通常是动态语言的特性&#xff0c;但Ponder通过提供一套API&#xff0c;使得在静态类型语言C中也能实现类似的功能。这对于需要动态处理对象&#xff0c;如序列化/反序列化、脚本绑定等场景非常有…
阅读更多...
微信小程序--注册时获取微信头像

微信小程序--注册时获取微信头像

参考官方文档&#xff1a;点击跳转 具体实现&#xff1a; wxml&#xff1a; <button class"avatarBtn" open-type"chooseAvatar" chooseavatar"onChooseAvatar"><image class"avatar" :src"avatarUrl"></…
阅读更多...
【语音识别】- 几个主流模型 2024年2月整理

【语音识别】- 几个主流模型 2024年2月整理

文章目录 1. Wav2Vec 2.02. Whisper3. WeNet4. Paraformer5. Flan-T51. Wav2Vec 2.0 由Facebook AI Research（FAIR）于2020年提出的在语音方向里具有一定影响力的预训练模型。 论文地址：https://arxiv.org/pdf/2006.11477.pdf 项目地址：https://github.com/pytorch/fairse…
阅读更多...
程序计数器介绍

程序计数器介绍

程序计数器是计算机处理器中的寄存器&#xff0c;它包含当前正在执行的指令的地址(位置)。当每个指令被获取&#xff0c;程序计数器的存储地址加一。在每个指令被获取之后&#xff0c;程序计数器指向顺序中的下一个指令。当计算机重启或复位时&#xff0c;程序计数器通常恢复到…
阅读更多...
java微服务技术选型，Java学习的三个终极问题及学习路线规划

java微服务技术选型，Java学习的三个终极问题及学习路线规划

前言 在网络技术中基于浏览器的B/S结构无论在PC端还是手机端都充当着至关重要的角色。 PC端自不必说&#xff0c;手机中很多应用虽然是以APP的形式存在&#xff0c;但它采用的还是B/S结构。如今日头条、微信的朋友圈等&#xff0c;这些应用在内部封装了浏览器&#xff0c;后端…
阅读更多...
【项目实战】高并发内存池（仿tcmalloc）

【项目实战】高并发内存池（仿tcmalloc）

【项目实战】高并发内存池&#xff08;仿tcmalloc&#xff09; 作者&#xff1a;爱写代码的刚子 时间&#xff1a;2024.2.12 前言&#xff1a; 当前项目是实现一个高并发的内存池&#xff0c;它的原型是google的一个开源项目tcmalloc&#xff0c;tcmalloc全称 Thread-Caching M…
阅读更多...
MySQL 8.0 架构 之 DDL日志（元数据日志）（DDL log）

MySQL 8.0 架构 之 DDL日志（元数据日志）（DDL log）

文章目录 MySQL 8.0 架构 之 DDL日志&#xff08;元数据日志&#xff09;&#xff08;DDL log&#xff09;MySQLDDL日志&#xff08;元数据日志&#xff09;&#xff08;DDL log&#xff09;参考 【声明】文章仅供学习交流&#xff0c;观点代表个人&#xff0c;与任何公司无关。…
阅读更多...
【JavaScript】将数组中的数字按照从小到大排序(sort)

【JavaScript】将数组中的数字按照从小到大排序(sort)

如果在 sort()方法中带参&#xff0c;我们就可以自定义排序规则。具体做法如下&#xff1a; 我们可以在 sort()的参数中添加一个回调函数&#xff0c;来指定排序规则。回调函数中需要定义两个形参&#xff0c;JS将会分别使用数组中的元素作为实参去调用回调函数。 JS根据回调…
阅读更多...
宠物的异味，用空气净化器可以解决吗？宠物空气净化器品牌推荐

宠物的异味，用空气净化器可以解决吗？宠物空气净化器品牌推荐

养猫的人都了解&#xff0c;一个养猫家庭的环境卫生和气味问题与主人的关系密切相关。主人的勤劳程度和对卫生的重视程度直接影响着家中的气味。尽管主人通常会经常更换猫砂&#xff0c;但有时候仍然会存在一些难闻的气味。事实上&#xff0c;忙碌的猫主人可能会因为没有足够的…
阅读更多...
MySQL Strict Mode is not set for database connection ‘default‘

MySQL Strict Mode is not set for database connection ‘default‘

在使用 DJango 框架执行迁移文件的命令时&#xff0c;可以看到出现如下警告&#xff1a; (ll_env) D:\workspace\workspace-mengll\learning-log>python manage.py migrate System check identified some issues: WARNINGS: ?: (mysql.W002) MySQL Strict Mode is not set …
阅读更多...
TS常见问题

TS常见问题

文章目录 1. 什么是 TypeScript&#xff1f;它与 JavaScript 有什么区别&#xff1f;2. TS 泛型、接口、泛型工具record、Pick、Omit3. TS unknow和any的区别&#xff0c;如何告诉编译器unknow一定是某个类型&#xff1f;4. 元组与常规数组的区别5. 什么是泛型,有什么作用&…
阅读更多...
解决移除数字问题的两种方法：暴力法和使用栈

解决移除数字问题的两种方法：暴力法和使用栈

题目 给你一个以字符串表示的非负整数 num 和一个整数 k &#xff0c;移除这个数中的 k 位数字&#xff0c;使得剩下的数字最小。请你以字符串形式返回这个最小的数字 示例 1 &#xff1a; 输入&#xff1a;num "1432219", k 3 输出&#xff1a;"1219"…
阅读更多...
【yolov8自带脚本划分数据集】yolov8自己数据集训练

【yolov8自带脚本划分数据集】yolov8自己数据集训练

1. 命令 ultralytics.data.utils.autosplit(pathDATASETS_DIR / coco8/images, weights(0.9, 0.1, 0.0), annotated_onlyFalse)from ultralytics.data.utils import autosplitautosplit( path"path/to/images",weights(0.9, 0.1, 0.0), # (train, validation, test)…
阅读更多...
分组交换网的性能指标

分组交换网的性能指标

一、概述 在理想情况下&#xff0c;我们希望因特网能够在任意两个端系统之间随心所欲地移动数据而没有任何数据的丢失。然而&#xff0c;这是一个极高的目标&#xff0c;实践中难以达到。与之相反&#xff0c;计算机网络必定要限制在端到端之间的吞吐量&#xff08;每秒能够传送…
阅读更多...
利用Python爬取高德地图全国地铁站点信息

利用Python爬取高德地图全国地铁站点信息

利用Python中的requests库进行地铁站点信息的获取,同时将数据保存在本机excel中 # 首先引入所需要的包 import requests from bs4 import BeautifulSoup import pandas as pd import json# 发送 GET 请求获取网页内容 url http://map.amap.com/subway/index.html response r…
阅读更多...
最新文章

Copyright @ 2022~2023