Go命令行参数操作：os.Args、flag包

你的名字 2024-02-20 10:08 13阅读 0赞

## Go命令行参数操作：os.Args、flag包 ##

> 最近在写项目时，需要用到命令行传入的参数，正好借此机会整理一下。

### 1 os.Args：程序运行时，携带的参数（包含exe本身） ###

package main
    
    import (
    	"fmt"
    	"os"
    	"strconv"
    )
    
    func main () {
        
    	for idx, args := range os.Args {
        
    		fmt.Println("参数" + strconv.Itoa(idx) + ":", args)
    	}
    }

运行之后的结果：

$go run main.go 1 3 -X ?
    参数0: /tmp/go-build116558042/command-line-arguments/_obj/exe/main
    参数1: 1
    参数2: 3
    参数3: -X
    参数4: ?

可以看到，命令行参数包括了程序路径本身，以及通常意义上的参数。

程序中os.Args的类型是 \[\]string ，也就是字符串切片。所以可以在for循环的range中遍历，还可以用 len(os.Args) 来获取其数量。

> 如果不想要输出os.Args的第一个值，也就是可执行文件本身的信息，可以修改上述程序：
> 
>     for idx, args := range os.Args[1:] {

将range后面的切片，去掉第一个元素。  
输出切片的所有元素，还有更简洁的方式：

fmt.Println(strings.Join(os.Args[1:], "\n"))
    fmt.Println(os.Args[1:])
    /*
    后一种方式的结果是[1 3 -X ?]，这是fmt.Println输出切片的格式
    */

### 2 flag包：解析自定义参数 ###

#### 2.1 定义参数：flag.String(name,defaultValue,usage) ####

> 使用flag包，首先定义待解析命令行参数，也就是以"-"开头的参数，比如这里的 -b -s -help等。-help不需要特别指定，可以自动处理。  
> 这里指定了两个参数，-b和-s：

var b = flag.Bool("b", false, "bool类型参数")
    var s = flag.String("s", "", "string类型参数")
    
    -----------------
    原型：
    func Bool(name string, value bool, usage string) *bool
    func String(name string, value string, usage string) *string

> 通过flag.Bool和flag.String，建立了2个指针b和s，分别指向bool类型和string类型的变量。所以后续要通过 \*b 和 \*s 使用变量值。

flag.Bool和flag.String的参数有3个，分别是命令行参数名称，默认值，提示字符串。

![在这里插入图片描述][5dfc8d1fe365474697f23da3da470879.png]

#### 2.2 解析参数：flag.Parse() ####

> 使用之前必须要解析，否则会获取不到参数具体的值

//解析参数
    flag.Parse()

#### 2.3 获取参数的值 ####

> 通过\*号+参数名获取解析后的参数值

##### ①已经定义过的参数：\*paramName直接取值 #####

> 上文已经说明，通过flag方法定义好的参数变量指针，通过间接引用操作即可使用其内容：

fmt.Println("-b:", *b)
    fmt.Println("-s:", *s)

##### ②未定义的参数:flag.Args()，获取剩下参数（字符切片） #####

> 参数中没有能够按照预定义的参数解析的部分，通过flag.Args()即可获取，是一个字符串切片。

fmt.Println("其他参数：", flag.Args())

需要注意的是，从第一个不能解析的参数开始，后面的所有参数都是无法解析的。即使后面的参数中含有预定义的参数：

$ go run main.go -b stop -s test others
    -b: true
    -s: 
    其他参数： [stop -s test others]

#### 2.4 案例 ####

package main
    
    import (
    	"flag"
    	"fmt"
    )
    
    func main() {
        
    	var uname = flag.String("username", "ziyi", "the user name")
    	var age = flag.Int("age", 18, "the user age")
    	flag.Parse()
    	//①情况一：带参数
    	// ./main -username tom -age 22
    	//解析后的结果：parse after, uname= tom  age= 22
    
    	//②情况二：不带参数，但是因为我们定义了默认值，因此参数会被赋上默认值
    	// ./main
    	//解析后：parse after, uname= ziyi  age= 18
    	fmt.Println("parse after, uname=", *uname, " age=", *age)
    
    }

参考：https://blog.csdn.net/guanchunsheng/article/details/79612153

[5dfc8d1fe365474697f23da3da470879.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/20/62f460b5a16a42598e4e2829a9c8c27f.png