golang flag包的使用教程

 更新时间:2023年09月10日 08:46:18   作者:阿兵云原生  
golang 的 flag 包是用于处理命令行参数的工具包,我们可以基于这个包来开发自定义的命令行工具,下面小编就来为大家介绍一下flag包的具体使用吧

前言

说起 golang 的 flag 个包,我们第一反应的是什么呢?至少我曾经第一次看到 flag 包的时候,第一反应是想起写 C 语言的时候咱们用于定义一个表示的,我们一般会命名为 flag 变量

实际上 golang 的 flag 包是用于处理命令行参数的工具包,我们可以基于这个包来开发自定义的命令行工具

对于命令行,相信大家都不陌生吧,学过 C 的就知道,如下代码是否很熟悉

int main(int argc,char **argv)
{
    // 打印 agrc  和 argv
        return 0;
}

其中 argc 表示命令行的参数个数, argv 二级指针表示实际的命令参数

那么,对于咱们的 golang 是如何玩的,咱们先写个 demo 看看效果

main.go

func main() {
   if len(os.Args) > 0 {
      fmt.Println("len(os.Args) == ", len(os.Args))
      for _, v := range os.Args {
         fmt.Println(v)
      }
   }
}

效果如下:

咱们 go build 输出程序名为 testFlag 的可执行程序,如下运行即可

当然需要看非常详细和全面的关于 flag 包的内容,可以直接查看官方文档 ,此处咱们是对 flag 包的介绍,平常都会使用到的一些功能,以及注意事项,分别从如下 3 个小点介绍一下常用的功能

  • 注册 flag 和 Flag 解析支持的数据类型
  • 绑定 flag 变量
  • flag.Parse() 的使用方式

注册 flag 和 Flag 解析支持的数据类型

我们可以看到上述简单 demo 演示的是咱们运行可执行程序的时候追加我们期望的参数

实际上我们使用的比较多的是在程序内部去设置 flag,例如一般写 web 服务器的时候,就会去使用 flag 包设置端口

咱们在程序中使用 flag 包,定义一个端口

通过效果,我们可看到,咱们使用 flag 包来设置命令行参数时,实际上返回的是一个指针,这个地方可别弄错了

在我们的代码中,我们可以看到 flag 包他支持这么多数据类型的注册,如下:

  • 基本的 int,int64,uint,uint64 ,整数的 flag 支持这些进制的:1234、0664、0x1234
  • 布尔值,bool , 布尔值可以这样来写:1, 0, t, f, T, F, true, false, TRUE, FALSE, True, False
  • 浮点数,float,float64
  • 字符串,string
  • 时间段 duration 也是支持的很好的,例如:我们可以设置为 100ms,1h,1us,1h25m 等等都是可以的

那么对应到咱们去设置各种数据类型的命令行参数的时候,我们就可以简单的使用 flag 包对应的函数即可,如:

port := flag.Int("port", 8866, "端口")
name := flag.String("name", "小猪", "姓名")
money := flag.Float64("money",10.36,"钱")

其他的照葫芦画瓢就可以了,这些函数的参数都是一样的效果

  • 参数1 flag 名称
  • 参数2 默认值
  • 参数3 帮助信息

这里再来敲一下黑板,上述的 port,name,money 都是指针类型的哦

绑定 flag 变量

如果用不习惯上述方式来注册 flag 的话,我们也是可以先定义一个变量,然后将命令行参数绑定到变量上,如:

var city string
var food string
var age int
flag.StringVar(&city,"city","beijing","城市")
flag.StringVar(&food,"food","roast duck","美食")
flag.IntVar(&age,"age",18,"年龄")

在 flag 包中,我们可以看到也有一堆关于各种数据类型绑定变量的函数

如:flag.StringVar(&city,"city","beijing","城市")

参数类型和上述说到的类似,多了一个参数放在最前面

  • 参数1 具体的变量地址
  • 参数2 flag 名称
  • 参数3 默认值
  • 参数4 帮助信息

flag.Parse() 的使用方式

前面说了那么多的铺垫,那么我应该如何来使用呢?不可能我们都只去使用默认值吧

自然是自己开发自定义的命名行工具提供出去使用咯,这就需要咱们使用 flag.Parse() 了

flag.Parse() 来解析命令行参数写入注册的 flag 里,解析出来的是值,还是指针,这个取决于上面咱们注册 flag 的方式,再次敲黑板,此处可别弄错了

例如咱们写一个简单的 demo

此处,我们可以看到 port 是注册的自身的flag 的,port 是一个指针,所以咱们通过 flag.Parse() 之后,使用 port 时需要取地址

咱们可以参看效果如下:

编译执行可执行程序之后,我们可以看到,输出的是默认值,另外,咱们机上 --help 参数,就可以看到我们编写的帮助信息

站在使用者的角度,去使用这个工具,按照提示输入相关信息之后,我们可以看到输出的结果是我们所期望的

当然此处需要提几个注意事项:

上述我们可以看到,咱们给对应的 flag 传值的时候是, -flag xxx,我们也是可以 --flag xxx,我们还可以 -flag=xxx ,同理 --flag=xxx 也是 ok 的

当然,如果对 golang 自身对于 flag 包的实现方式感兴趣的兄弟,也可以好好看看 flag 包中对于命名行参数的字符串数据解析

func (f *FlagSet) ``parseOne``() (bool, error) {

以上就是golang flag包的使用教程的详细内容,更多关于golang flag包的资料请关注脚本之家其它相关文章!

相关文章

  • Golang设计模式工厂模式实战写法示例详解

    Golang设计模式工厂模式实战写法示例详解

    这篇文章主要为大家介绍了Golang 工厂模式实战写法示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-08-08
  • go 实现简易端口扫描的示例

    go 实现简易端口扫描的示例

    该功能实现原理很简单,就是发送socket连接(IP+端口),如果能连接成功,说明目标主机开放了某端口。当要大量扫描端口时,就需要写并发编程了。
    2021-05-05
  • go Antlr重构脚本解释器实现示例

    go Antlr重构脚本解释器实现示例

    这篇文章主要为大家介绍了go Antlr重构脚本解释器实现示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-08-08
  • Go语言基础学习之map的示例详解

    Go语言基础学习之map的示例详解

    哈希表是常见的数据结构,有的语言会将哈希称作字典或者映射,在Go中,哈希就是常见的数据类型map,本文就来聊聊Golang中map的相关知识吧
    2023-04-04
  • 解析Golang和Java的优势与劣势

    解析Golang和Java的优势与劣势

    Golang和Java是两种流行的编程语言,它们在很多方面有着相似之处,但也存在一些重要的区别,本文将对Golang和Java进行对比,探讨它们的特点和适用场景,需要的朋友可以参考下
    2023-10-10
  • GO如何模拟流操作实现示例探究

    GO如何模拟流操作实现示例探究

    这篇文章主要为大家介绍了GO如何模拟流操作实现示例探究,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2024-01-01
  • Golang编译器介绍

    Golang编译器介绍

    今天小编就为大家分享一篇关于go语言编译器的介绍,小编觉得内容挺不错的,现在分享给大家,具有很好的参考价值,需要的朋友一起跟随小编来看看吧
    2018-09-09
  • Golang实现简易的rpc调用

    Golang实现简易的rpc调用

    RPC指(Remote Procedure Call Protocol)远程过程调用协议。本文将实现利用Golang进行rpc调用(只实现一个rpc框架基本的功能,不对性能做保证),需要的可以参考一下
    2023-03-03
  • GoFrame gredis缓存DoVar及Conn连接对象的自动序列化

    GoFrame gredis缓存DoVar及Conn连接对象的自动序列化

    这篇文章主要为大家介绍了GoFrame gredis干货DoVar Conn连接对象自动序列化详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-06-06
  • Go目录文件路径操作的实现

    Go目录文件路径操作的实现

    在Go语言中,可以使用绝对路径或相对路径来表示文件路径,本文就来介绍一下Go目录文件路径操作,感兴趣的可以了解一下
    2023-10-10

最新评论