1. 寫在最前面

筆者在使用 dockerfile 多階段構(gòu)建的功能時，寫出了一個「circular dependency detected on stage: xx」的錯誤。

解決方式：解耦互相依賴的構(gòu)建階段即可，構(gòu)建 A <=> 構(gòu)建 B 兩個階段是互相依賴的，改為構(gòu)建 A => 構(gòu)建 B

注：「多階段構(gòu)建」是 Docker 提供的一種功能，運行用戶在一個 Dockerfile 中定義多個構(gòu)建階段，從而優(yōu)化構(gòu)鏡像的大小和構(gòu)建過程的效率。通過這種方式，開發(fā)者可以在不同的階段使用不同的基礎(chǔ)鏡像和工具，最終只將所需要的文件和依賴項復(fù)制到最終的鏡像中。

但是，作為一個有求知精神的軟件開發(fā)工程師，筆者去翻看了一下源碼的位置。（ps: 其實就是自己感興趣 BuildKit 的源碼想要學習一下，而帶著問題學習的速度更快）

1.1 具體循環(huán)依賴的例子

FROM busybox AS stage0
COPY --from=stage0 f1 /sub/ 

• FROM busybox AS stage0: 這行代碼定義了一個名為 stage0 的構(gòu)建階段，并使用 busybox 作為基礎(chǔ)鏡像。

• COPY --from=stage0 f1 /sub/: 這行代碼嘗試從名為 stage0 的構(gòu)建階段復(fù)制文件 f1 到 /sub/ 目錄。

在這個情況下，在同一個構(gòu)建階段中同時定義了一個新的階段并嘗試從該階段復(fù)制文件。這會導(dǎo)致 Docker 無法解析這個依賴關(guān)系，因為 stage0 還沒有完成構(gòu)建就被引用了。

2. 報錯的位置

源碼倉庫：GitHub - moby/buildkit: concurrent, cache-efficient, and Dockerfile-agnostic builder toolkit

具體位置：buildkit/frontend/dockerfile/dockerfile2llb/convert.go at master · moby/buildkit · GitHub

2.1 代碼快速分析

得益于 Github 支持了 Codespaces 讓筆者可以無需代碼下載到本地，可以直接基于 Codespaces 對 「convert_test.go」的具體 case 直接做在線 debug ，逐行分析。

注：GitHub Codespaces 是一個基于云的開發(fā)環(huán)境，允許開發(fā)者在瀏覽器中創(chuàng)建和使用完整的開發(fā)環(huán)境。它旨在簡化開發(fā)流程，特別是對于團隊協(xié)作和快速啟動項目。以下是 GitHub Codespaces 的一些關(guān)鍵特性和功能：

代碼 debug 效果：

注：感慨一下 Codespaces 真的香！

2.2 代碼總結(jié)

核心的循環(huán)依賴檢測邏輯代碼如下：

func validateCircularDependency(states []*dispatchState) error {
	var visit func(*dispatchState, []instructions.Command) []instructions.Command
	if states == nil {
		return nil
	}
	visited := make(map[*dispatchState]struct{})
	path := make(map[*dispatchState]struct{})

	visit = func(state *dispatchState, current []instructions.Command) []instructions.Command {
		_, ok := visited[state]
		if ok {
			return nil
		}
		visited[state] = struct{}{}
		path[state] = struct{}{}
		for dep, c := range state.deps {
			next := append(current, c)
			if _, ok := path[dep]; ok {
				return next
			}
			if c := visit(dep, next); c != nil {
				return c
			}
		}
		delete(path, state)
		return nil
	}
	for _, state := range states {
		if cmds := visit(state, nil); cmds != nil {
			err := errors.Errorf("circular dependency detected on stage: %s", state.stageName)
			for _, c := range cmds {
				err = parser.WithLocation(err, c.Location())
			}
			return err
		}
	}
	return nil
}

核心分析：它使用深度優(yōu)先搜索（DFS）的方式來檢測循環(huán)依賴，并在發(fā)現(xiàn)循環(huán)時返回一個錯誤。

注：看來不是算法沒有用，是業(yè)務(wù)邏輯的代碼中使用 DFS 這種算法的場景比較少，還是得多看源碼

2.3 關(guān)于 parser 的記錄

對于 dockerfile 的 parser 也有點興趣，后面要繼續(xù)抽個時間深入分析一下。筆者當前負責的模塊重構(gòu)成一個通用的 parser 的話，代碼的復(fù)用率會更高一點。希望后面有時間可以優(yōu)化改進一波

總結(jié)

到此這篇關(guān)于一次dockerfile的循環(huán)依賴錯誤的文章就介紹到這了,更多相關(guān)dockerfile循環(huán)依賴錯誤內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評論