Go标准库——Flag库和Log库

2024-05-07 12:20
文章标签 go flag 标准 log

本文主要是介绍Go标准库——Flag库和Log库,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

一.Flag

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

        1.1 os.Args

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

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

         1.2 flag包的基本使用

  • 导入flag包
import fmt
  • flag参数类型

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

        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 stringvar age intvar married boolvar d time.Durationflag.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 使用

二. Log

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

        1.1 使用Logger

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

        例如:

        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: messageLdate         = 1 << iota     // 日期:2009/01/23Ltime                         // 时间:01:23:23Lmicroseconds                 // 微秒分辨率:01:23:23.123123(用于增强Ltime位)Llongfile                     // 文件全路径名+行号: /a/b/c/d.go:23Lshortfile                    // 文件无路径名+行号:d.go:23(会覆盖掉Llongfile)LstdFlags     = Ldate | Ltime // 标准logger的初始值
)

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

        1.3 配置日志前缀

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

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

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

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

        1.4 配置日志输出位置

func SetOutput(w io.Writer)

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

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

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

package mainimport ("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定义日志的属性(时间,文件等)。

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

 

 

这篇关于Go标准库——Flag库和Log库的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/967336

相关文章

从基础到高级详解Go语言中错误处理的实践指南

《从基础到高级详解Go语言中错误处理的实践指南》Go语言采用了一种独特而明确的错误处理哲学,与其他主流编程语言形成鲜明对比,本文将为大家详细介绍Go语言中错误处理详细方法,希望对大家有所帮助... 目录1 Go 错误处理哲学与核心机制1.1 错误接口设计1.2 错误与异常的区别2 错误创建与检查2.1 基础

Go语言中json操作的实现

《Go语言中json操作的实现》本文主要介绍了Go语言中的json操作的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧... 目录 一、jsOChina编程N 与 Go 类型对应关系️ 二、基本操作:编码与解码 三、结构体标签(Struc

使用Go调用第三方API的方法详解

《使用Go调用第三方API的方法详解》在现代应用开发中,调用第三方API是非常常见的场景,比如获取天气预报、翻译文本、发送短信等,Go作为一门高效并发的编程语言,拥有强大的标准库和丰富的第三方库,可以... 目录引言一、准备工作二、案例1:调用天气查询 API1. 注册并获取 API Key2. 代码实现3

基于Go语言开发一个 IP 归属地查询接口工具

《基于Go语言开发一个IP归属地查询接口工具》在日常开发中,IP地址归属地查询是一个常见需求,本文将带大家使用Go语言快速开发一个IP归属地查询接口服务,有需要的小伙伴可以了解下... 目录功能目标技术栈项目结构核心代码(main.go)使用方法扩展功能总结在日常开发中,IP 地址归属地查询是一个常见需求:

GO语言短变量声明的实现示例

《GO语言短变量声明的实现示例》在Go语言中,短变量声明是一种简洁的变量声明方式,使用:=运算符,可以自动推断变量类型,下面就来具体介绍一下如何使用,感兴趣的可以了解一下... 目录基本语法功能特点与var的区别适用场景注意事项基本语法variableName := value功能特点1、自动类型推

GO语言中函数命名返回值的使用

《GO语言中函数命名返回值的使用》在Go语言中,函数可以为其返回值指定名称,这被称为命名返回值或命名返回参数,这种特性可以使代码更清晰,特别是在返回多个值时,感兴趣的可以了解一下... 目录基本语法函数命名返回特点代码示例命名特点基本语法func functionName(parameters) (nam

Go之errors.New和fmt.Errorf 的区别小结

《Go之errors.New和fmt.Errorf的区别小结》本文主要介绍了Go之errors.New和fmt.Errorf的区别,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考... 目录error的基本用法1. 获取错误信息2. 在条件判断中使用基本区别1.函数签名2.使用场景详细对

Go语言连接MySQL数据库执行基本的增删改查

《Go语言连接MySQL数据库执行基本的增删改查》在后端开发中,MySQL是最常用的关系型数据库之一,本文主要为大家详细介绍了如何使用Go连接MySQL数据库并执行基本的增删改查吧... 目录Go语言连接mysql数据库准备工作安装 MySQL 驱动代码实现运行结果注意事项Go语言执行基本的增删改查准备工作

Go中select多路复用的实现示例

《Go中select多路复用的实现示例》Go的select用于多通道通信,实现多路复用,支持随机选择、超时控制及非阻塞操作,建议合理使用以避免协程泄漏和死循环,感兴趣的可以了解一下... 目录一、什么是select基本语法:二、select 使用示例示例1:监听多个通道输入三、select的特性四、使用se

Go语言使用Gin处理路由参数和查询参数

《Go语言使用Gin处理路由参数和查询参数》在WebAPI开发中,处理路由参数(PathParameter)和查询参数(QueryParameter)是非常常见的需求,下面我们就来看看Go语言... 目录一、路由参数 vs 查询参数二、Gin 获取路由参数和查询参数三、示例代码四、运行与测试1. 测试编程路