iis服务器助手广告广告
返回顶部
首页 > 资讯 > 后端开发 > GO >Go语言中log日志库的介绍
  • 444
分享到

Go语言中log日志库的介绍

2024-04-02 19:04:59 444人浏览 泡泡鱼
摘要

目录一、标准库log介绍1、使用Logger2、配置logger 2.1、标准logger的配置二、自定义日志库 1、需要满足的需求2、了解下runtime包3、

一、标准库log介绍

  • Go语言内置的log包实现了简单的日志服务。

1、使用Logger

  • log包定义了Logger类型,该类型提供了一些格式化输出的方法。
  • log包也提供了一个预定义的“标准”logger,可以通过调用函数Print系列(Print|Printf|Println)、Fatal系列(Fatal|Fatalf|Fatalln)、和Panic系列(Panic|Panicf|Panicln)来使用,比自行创建一个logger对象更容易使用。

logger会打印每条日志信息的日期、时间,默认输出到系统的标准错误。

Fatal系列函数会在写入日志信息后调用os.Exit(1)。

Panic系列函数会在写入日志信息后panic。

示例:


// 直接调用print来输出日志到终端
func main() {
	log.Println("这是一条很普通的日志。")
	v := "很普通的"
	log.Printf("这是一条%s日志。\n", v)
	log.Fatalln("这是一条会触发fatal的日志。")
	log.Panicln("这是一条会触发panic的日志。")
}

2、配置logger

 2.1、标准logger的配置

  • 默认情况下的logger只会提供日志的时间信息,但是很多情况下我们希望得到更多信息,比如记录该日志的文件名和行号等。
  • log标准库中为我们提供了定制这些设置的方法。log标准库中的Flags函数会返回标准logger的输出配置,而SetFlags函数用来设置标准logger的输出配置。

二、自定义日志库

 1、需要满足的需求

 1、支持网不同地方输出日志

2、日志要支持开关控制

3、完整的日志要包含时间、行号、文件名、日志级别、日志信息

4、日志文件要能切割

5、日志级别

  • Debug
  • Trace
  • Info
  • Warning
  • Error
  • Fatal

2、了解下runtime包

  • runtime.Caller() 方法,会返回函数调用的信息,在()内传入int类型数据,代表调用的层数(0代表第一层被调用,1代表第二层,一次类推)。runtime.Caller()返回如下四个参数:

pc: 记录了调用的函数消息,如函数名等
file: 调用的文件名
line: 行数
OK: 返回的bool值


// 获取代码行号
func getinfo(n int) {
	
	pc, file, line, ok := runtime.Caller(n)
	if !ok {
		fmt.Printf("runtime.Caller() failed\n")
		return
	}
	fmt.Println(pc)  // 用于调用函数消息
	funcName := runtime.FuncForpc(pc).Name() // 利用 runtime.FuncForPC()方法,参数pc序号,可以调出函数名
	fmt.Println(funcName)
	fmt.Println(file)   // 打印出执行的文件的绝对路径
	fmt.Println(path.Base(file))  // path.Base()方法可以获取传入的绝对路径的最后一个文件名称
	fmt.Println(line)   // 打印出执行的行号
}

func main() {
	getinfo(0)
}

3、自定义日志库

1、在 E:\GoProject\src\gitee.com 项目目录下,新建 mylogger 包目录,存放日志库代码

在mylogger包目录下console.go文件中,放将日志输出到终端的代码


# E:\GoProject\src\gitee.com\mylogger\console.go

package mylogger

import (
	"fmt"
	"strings"
	"time"
)

// 终端输出的日志内容

// Logger 日志结构体
type ConsoleLogger struct {
	Level LogLevel
}

// 构造函数
func NewLog(levelStr string) ConsoleLogger {
	level, err := parseLogLevel(levelStr)
	if err != nil {
		panic(err)
	}
	return ConsoleLogger{
		Level: level,
	}
}

// 定义日志等级比较
func (c ConsoleLogger) enable(level LogLevel) bool {
	return c.Level <= level
}

// 定义一个日志打印方法
func (c ConsoleLogger) outLog(lv LogLevel, fORMat string, a ...interface{}) {
	level := parseLogLevelStr(lv)
	if c.enable(lv) {
		msg := fmt.Sprintf(format, a...) // 支持格式化操作,a...表示对接收的接口进行展开
		level = strings.ToUpper(level)
		fileName, funcName, linenu := getinfo(3)
		fmt.Printf("[%s] [%s] [FileName:%s lineNum:%d:%s] %s\n", time.Now().Format("2006-01-02 15:04:05"), level, fileName, linenu, funcName, msg)
	}
}

// Debug日志
func (c ConsoleLogger) Debug(msg string, a ...interface{}) {
	c.outLog(DEBUG, msg, a...)
}

// Info日志
func (c ConsoleLogger) Info(msg string, a ...interface{}) {
	c.outLog(INFO, msg, a...)
}

// Warning日志
func (c ConsoleLogger) Warning(msg string, a ...interface{}) {
	c.outLog(WARNING, msg, a...)
}

// Error日志
func (c ConsoleLogger) Error(msg string, a ...interface{}) {
	c.outLog(ERROR, msg, a...)
}

// Fatal日志
func (c ConsoleLogger) Fatal(msg string, a ...interface{}) {
	c.outLog(FATAL, msg, a...)
}

在mylogger包目录下logfile.go文件中,放将日志输出到文件的代码


# E:\GoProject\src\gitee.com\mylogger\logfile.go

package mylogger

// 向文件中写日志的相关操作

import (
	"fmt"
	"os"
	"path"
	"strings"
	"time"
)

// Logger 日志结构体
type FileLogger struct {
	Level       LogLevel
	logPath     string // 日志文件目录
	fileName    string // 日志文件名称
	maxFileSize int64  // 日志文件大小
	fileObj     *os.File
	errFileObj  *os.File
}

// 构造函数
func NewFileLog(levelStr, fp, fn string, maxSize int64) *FileLogger {
	level, err := parseLogLevel(levelStr)
	if err != nil {
		panic(err)
	}
	f1 := &FileLogger{
		Level:       level,
		logPath:     fp,
		fileName:    fn,
		maxFileSize: maxSize,
	}
	err = f1.initFile()
	if err != nil {
		panic(err)
	}
	return f1
}

// 定义文件初始化方法,打开文件
func (f *FileLogger) initFile() error {
	// 打开文件
	fullPath := path.Join(f.logPath, f.fileName)
	fileObj, err := os.OpenFile(fullPath, os.O_CREATE|os.O_APPEND|os.O_WRONLY, 0644)
	if err != nil {
		fmt.Printf("open logFile failed,Err:%v", err)
		return err
	}
	// 打开错误日志文件
	errFileObj, err := os.OpenFile("error-"+fullPath, os.O_CREATE|os.O_APPEND|os.O_WRONLY, 0644)
	if err != nil {
		fmt.Printf("open errorLogFile failed,Err:%v", err)
		return err
	}
	// 将文件句柄赋值给结构体中的元素
	f.fileObj = fileObj
	f.errFileObj = errFileObj
	return nil
}

// 关闭文件方法
func (f *FileLogger) closeFile() {
	f.fileObj.Close()
	f.errFileObj.Close()
}

// 定义日志等级比较
func (f *FileLogger) enable(level LogLevel) bool {
	return f.Level <= level
}

// 定义检查日志大小进行切割的方法
func (f *FileLogger) checkLogSize(file *os.File) bool { // 利用os.Open()方法打开的文件句柄类型都是 *os.File 这种指针类型
	fileInfo, err := file.Stat()
	if err != nil {
		fmt.Printf("get file info failed,err:%v\n", err)
		return false
		// panic(err)
	}
	if fileInfo.Size() > f.maxFileSize {
		return true
	}
	return false
}

func (f *FileLogger) cutFile(file *os.File) (*os.File, error) {
	// 获取当前文件名
	fileInfo, err := file.Stat()
	if err != nil {
		fmt.Printf("get file info failed,err:%v\n", err)
		return nil, err
	}
	append := "_" + time.Now().Format("2006-01-02-15-04-05") + ".log" // 时间戳后缀
	fileName := fileInfo.Name()
	newFileName := fileName + append
	oldPath := path.Join(f.logPath, fileName) // 日志文件的全路径
	newPath := path.Join(f.logPath, newFileName)
	// 关闭当前文件句柄
	file.Close()
	// 进行更名备份
	os.Rename(oldPath, newPath)
	// 再打开一个文件
	fileObj, err := os.OpenFile(oldPath, os.O_CREATE|os.O_APPEND|os.O_WRONLY, 0644)
	if err != nil {
		fmt.Printf("open logFile failed,Err:%v\n", err)
		return nil, err
	}
	return fileObj, nil
}

// 定义一个日志输出的方法
func (f *FileLogger) outLog(lv LogLevel, format string, a ...interface{}) {
	level := parseLogLevelStr(lv)
	if f.enable(lv) {
		msg := fmt.Sprintf(format, a...) // 支持格式化操作,a...表示对接收的接口进行展开
		level = strings.ToUpper(level)
		fileName, funcName, linenu := getinfo(3)
		// 判断日志是否需要切割
		if f.checkLogSize(f.fileObj) {
			fileobj, err := f.cutFile(f.fileObj)
			if err != nil {
				fmt.Printf("log cut failed,err:%v\n", err)
			}
			f.fileObj = fileobj
		}
		// 将日志记录在日志文件中
		fmt.Fprintf(f.fileObj, "[%s] [%s] [FileName:%s lineNum:%d:%s] %s\n", time.Now().Format("2006-01-02 15:04:05"), level, fileName, linenu, funcName, msg)
		if lv >= ERROR {
			// 判断错误日志是否需要切割
			if f.checkLogSize(f.errFileObj) {
				fileobj, err := f.cutFile(f.errFileObj)
				if err != nil {
					fmt.Printf("log cut failed,err:%v\n", err)
				}
				f.errFileObj = fileobj
			}
			// 将日志等级大于ERROR的在错误日志中再记录一遍
			fmt.Fprintf(f.errFileObj, "[%s] [%s] [FileName:%s lineNum:%d:%s] %s\n", time.Now().Format("2006-01-02 15:04:05"), level, fileName, linenu, funcName, msg)
		}
	}
}

// Debug日志
func (f *FileLogger) Debug(msg string, a ...interface{}) {
	f.outLog(DEBUG, msg, a...)
}

// Info日志
func (f *FileLogger) Info(msg string, a ...interface{}) {
	f.outLog(INFO, msg, a...)
}

// Warning日志
func (f *FileLogger) Warning(msg string, a ...interface{}) {
	f.outLog(WARNING, msg, a...)
}

// Error日志
func (f *FileLogger) Error(msg string, a ...interface{}) {
	f.outLog(ERROR, msg, a...)
}

// Fatal日志
func (f *FileLogger) Fatal(msg string, a ...interface{}) {
	f.outLog(FATAL, msg, a...)
}

在mylogger包目录下创建mylogger.go文件,放包内共用的代码


# E:\GoProject\src\gitee.com\mylogger\mylogger.go

package mylogger

import (
	"errors"
	"fmt"
	"path"
	"runtime"
	"strings"
)

// 设置日志级别
type LogLevel uint16

const (
	UNKNOWN LogLevel = iota
	DEBUG
	TRACE
	INFO
	WARNING
	ERROR
	FATAL
)

// 解析日志等级,将字符串解析成int
func parseLogLevel(s string) (LogLevel, error) {
	s = strings.ToLower(s) // 将字符串全部转为小写
	switch s {
	case "debug":
		return DEBUG, nil
	case "trace":
		return TRACE, nil
	case "info":
		return INFO, nil
	case "warning":
		return WARNING, nil
	case "error":
		return ERROR, nil
	case "fatal":
		return FATAL, nil
	default:
		err := errors.New("无效日志等级")
		return UNKNOWN, err
	}
}

// 将日志等级解析成字符串
func parseLogLevelStr(lv LogLevel) (s string) {
	s = strings.ToLower(s) // 将字符串全部转为小写
	switch lv {
	case DEBUG:
		return "DEBUG"
	case TRACE:
		return "TRACE"
	case INFO:
		return "INFO"
	case WARNING:
		return "WARNING"
	case ERROR:
		return "ERROR"
	case FATAL:
		return "FATAL"
	default:
		return "DEBUG"
	}
}

// 获取代码行号
func getinfo(n int) (fileName, funcName string, line int) {
	
	pc, file, line, ok := runtime.Caller(n)
	if !ok {
		fmt.Printf("runtime.Caller() failed\n")
		return
	}
	fileName = path.Base(file)
	funcName = runtime.FuncForPC(pc).Name()
	return fileName, funcName, line
}

2、调用日志库代码测试

需要注意,导入mylogger包,是从$GOPATH路径开始的(即从src目录开始的相对路径)


# E:\GoProject\src\gitee.com\LTP\logging

package main

import (
	"time"

	mylogger "gitee.com/mylogger"
)


func main() {
	id := 10
	name := "小明"
	flogger := mylogger.NewFileLog("info", "./", "app.log", 1024)
	for {
		flogger.Warning("这是个Warning日志")
		flogger.Error("这是个Error日志,id:%d name:%s", id, name)
		time.Sleep(2 * time.Second)
	}
}

到此这篇关于Go log日志库的文章就介绍到这了,更多相关Go log日志库内容请搜索编程网以前的文章或继续浏览下面的相关文章希望大家以后多多支持编程网!

您可能感兴趣的文档:

--结束END--

本文标题: Go语言中log日志库的介绍

本文链接: https://www.lsjlt.com/news/155859.html(转载时请注明来源链接)

有问题或投稿请发送至: 邮箱/279061341@qq.com    QQ/279061341

本篇文章演示代码以及资料文档资料下载

下载Word文档到电脑,方便收藏和打印~

下载Word文档
猜你喜欢
  • Go语言中log日志库的介绍
    目录一、标准库log介绍1、使用Logger2、配置logger 2.1、标准logger的配置二、自定义日志库 1、需要满足的需求2、了解下runtime包3、...
    99+
    2024-04-02
  • Golang常用日志库介绍
    Golang常用日志库有”log包“、”go-logging“和”zap“三个:1、log包,Go语言内置的,可以进行基本的日志记录和输出;2、go-logging,一个功能强大、灵活且易于使用的日志库,支持多种格式的日志输出和级别控制;3...
    99+
    2023-12-18
    golang日志库 go语言 Golang
  • Go语言中的Beego框架介绍
    Beego是一个基于MVC架构的Go语言Web框架,它提供了一整套的解决方案来简化Web应用程序的开发。Beego内置了很多功能模块,如路由、ORM、Session等,同时也提供了很多...
    99+
    2024-04-02
  • Go语言中DateTime的用法介绍
    一、基本使用 ①从属于time这个包 ②一般使用都是使用 time.Time 这个类型表示时间 ,time包中还有一些常量,源码如下 // Common durations. The...
    99+
    2024-04-02
  • Go语言Zap日志库如何使用
    这篇“Go语言Zap日志库如何使用”文章的知识点大部分人都不太理解,所以小编给大家总结了以下内容,内容详细,步骤清晰,具有一定的借鉴价值,希望大家阅读完这篇文章能有所收获,下面我们一起来看看这篇“Go语言Zap日志库如何使用”文章吧。一、日...
    99+
    2023-07-05
  • Go语言中的日志库有哪些值得推荐?
    随着互联网技术的不断发展,日志已经成为了软件开发中必不可少的一部分。在Go语言中,有很多优秀的日志库可供选择。本文将介绍几个值得推荐的日志库,并演示它们的使用方法。 logrus logrus是一个非常流行的日志库,它提供了丰富的功能...
    99+
    2023-06-04
    日志 shell 编程算法
  • Go语言中的数组与切片介绍
    这篇文章主要讲解了“Go语言中的数组与切片介绍”,文中的讲解内容简单清晰,易于学习与理解,下面请大家跟着小编的思路慢慢深入,一起来研究和学习“Go语言中的数组与切片介绍”吧!1. 数组数组是一个由固定长度的...
    99+
    2024-04-02
  • 简要介绍Go语言中的运算符
    Go语言中运算符的使用方法简介 一、算术运算符Go语言中常见的算术运算符有加法运算符"+"、减法运算符"-"、乘法运算符"*"、除法运算符"/"、取余运算符"%"等。下面是一些常见的算术运算符的使用方法及代码...
    99+
    2024-01-18
    运算符介绍
  • go日志库中的logrus
    一、安装 go get github.com/sirupsen/logrus 二、使用 1、当做标准库使用 logrus实现了标准库log的方法,可以用标准库的方法用于logrus,...
    99+
    2024-04-02
  • Go语言中循环Loop的用法介绍
    Go语言和其他语言不一样,它只有一种循环方式,就是for语句 可以参考如下公式: for initialisation; condition; post{ //Do Some...
    99+
    2024-04-02
  • 在Go语言项目中怎么使用Zap日志库
    本篇内容介绍了“在Go语言项目中怎么使用Zap日志库”的有关知识,在实际案例的操作过程中,不少人都会遇到这样的困境,接下来就让小编带领大家学习一下如何处理这些情况吧!希望大家仔细阅读,能够学有所成!在Go语言项目中使用Zap日志库介绍在许多...
    99+
    2023-06-30
  • Go语言指针的详细介绍
    本篇内容介绍了“Go语言指针的详细介绍”的有关知识,在实际案例的操作过程中,不少人都会遇到这样的困境,接下来就让小编带领大家学习一下如何处理这些情况吧!希望大家仔细阅读,能够学有所成!Go语言为程序员提供了...
    99+
    2024-04-02
  • go语言中函数与方法介绍
    在C#或者Java里面我们都知道,一个Class是要包含成员变量和方法的,对于GO语言的Struct也一样,我们也可以给Struct定义一系列方法。 一、怎么定义一个方法? Go的方...
    99+
    2024-04-02
  • Go语言中定时任务库Cron使用方法介绍
    目录快速入门Cron表达式格式预定义时间表设置时区常用的方法介绍快速入门 安装cron,注意这里安装的是v3版本。新版本和旧版时间使用有所区别 go get github.com/r...
    99+
    2024-04-02
  • MongoDB中4种日志的详细介绍
    前言 任何一种数据库都有各种各样的日志,MongoDB也不例外。MongoDB中有4种日志,分别是系统日志、Journal日志、oplog主从日志、慢查询日志等。这些日志记录着MongoDB数据库不同方面的...
    99+
    2024-04-02
  • Go语言标准库中的log该如何理解
    这篇文章给大家介绍Go语言标准库中的log该如何理解,内容非常详细,感兴趣的小伙伴们可以参考借鉴,希望对大家能有所帮助。Go语言标准库中的log介绍1.log1.1使用Loggerlog包定义了Logger...
    99+
    2024-04-02
  • ASP.NET Core的日志系统介绍
    .net core是内置了日志系统的,本文这里简单的介绍一下它的基本用法。如下是一个简单的示例:  var service = new ServiceCollection(...
    99+
    2024-04-02
  • Go语言中有哪些经典的缓存与日志处理库?
    Go语言作为一门高效且易于学习的编程语言,其生态系统也相当丰富。在Go语言中,有许多经典的缓存与日志处理库,它们都为我们提供了极大的帮助。本文将介绍Go语言中一些经典的缓存与日志处理库。 一、缓存库 GoCache GoCache是Go...
    99+
    2023-10-20
    缓存 日志 分布式
  • Go语言基础知识点介绍
    Go 语言教程 Go 是一个开源的编程语言,它能让构造简单、可靠且高效的软件变得容易。 Go是从2007年末由Robert Griesemer, Rob Pike, Ken Thom...
    99+
    2024-04-02
  • 如何在 Go语言中使用日志包
    目录Go 语言标准库之log 包如何将日志消息存储在 Go 中的文件中定制你的日志记录器总结引言: 在我们的日常编程中,日志很重要。只要是我们写代码,就有可能出现 Bug。日志文件就...
    99+
    2024-04-02
软考高级职称资格查询
编程网,编程工程师的家园,是目前国内优秀的开源技术社区之一,形成了由开源软件库、代码分享、资讯、协作翻译、讨论区和博客等几大频道内容,为IT开发者提供了一个发现、使用、并交流开源技术的平台。
  • 官方手机版

  • 微信公众号

  • 商务合作