利用Go怎么創(chuàng)建一個(gè)命令行工具

利用Go怎么創(chuàng)建一個(gè)命令行工具？很多新手對(duì)此不是很清楚，為了幫助大家解決這個(gè)難題，下面小編將為大家詳細(xì)講解，有這方面需求的人可以來(lái)學(xué)習(xí)下，希望你能有所收獲。

用 Go 重寫(xiě)為 cli 工具后使用效果如下：

3-min.gif

需要掌握哪些技能

之所以選擇這個(gè)工具用 Go 來(lái)重寫(xiě)；一個(gè)是功能比較簡(jiǎn)單，但也正好可以利用到 Go 的一些特點(diǎn)，比如網(wǎng)絡(luò) IO、協(xié)程同步之類。

同時(shí)修改為命令行工具后是不是感覺(jué)更極客了呢。

再開(kāi)始之前還是先為不熟悉 Go 的 Javaer 介紹下大概會(huì)用到哪些知識(shí)點(diǎn)：

• 使用和管理第三方依賴包(go mod)

• 協(xié)程的運(yùn)用。

• 多平臺(tái)打包。

下面開(kāi)始具體操作，我覺(jué)得即便是沒(méi)怎么接觸過(guò) Go 的朋友看完之后也能快速上手實(shí)現(xiàn)一個(gè)小工具。

使用和管理第三方依賴

還沒(méi)有安裝 Go 的朋友請(qǐng)參考官網(wǎng)自行安裝。

首先介紹一下 Go 的依賴管理，在版本 1.11 之后官方就自帶了依賴管理模塊，所以在當(dāng)下最新版 1.15 中已經(jīng)強(qiáng)烈推薦使用。

它的目的和作用與 Java 中的 maven，Python 中的 pip 類似，但使用起來(lái)比 maven 簡(jiǎn)單許多。

根據(jù)它的使用參考，需要首先在項(xiàng)目目錄下執(zhí)行 go mod init 用于初始化一個(gè) go.mod 文件，當(dāng)然如果你使用的是 GoLang 這樣的 IDE，在新建項(xiàng)目時(shí)會(huì)自動(dòng)幫我們創(chuàng)建好目錄結(jié)構(gòu)，當(dāng)然也包含 go.mod 這個(gè)文件。

在這個(gè)文件中我們引入我們需要的第三方包：

module btb
 
go 1.15
 
require (
 github.com/cheggaaa/pb/v3 v3.0.5
 github.com/fatih/color v1.10.0
 github.com/urfave/cli/v2 v2.3.0

我這里使用了三個(gè)包，分別是：

pb: progress bar，用于在控制臺(tái)輸出進(jìn)度條。

color: 用于在控制臺(tái)輸出不同顏色的文本。

cli: 命令行工具開(kāi)發(fā)包。

import (
 "btb/constants"
 "btb/service"
 "github.com/urfave/cli/v2"
 "log"
 "os"
)
 
func main() {
 var model string
 downloadPath := constants.DownloadPath
 markdownPath := constants.MarkdownPath
 
 app := &cli.App{
 Flags: []cli.Flag{
 &cli.StringFlag{
 Name:  "model",
 Usage:  "operating mode; r:replace, b:backup",
 DefaultText: "b",
 Aliases:  []string{"m"},
 Required: true,
 Destination: &model,
 },
 &cli.StringFlag{
 Name:  "download-path",
 Usage:  "The path where the image is stored",
 Aliases:  []string{"dp"},
 Destination: &downloadPath,
 Required: true,
 Value:  constants.DownloadPath,
 },
 &cli.StringFlag{
 Name:  "markdown-path",
 Usage:  "The path where the markdown file is stored",
 Aliases:  []string{"mp"},
 Destination: &markdownPath,
 Required: true,
 Value:  constants.MarkdownPath,
 },
 },
 Action: func(c *cli.Context) error {
 service.DownLoadPic(markdownPath, downloadPath)
 
 return nil
 },
 Name: "btb",
 Usage: "Help you backup and replace your blog's images",
 }
 
 err := app.Run(os.Args)
 if err != nil {
 log.Fatal(err)
 }
}

代碼非常簡(jiǎn)單，無(wú)非就是使用了 cli 所提供的 api 創(chuàng)建了幾個(gè)命令，將用戶輸入的 -dp、-mp 參數(shù)映射到 downloadPath、markdownPath 變量中。

之后便利用這兩個(gè)數(shù)據(jù)掃描所有的圖片，以及將圖片下載到對(duì)應(yīng)的目錄中。

更多使用指南可以直接參考官方文檔。

可以看到部分語(yǔ)法與 Java 完全不同，比如：

申明變量時(shí)類型是放在后邊，先定義變量名稱；方法參數(shù)類似。

類型推導(dǎo)，可以不指定變量類型（新版本的 Java 也支持）

方法支持同時(shí)返回多個(gè)值，這點(diǎn)非常好用。

公共、私用函數(shù)利用首字母大小寫(xiě)來(lái)區(qū)分。

還有其他的就不一一列舉了。

協(xié)程

緊接著命令執(zhí)行處調(diào)用了 service.DownLoadPic(markdownPath, downloadPath) 處理業(yè)務(wù)邏輯。

這里包含的文件掃描、圖片下載之類的代碼就不分析了；官方 SDK 寫(xiě)的很清楚，也比較簡(jiǎn)單。

重點(diǎn)看看 Go 里的 goroutime 也就是協(xié)程。

我這里使用的場(chǎng)景是每掃描到一個(gè)文件就利用一個(gè)協(xié)程去解析和下載圖片，從而可以提高整體的運(yùn)行效率。

func DownLoadPic(markdownPath, downloadPath string) {
 wg := sync.WaitGroup{}
 allFile, err := util.GetAllFile(markdownPath)
 wg.Add(len(*allFile))
 
 if err != nil {
 log.Fatal("read file error")
 }
 
 for _, filePath := range *allFile {
 
 go func(filePath string) {
 allLine, err := util.ReadFileLine(filePath)
 if err != nil {
 log.Fatal(err)
 }
 availableImgs := util.MatchAvailableImg(allLine)
 bar := pb.ProgressBarTemplate(constants.PbTmpl).Start(len(*availableImgs))
 bar.Set("fileName", filePath).
 SetWidth(120)
 
 for _, url := range *availableImgs {
 if err != nil {
  log.Fatal(err)
 }
 err := util.DownloadFile(url, *genFullFileName(downloadPath, filePath, &url))
 if err != nil {
  log.Fatal(err)
 }
 bar.Increment()
 
 }
 bar.Finish()
 wg.Done()
 
 }(filePath)
 }
 wg.Wait()
 color.Green("Successful handling of [%v] files.\n", len(*allFile))
 
 if err != nil {
 log.Fatal(err)
 }
}

就代碼使用層面看起來(lái)是不是要比 Java 簡(jiǎn)潔許多，我們不用像 Java 那樣需要維護(hù)一個(gè) executorService，也不需要考慮這個(gè)線程池的大小，一切都交給 Go 自己去調(diào)度。

使用時(shí)只需要在調(diào)用函數(shù)之前加上 go 關(guān)鍵字，只不過(guò)這里是一個(gè)匿名函數(shù)。

而且由于 goroutime 非常輕量，與 Java 中的 thread 相比占用非常少的內(nèi)存，所以我們也不需要精準(zhǔn)的控制創(chuàng)建數(shù)量。

不過(guò)這里也用到了一個(gè)和 Java 非常類似的東西：WaitGroup。

它的用法與作用都與 Java 中的 CountDownLatch 非常相似；主要用于等待所有的 goroutime 執(zhí)行完畢，在這里自然是等待所有的圖片都下載完畢然后退出程序。

使用起來(lái)主要分為三步：

創(chuàng)建和初始化 goruntime 的數(shù)量：wg.Add(len(number)

每當(dāng)一個(gè) goruntime 執(zhí)行完畢調(diào)用 wg.Done() 讓計(jì)數(shù)減一。

最終調(diào)用 wg.Wait() 等待WaitGroup 的數(shù)量減為0。

對(duì)于協(xié)程 Go 推薦使用 chanel 來(lái)互相通信，這點(diǎn)今后有機(jī)會(huì)再討論。

打包

核心邏輯也就這么多，下面來(lái)講講打包與運(yùn)行；這點(diǎn)和 Java 的區(qū)別就比較大了。

眾所周知，Java 有一句名言：write once run anywhere

這是因?yàn)橛辛?JVM 虛擬機(jī)，所以我們不管代碼最終運(yùn)行于哪個(gè)平臺(tái)都只需要打出一個(gè)包；但 Go 沒(méi)有虛擬機(jī)它是怎么做到在個(gè)各平臺(tái)運(yùn)行呢。

簡(jiǎn)單來(lái)說(shuō) Go 可以針對(duì)不同平臺(tái)打包出不同的二進(jìn)制文件，這個(gè)文件包含了所有運(yùn)行所需要的依賴，甚至都不需要在目標(biāo)平臺(tái)安裝 Go 環(huán)境。

雖說(shuō) Java 最終只需要打一個(gè)包，但也得在各個(gè)平臺(tái)安裝兼容的 Java 運(yùn)行環(huán)境。

我在這里編寫(xiě)了一個(gè) Makefile 用于執(zhí)行打包：make relea

# Binary name
BINARY=btb
GOBUILD=go build -ldflags "-s -w" -o ${BINARY}
GOCLEAN=go clean
RMTARGZ=rm -rf *.gz
VERSION=0.0.1
 
release:
 # Clean
 $(GOCLEAN)
 $(RMTARGZ)
 # Build for mac
 CGO_ENABLED=0 GOOS=darwin GOARCH=amd64 $(GOBUILD)
 tar czvf ${BINARY}-mac64-${VERSION}.tar.gz ./${BINARY}
 # Build for arm
 $(GOCLEAN)
 CGO_ENABLED=0 GOOS=linux GOARCH=arm64 $(GOBUILD)
 tar czvf ${BINARY}-arm64-${VERSION}.tar.gz ./${BINARY}
 # Build for linux
 $(GOCLEAN)
 CGO_ENABLED=0 GOOS=linux GOARCH=amd64 $(GOBUILD)
 tar czvf ${BINARY}-linux64-${VERSION}.tar.gz ./${BINARY}
 # Build for win
 $(GOCLEAN)
 CGO_ENABLED=0 GOOS=windows GOARCH=amd64 $(GOBUILD).exe
 tar czvf ${BINARY}-win64-${VERSION}.tar.gz ./${BINARY}.exe
 $(GOCLEAN)

可以看到我們只需要在 go build 之前指定系統(tǒng)變量即可打出不同平臺(tái)的包，比如我們?yōu)?Linux 系統(tǒng)的 arm64 架構(gòu)打包文件：

CGO_ENABLED=0 GOOS=linux GOARCH=arm64 go build main.go -o btb

便可以直接在目標(biāo)平臺(tái)執(zhí)行 ./btb  運(yùn)行程序。

看完上述內(nèi)容是否對(duì)您有幫助呢？如果還想對(duì)相關(guān)知識(shí)有進(jìn)一步的了解或閱讀更多相關(guān)文章，請(qǐng)關(guān)注億速云行業(yè)資訊頻道，感謝您對(duì)億速云的支持。