You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 17 Next »

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

使用方式：

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

接口文档：

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

缓存

GetContentsWithCache

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

  • 示例：

    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
}

主目录

Home

  • 说明：获取运行用户的主目录

  • 示例：

    func ExampleHome() {
	// user's home directory
	homePath, _ := gfile.Home()
	fmt.Println(homePath)

	// May Output:
	// C:\Users\hailaz
}

替换

ReplaceFile

  • 说明：替换指定文件的指定内容为新内容

  • 示例：

    func ExampleReplaceFile() {
	// init
	fileName := "123.txt"
	tempDir := gfile.TempDir("gfile_example_replace")
	tempFile := gfile.Join(tempDir, fileName)

	gfile.Mkdir(tempDir)
	gfile.Create(tempFile)

	// write contents
	gfile.PutContents(tempFile, "test contents")

	// read contents
	content := gfile.GetContents(tempFile)
	fmt.Println(content)

	gfile.ReplaceFile("test", "replace word", tempFile)

	content1 := gfile.GetContents(tempFile)
	fmt.Println(content1)

	// Output:
	// test contents
	// replace word contents
}

ReplaceFileFunc

  • 说明：使用自定义函数替换指定文件内容

  • 示例：

    func ExampleReplaceFileFunc() {
	// init
	fileName := "123.txt"
	tempDir := gfile.TempDir("gfile_example_replace")
	tempFile := gfile.Join(tempDir, fileName)

	gfile.Mkdir(tempDir)
	gfile.Create(tempFile)

	// write contents
	gfile.PutContents(tempFile, "666 test contents 888 a1a2a3")

	// read contents
	content := gfile.GetContents(tempFile)
	fmt.Println(content)

	// replace by yourself
	gfile.ReplaceFileFunc(func(path, content string) string {
		// Replace with regular match
		reg, _ := regexp.Compile(`\d{3}`)
		return reg.ReplaceAllString(content, "[num]")
	}, tempFile)

	content1 := gfile.GetContents(tempFile)
	fmt.Println(content1)

	// Output:
	// 666 test contents 888 a1a2a3
	// [num] test contents [num] a1a2a3
}

ReplaceDir

  • 说明：扫描指定目录，替换符合条件的文件的指定内容为新内容

  • 示例：

    func ExampleReplaceDir() {
	// init
	fileName := "123.txt"
	tempDir := gfile.TempDir("gfile_example_replace")
	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)

	// write contents
	gfile.PutContents(tempFile, "test contents")
	gfile.PutContents(tempSubFile, "test contents")

	// read contents
	content := gfile.GetContents(tempFile)
	fmt.Println(content)
	contentSub := gfile.GetContents(tempSubFile)
	fmt.Println(contentSub)

	gfile.ReplaceDir("test", "replace word", tempDir, "123.txt", true)

	// read contents
	content1 := gfile.GetContents(tempFile)
	fmt.Println(content1)
	contentSub1 := gfile.GetContents(tempSubFile)
	fmt.Println(contentSub1)

	// Output:
	// test contents
	// test contents
	// replace word contents
	// replace word contents
}

ReplaceDirFunc

  • 说明：扫描指定目录，使用自定义函数替换符合条件的文件的指定内容为新内容

  • 示例：

    func ExampleReplaceDirFunc() {
	// init
	fileName := "123.txt"
	tempDir := gfile.TempDir("gfile_example_replace")
	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)

	// write contents
	gfile.PutContents(tempFile, "666 test contents 888 a1a2a3")
	gfile.PutContents(tempSubFile, "666 test contents 888 a1a2a3")

	// read contents
	content := gfile.GetContents(tempFile)
	fmt.Println(content)
	contentSub := gfile.GetContents(tempSubFile)
	fmt.Println(contentSub)

	gfile.ReplaceDirFunc(func(path, content string) string {
		// Replace with regular match
		reg, _ := regexp.Compile(`\d{3}`)
		return reg.ReplaceAllString(content, "[num]")
	}, tempDir, "123.txt", true)

	// read contents
	content1 := gfile.GetContents(tempFile)
	fmt.Println(content1)
	contentSub1 := gfile.GetContents(tempSubFile)
	fmt.Println(contentSub1)

	// Output:
	// 666 test contents 888 a1a2a3
	// 666 test contents 888 a1a2a3
	// [num] test contents [num] a1a2a3
	// [num] test contents [num] a1a2a3
}

修改时间

MTime

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

  • 示例：

    func ExampleMTime() {
	t := gfile.MTime(gfile.TempDir())
	fmt.Println(t)

	// May Output:
	// 2021-11-02 15:18:43.901141 +0800 CST
}

ExampleMTimestamp

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

  • 示例：

    func ExampleMTimestamp() {
	t := gfile.MTimestamp(gfile.TempDir())
	fmt.Println(t)

	// May Output:
	// 1635838398
}

ExampleMTimestampMilli

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

  • 示例：

    func ExampleMTimestampMilli() {
	t := gfile.MTimestampMilli(gfile.TempDir())
	fmt.Println(t)

	// May Output:
	// 1635838529330
}

大小

Size

  • 说明：获取路径大小

  • 示例：

    func ExampleSize() {
	tempDir := gfile.TempDir("gfile_example")
	gfile.Mkdir(tempDir)
	size := gfile.Size(tempDir)
	fmt.Println(size)

	// Output:
	// 0
}

SizeFormat

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

  • 示例：

    func ExampleSizeFormat() {
	tempDir := gfile.TempDir("gfile_example")
	gfile.Mkdir(tempDir)
	sizeStr := gfile.SizeFormat(tempDir)
	fmt.Println(sizeStr)

	// Output:
	// 0.00B
}

ReadableSize

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

  • 示例：

    func ExampleReadableSize() {
	tempDir := gfile.TempDir("gfile_example")
	gfile.Mkdir(tempDir)
	sizeStr := gfile.ReadableSize(tempDir)
	fmt.Println(sizeStr)

	// Output:
	// 0.00B
}

StrToSize

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

  • 示例：

    func ExampleStrToSize() {
	size := gfile.StrToSize("100MB")
	fmt.Println(size)

	// Output:
	// 104857600
}

FormatSize

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

  • 示例：

    func ExampleFormatSize() {
	sizeStr := gfile.FormatSize(104857600)
	fmt.Println(sizeStr)
	sizeStr1 := gfile.FormatSize(999999999999999999)
	fmt.Println(sizeStr1)

	// Output:
	// 100.00M
	// 888.18P
}

排序

SortFiles

  • 说明：排序多个路径

  • 示例：

    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]
}

搜索

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

  • 示例：

    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

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

  • 示例：

    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

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

  • 示例：

    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

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

  • 示例：

    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

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

  • 示例：

    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
}





Content Menu

  • No labels