快捷導(dǎo)航

golang如何判斷文件是否存在

更新時(shí)間：2024年11月26日 11:35:20 作者：apocelipes

判斷一個(gè)文件是否存在是一個(gè)相當(dāng)常見(jiàn)的需求,在golang中也有多種方案實(shí)現(xiàn)這一功能,下面就跟隨小編一起學(xué)習(xí)一下具體的實(shí)現(xiàn)方法吧

跨平臺(tái)實(shí)現(xiàn)

跨平臺(tái)實(shí)現(xiàn)的思路很簡(jiǎn)單，如果某個(gè)文件不存在，那么使用os.Lstat就一定會(huì)返回error，只要判斷error是否代表文件不存在即可。

也許你注意到了有些代碼會(huì)使用os.Open來(lái)完成上述工作，不過(guò)最好不要這么做，因?yàn)殡m然兩者完成的功能沒(méi)有區(qū)別，但open和stat的調(diào)用開(kāi)銷(xiāo)是不同的，后者要小于前者，而且對(duì)于判斷文件是否存在，檢查它的元數(shù)據(jù)要比直接嘗試打開(kāi)它更加合理。

那么來(lái)看看實(shí)現(xiàn)的代碼：

func FileExist(path string) bool {
  _, err := os.Lstat(path)
  return !os.IsNotExist(err)
}

代碼很簡(jiǎn)單，對(duì)于Windows/Linux/MacOS等是通用的，一般沒(méi)有特殊需求我也比較推薦這種實(shí)現(xiàn)。

POSIX平臺(tái)實(shí)現(xiàn)

如果你的程序是面向POSIX平臺(tái)的（例如UNIX、Linux等），那么還有一種更簡(jiǎn)單的方案——syscall.Access。

syscall.Access提供了用戶檢查文件元信息的手段，通常它被用來(lái)檢查文件權(quán)限以及文件的存在性。

通過(guò)使用syscall.F_OK標(biāo)志檢查文件，如果不存在則會(huì)返回和os.Lstat一樣的error：

func FileExist(path string) bool {
  err := syscall.Access(path, syscall.F_OK)
  return !os.IsNotExist(err)
}

這種實(shí)現(xiàn)的最大優(yōu)勢(shì)在于它簡(jiǎn)單而直觀，但是它無(wú)法在Windows上使用。

一些提示

首先當(dāng)我們的FileExist返回true時(shí)，其實(shí)文件并不一定存在。

當(dāng)我們對(duì)目標(biāo)path中的某一部分沒(méi)有可讀權(quán)限時(shí)，os.Lstat和syscall.Access同樣會(huì)返回error，不過(guò)這個(gè)error不會(huì)讓os.IsNotExist返回true。

當(dāng)文件不存在而你對(duì)文件所在的目錄或者它的上層目錄沒(méi)有訪問(wèn)權(quán)限時(shí)，FileExist依舊會(huì)返回true，bug就在這時(shí)發(fā)生了。所以重要的一點(diǎn)是在判斷文件是否存在前應(yīng)該先判斷自己對(duì)文件及其路徑是否有訪問(wèn)權(quán)限。

其次syscall.Access只會(huì)使用運(yùn)行程序的用戶的uid和gid，這會(huì)導(dǎo)致setuid之類(lèi)的權(quán)限失效，通常來(lái)說(shuō)這是沒(méi)什么問(wèn)題的，然而posix平臺(tái)上一般都會(huì)考慮euid和egid，因此你可能需要使用syscall.Faccessat做代替。你需要在深思熟慮后使用合適的系統(tǒng)調(diào)用。

性能測(cè)試

最后我們看看兩個(gè)方案的性能，我們以os.Open做為基準(zhǔn)，分別測(cè)試先文件存在和不存在時(shí)的性能表現(xiàn)：

func checkWithOpen(path string) bool {
	f, err := os.Open(path)
	if err != nil {
		return false
	}
	f.Close()
	return true
}

func checkWithLstat(path string) bool {
	_, err := os.Lstat(path)
	return !os.IsNotExist(err)
}

func checkWithAccess(path string) bool {
        err := syscall.Access(path, syscall.F_OK)
	return !os.IsNotExist(err)
}

func BenchmarkNotExists(b *testing.B) {
	for range b.N {
		checkWithOpen("/home/apocelipes/no-")
	}
}

func BenchmarkNotExistsLstat(b *testing.B) {
	for range b.N {
		checkWithLstat("/home/apocelipes/no-")
	}
}

func BenchmarkNotExistsAccess(b *testing.B) {
	for range b.N {
		checkWithAccess("/home/apocelipes/no-")
	}
}

func BenchmarkExists(b *testing.B) {
	for range b.N {
		checkWithOpen("/home/apocelipes/.zshrc")
	}
}

func BenchmarkExistsLstat(b *testing.B) {
	for range b.N {
		checkWithLstat("/home/apocelipes/.zshrc")
	}
}

func BenchmarkExistsAccess(b *testing.B) {
	for range b.N {
		checkWithAccess("/home/apocelipes/.zshrc")
	}
}

這是結(jié)果：