一文秒懂Go 編寫命令行工具的代碼
前言
最近因?yàn)轫?xiàng)目需要寫了一段時間的 Go ，相對于 Java 來說語法簡單同時又有著一些 Python 之類的語法糖，讓人大呼”真香“。
但現(xiàn)階段相對來說還是 Python 寫的多一些，偶爾還得回爐寫點(diǎn) Java ；自然對 Go 也談不上多熟悉。
于是便利用周末時間自己做個小項(xiàng)目來加深一些使用經(jīng)驗(yàn)。于是我便想到了之前利用 Java 寫的一個博客小工具。
那段時間正值微博圖床大量圖片禁止外鏈，導(dǎo)致許多個人博客中的圖片都不能查看。這個工具可以將文章中的圖片備份到本地，還能將圖片直接替換到其他圖床。
我個人現(xiàn)在是一直在使用，通常是在碼字的時候利用 iPic 之類的工具將圖片上傳到微博圖床（主要是方便+免費(fèi)）。寫完之后再通過這個工具一鍵切換到 [SM.MS](http://sm.MS) 這類付費(fèi)圖床，同時也會將圖片備份到本地磁盤。
改為用 Go 重寫為 cli 工具后使用效果如下：
需要掌握哪些技能
之所以選擇這個工具用 Go 來重寫；一個是功能比較簡單，但也正好可以利用到 Go 的一些特點(diǎn)，比如網(wǎng)絡(luò) IO、協(xié)程同步之類。
同時修改為命令行工具后是不是感覺更極客了呢。
再開始之前還是先為不熟悉 Go 的 Javaer 介紹下大概會用到哪些知識點(diǎn)：
- 使用和管理第三方依賴包(
go mod) - 協(xié)程的運(yùn)用。
- 多平臺打包。
下面開始具體操作，我覺得即便是沒怎么接觸過 Go 的朋友看完之后也能快速上手實(shí)現(xiàn)一個小工具。
使用和管理第三方依賴
- 還沒有安裝 Go 的朋友請參考官網(wǎng)自行安裝。
首先介紹一下 Go 的依賴管理，在版本 1.11 之后官方就自帶了依賴管理模塊，所以在當(dāng)下最新版 1.15 中已經(jīng)強(qiáng)烈推薦使用。
它的目的和作用與 Java 中的 maven，Python 中的 pip 類似，但使用起來比 maven 簡單許多。
根據(jù)它的使用參考，需要首先在項(xiàng)目目錄下執(zhí)行 go mod init 用于初始化一個 go.mod 文件，當(dāng)然如果你使用的是 GoLang 這樣的 IDE，在新建項(xiàng)目時會自動幫我們創(chuàng)建好目錄結(jié)構(gòu)，當(dāng)然也包含 go.mod 這個文件。
在這個文件中我們引入我們需要的第三方包：
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 )
我這里使用了三個包，分別是：
pb: progress bar，用于在控制臺輸出進(jìn)度條。color: 用于在控制臺輸出不同顏色的文本。cli: 命令行工具開發(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)
}
}
代碼非常簡單，無非就是使用了 cli 所提供的 api 創(chuàng)建了幾個命令，將用戶輸入的 -dp、-mp 參數(shù)映射到 downloadPath、markdownPath 變量中。
之后便利用這兩個數(shù)據(jù)掃描所有的圖片，以及將圖片下載到對應(yīng)的目錄中。
更多使用指南可以直接參考官方文檔。
可以看到部分語法與 Java 完全不同，比如：
- 申明變量時類型是放在后邊，先定義變量名稱；方法參數(shù)類似。
- 類型推導(dǎo)，可以不指定變量類型（新版本的
Java也支持）方法支持同時返回多個值，這點(diǎn)非常好用。 - 公共、私用函數(shù)利用首字母大小寫來區(qū)分。
- 還有其他的就不一一列舉了。
協(xié)程
緊接著命令執(zhí)行處調(diào)用了 service.DownLoadPic(markdownPath, downloadPath) 處理業(yè)務(wù)邏輯。
這里包含的文件掃描、圖片下載之類的代碼就不分析了；官方 SDK 寫的很清楚，也比較簡單。
重點(diǎn)看看 Go 里的 goroutime 也就是協(xié)程。
我這里使用的場景是每掃描到一個文件就利用一個協(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)
}
}
就代碼使用層面看起來是不是要比 Java 簡潔許多，我們不用像 Java 那樣需要維護(hù)一個 executorService，也不需要考慮這個線程池的大小，一切都交給 Go 自己去調(diào)度。
使用時只需要在調(diào)用函數(shù)之前加上 go 關(guān)鍵字，只不過這里是一個匿名函數(shù)。
而且由于 goroutime 非常輕量，與 Java 中的 thread 相比占用非常少的內(nèi)存，所以我們也不需要精準(zhǔn)的控制創(chuàng)建數(shù)量。
不過這里也用到了一個和 Java 非常類似的東西：WaitGroup。
它的用法與作用都與 Java 中的 CountDownLatch 非常相似；主要用于等待所有的 goroutime 執(zhí)行完畢，在這里自然是等待所有的圖片都下載完畢然后退出程序。
使用起來主要分為三步：
- 創(chuàng)建和初始化
goruntime的數(shù)量：wg.Add(len(number) - 每當(dāng)一個
goruntime執(zhí)行完畢調(diào)用wg.Done()讓計(jì)數(shù)減一。 - 最終調(diào)用
wg.Wait()等待WaitGroup的數(shù)量減為0。
對于協(xié)程 Go 推薦使用 chanel 來互相通信，這點(diǎn)今后有機(jī)會再討論。
打包
核心邏輯也就這么多，下面來講講打包與運(yùn)行；這點(diǎn)和 Java 的區(qū)別就比較大了。
眾所周知，Java 有一句名言：write once run anywhere
這是因?yàn)橛辛?JVM 虛擬機(jī)，所以我們不管代碼最終運(yùn)行于哪個平臺都只需要打出一個包；但 Go 沒有虛擬機(jī)它是怎么做到在個各平臺運(yùn)行呢。
簡單來說 Go 可以針對不同平臺打包出不同的二進(jìn)制文件，這個文件包含了所有運(yùn)行所需要的依賴，甚至都不需要在目標(biāo)平臺安裝 Go 環(huán)境。
- 雖說 Java 最終只需要打一個包，但也得在各個平臺安裝兼容的
Java運(yùn)行環(huán)境。
我在這里編寫了一個 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)變量即可打出不同平臺的包，比如我們?yōu)?Linux 系統(tǒng)的 arm64 架構(gòu)打包文件：
CGO_ENABLED=0 GOOS=linux GOARCH=arm64 go build main.go -o btb
便可以直接在目標(biāo)平臺執(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
目前這個版本只實(shí)現(xiàn)了圖片下載備份，后續(xù)會完善圖床替換及其他功能。
這段時間接觸 Go 之后給我的感觸頗深，對于年紀(jì) 25 歲的 Java 來說，Go 確實(shí)是后生可畏，更氣人的是還趕上了云原生這個浪潮，就更惹不起了。
一些以前看來不那么重要的小毛病也被重點(diǎn)放大，比如啟動慢、占用內(nèi)存多、語法啰嗦等；不過我依然對這位賞飯吃的祖師爺保持期待，從新版本的 Java 可以看出也在積極改變，更不用說它還有無人撼動的龐大生態(tài)。
到此這篇關(guān)于一文秒懂Go 編寫命令行工具的代碼的文章就介紹到這了,更多相關(guān)Go 編寫命令行工具內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
相關(guān)文章
WebSocket是一種在單個TCP連接上進(jìn)行全雙工通信的協(xié)議。這篇文章主要和大家分享了一個Go語言中websocket的使用demo，需要的可以參考一下2022-12-12
當(dāng)使用Go語言進(jìn)行 HTTP 請求時,默認(rèn)情況下,http.Client 會自動處理服務(wù)器返回的重定向響應(yīng)（3xx 狀態(tài)碼）,本文將詳細(xì)介紹如何在 Go 中實(shí)現(xiàn)禁止 HTTP 請求的重定向、限制重定向次數(shù)以及添加自定義重定向策略,需要的朋友可以參考下2024-08-08
golang Gorm與數(shù)據(jù)庫完整性約束詳解
這篇文章主要介紹了golang Gorm與數(shù)據(jù)庫完整性約束詳解，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧2020-12-12
在不斷發(fā)展的Web開發(fā)領(lǐng)域中,選擇正確的框架可以極大地影響項(xiàng)目的效率和成功,介紹一下Fiber,這是一款令人印象深刻的Golang（Go語言）Web框架,在本文中,我們將深入了解Fiber的世界,探討其獨(dú)特的特性,并理解為什么它在Go生態(tài)系統(tǒng)中引起了如此大的關(guān)注2023-10-10
golang中l(wèi)og包自定義輸出日志格式與寫入到文件
這篇文章主要給大家介紹了關(guān)于golang中l(wèi)og包自定義輸出日志格式與寫入到文件的相關(guān)資料,日志輸出在任何項(xiàng)目中都極其重要,是有助于后續(xù)我們排查解決程序BUG,需要的朋友可以參考下2023-06-06
這篇文章主要介紹了golang連接redis庫及基本操作示例過程，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步早日升職加薪2022-04-04
fasthttp?是一個使用?Go?語言開發(fā)的?HTTP?包,主打高性能,針對?HTTP?請求響應(yīng)流程中的?hot?path?代碼進(jìn)行了優(yōu)化,下面我們就來介紹go語言fasthttp使用實(shí)例小結(jié),感興趣的朋友跟隨小編一起看看吧2024-03-03
本文主要介紹了go的切片擴(kuò)容機(jī)制詳解，文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2023-04-04
這篇文章主要介紹了golang 中strings包的Replace的使用說明，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧2021-03-03
Go語言采用返回值的形式來返回錯誤,這一機(jī)制既可以讓開發(fā)者真正理解錯誤處理的含義,也可以大大降低程序的復(fù)雜度,下面這篇文章主要給大家介紹了關(guān)于Go語言學(xué)習(xí)筆記之錯誤和異常的相關(guān)資料,需要的朋友可以參考下2022-07-07