gfile模块是对文件操作的进一步封装，提供了常用的，简易的API来操作底层文件，隐藏了复杂的底层实现细节。

使用方式：

import "github.com/gogf/gf/os/gfile"

接口文档：

https://godoc.org/github.com/gogf/gf/os/gfile

缓存

GetContentsWithCache

• 说明：带缓存获取文件内容，可设置缓存超时，文件发生变化自动清除缓存

• 示例：

  Code Block
  language go
  func ExampleGetContentsWithCache() { // init fileName := "123.txt" tempDir := gfile.TempDir("gfile_example_cache") tempFile := gfile.Join(tempDir, fileName) gfile.Mkdir(fileName) gfile.Create(tempFile) // write contents gfile.PutContents(tempFile, "test contents") // read contents content := gfile.GetContentsWithCache(tempFile, time.Minute) fmt.Println(content) time.Sleep(time.Second * 1) // read contents content1 := gfile.GetContentsWithCache(tempFile) fmt.Println(content1) // write new contents will clear its cache gfile.PutContents(tempFile, "new test contents") // read contents content2 := gfile.GetContentsWithCache(tempFile) fmt.Println(content2) // Output: // test contents // test contents // new test contents }

  
  

修改时间

MTime

• 说明：获取路径修改时间

• 示例：

  Code Block
  language go
  func ExampleMTime() { t := gfile.MTime(gfile.TempDir()) fmt.Println(t) // May Output: // 2021-11-02 15:18:43.901141 +0800 CST }

  
  

ExampleMTimestamp

• 说明：获取路径修改时间戳（秒）

• 示例：

  Code Block
  language go
  func ExampleMTimestamp() { t := gfile.MTimestamp(gfile.TempDir()) fmt.Println(t) // May Output: // 1635838398 }

  
  

ExampleMTimestampMilli

• 说明：获取路径修改时间戳（毫秒）

• 示例：

  Code Block
  language go
  func ExampleMTimestampMilli() { t := gfile.MTimestampMilli(gfile.TempDir()) fmt.Println(t) // May Output: // 1635838529330 }

  
  

大小

Size

• 说明：获取路径大小

• 示例：

  Code Block
  language go
  func ExampleSize() { tempDir := gfile.TempDir("gfile_example") gfile.Mkdir(tempDir) size := gfile.Size(tempDir) fmt.Println(size) // Output: // 0 }

  
  

SizeFormat

• 说明：获取路径大小，并格式化

• 示例：

  Code Block
  language go
  func ExampleSizeFormat() { tempDir := gfile.TempDir("gfile_example") gfile.Mkdir(tempDir) sizeStr := gfile.SizeFormat(tempDir) fmt.Println(sizeStr) // Output: // 0.00B }

  
  

ReadableSize

• 说明：获取路径大小，并格式化人类易读

• 示例：

  Code Block
  language go
  func ExampleReadableSize() { tempDir := gfile.TempDir("gfile_example") gfile.Mkdir(tempDir) sizeStr := gfile.ReadableSize(tempDir) fmt.Println(sizeStr) // Output: // 0.00B }

  
  

StrToSize

• 说明：大小字符串转换为大小整形

• 示例：

  Code Block
  language go
  func ExampleStrToSize() { size := gfile.StrToSize("100MB") fmt.Println(size) // Output: // 104857600 }

  
  

FormatSize

• 说明：大小整形转换为大小字符串

• 示例：

  Code Block
  language go
  func ExampleFormatSize() { sizeStr := gfile.FormatSize(104857600) fmt.Println(sizeStr) sizeStr1 := gfile.FormatSize(999999999999999999) fmt.Println(sizeStr1) // Output: // 100.00M // 888.18P }

  
  

排序

SortFiles

• 说明：排序多个路径

• 示例：

  Code Block
  language go
  func ExampleSortFiles() { files := []string{ "/aaa/bbb/ccc.txt", "/aaa/bbb/", "/aaa/", "/aaa", "/aaa/ccc/ddd.txt", "/bbb", "/0123", "/ddd", "/ccc", } sortOut := gfile.SortFiles(files) fmt.Println(sortOut) // Output: // [/0123 /aaa /aaa/ /aaa/bbb/ /aaa/bbb/ccc.txt /aaa/ccc/ddd.txt /bbb /ccc /ddd] }

  
  

搜索

Search

• 说明：在指定目录（默认包含当前目录、运行目录、主函数目录；不会递归子目录）中搜索文件并返回真实路径

• 示例：

  Code Block
  language go
  func ExampleSearch() { // init fileName := "123.txt" tempDir := gfile.TempDir("gfile_example") tempFile := gfile.Join(tempDir, fileName) gfile.Mkdir(tempDir) gfile.Create(tempFile) // search file realPath, _ := gfile.Search(fileName, tempDir) fmt.Println(gfile.Basename(realPath)) // Output: // 123.txt }

  
  

扫描目录

ScanDir

• 说明：扫描指定目录，可扫描文件或目录，支持递归扫描

• 示例：

  Code Block
  language go
  func ExampleScanDir() { // init fileName := "123.txt" tempDir := gfile.TempDir("gfile_example") tempFile := gfile.Join(tempDir, fileName) tempSubDir := gfile.Join(tempDir, "sub_dir") tempSubFile := gfile.Join(tempSubDir, fileName) gfile.Mkdir(tempSubDir) gfile.Create(tempFile) gfile.Create(tempSubFile) // scans directory recursively list, _ := gfile.ScanDir(tempDir, "123.txt,sub_dir", true) for _, v := range list { fmt.Println(gfile.Basename(v)) } // Output: // 123.txt // sub_dir // 123.txt }

  
  

ScanDirFile

• 说明：扫描指定目录的文件，支持递归扫描

• 示例：

  Code Block
  language go
  func ExampleScanDirFile() { // init fileName := "123.txt" tempDir := gfile.TempDir("gfile_example") tempFile := gfile.Join(tempDir, fileName) tempSubDir := gfile.Join(tempDir, "sub_dir") tempSubFile := gfile.Join(tempSubDir, fileName) gfile.Mkdir(tempSubDir) gfile.Create(tempFile) gfile.Create(tempSubFile) // scans directory recursively exclusive of directories list, _ := gfile.ScanDirFile(tempDir, "123.txt,sub_dir", true) for _, v := range list { fmt.Println(gfile.Basename(v)) } // Output: // 123.txt // 123.txt }

  
  

ScanDirFunc

• 说明：扫描指定目录（自定义过滤方法），可扫描文件或目录，支持递归扫描

• 示例：

  Code Block
  language go
  func ExampleScanDirFunc() { // init fileName := "123.txt" fileName1 := "1234.txt" tempDir := gfile.TempDir("gfile_example_1") tempFile := gfile.Join(tempDir, fileName) tempSubDir := gfile.Join(tempDir, "sub_dir") tempSubFile := gfile.Join(tempSubDir, fileName1) gfile.Mkdir(tempSubDir) gfile.Create(tempFile) gfile.Create(tempSubFile) // scans directory recursively list, _ := gfile.ScanDirFunc(tempDir, "123.txt,1234.txt,sub_dir", true, func(path string) string { // ignores some files if gfile.Basename(path) == "1234.txt" { return "" } return path }) for _, v := range list { fmt.Println(gfile.Basename(v)) } // Output: // 123.txt // sub_dir }

  
  

ScanDirFileFunc

• 说明：扫描指定目录的文件（自定义过滤方法），支持递归扫描

• 示例：

  Code Block
  language go
  func ExampleScanDirFileFunc() { // init fileName := "123.txt" fileName1 := "1234.txt" tempDir := gfile.TempDir("gfile_example_1") tempFile := gfile.Join(tempDir, fileName) tempSubDir := gfile.Join(tempDir, "sub_dir") tempSubFile := gfile.Join(tempSubDir, fileName1) gfile.Mkdir(tempSubDir) gfile.Create(tempFile) gfile.Create(tempSubFile) // scans directory recursively exclusive of directories list, _ := gfile.ScanDirFileFunc(tempDir, "123.txt,1234.txt,sub_dir", true, func(path string) string { // ignores some files if gfile.Basename(path) == "1234.txt" { return "" } return path }) for _, v := range list { fmt.Println(gfile.Basename(v)) } // Output: // 123.txt }