docker-cli源碼窺探

最近一直在使用docker，看了一些書和教程，但是一直停在使用的層面，但總覺得不夠深入，故決定看看源碼，學(xué)習(xí)優(yōu)秀的項(xiàng)目。

我將以docker ps -a 命令為例探究docker命令在 client側(cè)的執(zhí)行過程，源碼的版本為20.10,。 選擇docker ps -a 的原因是，邏輯比較簡單，且通過debug跟蹤發(fā)現(xiàn)，該命令覆蓋了大部分的代碼邏輯。

為了突出顯示重要的代碼和節(jié)省篇幅，我將會(huì)隱藏部分代碼，以 … 代替。

docker cli 項(xiàng)目的入口函數(shù)是 cli/cmd/docker/docker.go 文件中的main()函數(shù)。

1.入口函數(shù)main()

main()函數(shù)中僅包含兩步驟：

• 先通過NewDockerCli() 獲取一個(gè)docker cli實(shí)例；
• 然后通過runDocker()運(yùn)行該cli實(shí)例

// 入口函數(shù)
func main(){
  dockerCli,err:=command.NewDockerCli()//1.獲取cli實(shí)例...
  if err:=runDocker(dockerCli);err!=nil{//執(zhí)行cli...
   os.Exit(1)
   }
}

1.1 NewDockerCli()

NewDockerCli() 中主要涉及一些對(duì)cli實(shí)例的配置，如內(nèi)容置信開關(guān)（默認(rèn)是關(guān)閉的），還有其他一些參數(shù)。這里與具體的執(zhí)行關(guān)系不大，就不贅述了。

1.2 runDokcer()

runDokcer()是真正命令開始解析執(zhí)行的地方。

runDocker()總體過程是：

• 首先通過newDockerCommand()實(shí)例化一個(gè)頂級(jí)命令（即 docker XXX）；
• 通過HandleGlobalFlags()對(duì)頂級(jí)命令做一些配置；
• 通過Initialize()對(duì)頂級(jí)命令初始化，主要涉及配置文件方面；
• 通過processAliases()處理命令別名；
• 通過Find() 判斷頂級(jí)命令后的 根命令是否合規(guī)。
• 最終通過Execute()開始執(zhí)行頂級(jí)命令

1.2.1 newDockerCommand()

在newDockerCommand()中會(huì)首先實(shí)例化一個(gè)cmd，cmd中有一個(gè)RunE字段，該字段為函數(shù)類型，這是docker命令默認(rèn)執(zhí)行的邏輯，如果docker 后面不加參數(shù)，默認(rèn)會(huì)顯示help, 而實(shí)際執(zhí)行時(shí)，確實(shí)是顯示了help信息。

在cmd實(shí)例創(chuàng)建之后，會(huì)對(duì)該實(shí)例進(jìn)行一些配置，如：添置一些模板函數(shù)，錯(cuò)誤處理，幫助信息打印等。

newDockerCommand()中另一個(gè)重要的函數(shù)是AddCommands()，該函數(shù)會(huì)將所有的根命令（例如，ps 、image、 build等等，現(xiàn)階段一共53個(gè) ），添加至cmd中：

最終通過 NewTopLevelCommand()將cmd封裝為一個(gè)頂級(jí)命令并返回。

1.2.2 HandleGlobalFlags()

對(duì)于該函數(shù)，我理解的其作用主要是將tcmd中的頂級(jí)命令及后面的參數(shù)取出來，以docker ps -a為例，cmd 就是docker命令，而返回為args則包含了ps -a。

1.2.3 Initialize()

此函數(shù)中主要是一些配置動(dòng)作，包括與安全有關(guān)的一些配置，讀取配置文件的動(dòng)作，此處就不詳細(xì)闡述了。

1.2.4 processAliases()

此函數(shù)主要處理一些命令別名，也略過了

1.2.5 Find()

Find()的主要作用是對(duì)命令做一些合規(guī)性檢查。例如：是不是在不該加參數(shù)的命令后面加了參數(shù)，是不是輸入了根本不存在命令等。

這里調(diào)用findNext()的主要目的是，判斷在AddCommands()中添加的53個(gè)根命令，是否包含args中的命令。

舉個(gè)例子，args 為 ["ps"," -a"]， 那么此時(shí)Find的作用就是判斷 AddCommands()函數(shù)中有沒有添加與Ps有關(guān)的命令。通過查詢，發(fā)現(xiàn)AddCommands()是包含Ps命令的。

后面，Execute() 會(huì)再次調(diào)用findNext()函數(shù)。

1.2.6 Execute()

Execute()實(shí)際會(huì)調(diào)用 ExecuteC()。

在ExecuteC()，會(huì)調(diào)用Traverse()，獲取c中的根命令,即ps -a 。并通過execute()執(zhí)行該命令。

1.2.6.1 Traverse()

Traverse函數(shù)中通過遞歸和findNext() 的結(jié)合實(shí)現(xiàn)根命令提，并將命令及參數(shù)返回。

1.2.6.2 execute()

回到ExecuteC()中調(diào)用的execute()，執(zhí)行最后獲取到了ps -a命令，函數(shù)中包含了一系列的前置和后置函數(shù)，但是最重要 的是RunE()。

要注意，此時(shí)的RunE，已經(jīng)不在頂級(jí)命令docker 的RunE，而是通過Traverse()函數(shù)獲取的NewPsCommand()中的RunE。該RunE中調(diào)用了runPs()獲取容器信息。

1.2.6.1.1 runPs()

runPs() 中，通過ContainerList接口，獲取所有的容器信息，并輸出相關(guān)結(jié)果。

1.2.6.1.2 ContainerList()

在ContainerList的接口實(shí)現(xiàn)中，發(fā)現(xiàn)此處通過向docker server發(fā)送一個(gè)get請(qǐng)求，獲取所有容器信息，然后返回，并由runPs()打印相關(guān)信息。

至此，整個(gè)docker ps -a 命令在docker client側(cè)的解析執(zhí)行過程就結(jié)束了，在此過程中涉及的函數(shù)眾多，且功能繁雜，但是代碼并不難懂。相信在明白這個(gè)命令之后，其他命令也能更容易學(xué)習(xí)。本人能力有限，難以將每個(gè)函數(shù)講清楚，建議大家可以自行搭建調(diào)式環(huán)境，通過打斷點(diǎn)的方式深入了解。后續(xù)，我也將更新docker ps -a 命令在docker server側(cè)的執(zhí)行過程。

如果說不會(huì)搭建調(diào)式環(huán)境，可以自行百度下

到此這篇關(guān)于docker-cli源碼窺探的文章就介紹到這了,更多相關(guān)docker-cli源碼內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評(píng)論