十分鐘學(xué)會(huì)用 Go 編寫(xiě)命令行工具
前言
最近因?yàn)轫?xiàng)目需要寫(xiě)了一段時(shí)間的 Go ，相對(duì)于 Java 來(lái)說(shuō)語(yǔ)法簡(jiǎn)單同時(shí)又有著一些 Python 之類的語(yǔ)法糖，讓人大呼”真香“。
但現(xiàn)階段相對(duì)來(lái)說(shuō)還是 Python 寫(xiě)的多一些，偶爾還得回爐寫(xiě)點(diǎn) Java ;自然對(duì) Go 也談不上多熟悉。
于是便利用周末時(shí)間自己做個(gè)小項(xiàng)目來(lái)加深一些使用經(jīng)驗(yàn)。于是我便想到了之前利用 Java 寫(xiě)的一個(gè)博客小工具。
那段時(shí)間正值微博圖床大量圖片禁止外鏈，導(dǎo)致許多個(gè)人博客中的圖片都不能查看。這個(gè)工具可以將文章中的圖片備份到本地，還能將圖片直接替換到其他圖床。
我個(gè)人現(xiàn)在是一直在使用，通常是在碼字的時(shí)候利用 iPic 之類的工具將圖片上傳到微博圖床(主要是方便+免費(fèi))。寫(xiě)完之后再通過(guò)這個(gè)工具一鍵切換到 [SM.MS](http://sm.MS) 這類付費(fèi)圖床，同時(shí)也會(huì)將圖片備份到本地磁盤(pán)。
改為用 Go 重寫(xiě)為 cli 工具后使用效果如下：
需要掌握哪些技能
之所以選擇這個(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 里的 goroutine 也就是協(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ù)。
而且由于 goroutine 非常輕量，與 Java 中的 thread 相比占用非常少的內(nèi)存，所以我們也不需要精準(zhǔn)的控制創(chuàng)建數(shù)量。
不過(guò)這里也用到了一個(gè)和 Java 非常類似的東西：WaitGroup。
它的用法與作用都與 Java 中的 CountDownLatch 非常相似;主要用于等待所有的 goroutine 執(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 release
- # 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)行程序。
總結(jié)
本文所有代碼都已上傳 Github: https://github.com/crossoverJie/btb
感興趣的也可以直接運(yùn)行安裝腳本體驗(yàn)。
- curl -fsSL https://raw.githubusercontent.com/crossoverJie/btb/master/install.sh | bash
目前這個(gè)版本只實(shí)現(xiàn)了圖片下載備份，后續(xù)會(huì)完善圖床替換及其他功能。
這段時(shí)間接觸 Go 之后給我的感觸頗深，對(duì)于年紀(jì) 25 歲的 Java 來(lái)說(shuō)，Go 確實(shí)是后生可畏，更氣人的是還趕上了云原生這個(gè)浪潮，就更惹不起了。
一些以前看來(lái)不那么重要的小毛病也被重點(diǎn)放大，比如啟動(dòng)慢、占用內(nèi)存多、語(yǔ)法啰嗦等;不過(guò)我依然對(duì)這位賞飯吃的祖師爺保持期待，從新版本的 Java 可以看出也在積極改變，更不用說(shuō)它還有無(wú)人撼動(dòng)的龐大生態(tài)。
