Go标准库Flag库和Log库的使用

来自:网络
时间:2024-06-07
阅读:

一.Flag

Go语言内置的flag包实现了命令行参数的解析,flag包使得开发命令行工具更为简单。

1.1 os.Args

如果你只是简单的的想要获取命令行参数,可以像下面代码示例一样使用os.Args来获取命令行参数。

os.Arg实际是一个存储命令行参数的字符串切片([]string),它的第一个元素是执行文件的名称。

Go标准库Flag库和Log库的使用

1.2 flag包的基本使用

导入flag包

import fmt

flag参数类型

flag包支持的命令行参数类型有bool,int,int64,uint,uint64,float,float64,string,duration。

Go标准库Flag库和Log库的使用

1.2.1 定义命令行flag参数

有以下两种常见的定义命令行flag参数的方法。

flag.Type()

基本格式如下:

flag.Type(flag名,默认值,帮助信息) *Type。

例如我们要定义姓名,年龄,婚否三个命令行参数,我们可以按如下方式定义:

	name := flag.String("name", "张三", "姓名")
	age := flag.Int("age", 25, "年龄")
	married := flag.Bool("married", false, "婚否")
	delay := flag.Duration("d", 0, "时间间隔")

需要注意的是:此时name,age, married,delay均为对应类型的指针。

flag.TypeVar()

基本格式如下:flag.TypeVar(Type指针,flag名,默认值,帮助信息)

例如我们要定义姓名,年龄,婚否三个命令参数,我们可以按照如下方式定义。

func main() {
	var name string
	var age int
	var married bool
	var d time.Duration

	flag.StringVar(&name, "name", "张三", "姓名")
	flag.IntVar(&age, "age", 25, "年龄")
	flag.BoolVar(&married, "married", false, "婚否")
	flag.DurationVar(&d, "d", 0, "时间间隔")

	fmt.Println(name, age, married, d)
}

flag.Parse()

通过以上两种方式定义号命令行flag参数后,需要通过调用flag.Parse()来对命令行参数进行解析。

支持的命令行参数格式有以下几种:

  • -flag xxx (使用空格,一个'-'符号)
  • --flag xxx (使用空格,两个'-'符号)
  • -flag=xxx(使用等号,一个'-'符号)
  • --flag=xxx(使用等号,两个'--'符号)

其中布尔类型的参数必须使用等号的方式指定。

flag解析在第一个非flag参数(单个'-'不是flag参数)之前停止,或者在终止符'-'之后停止。

1.2.2 flag其它函数

  • flag.Args():返回命令行参数后的其它参数,以[]string类型
  • flag.NArg():返回命令行参数后的其它参数个数
  • flag.NFlag():返回使用命令行参数个数

1.2.3 使用

Go标准库Flag库和Log库的使用

二. Log

Go语言内置的log包实现了简单的日志服务。本文介绍了标准库log的基本使用。

1.1 使用Logger

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

例如:

Go标准库Flag库和Log库的使用

logger会打印每条日志信息的日期,时间,默认输出到系统的标准错误。Fatal系列函数会在写入日志信息后调用os.Exit(1)。Panic系列函数会在写入日志信息后Panic。

1.2 配置logger

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

log标准库中的Flags函数会返回标准logger的输出设置,而SetFlags函数用来设置标准logger的输出配置。

func Flags() int
func SetFlags(flag int)

flag选项

log标准库提供了如下的flag选项,它们是一系列定义好的常量。

const (
    // 字位共同控制输出日志信息的细节。不能控制输出的顺序和格式。
    // 在所有项目后会有一个冒号:2009/01/23 01:23:23.123123 /a/b/c/d.go:23: message
    Ldate         = 1 << iota     // 日期:2009/01/23
    Ltime                         // 时间:01:23:23
    Lmicroseconds                 // 微秒分辨率:01:23:23.123123(用于增强Ltime位)
    Llongfile                     // 文件全路径名+行号: /a/b/c/d.go:23
    Lshortfile                    // 文件无路径名+行号:d.go:23(会覆盖掉Llongfile)
    LstdFlags     = Ldate | Ltime // 标准logger的初始值
)

下面设置一下标准logger的输出选项:

Go标准库Flag库和Log库的使用

1.3 配置日志前缀

log标准库中还提供了关于日志信息前缀的两种方法:

func (l *Logger) Prefix() string
func (l *Logger) SetPrefix(prefix string)

其中Prefix函数用来查看标准logger的输出前缀,SetPrefix函数用来设置输出前缀。

Go标准库Flag库和Log库的使用

这样我们就能够在代码中为我们的日志信息添加指定前缀,方便之后对日志信息进行检索和处理。

1.4 配置日志输出位置

func SetOutput(w io.Writer)

SetOutput函数用来设置标准logger的输出目的地。默认是标准错误。

例如:我们将日志信息输出来文件中:

Go标准库Flag库和Log库的使用

如果你要使用标准的logger,我们通常会把上面的配置操作写到init函数中。

package main

import (
	"fmt"
	"log"
	"os"
)

func init() {
	logfile, err := os.OpenFile("./xx.log", os.O_CREATE|os.O_APPEND|os.O_WRONLY, 0644)
	if err != nil {
		fmt.Println("open file fail")
		return
	}

	log.SetOutput(logfile)
	log.SetFlags(log.Ldate | log.Ltime | log.Lmicroseconds | log.Llongfile)
}

func main() {
	log.SetPrefix("[hello]")
	log.Println("这是一条普通的日志")
}

1.5 创建logger

log标准库还提供了一个创建新logger对象的构造函数——New,支持我们创建自己的logger实例,New函数签名如下:

func New(out io.Writer, prefix string, flag int) *Logger

New创建一个Logger对象,其中参数out设置日志信息写入目的地,参数prefix会添加到生成的每条日志的前缀,参数flag定义日志的属性(时间,文件等)。

Go标准库Flag库和Log库的使用

总结:log标准库的功能有限,例如无法满足记录不同级别的日志情况,我们实际项目中根据自己的需要选择使用第三方的日志库,如logrus,zap等。 

返回顶部
顶部