Go-命令行参数解析

时间：2024-01-24 07:50:29

1. 解析命令行参数

程序在执行时，获取在命令行启动程序是使用的参数

  • 命令行( Command line interface -- CLI)：基于文本来查看、处理、操作计算机的界面，又被称为 终端、控制台
  • 命令：在命令行执行的程序，一般是一行，包含命令名字、子命令与命令相关的选项(Flag)，
  • Flag：传递给命令的参数，通过参数全称或者参数首字符指定参数名称，参数之后使用=或空格连接参数与参数值

2. Golang 获取命令行参数

  • os.Args: 返回一个字符串slice，第一个当前程序自身路径，剩余参数是传递给命令行的参数

    传递的参数一般是 --key=value 形式 、简写 -k value 形式或者是一个开关标志 -k，使用os.Args只是获取一个以空格分隔的字符串列表，无法很好的解析传递进来的参数到变量中

package main

import (
	"fmt"
	"os"
)

func main() {
	commandArgs := os.Args
	fmt.Println(commandArgs)
}

# 执行程序: 递归浏览指定目录下所有文件
go run main.go --name ls --value /etc -r

# 输出: [/tmp/go-build2637413899/b001/exe/main --name ls --value /etc -r]
  • 命令行参数解析 -- flag包

需要知晓程序的命令行需要传递哪些参数，如果没有传递该参数，那么默认值是什么，参数的说明

使用flag的流程:
1. 初始化存放命令行参数的全局变量
2. 在main包的init函数中注册需要解析的命令行参数，包含参数的类型、参数存放到哪个变量、参数的名称、参数的默认值、参数的使用说明
3. 在定义解析命令行参数最后，添加 flag.Parse()，解析传递到程序的命令行参数到变量中
4. 主函数中通过全局变量引用命令行参
5. 运行主函数，通过 -<参数名>=<value> 或  -<参数名> <value> 方式传参

解析命令行参数的基本文法:
1. flag.<类型>Var(<指针>, <参数名称>, <默认值>, <用法说明>)
2. 等价方法: flag.<类型>(<参数名称>, <默认值>, <用法说明>)
- 区别在于，Var后缀方法是通过指针将值存放到指针指向的变量，未带Var后缀的方法返回一个指定值的指针
- 相同的，参数值不同则使用不同的类型，都包含参数的名称、参数的默认值、该参数使用说明
- 类型是基本数据类型：int int64 uint uint64 string bool fl0at64 Duration

package main

import (
	"flag"
	"fmt"
)

// 1. 声明保存命令行参数的变量
var (
	name        string
	value       string
	isRecursive bool
)

func init() {
	// 2. 注册需要解析的命令行参: 参数名、默认值、参数说明
	flag.StringVar(&name, "name", "none", "执行命令的名称")
	flag.StringVar(&value, "value", "none", "执行命令的参数")
	flag.BoolVar(&isRecursive, "recursive", false, "是否递归")

	// 3. 解析命令行参数
	flag.Parse()
}

func main() {
	// 4. 主程序中通过全局变量引用命令行参
	fmt.Println(name, value, isRecursive)
}


# 输出：ls /etc true
go run main.go -name ls -value /etc -recursive

# 输出: ls /etc false
go run main.go -name ls -value /etc

Flag包相关的其他方法

  • flag.Set()解析后修改或设置命令行参数
package main

import (
	"flag"
	"fmt"
)

// 1. 声明保存命令行参数的变量
var (
	name string
)

func init() {
	// 2. 声明需要解析的命令行参: 参数名、默认值、参数说明
	flag.StringVar(&name, "name", "none", "执行命令的名称")

	// 将name的值修改为 find
	flag.Set("name", "find")
}

func main() {
	// 4. 主程序中通过全局变量引用命令行参
	fmt.Println(name)
}


# 输出：find
go run main.go -name ls
  • flog.NFlag() 返回被设置的flag数量
package main

import (
	"flag"
	"fmt"
)

// 1. 声明保存命令行参数的变量
var (
	name        string
	value       string
	isRecursive bool
)

func init() {
	flag.StringVar(&name, "name", "none", "执行命令的名称")
	flag.StringVar(&value, "value", "none", "执行命令的参数")
	flag.BoolVar(&isRecursive, "recursive", false, "是否递归")
    
	flag.Parse()
}

func main() {
	fmt.Println("number of set flag:", flag.NFlag())
}


# 输出：number of set flag: 2
go run main.go -name ls -value /etc
  • flag,Parsed() 检查 flag.Parse()是否被调用过
package main

import (
	"flag"
	"fmt"
)

// 1. 声明保存命令行参数的变量
var (
	name        string
	value       string
	isRecursive bool
)

func init() {
	flag.StringVar(&name, "name", "none", "执行命令的名称")
	flag.StringVar(&value, "value", "none", "执行命令的参数")
	flag.BoolVar(&isRecursive, "recursive", false, "是否递归")

	flag.Parse()
}

func main() {
	fmt.Println("is Parsed", flag.Parsed())
}

# 输出:is Parsed true
go run main.go -name ls -value /etc
  • flag.Visit(func (*Flag)) 按字典顺序遍历，进行设置了的标签
package main

import (
	"flag"
	"fmt"
)

// 1. 声明保存命令行参数的变量
var (
	name        string
	value       string
	isRecursive bool
)

func init() {
	flag.StringVar(&name, "name", "none", "执行命令的名称")
	flag.StringVar(&value, "value", "none", "执行命令的参数")
	flag.BoolVar(&isRecursive, "recursive", false, "是否递归")

	flag.Parse()
}

func main() {
	flag.Visit(func(f *flag.Flag) {
		fmt.Printf("Name: %s, Value: %s, DefValue: %s, Usage: %s \n", f.Name, f.Value, f.DefValue, f.Usage)
	})
}


# 输出： 
# Name: name, Value: ls, DefValue: none, Usage: 执行命令的名称 
# Name: value, Value: /etc, DefValue: none, Usage: 执行命令的参数 
go run main.go -name ls -value /etc

相关文章