Golang實現簡易的命令行功能
前言
一次偶然的想法,想知道為什么在終端輸入那些命令行后,就執(zhí)行了對應的操作,這轉化為代碼,應該怎么實現呢?
既然有了問題,那我們就來解決問題吧!
首先我認為想做命令行操作,那就得先”認識“命令行(當然這里指你的代碼認識),所以我認位有兩個步驟:
- 解析命令行
- 實現對應命令行的功能
話不多說開干!
開始
正好在學習 Golang
,那就用它的試試吧!
首先,我們先來學習以下幾個 API
flag.String
// String defines a string flag with specified name, default value, and usage string. // The return value is the address of an int variable that stores the value of the flag. // String 定義了一個字符串標志,具有指定的名稱、默認值和用法字符串。返回值是存儲標志值的字符串變量的地址。 func String(name string, value string, usage string) *string { return CommandLine.String(name, value, usage) }
也就是說,使用-name value
的命令參數,usage
是對這個參數的說明,返回值是這個 value 的指針
,也就是用戶輸入在 -name
后的 value
。
flag.Int
// Int defines an int flag with specified name, default value, and usage string. // The return value is the address of an int variable that stores the value of the flag. // Int 定義了一個具有指定名稱、默認值和用法字符串的 int 標志。返回值是存儲標志值的 int 變量的地址。 func Int(name string, value int, usage string) *int { return CommandLine.Int(name, value, usage) }
使用方式和 String()
一樣,只是類型的區(qū)別。
flag.StringVar
// StringVar defines a string flag with specified name, default value, and usage string. // The argument p points to a string variable in which to store the value of the flag. // StringVar 定義了一個帶有指定名稱、默認值和用法字符串的字符串標志。參數 p 指向一個字符串變量,用于存儲標志的值。 func StringVar(p *string, name string, value string, usage string) { CommandLine.Var(newStringValue(value, p), name, usage) }
這里可以看到區(qū)別就是,將返回值指針,變成了函數的第一個參數。
flag.IntVar
// IntVar defines an int flag with specified name, default value, and usage string. // The argument p points to an int variable in which to store the value of the flag. // IntVar 定義了一個具有指定名稱、默認值和用法字符串的 int 標志。參數 p 指向一個存儲標志值的 int 變量。 func IntVar(p *int, name string, value int, usage string) { CommandLine.Var(newIntValue(value, p), name, usage) }
了解這些后,我們就開始吧!
定義命令行參數
package main // ...import func commandStyle() { methodPtr := flag.String("method", "default", "method of sample") valuePtr := flag.Int("value", -1, "value of sample") // 解析 flag.Parse() fmt.Println(*methodPtr, *valuePtr) } func commandStyle2() { var method string var value int flag.StringVar(&method, "method", "default", "method of sample") flag.IntVar(&value, "value", -1, "value of sample") flag.Parse() fmt.Println(method, value) } func main() { commandStyle() }
在終端使用 go run . -method get -value 1
這串命令后,打印出了 get 1
。
Parse 解析來自 os.Args[1:] 的命令行標志。必須在定義所有標志之后和程序訪問標志之前調用。
這里的一個重要的點就是要使用 flag.Parse()
,也就是解析go run .` 之后的標志。使用變量將標志的值接收,然后打印。
這兩種方式結果都是一樣,只有寫法上的差距,這時候雖然我們體驗了一點簡單的命令行的影子了,但似乎還是感覺好像啥效果也沒有呀。接下來我們就來實現一個 copy 文件內容的功能
實現 -f -v 是否強制拷貝
首先我們使用上面說過的類似方式,注冊標志 f,v
,然后解析標志
func main() { var showProgress, force bool // -f 當存在時拷貝,是否強制拷貝 flag.BoolVar(&force, "f", false, "force copy when existing") flag.BoolVar(&showProgress, "v", false, "explain what is being done") flag.Parse() // 獲取參數個數,必須要輸入兩個參數,因為copy是從這個文件到另一個文件 if flag.NArg() < 2 { flag.Usage() // 打印用途 return } copyFileAction(flag.Arg(0), flag.Arg(1), showProgress, force) }
注冊標志完成后,我們就可以開始實現我們的 copy
功能了
首先我們必須后面要輸入兩個文件名,讓最后一個文件copy到前一個文件(制定規(guī)則)
我們模擬命令行輸入:go run . -f -v a.txt b.txt
,這就是我們最后需要實現的東西,f, v
是可以省略的,默認把 a.txt -> b.txt
。
-f
表示當文件存在時,強制copy覆蓋里面的內容-v
表示解釋正在做什么
接下來我們需要實現一個 copyFileAction
函數,來實現copy功能,以及命令行參數的效果
copyFileAction 實現
func fileExist(fileName string)bool { _, err := os.Stat(fileName) // 返回這個文件信息 // IsExist 只是錯誤或報告是否存在 // err == nil,表示有文件信息,os.IsExist(err),表示有文件存在 return err == nil || os.IsExist(err) } // 轉化操作,命令行,與功能實現的邏輯判斷 func copyFileAction(src, dst string, showProgress, force bool) { if !force { // 判斷是否存在文件,若存在,是否需要覆蓋它 if fileExist(dst) { fmt.Printf("%s exists override? y/n \n", dst) reader := bufio.NewReader(os.Stdin) // 讀取輸入內容 data, _, _ := reader.ReadLine() // 取一行的內容 // 判斷輸入的內容 if strings.TrimSpace(string(data)) != "y" { return } } } // copy 文件 copyFile(src, dst) }
這里我們可以看到充分利用到了 showProgress 和 force
兩個命令行取的值,當文件``存在且不強制`時,會有一個詢問,是否覆蓋,同意就實行 copy 操作,不同意不做處理(相當于一次無效命令)。
接下來我們實現功能核心 copyFile
copyFile
func copyFile(originFile, targetFile string)(written int64, err error){ srcFile, err := os.Open(originFile) // 打開文件 if err != nil { // Error() 返回錯誤信息 log.Fatal(err) return } defer srcFile.Close() dstFile, err := os.Create(targetFile) // 創(chuàng)建文件 if err != nil { // Error() 返回錯誤信息 log.Fatal(err) return } defer dstFile.Close() return io.Copy(dstFile, srcFile) // 拷貝文件 }
這里我們是采取,將需要被拷貝的文件打開,拷貝到的文件名進行創(chuàng)建,然后將內容填充進去,這里使用了io.Copy()
的內置功能。
效果圖
完整代碼
package main import ( "bufio" "flag" "fmt" "io" "log" "os" "strings" ) // func commandStyle() { // methodPtr := flag.String("method", "default", "method of sample") // valuePtr := flag.Int("value", -1, "value of sample") // // 解析 // flag.Parse() // fmt.Println(*methodPtr, *valuePtr) // } // func commandStyle2() { // var method string // var value int // flag.StringVar(&method, "method", "default", "method of sample") // flag.IntVar(&value, "value", -1, "value of sample") // flag.Parse() // fmt.Println(method, value) // } func main() { // commandStyle() // commandStyle2() var showProgress, force bool // -f 當存在時拷貝,是否強制拷貝 flag.BoolVar(&force, "f", false, "force copy when existing") flag.BoolVar(&showProgress, "v", false, "explain what is being done") flag.Parse() // 獲取參數個數 if flag.NArg() < 2 { flag.Usage() // 打印用途 return } copyFileAction(flag.Arg(0), flag.Arg(1), showProgress, force) } func fileExist(fileName string)bool { _, err := os.Stat(fileName) // 返回這個文件信息 // IsExist 只是錯誤或報告是否存在 // err == nil,表示有文件信息,os.IsExist(err),表示有文件存在 return err == nil || os.IsExist(err) } func copyFile(originFile, targetFile string)(written int64, err error){ srcFile, err := os.Open(originFile) // 打開文件 if err != nil { // Error() 返回錯誤信息 log.Fatal(err) return } defer srcFile.Close() dstFile, err := os.Create(targetFile) // 創(chuàng)建文件 if err != nil { // Error() 返回錯誤信息 log.Fatal(err) return } defer dstFile.Close() return io.Copy(dstFile, srcFile) // 拷貝文件 } // 拷貝文件 func copyFileAction(src, dst string, showProgress, force bool) { if !force { // 判斷是否存在文件,若存在,是否需要覆蓋它 if fileExist(dst) { fmt.Printf("%s exists override? y/n \n", dst) reader := bufio.NewReader(os.Stdin) // 讀取輸入內容 data, _, _ := reader.ReadLine() // 取一行的內容 // 判斷輸入的內容 if strings.TrimSpace(string(data)) != "y" { return } } } // copy 文件 copyFile(src, dst) }
以上就是Golang實現簡易的命令行功能的詳細內容,更多關于Golang命令行功能的資料請關注腳本之家其它相關文章!
相關文章
Go類型斷言提取測試接口值動態(tài)類型及靜態(tài)轉換確保類型接口編譯安全
這篇文章主要為大家介紹了Go類型斷言提取測試接口值動態(tài)類型及靜態(tài)轉換確保類型實現特定接口的編譯時安全性詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進步,早日升職加薪2023-10-10go mod 安裝依賴 unkown revision問題的解決方案
這篇文章主要介紹了go mod 安裝依賴 unkown revision問題的解決方案,具有很好的參考價值,希望對大家有所幫助。一起跟隨小編過來看看吧2021-05-05Go語言net包RPC遠程調用三種方式http與json-rpc及tcp
這篇文章主要為大家介紹了Go語言net包RPC遠程調用三種方式分別使用http與json-rpc及tcp的示例詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助2021-11-11