Go語言 命令行解析（一）

命令行啟動服務的方式，在後端使用非常廣泛，如果有寫過C語言的同學相信不難理解這一點！在C語言中，我們可以根據argc和argv來獲取和解析命令行的參數，從而通過不同的參數調取不同的方法，同時也可以用Usage來列印幫助信息了。

那麼開始今天的話題之前，我們回顧一下在C語言中是如何解析傳遞的參數的。

示例代碼：

#include <stdio.h>
#include <stdlib.h>

// argc 為int型
// argv 為char指針數組，元素個數是argc，存放的是指向每一個參數的指針
int main(int argc, char *argv[])
{

    printf("命令行參數個數: %d\n", argc);
    printf("執行程式的名稱：%s\n", argv[0]);

    int i = 1; // 從下標1開始獲取，因為0代表的是程式名稱

    while(i < argc)
    {
        // 迴圈列印每個命令行的參數
        printf("%s\n", argv[i]);
        i++;
    }

    return 0;
}

編譯運行：

#gcc c_cli.c -o c_cli
./c_cli /usr/local/service/config /usr/local/service/log/service.log                   
命令行參數個數: 3
執行程式的名稱：./c_cli
/usr/local/service/config
/usr/local/service/log/service.log

看完上面的例子，其實我們可以發現，上例中是C語言自帶的參數解析，對於簡單的參數構成還是可以使用的。下麵我們再看一下Go語言os標準庫的實現。

示例代碼：

package main

import (
	"fmt"
	"os"
)

func main() {

	var args = os.Args
	fmt.Println(args)

	return
}

編譯執行：

#go build go_flag.go
#./go_flag /usr/local/service/config /usr/local/service/log/service.log
[./go_flag /usr/local/service/config /usr/local/service/log/service.log]

上例中，我們可以看到os.Args返回一個數組，數組裡面是我們命令行執行時，所傳遞的參數和程式名稱。os自帶的參數獲取，對於簡單的參數來說還能使用，如果參數複雜的情況下，那麼解析起來就比較費勁的。這個時候，我們可以選擇Go語言的flag標準庫來幫我們處理命令行解析工作。

Flag包：https://golang.org/pkg/flag/

是Go語言提供的一個標準庫，能夠較為方便和靈活的解析命令行傳遞的參數。

flag有兩種方式：

1、flag.Type，其中Type可以是：int、string、bool，float等類型，返回指針類型。

var port = flag.Int("port", 0, "相關描述")

參數1：flag的名稱

參數2：flag的值，上例中預設值是0

參數3：flag的描述

2、flag.TypeVar，將類型綁定到一個變數上。

var port int
flag.IntVar(&port, "port", 0, "相關描述")

參數1：flag的值

參數2：flag的名稱

參數3：flag的值，上例中預設值是0

參數4：flag的描述

示例代碼：

package main

import (
	"flag"
	"fmt"
	"os"
)

var (
	// 定義一個tcp埠號
	tcp_port int

	// flag.Type（Name為Flag的名字，Value是Flag的值，Usage是Flag的提示信息）
	port    = flag.Int("port", 0, "服務埠設置參數為：-port=80")
	config  = flag.String("config", "", "配置文件配置參數為：-config=/usr/local/service/config")
	logFile = flag.String("logfile", "", "日誌文件配置參數為：-logfile=/usr/local/service/log/service.log")
	// flag.Type返回的是指針類型，所以獲取值為"*變數"

)

func init() {
	flag.IntVar(&tcp_port, "tcp_port", 0, "TCP服務埠描述: -tcp_port=2001")
	flag.Usage = func() {
		_, _ = fmt.Fprint(os.Stderr,
			"cli : go_flag -port=8080 -config=/usr/local/service/config "+
				"-logfile=/usr/local/service/log/service.log -tcp_port=2001\n")
		flag.PrintDefaults()
	}

	flag.Parse()
}

func main() {

	if *port <= 0 {
		flag.PrintDefaults()
		os.Exit(1)
	}

	if tcp_port <= 0 {
		flag.PrintDefaults()
		os.Exit(1)
	}

	if *config == "" {
		flag.PrintDefaults()
		os.Exit(2)
	}

	if *logFile == "" {
		flag.PrintDefaults()
		os.Exit(3)
	}

	fmt.Printf("service tcp port : %d \n", tcp_port)
	fmt.Printf("service port : %d \n", *port)
	fmt.Printf("service config : %s \n", *config)
	fmt.Printf("service logfile : %s \n", *logFile)
	return
}

運行結果：

#go build go_flag.go
#./go_flag 
  -config string
        配置文件配置參數為：-config=/usr/local/service/config
  -logfile string
        日誌文件配置參數為：-logfile=/usr/local/service/log/service.log
  -port int
        服務埠設置參數為：-port=80
  -tcp_port int
        TCP服務埠描述: -tcp_port=2001

#./go_flag -port 8090 -config=/usr/local/service/config -logfile= /usr/local/service/log/service.log -tcp_port=2001
service tcp port : 2001 
service port : 8090 
service config : /usr/local/service/config 
service logfile : /usr/local/service/log/service.log 

查看幫助：

#./go_flag -h
cli : go_flag -port=8080 -config=/usr/local/service/config -logfile=/usr/local/service/log/service.log
  -config string
        配置文件配置參數為：-config=/usr/local/service/config
  -logfile string
        日誌文件配置參數為：-logfile=/usr/local/service/log/service.log
  -port int
        服務埠設置參數為：-port=80
  -tcp_port int
        TCP服務埠描述: -tcp_port=2001

Flag語法：

• -flag 只支持bool參數
• -flag=p 
• -flag p bool類型不能使用，當p為false時會引起歧義

Flag解析：

parseOne()函數來處理-flag=value的，如果處理成功後，會將flag存儲到FlagSet.actucal map[string]*Flag中。

flag.Parse()函數來解析命令行中的參數中定義的flag，該方法遇到第一個非flag的命令方法就中止。

1、non-flag的時候，會終止解析工作。

​

2、連續兩個“-”的時候，會終止解析工作。
​

然後，再看我們傳遞錯誤的參數的返回情況。

#./go_flag -a=b
flag provided but not defined: -a
cli : go_flag -port=8080 -config=/usr/local/service/config -logfile=/usr/local/service/log/service.log
  -config string
        配置文件配置參數為：-config=/usr/local/service/config
  -logfile string
        日誌文件配置參數為：-logfile=/usr/local/service/log/service.log
  -port int
        服務埠設置參數為：-port=80
  -tcp_port int
        TCP服務埠描述: -tcp_port=2001

跟蹤到代碼中可以看到如圖：

​

從上例可見，其實flag並沒有非常強大，下一章節會介紹一個更強大的命令行解析工具。

總結：

1. os標準庫提供的解析方法，能夠解析簡單的命令行參數。
2. flag能夠解析約定好的常規按照-flag傳遞的命令行參數，有幫助信息。
3. os和flag還不能夠解析複雜結構的啟動參數。

喜歡的話，可以關註公眾號