Go 判断文件或文件夹是否存在

准备读取配置或写入数据之前,我们常常需要先确认一件事:目标文件或文件夹在硬盘上到底存不存在?

Go 语言标准库并没有直接提供一个叫 FileExists() 的现成函数。想要判断路径是否存在,我们需要先调用 os 包中的 os.Stat() 函数查询目标路径的状态信息,再根据它返回的 error 错误值来做出判断。

os.Stat() 判断路径是否存在

在 Go 语言中,我们可以使用 os.Stat() 函数查询某个路径在硬盘上的状态与属性信息。其中,stat 是 “status(状态)” 的缩写。

语法:

info, err := os.Stat(name)

说明:

os.Stat() 接收文件或文件夹的路径字符串 name 作为参数,并返回描述文件属性的对象 info 和错误值 err。我们可以根据 err 的结果来判断目标路径是否存在,主要分为以下 3 种情况:

  • err == nil:成功获取到状态信息,说明该文件或文件夹确实存在。
  • errors.Is(err, os.ErrNotExist) 为 true:通过 errors.Is() 进行匹配,如果错误属于 os.ErrNotExist,说明该文件或文件夹确实不存在。
  • 其他非空 err:err 既不是 nil,也不匹配 os.ErrNotExist,比如当前用户没有上级目录的访问权限。此时我们无法断定目标是否存在,应该按普通错误进行处理。

测试这一节的 3 个示例时,我们先在当前工作目录下准备一个 hello.txt 文件,在里面写入 "Hello, Go!"(共 10 个英文字符与标点,不含换行符)并保存。下面先拿已存在的 hello.txt 和不存在的 ghost.txt 来对比效果。

示例 1:检查文件是否存在

package main

import (
    "errors"
    "fmt"
    "os"
)

func main() {
    // 检查已存在的文件
    _, err := os.Stat("hello.txt")
    if err == nil {
        fmt.Println("文件 hello.txt 存在")
    } else if errors.Is(err, os.ErrNotExist) {
        fmt.Println("文件 hello.txt 不存在")
    } else {
        fmt.Println("查询出错:", err)
    }

    // 检查不存在的文件
    _, err = os.Stat("ghost.txt")
    if err == nil {
        fmt.Println("文件 ghost.txt 存在")
    } else if errors.Is(err, os.ErrNotExist) {
        fmt.Println("文件 ghost.txt 不存在")
    } else {
        fmt.Println("查询出错:", err)
    }
}

运行结果如下。

文件 hello.txt 存在
文件 ghost.txt 不存在

分析:

上面代码先后调用了两次 os.Stat()。由于这里暂时不需要查看文件的详细属性,我们使用空白标识符 _ 忽略了第 1 个返回值 info。

当我们第 1 次查询已存在的 hello.txt 时,函数返回 err == nil。第 2 次查询的 ghost.txt 在硬盘上并不存在,返回的 err 匹配 os.ErrNotExist,因此进入第 2 个分支打印出文件不存在。

提示: 在早期的 Go 代码中,很多人习惯写 os.IsNotExist(err) 来判断文件是否不存在。从 Go 1.13 引入错误包装机制后,官方更推荐使用 errors.Is(err, os.ErrNotExist),因为它能自动识别被多层包装过的错误,判断结果更加准确。

封装 pathExists() 工具函数

如果每次检查路径存不存在都要重复写一串 if...else 分支,代码会显得比较繁琐。在实际开发中,我们可以把上面这 3 种判断情况封装成一个 pathExists() 函数,方便在项目里随时调用。

示例 2:封装 pathExists() 函数

package main

import (
    "errors"
    "fmt"
    "os"
)

// 判断文件或文件夹是否存在
func pathExists(path string) (bool, error) {
    _, err := os.Stat(path)
    if err == nil {
        return true, nil
    }
    if errors.Is(err, os.ErrNotExist) {
        return false, nil
    }
    return false, err
}

func main() {
    exists1, err := pathExists("hello.txt")
    if err != nil {
        fmt.Println("检查出错:", err)
        return
    }
    fmt.Printf("hello.txt 是否存在:%t\n", exists1)

    exists2, err := pathExists("ghost.txt")
    if err != nil {
        fmt.Println("检查出错:", err)
        return
    }
    fmt.Printf("ghost.txt 是否存在:%t\n", exists2)
}

运行结果如下。

hello.txt 是否存在:true
ghost.txt 是否存在:false

分析:

pathExists() 同时返回 bool 和 error 两个值,把 “是否存在” 和 “查询是否出错” 清晰地分开了。路径存在时返回 true, nil;确认不存在时返回 false, nil;只有遇到无访问权限等异常情况时,才会把具体的 err 返回给调用方处理。

当然了,如果只是写简单的本地小脚本,也可以简化成只返回布尔值的写法,如下所示:

func pathExists(path string) bool {
    _, err := os.Stat(path)
    return err == nil
}

这种简写方式调用起来更轻便,只是遇到目录无访问权限时也会统一返回 false,小伙伴们可以根据实际需求灵活选用。

info.IsDir() 区分文件与文件夹

os.Stat() 既可以检查普通文件,也可以检查文件夹(目录)。当确认某个路径存在后,如果我们还想进一步区分它到底是一个普通文件还是一个文件夹,可以调用返回的 info 对象的 IsDir() 方法。其中,IsDir 是 “Is Directory(是否为目录)” 的缩写。

语法:

info.IsDir()
info.Name()
info.Size()
info.ModTime()

说明:

当 os.Stat() 返回的 err == nil 时,我们可以调用 info 对象的以下常用方法查看详细信息:

  • info.IsDir():判断目标路径是否为文件夹。如果是文件夹则返回 true,如果是普通文件则返回 false。
  • info.Name():获取文件或文件夹本身的名称,不包含前面的父目录路径,效果与 filepath.Base() 类似。
  • info.Size():获取普通文件的字节大小,返回值类型为 int64。
  • info.ModTime():获取文件或文件夹的最后修改时间。

下面我们直接复用前面准备好的 hello.txt,再在同目录下手动新建一个空的 docs 文件夹用来对比测试。

示例 3:区分普通文件与文件夹

package main

import (
    "fmt"
    "os"
)

func main() {
    // 查看普通文件的信息
    fileInfo, err := os.Stat("hello.txt")
    if err != nil {
        fmt.Println("获取 hello.txt 失败:", err)
    } else {
        fmt.Printf("名称:%s\n", fileInfo.Name())
        fmt.Printf("大小:%d\n", fileInfo.Size())
        fmt.Printf("是否为文件夹:%t\n", fileInfo.IsDir())
    }

    // 查看文件夹的信息
    dirInfo, err := os.Stat("docs")
    if err != nil {
        fmt.Println("获取 docs 失败:", err)
    } else {
        fmt.Printf("名称:%s\n", dirInfo.Name())
        fmt.Printf("是否为文件夹:%t\n", dirInfo.IsDir())
    }
}

运行结果如下。

名称:hello.txt
大小:10
是否为文件夹:false
名称:docs
是否为文件夹:true

分析:

从运行结果可以看出,hello.txt 包含 "Hello, Go!" 这 10 个英文字符与标点,因此 fileInfo.Size() 返回字节数 10,fileInfo.IsDir() 返回 false。而 docs 是一个文件夹,因此 dirInfo.IsDir() 返回 true。

这里小伙伴们要特别留意:在调用 info.IsDir() 或 info.Size() 之前,我们一定要先判断 err == nil 确认路径存在。下面这种不检查错误就直接调用方法的写法是错误的。

info, _ := os.Stat("ghost.txt")
fmt.Println(info.IsDir())    // 路径不存在时 info 为 nil

当 "ghost.txt" 在硬盘上不存在时,os.Stat() 返回的 info 是空值 nil。直接对 nil 调用方法就会触发空指针错误,导致程序直接崩溃。

上一篇:

下一篇:

给站长反馈

绿叶网正在不断完善中,小伙伴们如果发现任何问题,还望多多给站长反馈,谢谢!

邮箱:lvyenet@vip.qq.com

「绿叶网」服务号
绿叶网服务号放大
关注服务号,微信也能看教程。
绿叶网服务号