loggerx/options.go

package loggerx

import (
	"io"
	"os"
	"time"
)

type loggerOption struct {
	prefix      string // 日志前缀
	format      string // text json
	dir         string // 文件目录
	isGinLog    bool
	isGid       bool
	isPrintFile bool
	writeType   writeType      // 是否异步罗盘
	traceField  string         // trace字段
	errorToInfo bool           // 错误日志是否写入info日志
	days        int            // 日志保存天数
	drivers     []io.Writer    // 文件落盘驱动器
	fileSplit   FileSplit      // 文件切割规则
	sizeSplit   int            // 根据文件大小切割
	timeZone    *time.Location // 时区
	escapeHTML  bool
	expandData  map[string]string // 扩展字段
}

type writeType uint8

const (
	// 0.默认(同步) 1.指定同步 2.指定异步
	writeTypeDefault writeType = iota
	writeTypeSync
	writeTypeAsync
)

func defaultOptions() loggerOption {
	return loggerOption{
		isGinLog:    true,
		isGid:       true,
		isPrintFile: true,
		writeType:   writeTypeDefault, // 默认同步
		format:      "json",
		dir:         "./log",
		traceField:  "trace_id",
		days:        7,
		fileSplit:   FileSplitTimeE,
		timeZone:    time.Local,
		escapeHTML:  true,
		expandData:  make(map[string]string),
	}
}

type Option func(*loggerOption)

// trace字段
func SetTraceField(traceField string) Option {
	return func(o *loggerOption) {
		o.traceField = traceField
	}
}

// 附加字段
func SetExpandData(key string, value string) Option {
	return func(o *loggerOption) {
		if o.expandData == nil {
			o.expandData = make(map[string]string)
		}
		o.expandData[key] = value
	}
}

// 是否异步写入
func SetWriteAsync() Option {
	return func(o *loggerOption) {
		o.writeType = writeTypeAsync
	}
}

// 打印到控制台
func SetToConsole() Option {
	return func(o *loggerOption) {
		o.drivers = append(o.drivers, os.Stdout)
	}
}

// 错误日志是否写入info日志
func SetErrorToInfo() Option {
	return func(o *loggerOption) {
		o.errorToInfo = true
	}
}

// 日志的前缀
func SetPrefix(prefix string) Option {
	return func(o *loggerOption) {
		o.prefix = prefix
	}
}

// 日志格式(默认json)
func SetFormat(format string) Option {
	return func(o *loggerOption) {
		o.format = format
	}
}

// 设置是否打印到文件
func SetPrintFile(print bool) Option {
	return func(o *loggerOption) {
		o.isPrintFile = print
	}
}

// 是否保存gin的日志
func SetGinLog(open bool) Option {
	return func(o *loggerOption) {
		o.isGinLog = open
	}
}

// 文件路径
func SetDir(dir string) Option {
	return func(o *loggerOption) {
		if dir != "" {
			o.dir = dir
		}
	}
}

// 保存goroutine的ID信息
func SetGID(open bool) Option {
	return func(o *loggerOption) {
		o.isGid = open
	}
}

// 日志保存天数
func SetDays(days int) Option {
	return func(o *loggerOption) {
		o.days = days
	}
}

// 设置时区
func SetTimeZone(loc *time.Location) Option {
	return func(o *loggerOption) {
		o.timeZone = loc
	}
}

// 文件额外的驱动
func SetExtraDriver(ds ...io.Writer) Option {
	return func(o *loggerOption) {
		for _, d := range ds {
			if d != nil {
				o.drivers = append(o.drivers, d)
			}
		}
	}
}

// 文件切割规则
// 1.文件大小
// 2.时间A（年/月/日/时）
// 3.时间B（年/月-日）
// 4.时间C（年-月-日-时）
// 5.时间D（年-月-日）
func SetFileSplit(split FileSplit) Option {
	return func(o *loggerOption) {
		o.fileSplit = split
	}
}

type FileSplit string

const (
	FileSplitNone  FileSplit = "none"  // 不切割
	FileSplitTimeA FileSplit = "timeA" // （年/月/日/时）
	FileSplitTimeB FileSplit = "timeB" // （年/月/日）
	FileSplitTimeC FileSplit = "timeC" // （年/月-日）
	FileSplitTimeD FileSplit = "timeD" // （年-月-日-时）
	FileSplitTimeE FileSplit = "timeE" // （年-月-日）

)

// 根据文件大小切割(暂时未生效)
func SetSizeSplit(m int) Option {
	return func(o *loggerOption) {
		o.sizeSplit = m
	}
}

func SetEscapeHTML(b bool) Option {
	return func(o *loggerOption) {
		o.escapeHTML = b
	}
}