sclog

package module

v1.3.3 Latest Latest Go to latest Published: Dec 26, 2024 License: GPL-2.0 Imports: 5 Imported by: 5

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

gitee.com/swsk33/sclog

Links

Open Source Insights

README ¶

简单彩色日志-Go

1，介绍

sclog（Simple Color Log）是一个简单的Go日志库，可用于在控制台输出彩色字符的日志。

该日志库的功能非常简单，仅用于在控制台上输出不同级别的日志，并支持自定义一些输出日志的配置，适用于一些简单的需要在控制台输出日志的场景或者小型程序。

如果你对性能有一定的要求，或者需要更加强大的日志功能，请考虑使用其它更加专业的结构化日志库，例如Zap、Logrus等等。

可通过下列命令集成该日志库：

go get gitee.com/swsk33/sclog

2，输出日志的基本方法

在导入gitee.com/swsk33/sclog包后，直接调用对应的日志级别方法即可：

package main

import "gitee.com/swsk33/sclog"

func main() {
	// 格式化输出日志
	sclog.Trace("这是%s级别日志\n", "Trace")
	sclog.Debug("这是%s级别日志\n", "Debug")
	sclog.Info("这是%s级别日志\n", "Info")
	sclog.Warn("这是%s级别日志\n", "Warn")
	sclog.Error("这是%s级别日志\n", "Error")
}

结果：

每一个级别的方法例如Info等等的使用方式和fmt.Printf一样，第一个参数都是格式化字符串，后面可以传入不定长个参数表示格式化字符串中每个占位符的值。

除了格式化输出日志之外，还可以输出单行日志，例如：

package main

import "gitee.com/swsk33/sclog"

func main() {
	// 输出一行日志
	sclog.TraceLine("这是一行Trace日志")
	sclog.DebugLine("这是一行Debug日志")
	sclog.InfoLine("这是一行Info日志")
	sclog.WarnLine("这是一行Warn日志")
	sclog.ErrorLine("这是一行Error日志")
}

结果：

以Info级别日志输出方法为例，可见：

Info方法为格式化输出，并且不会自动换行，需要通过\n实现换行
InfoLine方法为单行字符串输出，会自动换行

3，日志级别

目前有下列日志级别：

TRACE 跟踪级别
DEBUG 调试级别
INFO 普通信息级别
WARN 警告级别
ERROR 错误级别

不同级别的权重大小为：

TRACE < DEBUG < INFO < WARN < ERROR

在sclog包下，每个级别都定义了一个常量，在后续部分涉及到设定日志最小级别等其它自定义操作时，就可以直接调用这些日志级别常量：

// 表示INFO级别的常量
sclog.INFO
// 表示ERROR级别的常量
sclog.ERROR

4，自定义日志输出器

上述通过直接调用sclog包中的函数（例如Info、Debug等等）其实是调用的默认内置的日志输出器对象实现日志打印，默认的日志输出器是不能进行自定义和配置的，因此如果需要进行一些定制，可以自己创建新的日志输出器对象。

通过下列代码可以定义一个新的日志输出器Logger对象，并设定其最低级别为DEBUG级别：

package main

import "gitee.com/swsk33/sclog"

func main() {
	// 创建一个新的日志输出器
	myLogger := sclog.NewLogger()
	// 设定最低级别为DEBUG
	myLogger.Level = sclog.DEBUG
	// 调用该日志输出器的对应方法输出日志
	myLogger.Trace("这是%s级别日志\n", "Trace")
	myLogger.Debug("这是%s级别日志\n", "Debug")
	myLogger.Info("这是%s级别日志\n", "Info")
	myLogger.Warn("这是%s级别日志\n", "Warn")
	myLogger.Error("这是%s级别日志\n", "Error")
}

结果：

通过NewLogger方法能够返回一个日志输出器的指针对象，且包含默认的配置，调用该日志输出器对象的对应级别方法（例如Info、InfoLine等等）就可以输出日志，使用方式与sclog包下的函数一样，其默认的最低级别为INFO。可见上述由于设定了最低级别为DEBUG，因此低于该级别的TRACE日志将不会被打印。

如果想直接关闭全部级别的日志输出，则设定其Level为sclog.OFF即可。

5，输出内容的自定义配置

每一行日志的输出内容，其结构都是固定的，具体如下：

2024-09-29 23:13:37.347 INFO  这是Info级别日志
\_____________________/ \__/  \_____________/
           |              |          |
          时间           级别    日志消息内容

在sclog中还定义了针对输出内容的自定义配置模型，该模型结构体表示如下：

// LineConfig 关于日志的每行输出的配置
type LineConfig struct {
	// 关于时间部分输出的配置
	Time struct {
		// 是否显示时间
		Enabled bool
		// 时间显示格式，为Go语言时间格式形式
		//
		// 例如：
		// "2006-01-02 15:04:05"
		// "2006-01-02 15:04:05.000"
		Pattern string
		// 输出颜色配置
		Color *color.Color
	}
	// 关于级别部分输出的配置
	Level struct {
		// 是否显示日志级别
		Enabled bool
		// 输出颜色配置
		Color *color.Color
	}
	// 关于具体日志消息部分的配置
	Message struct {
		// 是否显示日志消息
		Enabled bool
		// 消息部分前缀
		Prefix string
		// 输出颜色配置
		Color *color.Color
	}
}

这个结构体表示了输出的每一行日志的结构、颜色等配置信息，每一个级别都会对应一个这样的配置对象，可以通过sclog包的函数NewLineConfig创建一个LineConfig对象，刚创建出来的LineConfig对象都是包含默认值的。

在LineConfig对象中：

Time属性为结构体，用于自定义日志时间部分的输出行为，其中：
- Enabled 是否输出时间部分内容，默认为true
- Pattern 格式化时间字符串，使用的是time.Format的Layout字符串，默认为2006-01-02 15:04:05.000
- Color 时间部分的颜色，默认为白色
Level属性为结构体，用于自定义日志级别部分的输出行为，其中：
- Enabled 是否输出级别部分内容，默认为true
- Color 时间部分的颜色，默认为白色
Message属性为结构体，用于自定义日志消息部分的输出行为，其中：
- Enabled 是否输出消息部分内容，默认为true
- Prefix 消息部分的前缀字符串，默认为空字符串
- Color 时间部分的颜色，默认为白色

通过创建LineConfig对象，修改需要的配置属性，并配置给日志输出器Logger的对应级别即可实现自定义输出内容，下面将通过几个示例进一步地实现日志输出的自定义。

(1) 配置`LineConfig`的方式

在定义了LineConfig对象后，我们可以将其直接设定到Logger的全部级别上：

package main

import "gitee.com/swsk33/sclog"

func main() {
	// 创建一个配置对象
	myConfig := sclog.NewLineConfig()
	// 修改时间部分配置
	// 关闭时间显示
	myConfig.Time.Enabled = false
	// 创建一个新的日志输出器
	myLogger := sclog.NewLogger()
	// 将自定义配置对象应用到全部的级别
	myLogger.ConfigAll(myConfig)
	// 调用该日志输出器的对应方法输出日志
	myLogger.Info("这是%s级别日志\n", "Info")
	myLogger.Warn("这是%s级别日志\n", "Warn")
	myLogger.Error("这是%s级别日志\n", "Error")
}

结果：

通过Logger对象的ConfigAll方法可以直接将一个自定义的LineConfig配置对象应用到全部级别，如果说只想设定到其中一个级别，可以用ConfigLevel方法：

package main

import "gitee.com/swsk33/sclog"

func main() {
	// 创建一个配置对象
	myConfig := sclog.NewLineConfig()
	// 修改时间部分配置
	// 关闭时间显示
	myConfig.Time.Enabled = false
	// 创建一个新的日志输出器
	myLogger := sclog.NewLogger()
	// 将自定义配置对象只应用到INFO级别
	myLogger.ConfigLevel(sclog.INFO, myConfig)
	// 调用该日志输出器的对应方法输出日志
	myLogger.Info("这是%s级别日志\n", "Info")
	myLogger.Warn("这是%s级别日志\n", "Warn")
	myLogger.Error("这是%s级别日志\n", "Error")
}

结果：

此时，只有INFO级别应用了自定义的配置。

如果不想自己创建配置，只是想基于Logger默认的配置进行修改，则可以通过直接修改Logger中LevelConfig列表中对应级别的配置对象属性即可。

Logger的LevelConfig属性是一个map类型，键为不同的级别（例如sclog.INFO），值为该级别对应的配置对象，每个Logger中的LevelConfig中都包含了全部级别的配置对象。

package main

import "gitee.com/swsk33/sclog"

func main() {
	// 创建一个新的日志输出器
	myLogger := sclog.NewLogger()
	// 直接修改Logger中INFO级别的配置
	// 修改INFO级别的时间Layout
	myLogger.LevelConfig[sclog.INFO].Time.Pattern = "2006-01-02 15:04:05"
	// 调用该日志输出器的对应方法输出日志
	myLogger.Info("这是%s级别日志\n", "Info")
	myLogger.Warn("这是%s级别日志\n", "Warn")
	myLogger.Error("这是%s级别日志\n", "Error")
}

结果：

(2) 消息内容前缀

通过设定LineConfig对象的Message结构体的Prefix属性，可以实现在日志内容部分加上自定义前缀：

package main

import "gitee.com/swsk33/sclog"

func main() {
	// 创建一个新的日志输出器
	myLogger := sclog.NewLogger()
	// 修改INFO级别的消息前缀
	myLogger.LevelConfig[sclog.INFO].Message.Prefix = "[主线程] "
	// 调用该日志输出器的对应方法输出日志
	myLogger.Info("这是%s级别日志\n", "Info")
}

结果：

(3) 自定义字符颜色

在默认的Logger中除了级别部分信息为彩色之外，其余部分消息均为白色字符，可通过设定LineConfig对象中对应结构体的Color属性实现设定颜色。

LineConfig对象中Color属性类型为github.com/fatih/color包下的Color指针类型，通过这个包下的New函数即可创建颜色对象，例如：

package main

import (
	"gitee.com/swsk33/sclog"
	"github.com/fatih/color"
)

func main() {
	// 创建颜色对象
	// 前景色为白色，背景色为绿色
	infoColor := color.New(color.FgWhite, color.BgGreen)
	// 创建日志输出器对象
	logger := sclog.NewLogger()
	// 修改日志输出器对象中，INFO级别配置对象的级别部分颜色为我们自定义的颜色对象
	logger.LevelConfig[sclog.INFO].Level.Color = infoColor
	// 输出日志
	logger.InfoLine("这是Info级别日志")
}

结果：

颜色对象color.Color通过New构造函数创建，函数中可以传入不定长个颜色常量作为参数以组合颜色，在color包下定义了所有可用颜色的常量，其中Fg开头的表示前景色，即文字颜色，而Bg开头的表示背景色，默认情况下前景色为白色，背景色为透明。

此外，还可以定义加粗或者带下划线的颜色对象：

package main

import (
	"gitee.com/swsk33/sclog"
	"github.com/fatih/color"
)

func main() {
	// 黄色加粗
	warnColor := color.New(color.FgHiYellow, color.Bold)
	// 红色带下划线
	errorColor := color.New(color.FgHiRed, color.Underline)
	// 配置自定义日志对象
	logger := sclog.NewLogger()
	// 配置对应级别消息部分颜色
	logger.LevelConfig[sclog.WARN].Message.Color = warnColor
	logger.LevelConfig[sclog.ERROR].Message.Color = errorColor
	// 打印日志
	logger.WarnLine("这是Warn日志")
	logger.ErrorLine("这是Error日志")
}

结果：

更多关于color.Color对象的创建，请参考color包的文档：传送门

6，修改级别显示名称

默认情况下，每个级别部分使用大写英文名称表示，例如INFO、ERROR等等，可以通过SetLevelName函数自定义每个级别的显示名：

package main

import (
	"gitee.com/swsk33/sclog"
)

func main() {
	// 自定义每个级别的名字
	sclog.SetLevelName(sclog.INFO, "普通")
	sclog.SetLevelName(sclog.WARN, "警告")
	sclog.SetLevelName(sclog.ERROR, "错误")
	a := 1
	sclog.Info("a的值为：%d\n", a)
	sclog.Warn("a的值为：%d\n", a)
	sclog.Error("a的值为：%d\n", a)
}

结果：

通过SetLevelName函数自定义的级别名称将应用于全局，无论是默认的Logger还是自定义的。

7，线程安全的日志

默认的日志输出器Logger不是线程安全的，这可能导致在多线程同时调用一个日志输出时发生输出消息错乱的情况。

因此，该类库还提供了下列线程安全的日志输出器实现：

MutexLogger 基于互斥锁的线程安全的日志实现
BufferLogger 基于通道缓冲区的线程安全的日志实现

上述线程安全的日志输出器都继承于Logger对象，因此可以使用上述方式对其进行配置例如级别、输出内容和颜色等。

(1) `MutexLogger`的使用

可以直接调用内部默认的MutexLogger函数实现：

package main

import "gitee.com/swsk33/sclog"

func main() {
	// 格式化输出
	sclog.MutexTrace("基于互斥锁的线程安全日志，级别：%d\n", sclog.TRACE)
	sclog.MutexDebug("基于互斥锁的线程安全日志，级别：%d\n", sclog.DEBUG)
	sclog.MutexInfo("基于互斥锁的线程安全日志，级别：%d\n", sclog.INFO)
	sclog.MutexWarn("基于互斥锁的线程安全日志，级别：%d\n", sclog.WARN)
	sclog.MutexError("基于互斥锁的线程安全日志，级别：%d\n", sclog.ERROR)
	// 单行输出
	sclog.MutexTraceLine("基于互斥锁的线程安全日志，单行输出")
	sclog.MutexDebugLine("基于互斥锁的线程安全日志，单行输出")
	sclog.MutexInfoLine("基于互斥锁的线程安全日志，单行输出")
	sclog.MutexWarnLine("基于互斥锁的线程安全日志，单行输出")
	sclog.MutexErrorLine("基于互斥锁的线程安全日志，单行输出")
}

只需在对应级别的方法名（例如Info）前面加上Mutex（例如MutexInfo）即可调用基于互斥锁的线程安全日志实现。

此外，也可以使用构造函数NewMutexLogger创建自定义的互斥锁线程安全日志输出器：

package main

import (
	"gitee.com/swsk33/sclog"
	"sync"
)

func main() {
	// 创建基于互斥锁的线程安全日志输出器
	mutexLogger := sclog.NewMutexLogger()
	mutexLogger.Level = sclog.INFO
	// 调用对应级别方法即可
	waitGroup := &sync.WaitGroup{}
	waitGroup.Add(2)
	go func() {
		for i := 0; i <= 10; i += 2 {
			mutexLogger.Info("[线程1] 当前输出：%d\n", i)
		}
		waitGroup.Done()
	}()
	go func() {
		for i := 1; i <= 11; i += 2 {
			mutexLogger.Info("[线程2] 当前输出：%d\n", i)
		}
		waitGroup.Done()
	}()
	waitGroup.Wait()
}

此外，还可以使用NewMutexLoggerShareLock传入一个现有的sync.Mutex对象，指定一个现有的互斥锁，实现多个日志输出器绑定到一个互斥锁上，这样即使创建多个MutexLogger对象，在多个线程中同时运行，也能够保证几个日志输出器的线程安全：

package main

import (
	"gitee.com/swsk33/sclog"
	"sync"
)

func main() {
	// 互斥锁
	lock := &sync.Mutex{}
	// 创建两个日志输出器，使用同一个互斥锁
	l1, l2 := sclog.NewMutexLoggerShareLock(lock), sclog.NewMutexLoggerShareLock(lock)
	waitGroup := &sync.WaitGroup{}
	waitGroup.Add(2)
	go func() {
		for i := 0; i <= 10; i += 2 {
			l1.Info("[线程1] 当前输出：%d\n", i)
		}
		waitGroup.Done()
	}()
	go func() {
		for i := 1; i <= 11; i += 2 {
			l2.Info("[线程2] 当前输出：%d\n", i)
		}
		waitGroup.Done()
	}()
	waitGroup.Wait()
}

基于互斥锁的线程安全日志输出器虽然能够保证线程安全，但是在并发调用数量过多时可能发生锁竞争导致性能有所下降。

(2) `BufferLogger`的使用

同样地可以直接调用内部函数实现：

package main

import (
	"gitee.com/swsk33/sclog"
	"time"
)

func main() {
	// 格式化输出
	sclog.BufferTrace("基于缓冲区通道的线程安全日志，级别：%d\n", sclog.TRACE)
	sclog.BufferDebug("基于缓冲区通道的线程安全日志，级别：%d\n", sclog.DEBUG)
	sclog.BufferInfo("基于缓冲区通道的线程安全日志，级别：%d\n", sclog.INFO)
	sclog.BufferWarn("基于缓冲区通道的线程安全日志，级别：%d\n", sclog.WARN)
	sclog.BufferError("基于缓冲区通道的线程安全日志，级别：%d\n", sclog.ERROR)
	// 单行输出
	sclog.BufferTraceLine("基于缓冲区通道的线程安全日志，单行输出")
	sclog.BufferDebugLine("基于缓冲区通道的线程安全日志，单行输出")
	sclog.BufferInfoLine("基于缓冲区通道的线程安全日志，单行输出")
	sclog.BufferWarnLine("基于缓冲区通道的线程安全日志，单行输出")
	sclog.BufferErrorLine("基于缓冲区通道的线程安全日志，单行输出")
	// 防止主线程提前退出
	time.Sleep(100 * time.Millisecond)
}

当然，也可以使用NewBufferLogger创建一个自定义的缓冲区线程安全日志输出器对象：

package main

import (
	"gitee.com/swsk33/sclog"
	"sync"
	"time"
)

func main() {
	// 创建基于缓冲区通道的线程安全日志输出器
	bufferLogger := sclog.NewBufferLogger(10)
	bufferLogger.Level = sclog.INFO
	// 调用对应级别方法即可
	waitGroup := &sync.WaitGroup{}
	waitGroup.Add(2)
	go func() {
		for i := 0; i <= 10; i += 2 {
			bufferLogger.Info("[线程1] 当前输出：%d\n", i)
		}
		waitGroup.Done()
	}()
	go func() {
		for i := 1; i <= 11; i += 2 {
			bufferLogger.Info("[线程2] 当前输出：%d\n", i)
		}
		waitGroup.Done()
	}()
	waitGroup.Wait()
	// 防止主线程提前退出
	time.Sleep(1 * time.Second)
}

NewBufferLogger的参数表示日志消息缓冲区的大小，若同一时间消息超过了缓冲区大小且未被及时输出，则可能导致调用日志时发生阻塞。

基于缓冲区通道的线程安全日志比起基于互斥锁的线程安全日志输出器通常会有更好的性能，但是可能造成额外的内存开销。

Documentation ¶

Index ¶

Constants
func BufferDebug(formatMessage string, args ...interface{})
func BufferDebugLine(messageLine string)
func BufferError(formatMessage string, args ...interface{})
func BufferErrorLine(messageLine string)
func BufferInfo(formatMessage string, args ...interface{})
func BufferInfoLine(messageLine string)
func BufferTrace(formatMessage string, args ...interface{})
func BufferTraceLine(messageLine string)
func BufferWarn(formatMessage string, args ...interface{})
func BufferWarnLine(messageLine string)
func Debug(formatMessage string, args ...interface{})
func DebugLine(messageLine string)
func Error(formatMessage string, args ...interface{})
func ErrorLine(messageLine string)
func Info(formatMessage string, args ...interface{})
func InfoLine(messageLine string)
func MutexDebug(formatMessage string, args ...interface{})
func MutexDebugLine(messageLine string)
func MutexError(formatMessage string, args ...interface{})
func MutexErrorLine(messageLine string)
func MutexInfo(formatMessage string, args ...interface{})
func MutexInfoLine(messageLine string)
func MutexTrace(formatMessage string, args ...interface{})
func MutexTraceLine(messageLine string)
func MutexWarn(formatMessage string, args ...interface{})
func MutexWarnLine(messageLine string)
func SetLevelName(level int, name string)
func Trace(formatMessage string, args ...interface{})
func TraceLine(messageLine string)
func Warn(formatMessage string, args ...interface{})
func WarnLine(messageLine string)
type BufferLogger
- func NewBufferLogger(size int) *BufferLogger
- func (logger *BufferLogger) Close()
- func (logger *BufferLogger) Debug(formatMessage string, args ...interface{})
- func (logger *BufferLogger) DebugLine(messageLine string)
- func (logger *BufferLogger) Error(formatMessage string, args ...interface{})
- func (logger *BufferLogger) ErrorLine(messageLine string)
- func (logger *BufferLogger) Info(formatMessage string, args ...interface{})
- func (logger *BufferLogger) InfoLine(messageLine string)
- func (logger *BufferLogger) Trace(formatMessage string, args ...interface{})
- func (logger *BufferLogger) TraceLine(messageLine string)
- func (logger *BufferLogger) Warn(formatMessage string, args ...interface{})
- func (logger *BufferLogger) WarnLine(messageLine string)
type LineConfig
- func NewLineConfig() *LineConfig
type Logger
- func NewLogger() *Logger
- func (logger *Logger) ConfigAll(config *LineConfig)
- func (logger *Logger) ConfigLevel(level int, config *LineConfig)
- func (logger *Logger) Debug(formatMessage string, args ...interface{})
- func (logger *Logger) DebugLine(messageLine string)
- func (logger *Logger) Error(formatMessage string, args ...interface{})
- func (logger *Logger) ErrorLine(messageLine string)
- func (logger *Logger) Info(formatMessage string, args ...interface{})
- func (logger *Logger) InfoLine(messageLine string)
- func (logger *Logger) Trace(formatMessage string, args ...interface{})
- func (logger *Logger) TraceLine(messageLine string)
- func (logger *Logger) Warn(formatMessage string, args ...interface{})
- func (logger *Logger) WarnLine(messageLine string)
type MutexLogger
- func NewMutexLogger() *MutexLogger
- func NewMutexLoggerShareLock(lock *sync.Mutex) *MutexLogger
- func (logger *MutexLogger) Debug(formatMessage string, args ...interface{})
- func (logger *MutexLogger) DebugLine(messageLine string)
- func (logger *MutexLogger) Error(formatMessage string, args ...interface{})
- func (logger *MutexLogger) ErrorLine(messageLine string)
- func (logger *MutexLogger) Info(formatMessage string, args ...interface{})
- func (logger *MutexLogger) InfoLine(messageLine string)
- func (logger *MutexLogger) Trace(formatMessage string, args ...interface{})
- func (logger *MutexLogger) TraceLine(messageLine string)
- func (logger *MutexLogger) Warn(formatMessage string, args ...interface{})
- func (logger *MutexLogger) WarnLine(messageLine string)

Constants ¶

View Source

const (
	TRACE = 0
	DEBUG = 1
	INFO  = 2
	WARN  = 3
	ERROR = 4
	OFF   = math.MaxInt
)

定义级别常量

Variables ¶

This section is empty.

Functions ¶

func BufferDebug ¶ added in v1.3.0

func BufferDebug(formatMessage string, args ...interface{})

BufferDebug 打印一行DEBUG级别日志使用通道作为缓冲区保证线程安全性

formatMessage 格式化的消息字符串 args 格式化消息参数

func BufferDebugLine ¶ added in v1.3.0

func BufferDebugLine(messageLine string)

BufferDebugLine 打印一行DEBUG级别日志，并换行使用通道作为缓冲区保证线程安全性

formatMessage 格式化的消息字符串

func BufferError ¶ added in v1.3.0

func BufferError(formatMessage string, args ...interface{})

BufferError 打印一行ERROR级别日志使用通道作为缓冲区保证线程安全性

formatMessage 格式化的消息字符串 args 格式化消息参数

func BufferErrorLine ¶ added in v1.3.0

func BufferErrorLine(messageLine string)

BufferErrorLine 打印一行Warn级别日志，并换行使用通道作为缓冲区保证线程安全性

formatMessage 格式化的消息字符串

func BufferInfo ¶ added in v1.3.0

func BufferInfo(formatMessage string, args ...interface{})

BufferInfo 打印一行INFO级别日志使用通道作为缓冲区保证线程安全性

formatMessage 格式化的消息字符串 args 格式化消息参数

func BufferInfoLine ¶ added in v1.3.0

func BufferInfoLine(messageLine string)

BufferInfoLine 打印一行INFO级别日志，并换行使用通道作为缓冲区保证线程安全性

formatMessage 格式化的消息字符串

func BufferTrace ¶ added in v1.3.0

func BufferTrace(formatMessage string, args ...interface{})

BufferTrace 打印一行TRACE级别日志使用通道作为缓冲区保证线程安全性

formatMessage 格式化的消息字符串 args 格式化消息参数

func BufferTraceLine ¶ added in v1.3.0

func BufferTraceLine(messageLine string)

BufferTraceLine 打印一行TRACE级别日志，并换行使用通道作为缓冲区保证线程安全性

formatMessage 格式化的消息字符串

func BufferWarn ¶ added in v1.3.0

func BufferWarn(formatMessage string, args ...interface{})

BufferWarn 打印一行WARN级别日志使用通道作为缓冲区保证线程安全性

formatMessage 格式化的消息字符串 args 格式化消息参数

func BufferWarnLine ¶ added in v1.3.0

func BufferWarnLine(messageLine string)

BufferWarnLine 打印一行Warn级别日志，并换行使用通道作为缓冲区保证线程安全性

formatMessage 格式化的消息字符串

func Debug ¶

func Debug(formatMessage string, args ...interface{})

Debug 打印一行DEBUG级别日志

formatMessage 格式化的消息字符串 args 格式化消息参数

func DebugLine ¶

func DebugLine(messageLine string)

DebugLine 打印一行DEBUG级别日志，并换行

formatMessage 格式化的消息字符串

func Error ¶

func Error(formatMessage string, args ...interface{})

Error 打印一行ERROR级别日志

formatMessage 格式化的消息字符串 args 格式化消息参数

func ErrorLine ¶

func ErrorLine(messageLine string)

ErrorLine 打印一行Warn级别日志，并换行

formatMessage 格式化的消息字符串

func Info ¶

func Info(formatMessage string, args ...interface{})

Info 打印一行INFO级别日志

formatMessage 格式化的消息字符串 args 格式化消息参数

func InfoLine ¶

func InfoLine(messageLine string)

InfoLine 打印一行INFO级别日志，并换行

formatMessage 格式化的消息字符串

func MutexDebug ¶ added in v1.3.0

func MutexDebug(formatMessage string, args ...interface{})

MutexDebug 打印一行DEBUG级别日志使用互斥锁保证线程安全性

formatMessage 格式化的消息字符串 args 格式化消息参数

func MutexDebugLine ¶ added in v1.3.0

func MutexDebugLine(messageLine string)

MutexDebugLine 打印一行DEBUG级别日志，并换行使用互斥锁保证线程安全性

formatMessage 格式化的消息字符串

func MutexError ¶ added in v1.3.0

func MutexError(formatMessage string, args ...interface{})

MutexError 打印一行ERROR级别日志使用互斥锁保证线程安全性

formatMessage 格式化的消息字符串 args 格式化消息参数

func MutexErrorLine ¶ added in v1.3.0

func MutexErrorLine(messageLine string)

MutexErrorLine 打印一行Warn级别日志，并换行使用互斥锁保证线程安全性

formatMessage 格式化的消息字符串

func MutexInfo ¶ added in v1.3.0

func MutexInfo(formatMessage string, args ...interface{})

MutexInfo 打印一行INFO级别日志使用互斥锁保证线程安全性

formatMessage 格式化的消息字符串 args 格式化消息参数

func MutexInfoLine ¶ added in v1.3.0

func MutexInfoLine(messageLine string)

MutexInfoLine 打印一行INFO级别日志，并换行使用互斥锁保证线程安全性

formatMessage 格式化的消息字符串

func MutexTrace ¶ added in v1.3.0

func MutexTrace(formatMessage string, args ...interface{})

MutexTrace 打印一行TRACE级别日志使用互斥锁保证线程安全性

formatMessage 格式化的消息字符串 args 格式化消息参数

func MutexTraceLine ¶ added in v1.3.0

func MutexTraceLine(messageLine string)

MutexTraceLine 打印一行TRACE级别日志，并换行使用互斥锁保证线程安全性

formatMessage 格式化的消息字符串

func MutexWarn ¶ added in v1.3.0

func MutexWarn(formatMessage string, args ...interface{})

MutexWarn 打印一行WARN级别日志使用互斥锁保证线程安全性

formatMessage 格式化的消息字符串 args 格式化消息参数

func MutexWarnLine ¶ added in v1.3.0

func MutexWarnLine(messageLine string)

MutexWarnLine 打印一行Warn级别日志，并换行使用互斥锁保证线程安全性

formatMessage 格式化的消息字符串

func SetLevelName ¶

func SetLevelName(level int, name string)

SetLevelName 设定对应级别的显示名称

func Trace ¶

func Trace(formatMessage string, args ...interface{})

Trace 打印一行TRACE级别日志

formatMessage 格式化的消息字符串 args 格式化消息参数

func TraceLine ¶

func TraceLine(messageLine string)

TraceLine 打印一行TRACE级别日志，并换行

formatMessage 格式化的消息字符串

func Warn ¶

func Warn(formatMessage string, args ...interface{})

Warn 打印一行WARN级别日志

formatMessage 格式化的消息字符串 args 格式化消息参数

func WarnLine ¶

func WarnLine(messageLine string)

WarnLine 打印一行Warn级别日志，并换行

formatMessage 格式化的消息字符串

Types ¶

type BufferLogger ¶ added in v1.3.0

type BufferLogger struct {
	// 继承普通Logger
	*Logger
	// contains filtered or unexported fields
}

BufferLogger 基于通道缓冲区的线程安全日志输出器

func NewBufferLogger ¶ added in v1.3.0

func NewBufferLogger(size int) *BufferLogger

NewBufferLogger 构造函数

size 缓冲区大小当缓冲区内的消息数量未被消费（输出）且已到达设定大小时，再次调用日志输出就会导致阻塞

func (*BufferLogger) Close ¶ added in v1.3.0

func (logger *BufferLogger) Close()

Close 关闭缓冲区日志，释放资源

func (*BufferLogger) Debug ¶ added in v1.3.0

func (logger *BufferLogger) Debug(formatMessage string, args ...interface{})

Debug 打印一行DEBUG级别日志

formatMessage 格式化的消息字符串 args 格式化消息参数

func (*BufferLogger) DebugLine ¶ added in v1.3.0

func (logger *BufferLogger) DebugLine(messageLine string)

DebugLine 打印一行DEBUG级别日志，并换行

formatMessage 格式化的消息字符串

func (*BufferLogger) Error ¶ added in v1.3.0

func (logger *BufferLogger) Error(formatMessage string, args ...interface{})

Error 打印一行ERROR级别日志

formatMessage 格式化的消息字符串 args 格式化消息参数

func (*BufferLogger) ErrorLine ¶ added in v1.3.0

func (logger *BufferLogger) ErrorLine(messageLine string)

ErrorLine 打印一行Warn级别日志，并换行

formatMessage 格式化的消息字符串

func (*BufferLogger) Info ¶ added in v1.3.0

func (logger *BufferLogger) Info(formatMessage string, args ...interface{})

Info 打印一行INFO级别日志

formatMessage 格式化的消息字符串 args 格式化消息参数

func (*BufferLogger) InfoLine ¶ added in v1.3.0

func (logger *BufferLogger) InfoLine(messageLine string)

InfoLine 打印一行INFO级别日志，并换行

formatMessage 格式化的消息字符串

func (*BufferLogger) Trace ¶ added in v1.3.0

func (logger *BufferLogger) Trace(formatMessage string, args ...interface{})

Trace 打印一行TRACE级别日志

formatMessage 格式化的消息字符串 args 格式化消息参数

func (*BufferLogger) TraceLine ¶ added in v1.3.0

func (logger *BufferLogger) TraceLine(messageLine string)

TraceLine 打印一行TRACE级别日志，并换行

formatMessage 格式化的消息字符串

func (*BufferLogger) Warn ¶ added in v1.3.0

func (logger *BufferLogger) Warn(formatMessage string, args ...interface{})

Warn 打印一行WARN级别日志

formatMessage 格式化的消息字符串 args 格式化消息参数

func (*BufferLogger) WarnLine ¶ added in v1.3.0

func (logger *BufferLogger) WarnLine(messageLine string)

WarnLine 打印一行Warn级别日志，并换行

formatMessage 格式化的消息字符串

type LineConfig ¶

type LineConfig struct {
	// 关于时间部分输出的配置
	Time struct {
		// 是否显示时间
		Enabled bool
		// 时间显示格式，为Go语言时间格式形式
		//
		// 例如：
		// "2006-01-02 15:04:05"
		// "2006-01-02 15:04:05.000"
		Pattern string
		// 输出颜色配置
		Color *color.Color
	}
	// 关于级别部分输出的配置
	Level struct {
		// 是否显示日志级别
		Enabled bool
		// 输出颜色配置
		Color *color.Color
	}
	// 关于具体日志消息部分的配置
	Message struct {
		// 是否显示日志消息
		Enabled bool
		// 消息部分前缀
		Prefix string
		// 输出颜色配置
		Color *color.Color
	}
}

LineConfig 关于日志的每行输出的配置

func NewLineConfig ¶

func NewLineConfig() *LineConfig

NewLineConfig 日志行内容配置构造函数

type Logger ¶

type Logger struct {
	// 最低日志级别
	Level int
	// 每个级别分别对应的配置的列表
	LevelConfig map[int]*LineConfig
}

Logger 日志输出器对象

func NewLogger ¶

func NewLogger() *Logger

NewLogger 日志输出器构造函数

func (*Logger) ConfigAll ¶

func (logger *Logger) ConfigAll(config *LineConfig)

ConfigAll 一键设置全部级别的输出配置

config 行输出配置

func (*Logger) ConfigLevel ¶

func (logger *Logger) ConfigLevel(level int, config *LineConfig)

ConfigLevel 对某个级别的行输出单独进行配置

level 要配置的级别 config 传入对应配置

func (*Logger) Debug ¶

func (logger *Logger) Debug(formatMessage string, args ...interface{})

Debug 打印一行DEBUG级别日志

formatMessage 格式化的消息字符串 args 格式化消息参数

func (*Logger) DebugLine ¶

func (logger *Logger) DebugLine(messageLine string)

DebugLine 打印一行DEBUG级别日志，并换行

formatMessage 格式化的消息字符串

func (*Logger) Error ¶

func (logger *Logger) Error(formatMessage string, args ...interface{})

Error 打印一行ERROR级别日志

formatMessage 格式化的消息字符串 args 格式化消息参数

func (*Logger) ErrorLine ¶

func (logger *Logger) ErrorLine(messageLine string)

ErrorLine 打印一行Warn级别日志，并换行

formatMessage 格式化的消息字符串

func (*Logger) Info ¶

func (logger *Logger) Info(formatMessage string, args ...interface{})

Info 打印一行INFO级别日志

formatMessage 格式化的消息字符串 args 格式化消息参数

func (*Logger) InfoLine ¶

func (logger *Logger) InfoLine(messageLine string)

InfoLine 打印一行INFO级别日志，并换行

formatMessage 格式化的消息字符串

func (*Logger) Trace ¶

func (logger *Logger) Trace(formatMessage string, args ...interface{})

Trace 打印一行TRACE级别日志

formatMessage 格式化的消息字符串 args 格式化消息参数

func (*Logger) TraceLine ¶

func (logger *Logger) TraceLine(messageLine string)

TraceLine 打印一行TRACE级别日志，并换行

formatMessage 格式化的消息字符串

func (*Logger) Warn ¶

func (logger *Logger) Warn(formatMessage string, args ...interface{})

Warn 打印一行WARN级别日志

formatMessage 格式化的消息字符串 args 格式化消息参数

func (*Logger) WarnLine ¶

func (logger *Logger) WarnLine(messageLine string)

WarnLine 打印一行Warn级别日志，并换行

formatMessage 格式化的消息字符串

type MutexLogger ¶ added in v1.3.0

type MutexLogger struct {
	// 继承普通Logger
	*Logger
	// contains filtered or unexported fields
}

MutexLogger 基于互斥锁的线程安全日志输出器

func NewMutexLogger ¶ added in v1.3.0

func NewMutexLogger() *MutexLogger

NewMutexLogger 构造函数

func NewMutexLoggerShareLock ¶ added in v1.3.1

func NewMutexLoggerShareLock(lock *sync.Mutex) *MutexLogger

NewMutexLoggerShareLock 构造函数，使用现有的锁对象

func (*MutexLogger) Debug ¶ added in v1.3.0

func (logger *MutexLogger) Debug(formatMessage string, args ...interface{})

Debug 打印一行DEBUG级别日志

formatMessage 格式化的消息字符串 args 格式化消息参数

func (*MutexLogger) DebugLine ¶ added in v1.3.0

func (logger *MutexLogger) DebugLine(messageLine string)

DebugLine 打印一行DEBUG级别日志，并换行

formatMessage 格式化的消息字符串

func (*MutexLogger) Error ¶ added in v1.3.0

func (logger *MutexLogger) Error(formatMessage string, args ...interface{})

Error 打印一行ERROR级别日志

formatMessage 格式化的消息字符串 args 格式化消息参数

func (*MutexLogger) ErrorLine ¶ added in v1.3.0

func (logger *MutexLogger) ErrorLine(messageLine string)

ErrorLine 打印一行Warn级别日志，并换行

formatMessage 格式化的消息字符串

func (*MutexLogger) Info ¶ added in v1.3.0

func (logger *MutexLogger) Info(formatMessage string, args ...interface{})

Info 打印一行INFO级别日志

formatMessage 格式化的消息字符串 args 格式化消息参数

func (*MutexLogger) InfoLine ¶ added in v1.3.0

func (logger *MutexLogger) InfoLine(messageLine string)

InfoLine 打印一行INFO级别日志，并换行

formatMessage 格式化的消息字符串

func (*MutexLogger) Trace ¶ added in v1.3.0

func (logger *MutexLogger) Trace(formatMessage string, args ...interface{})

Trace 打印一行TRACE级别日志

formatMessage 格式化的消息字符串 args 格式化消息参数

func (*MutexLogger) TraceLine ¶ added in v1.3.0

func (logger *MutexLogger) TraceLine(messageLine string)

TraceLine 打印一行TRACE级别日志，并换行

formatMessage 格式化的消息字符串

func (*MutexLogger) Warn ¶ added in v1.3.0

func (logger *MutexLogger) Warn(formatMessage string, args ...interface{})

Warn 打印一行WARN级别日志

formatMessage 格式化的消息字符串 args 格式化消息参数

func (*MutexLogger) WarnLine ¶ added in v1.3.0

func (logger *MutexLogger) WarnLine(messageLine string)

WarnLine 打印一行Warn级别日志，并换行

formatMessage 格式化的消息字符串

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

README ¶

简单彩色日志-Go

1，介绍

2，输出日志的基本方法

3，日志级别

4，自定义日志输出器

5，输出内容的自定义配置

(1) 配置LineConfig的方式

(2) 消息内容前缀

(3) 自定义字符颜色

6，修改级别显示名称

7，线程安全的日志

(1) MutexLogger的使用

(2) BufferLogger的使用

Documentation ¶

Index ¶

Constants ¶

Variables ¶

Functions ¶

func BufferDebug ¶ added in v1.3.0

func BufferDebugLine ¶ added in v1.3.0

func BufferError ¶ added in v1.3.0

func BufferErrorLine ¶ added in v1.3.0

func BufferInfo ¶ added in v1.3.0

func BufferInfoLine ¶ added in v1.3.0

func BufferTrace ¶ added in v1.3.0

func BufferTraceLine ¶ added in v1.3.0

func BufferWarn ¶ added in v1.3.0

func BufferWarnLine ¶ added in v1.3.0

func Debug ¶

func DebugLine ¶

func Error ¶

func ErrorLine ¶

func Info ¶

func InfoLine ¶

func MutexDebug ¶ added in v1.3.0

func MutexDebugLine ¶ added in v1.3.0

func MutexError ¶ added in v1.3.0

func MutexErrorLine ¶ added in v1.3.0

func MutexInfo ¶ added in v1.3.0

func MutexInfoLine ¶ added in v1.3.0

func MutexTrace ¶ added in v1.3.0

func MutexTraceLine ¶ added in v1.3.0

func MutexWarn ¶ added in v1.3.0

func MutexWarnLine ¶ added in v1.3.0

func SetLevelName ¶

func Trace ¶

func TraceLine ¶

func Warn ¶

func WarnLine ¶

Types ¶

type BufferLogger ¶ added in v1.3.0

func NewBufferLogger ¶ added in v1.3.0

func (*BufferLogger) Close ¶ added in v1.3.0

func (*BufferLogger) Debug ¶ added in v1.3.0

func (*BufferLogger) DebugLine ¶ added in v1.3.0

func (*BufferLogger) Error ¶ added in v1.3.0

func (*BufferLogger) ErrorLine ¶ added in v1.3.0

func (*BufferLogger) Info ¶ added in v1.3.0

func (*BufferLogger) InfoLine ¶ added in v1.3.0

func (*BufferLogger) Trace ¶ added in v1.3.0

func (*BufferLogger) TraceLine ¶ added in v1.3.0

func (*BufferLogger) Warn ¶ added in v1.3.0

func (*BufferLogger) WarnLine ¶ added in v1.3.0

type LineConfig ¶

func NewLineConfig ¶

type Logger ¶

func NewLogger ¶

func (*Logger) ConfigAll ¶

func (*Logger) ConfigLevel ¶

func (*Logger) Debug ¶

func (*Logger) DebugLine ¶

func (*Logger) Error ¶

func (*Logger) ErrorLine ¶

func (*Logger) Info ¶

func (*Logger) InfoLine ¶

func (*Logger) Trace ¶

func (*Logger) TraceLine ¶

func (*Logger) Warn ¶

func (*Logger) WarnLine ¶

(1) 配置`LineConfig`的方式

(1) `MutexLogger`的使用

(2) `BufferLogger`的使用