本教程详细介绍了如何使用 go 语言在不同操作系统（linux/macos 和 windows）上获取磁盘的空闲空间和总容量信息。通过利用 go 的 `x/sys` 扩展包，我们能直接调用底层的系统 api，从而实现对磁盘使用情况的精确查询。文章提供了针对 posix 和 windows 系统的具体代码示例，并探讨了构建跨平台解决方案的策略。
在开发跨平台应用程序时，获取操作系统层面的磁盘使用情况（例如，总容量、可用空间、已用空间）是一个常见的需求。Go 语言本身的核心库并未直接提供一个统一的跨平台接口来执行类似 df -h 的操作。然而，通过 Go 提供的 x/sys 扩展包，我们可以方便地调用不同操作系统的底层系统调用，从而实现这一功能。
1. 在 POSIX 系统 (Linux/macOS) 上获取磁盘空间
对于基于 POSIX 标准的系统，如 Linux 和 macOS，我们可以使用 golang.org/x/sys/unix 包中的 Statfs 函数来获取文件系统统计信息。这个函数会填充一个 Statfs_t 结构体，其中包含了我们需要的所有磁盘信息。
核心概念：
- Statfs_t.Bavail: 可供非超级用户使用的空闲块数量。
- Statfs_t.Bsize: 每个文件系统块的大小（字节）。
- Statfs_t.Blocks: 文件系统中的总块数。
- Statfs_t.Bfree: 文件系统中的总空闲块数（包括为超级用户保留的块）。
通过 Bavail * Bsize 即可计算出可用的空闲字节数。
示例代码：
package main
import (
"fmt"
"os"
"golang.org/x/sys/unix"
)
func getDiskUsagePOSIX(path string) (total uint64, free uint64, err error) {
var stat unix.Statfs_t
err = unix.Statfs(path, &stat)
if err != nil {
return 0, 0, fmt.Errorf("无法获取 %s 的文件系统状态: %w", path, err)
}
// 总字节数 = 总块数 * 每块大小
total = stat.Blocks * uint64(stat.Bsize)
// 可用字节数 = 可用块数 * 每块大小
free = stat.Bavail * uint64(stat.Bsize)
return total, free, nil
}
func main() {
// 获取当前工作目录的磁盘使用情况
wd, err := os.Getwd()
if err != nil {
fmt.Printf("获取当前工作目录失败: %v\n", err)
return
}
total, free, err := getDiskUsagePOSIX(wd)
if err != nil {
fmt.Println(err)
return
}
fmt.Printf("POSIX 系统 (%s):\n", wd)
fmt.Printf(" 总空间: %d 字节 (%.2f GB)\n", total, float64(total)/(1024*1024*1024))
fmt.Printf(" 可用空间: %d 字节 (%.2f GB)\n", free, float64(free)/(1024*1024*1024))
}注意事项：
- Statfs 函数需要一个文件系统路径作为参数，通常是挂载点或目录路径。
- 返回的字节数是原始字节，需要进行单位转换（如除以 1024^3 转换为 GB）以提高可读性。
2. 在 Windows 系统上获取磁盘空间
对于 Windows 操作系统，我们需要使用 golang.org/x/sys/windows 包中的 GetDiskFreeSpaceEx 函数。这个函数是 Windows API 的直接封装，可以获取指定驱动器的磁盘空间信息。
核心概念：
- GetDiskFreeSpaceEx 函数接收一个驱动器根路径（例如 "C:\"）作为参数。
- 它会填充三个 uint64 类型的指针：
- lpFreeBytesAvailable: 调用进程可用的字节数。
- lpTotalNumberOfBytes: 驱动器上的总字节数。
- lpTotalNumberOfFreeBytes: 驱动器上所有用户可用的总空闲字节数。
示例代码：
package main
import (
"fmt"
"syscall"
"golang.org/x/sys/windows"
)
func getDiskUsageWindows(drivePath string) (total uint64, free uint64, err error) {
var freeBytesAvailable uint64
var totalNumberOfBytes uint64
var totalNumberOfFreeBytes uint64
// GetDiskFreeSpaceEx 需要以 UTF16 编码的路径
drivePathPtr, err := syscall.UTF16PtrFromString(drivePath)
if err != nil {
return 0, 0, fmt.Errorf("转换路径 %s 失败: %w", drivePath, err)
}
err = windows.GetDiskFreeSpaceEx(
drivePathPtr,
&freeBytesAvailable,
&totalNumberOfBytes,
&totalNumberOfFreeBytes,
)
if err != nil {
return 0, 0, fmt.Errorf("获取 %s 磁盘空间失败: %w", drivePath, err)
}
// 返回总字节数和调用进程可用的字节数
return totalNumberOfBytes, freeBytesAvailable, nil
}
func main() {
// 获取 C 盘的磁盘使用情况
drive := "C:\\"
total, free, err := getDiskUsageWindows(drive)
if err != nil {
fmt.Println(err)
return
}
fmt.Printf("Windows 系统 (%s):\n", drive)
fmt.Printf(" 总空间: %d 字节 (%.2f GB)\n", total, float64(total)/(1024*1024*1024))
fmt.Printf(" 可用空间: %d 字节 (%.2f GB)\n", free, float64(free)/(1024*1024*1024))
}注意事项：
- GetDiskFreeSpaceEx 需要驱动器的根路径，例如 "C:\" 而不是 "C:\" 或 "C"。
- 路径字符串需要通过 syscall.UTF16PtrFromString 转换为 UTF-16 指针。
- freeBytesAvailable 是当前用户/进程可用的空间，totalNumberOfFreeBytes 是整个驱动器上的总空闲空间。根据需求选择合适的返回值。
3. 实现跨平台解决方案
为了创建一个真正的跨平台 Go 包，我们需要利用 Go 的构建约束（Build Constraints）。构建约束允许我们根据目标操作系统、架构等条件包含或排除特定的源文件。
构建约束示例：
- // +build linux darwin：此文件仅在 Linux 和 macOS 上编译。
- // +build windows：此文件仅在 Windows 上编译。
一个典型的跨平台包会定义一个通用的接口（例如 DiskUsage 结构体和 GetDiskUsage 函数），然后在不同的文件中实现这个接口：
- disk_unix.go：包含 POSIX 系统的实现，顶部添加 // +build linux darwin freebsd 等。
- disk_windows.go：包含 Windows 系统的实现，顶部添加 // +build windows。
这样，当 Go 编译器针对特定平台构建时，它会自动选择相应的实现文件。
推荐做法： 可以参考现有的一些开源 Go 包，它们已经实现了跨平台获取磁盘使用情况的功能。例如，在问题更新中提到的 ricochet2200/go-disk-usage 包就是一个很好的参考。这些包通常会提供一个简洁的 API，隐藏底层操作系统调用的复杂性。
总结
通过 Go 语言的 x/sys 扩展包，我们可以直接访问底层操作系统的 API，从而实现对磁盘空间信息的精确获取。对于 POSIX 系统，golang.org/x/sys/unix.Statfs 是首选；对于 Windows 系统，golang.org/x/sys/windows.GetDiskFreeSpaceEx 提供了所需的功能。结合 Go 的构建约束，我们可以轻松地构建出健壮且高效的跨平台磁盘空间管理工具。在实际开发中，建议封装这些底层调用，提供一个统一且易于使用的 API，以提升代码的可维护性和可移植性。
