一個(gè)小時(shí)學(xué)會(huì)用 Go 編寫命令行工具

前言

最近因?yàn)轫?xiàng)目需要寫了一段時(shí)間的Go侧漓,相對(duì)于Java來說語法簡(jiǎn)單同時(shí)又有著一些Python之類的語法糖芬失,讓人大呼”真香“袍啡。

但現(xiàn)階段相對(duì)來說還是Python寫的多一些乞娄,偶爾還得回爐寫點(diǎn)Java剃斧;自然對(duì)Go也談不上多熟悉轨香。

于是便利用周末時(shí)間自己做個(gè)小項(xiàng)目來加深一些使用經(jīng)驗(yàn)。于是我便想到了之前利用Java寫的一個(gè)博客小工具幼东。

那段時(shí)間正值微博圖床大量圖片禁止外鏈臂容,導(dǎo)致許多個(gè)人博客中的圖片都不能查看。這個(gè)工具可以將文章中的圖片備份到本地根蟹,還能將圖片直接替換到其他圖床脓杉。

我個(gè)人現(xiàn)在是一直在使用,通常是在碼字的時(shí)候利用iPic之類的工具將圖片上傳到微博圖床(主要是方便+免費(fèi))简逮。寫完之后再通過這個(gè)工具一鍵切換到[SM.MS](http://sm.MS)這類付費(fèi)圖床球散,同時(shí)也會(huì)將圖片備份到本地磁盤。

改為用Go重寫為cli工具后使用效果如下:

需要掌握哪些技能

之所以選擇這個(gè)工具用Go來重寫散庶;一個(gè)是功能比較簡(jiǎn)單蕉堰,但也正好可以利用到Go的一些特點(diǎn)凌净,比如網(wǎng)絡(luò) IO、協(xié)程同步之類屋讶。

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

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

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

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

多平臺(tái)打包皿渗。

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

使用和管理第三方依賴

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

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

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

根據(jù)它的使用參考,需要首先在項(xiàng)目目錄下執(zhí)行g(shù)o 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 btbgo1.15require (github.com/cheggaaa/pb/v3 v3.0.5github.com/fatih/color v1.10.0github.com/urfave/cli/v2 v2.3.0)復(fù)制代碼

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

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

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

cli: 命令行工具開發(fā)包奏窑。

import("btb/constants""btb/service""github.com/urfave/cli/v2""log""os")funcmain(){varmodelstringdownloadPath := constants.DownloadPathmarkdownPath := constants.MarkdownPathapp := &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)returnnil},Name:"btb",Usage:"Help you backup and replace your blog's images",}err := app.Run(os.Args)iferr !=nil{log.Fatal(err)}}復(fù)制代碼

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

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

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

可以看到部分語法與Java完全不同漠趁,比如:

申明變量時(shí)類型是放在后邊扁凛,先定義變量名稱;方法參數(shù)類似棚潦。

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

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

公共叠必、私用函數(shù)利用首字母大小寫來區(qū)分荚孵。

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

協(xié)程

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

這里包含的文件掃描收叶、圖片下載之類的代碼就不分析了;官方SDK寫的很清楚共苛,也比較簡(jiǎn)單判没。

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

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

funcDownLoadPic(markdownPath, downloadPathstring){wg := sync.WaitGroup{}allFile, err := util.GetAllFile(markdownPath)wg.Add(len(*allFile))iferr !=nil{log.Fatal("read file error")}for_, filePath :=range*allFile {gofunc(filePathstring){allLine, err := util.ReadFileLine(filePath)iferr !=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 {iferr !=nil{log.Fatal(err)}err := util.DownloadFile(url, *genFullFileName(downloadPath, filePath, &url))iferr !=nil{log.Fatal(err)}bar.Increment()}bar.Finish()wg.Done()}(filePath)}wg.Wait()color.Green("Successful handling of [%v] files.\n",len(*allFile))iferr !=nil{log.Fatal(err)}}復(fù)制代碼

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

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

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

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

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

使用起來主要分為三步:

創(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來互相通信,這點(diǎn)今后有機(jī)會(huì)再討論丸升。

打包

核心邏輯也就這么多,下面來講講打包與運(yùn)行牺氨;這點(diǎn)和Java的區(qū)別就比較大了狡耻。

眾所周知,Java有一句名言:write once run anywhere

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

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

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

我在這里編寫了一個(gè)Makefile用于執(zhí)行打包:make release

# Binary nameBINARY=btbGOBUILD=go build -ldflags"-s -w"-o ${BINARY}GOCLEAN=go cleanRMTARGZ=rm -rf *.gzVERSION=0.0.1release:# Clean$(GOCLEAN)$(RMTARGZ)# Build for macCGO_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).exetar czvf ${BINARY}-win64-${VERSION}.tar.gz ./${BINARY}.exe$(GOCLEAN)復(fù)制代碼

可以看到我們只需要在go build之前指定系統(tǒng)變量即可打出不同平臺(tái)的包土至,比如我們?yōu)長(zhǎng)inux系統(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:github.com/crossoverJi…

感興趣的也可以直接運(yùn)行安裝腳本體驗(yàn)猾昆。

curl -fsSL https://raw.githubusercontent.com/crossoverJie/btb/master/install.sh | bash復(fù)制代碼

目前這個(gè)版本只實(shí)現(xiàn)了圖片下載備份陶因,后續(xù)會(huì)完善圖床替換及其他功能。

這段時(shí)間接觸Go之后給我的感觸頗深垂蜗,對(duì)于年紀(jì) 25 歲的Java來說楷扬,Go確實(shí)是后生可畏,更氣人的是還趕上了云原生這個(gè)浪潮贴见,就更惹不起了烘苹。

一些以前看來不那么重要的小毛病也被重點(diǎn)放大,比如啟動(dòng)慢片部、占用內(nèi)存多镣衡、語法啰嗦等;不過我依然對(duì)這位賞飯吃的祖師爺保持期待吞琐,從新版本的Java可以看出也在積極改變捆探,更不用說它還有無人撼動(dòng)的龐大生態(tài)。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末站粟,一起剝皮案震驚了整個(gè)濱河市黍图,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌奴烙,老刑警劉巖助被,帶你破解...
    沈念sama閱讀 221,273評(píng)論 6 515
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異切诀,居然都是意外死亡揩环,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 94,349評(píng)論 3 398
  • 文/潘曉璐 我一進(jìn)店門幅虑,熙熙樓的掌柜王于貴愁眉苦臉地迎上來丰滑,“玉大人,你說我怎么就攤上這事倒庵“” “怎么了?”我有些...
    開封第一講書人閱讀 167,709評(píng)論 0 360
  • 文/不壞的土叔 我叫張陵擎宝,是天一觀的道長(zhǎng)郁妈。 經(jīng)常有香客問我,道長(zhǎng)绍申,這世上最難降的妖魔是什么噩咪? 我笑而不...
    開封第一講書人閱讀 59,520評(píng)論 1 296
  • 正文 為了忘掉前任顾彰,我火速辦了婚禮,結(jié)果婚禮上胃碾,老公的妹妹穿的比我還像新娘涨享。我一直安慰自己,他們只是感情好书在,可當(dāng)我...
    茶點(diǎn)故事閱讀 68,515評(píng)論 6 397
  • 文/花漫 我一把揭開白布灰伟。 她就那樣靜靜地躺著儒旬,像睡著了一般栏账。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上栈源,一...
    開封第一講書人閱讀 52,158評(píng)論 1 308
  • 那天挡爵,我揣著相機(jī)與錄音,去河邊找鬼甚垦。 笑死茶鹃,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的艰亮。 我是一名探鬼主播闭翩,決...
    沈念sama閱讀 40,755評(píng)論 3 421
  • 文/蒼蘭香墨 我猛地睜開眼,長(zhǎng)吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼迄埃!你這毒婦竟也來了疗韵?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 39,660評(píng)論 0 276
  • 序言:老撾萬榮一對(duì)情侶失蹤侄非,失蹤者是張志新(化名)和其女友劉穎蕉汪,沒想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體逞怨,經(jīng)...
    沈念sama閱讀 46,203評(píng)論 1 319
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡者疤,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 38,287評(píng)論 3 340
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了叠赦。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片驹马。...
    茶點(diǎn)故事閱讀 40,427評(píng)論 1 352
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖除秀,靈堂內(nèi)的尸體忽然破棺而出窥翩,到底是詐尸還是另有隱情,我是刑警寧澤鳞仙,帶...
    沈念sama閱讀 36,122評(píng)論 5 349
  • 正文 年R本政府宣布,位于F島的核電站笔时,受9級(jí)特大地震影響棍好,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,801評(píng)論 3 333
  • 文/蒙蒙 一借笙、第九天 我趴在偏房一處隱蔽的房頂上張望扒怖。 院中可真熱鬧,春花似錦业稼、人聲如沸盗痒。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,272評(píng)論 0 23
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽俯邓。三九已至,卻和暖如春熔号,著一層夾襖步出監(jiān)牢的瞬間稽鞭,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,393評(píng)論 1 272
  • 我被黑心中介騙來泰國(guó)打工引镊, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留朦蕴,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 48,808評(píng)論 3 376
  • 正文 我出身青樓弟头,卻偏偏與公主長(zhǎng)得像吩抓,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子赴恨,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,440評(píng)論 2 359

推薦閱讀更多精彩內(nèi)容