golang如何判断文件是否存在

 更新时间:2024年11月26日 11:35:20   作者:apocelipes  
判断一个文件是否存在是一个相当常见的需求,在golang中也有多种方案实现这一功能,下面就跟随小编一起学习一下具体的实现方法吧

判断一个文件是否存在是一个相当常见的需求,在golang中也有多种方案实现这一功能。

现在我们介绍其中两种最常用也是最简单的实现,第一种将是跨平台通用的,而第二种则在POSIX平台上通用。

跨平台实现

跨平台实现的思路很简单,如果某个文件不存在,那么使用os.Lstat就一定会返回error,只要判断error是否代表文件不存在即可。

也许你注意到了有些代码会使用os.Open来完成上述工作,不过最好不要这么做,因为虽然两者完成的功能没有区别,但open和stat的调用开销是不同的,后者要小于前者,而且对于判断文件是否存在,检查它的元数据要比直接尝试打开它更加合理。

那么来看看实现的代码:

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

代码很简单,对于Windows/Linux/MacOS等是通用的,一般没有特殊需求我也比较推荐这种实现。

POSIX平台实现

如果你的程序是面向POSIX平台的(例如UNIX、Linux等),那么还有一种更简单的方案——syscall.Access

syscall.Access提供了用户检查文件元信息的手段,通常它被用来检查文件权限以及文件的存在性。

通过使用syscall.F_OK标志检查文件,如果不存在则会返回和os.Lstat一样的error:

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

这种实现的最大优势在于它简单而直观,但是它无法在Windows上使用。

一些提示

首先当我们的FileExist返回true时,其实文件并不一定存在。

当我们对目标path中的某一部分没有可读权限时,os.Lstatsyscall.Access同样会返回error,不过这个error不会让os.IsNotExist返回true。

当文件不存在而你对文件所在的目录或者它的上层目录没有访问权限时,FileExist依旧会返回true,bug就在这时发生了。所以重要的一点是在判断文件是否存在前应该先判断自己对文件及其路径是否有访问权限

其次syscall.Access只会使用运行程序的用户的uid和gid,这会导致setuid之类的权限失效,通常来说这是没什么问题的,然而posix平台上一般都会考虑euid和egid,因此你可能需要使用syscall.Faccessat做代替。你需要在深思熟虑后使用合适的系统调用。

性能测试

最后我们看看两个方案的性能,我们以os.Open做为基准,分别测试先文件存在和不存在时的性能表现:

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")
	}
}

这是结果:

测试使用的文件系统类型是XFS。

可以看到open是最慢的,lstat比access慢了16%左右。从结果里也可以看到lstat需要额外返回一个os.FileInfo结构导致了额外的内存分配,所以整体上速度更慢。

但考虑到跨平台以及兼容性,使用os.Lstat是更常见的做法。

以上就是golang如何判断文件是否存在的详细内容,更多关于go判断文件是否存在的资料请关注脚本之家其它相关文章!

相关文章

  • golang基础之Interface接口的使用

    golang基础之Interface接口的使用

    这篇文章主要介绍了golang基础之Interface接口的使用,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-07-07
  • 关于golang指针的有限操作详解

    关于golang指针的有限操作详解

    传统意义上来说,指针是一个指向某个确切的内存地址的值,这个内存地址可以是任何数据或代码的起始地址,在Go语言中有几种东西可以代表"指针",本文给大家介绍的是关于golang指针的有限操作,感兴趣的同学可以参考一下
    2023-08-08
  • 详解go中panic源码解读

    详解go中panic源码解读

    这篇文章主要介绍了go中panic源码解读,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2021-04-04
  • 详解Golang如何在编译时注入版本信息

    详解Golang如何在编译时注入版本信息

    这篇文章主要为大家详细介绍了Golang如何在编译时实现注入版本信息,文中的示例代码讲解详细,具有一定的学习价值,感兴趣的可以了解一下
    2023-06-06
  • go使用Viper管理配置文件的方法步骤

    go使用Viper管理配置文件的方法步骤

    在项目开发中,需要把一些配置配置提取出来,方便配置和管理,可以使用Viper工具,Viper 是 Go 应用程序的完整配置解决方案,也支持从环境变量中读取,本文给大家介绍了go使用Viper管理配置文件的方法步骤,需要的朋友可以参考下
    2024-07-07
  • 15个Golang中时间处理的实用函数

    15个Golang中时间处理的实用函数

    在Go编程中,处理日期和时间是一项常见任务,涉及到精确性和灵活性,本文将介绍一系列实用函数,它们充当time包的包装器,需要的可以参考下
    2024-01-01
  • Go Excelize API源码解析GetSheetFormatPr使用示例

    Go Excelize API源码解析GetSheetFormatPr使用示例

    这篇文章主要为大家介绍了Go Excelize API源码解析GetSheetFormatPr使用示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-08-08
  • Go利用GJSON组件解锁JSON读取新姿势

    Go利用GJSON组件解锁JSON读取新姿势

    Go 标准库提供了 encoding/json 包用于处理 json 数据,同时第三方库 GJSON & SJSON 也在 json 处理方面表现出色,下面我们就来看看如何使用GJSON解锁JSON读取新方法吧
    2025-03-03
  • Go Java算法最大单词长度乘积示例详解

    Go Java算法最大单词长度乘积示例详解

    这篇文章主要为大家介绍了Go Java算法最大单词长度乘积示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-08-08
  • 解决Go gorm踩过的坑

    解决Go gorm踩过的坑

    这篇文章主要介绍了解决Go gorm踩过的坑,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2021-04-04

最新评论