Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

基本介绍

gfile模块是对文件操作的进一步封装,提供了常用的,简易的API来操作底层文件,隐藏了复杂的底层实现细节。文件管理组件提供了更加丰富的文件/目录操作能力。

使用方式

Code Block
languagego
import "github.com/gogf/gf/v2/os/gfile"

接口文档

https://pkg.go.dev/github.com/gogf/gf/v2/os/gfile

Tip

以下常用方法列表,文档更新可能滞后于代码新特性,更多的方法及示例请参考代码文档:https://

godoc

pkg.go.

org

dev/github.com/gogf/gf/v2/os/gfile

缓存

GetContentsWithCache

内容管理

GetContents

  • 说明:读取指定路径文件内容,以字符串形式返回。
  • 格式: 

    Code Block
    languagego
    func GetContents(path string) string
    说明:带缓存获取文件内容,可设置缓存超时,文件发生变化自动清除缓存


  • 示例:

    Code Block
    languagego
    func ExampleGetContentsWithCacheExampleGetContents() {
    	// init
    	var (
    		fileName := "123gfile_example.txt"
    		tempDir  := gfile.TempDir("gfile_example_cachecontent")
    		tempFile := gfile.Join(tempDir, fileName)
    	)
    	gfile.Mkdir(fileName)
    	gfile.Create(tempFile)
    
    	
    	// write contents
    	gfile.PutContents(tempFile, "testgoframe example contentscontent")
    
    	// read contents
    	content := gfile.GetContentsWithCache(tempFile, time.Minute) It reads and returns the file content as string.
    	// It returns empty string if it fails reading, for example, with permission or IO error.
    	fmt.Println(content(gfile.GetContents(tempFile))
    
    	time.Sleep(time.Second * 1)
    
    // Output:
    	// readgoframe example contents
    	content1 := gfile.GetContentsWithCache(tempFile)
    	fmt.Println(content1)
    
    	// write new contents will clear its cache
    	gfile.PutContents(tempFile, "new test contents"content
    }


GetContentsWithCache

  • 说明:带缓存获取文件内容,可设置缓存超时,文件发生变化自动清除缓存。
  • 格式: 

    Code Block
    languagego
    func GetContentsWithCache(path string, duration ...time.Duration) string


  • 示例:

    Code Block
    languagego
    func ExampleGetContentsWithCache() {
    	// init
    	var (
    		fileName = "gfile_example.txt"
    		tempDir  = gfile.TempDir("gfile_example_cache")
    		tempFile = gfile.Join(tempDir, fileName)
    	)
    
    	// readwrite contents
    	content2 := gfile.GetContentsWithCache(tempFile)
    	fmt.Println(content2PutContents(tempFile, "goframe example content")
    
    	// Output:
    	// test contentsIt reads the file content with cache duration of one minute,
    	// test contents
    	// new test contents
    }

主目录

Home

  • 说明:获取运行用户的主目录
  • 示例:

    Code Block
    languagego
    func ExampleHome() {
    	// user's home directory
    	homePath, _ := gfile.Home()which means it reads from cache after then without any IO operations within on minute.
    	fmt.Println(homePathgfile.GetContentsWithCache(tempFile, time.Minute))
    
    	// May Output: write new contents will clear its cache
    	gfile.PutContents(tempFile, "new goframe example content")
    
    	// C:\Users\hailaz
    }

替换

ReplaceFile

  • There's some delay for cache clearing after file content change.
    	time.Sleep(time.Second * 1)
    
    	// read contents
    	fmt.Println(gfile.GetContentsWithCache(tempFile))
    
    	// May Output:
    	// goframe example content
    	// new goframe example content
    }


GetBytesWithCache

  • 说明:带缓存获取文件内容,可设置缓存超时,文件发生变化自动清除缓存,返回[]byte。
  • 格式: 

    Code Block
    languagego
    func GetBytesWithCache(path string, duration ...time.Duration) []byte


  • 示例:

    Code Block
    languagego
    func ExampleGetBytesWithCache() {
    	// init
    	var (
    		fileName = "gfile_example.txt"
    		tempDir  = gfile.TempDir("gfile_example_cache")
    		tempFile = gfile.Join(tempDir, fileName)
    	)
    
    	// write contents
    	gfile.PutContents(tempFile, "goframe example content")
    
    	// It reads the file content with cache duration of one minute,
    	// which means it reads from cache after then without any IO operations within on minute.
    	fmt.Println(gfile.GetBytesWithCache(tempFile, time.Minute))
    
    	// write new contents will clear its cache
    	gfile.PutContents(tempFile, "new goframe example content")
    
    	// There's some delay for cache clearing after file content change.
    	time.Sleep(time.Second * 1)
    
    	// read contents
    	fmt.Println(gfile.GetBytesWithCache(tempFile))
    
    	// Output:
    	// [103 111 102 114 97 109 101 32 101 120 97 109 112 108 101 32 99 111 110 116 101 110 116]
    	// [110 101 119 32 103 111 102 114 97 109 101 32 101 120 97 109 112 108 101 32 99 111 110 116 101 110 116]
    }


GetBytes

  • 说明:读取指定路径文件内容,以字节形式返回。
  • 格式: 

    Code Block
    languagego
    func GetBytes(path string) []byte


  • 示例:

    Code Block
    languagego
    func ExampleGetBytes() {
    	// init
    	var (
    		fileName = "gfile_example.txt"
    		tempDir  = gfile.TempDir("gfile_example_content")
    		tempFile = gfile.Join(tempDir, fileName)
    	)
    
    	// write contents
    	gfile.PutContents(tempFile, "goframe example content")
    
    	// It reads and returns the file content as []byte.
    	// It returns nil if it fails reading, for example, with permission or IO error.
    	fmt.Println(gfile.GetBytes(tempFile))
    
    	// Output:
    	// [103 111 102 114 97 109 101 32 101 120 97 109 112 108 101 32 99 111 110 116 101 110 116]
    }


GetBytesTilChar

  • 说明:以某个字符定位截取指定长度的文件内容以字节形式返回
  • 格式: 

    Code Block
    languagego
    func GetBytesTilChar(reader io.ReaderAt, char byte, start int64) ([]byte, int64)


  • 示例:

    Code Block
    languagego
    func ExampleGetBytesTilChar() {
    	// init
    	var (
    		fileName = "gfile_example.txt"
    		tempDir  = gfile.TempDir("gfile_example_content")
    		tempFile = gfile.Join(tempDir, fileName)
    	)
    
    	// write contents
    	gfile.PutContents(tempFile, "goframe example content")
    
    	f, _ := gfile.OpenWithFlagPerm(tempFile, os.O_RDONLY, gfile.DefaultPermOpen)
    
    	// GetBytesTilChar returns the contents of the file as []byte
    	// until the next specified byte `char` position.
    	char, i := gfile.GetBytesTilChar(f, 'f', 0)
    	fmt.Println(char)
    	fmt.Println(i)
    
    	// Output:
    	// [103 111 102]
    	// 2
    }


GetBytesByTwoOffsets

  • 说明:以指定的区间读取文件内容
  • 格式: 

    Code Block
    languagego
    func GetBytesByTwoOffsets(reader io.ReaderAt, start int64, end int64) []byte 


  • 示例:

    Code Block
    languagego
    func ExampleGetBytesByTwoOffsets() {
    	// init
    	var (
    		fileName = "gfile_example.txt"
    		tempDir  = gfile.TempDir("gfile_example_content")
    		tempFile = gfile.Join(tempDir, fileName)
    	)
    
    	// write contents
    	gfile.PutContents(tempFile, "goframe example content")
    
    	f, _ := gfile.OpenWithFlagPerm(tempFile, os.O_RDONLY, gfile.DefaultPermOpen)
    
    	// GetBytesTilChar returns the contents of the file as []byte
    	// until the next specified byte `char` position.
    	char := gfile.GetBytesByTwoOffsets(f, 0, 3)
    	fmt.Println(char)
    
    	// Output:
    	// [103 111 102]
    }


PutContents

  • 说明:往指定路径文件添加字符串内容。如果文件不存在将会递归的形式自动创建。
  • 格式: 

    Code Block
    languagego
    func putContents(path string, data []byte, flag int, perm os.FileMode) error


  • 示例:

    Code Block
    languagego
    func ExamplePutContents() {
    	// init
    	var (
    		fileName = "gfile_example.txt"
    		tempDir  = gfile.TempDir("gfile_example_content")
    		tempFile = gfile.Join(tempDir, fileName)
    	)
    
    	// It creates and puts content string into specifies file path.
    	// It automatically creates directory recursively if it does not exist.
    	gfile.PutContents(tempFile, "goframe example content")
    
    	// read contents
    	fmt.Println(gfile.GetContents(tempFile))
    
    	// Output:
    	// goframe example content
    }


PutBytes

  • 说明:以字节形式写入指定文件,如果文件不存在将会递归的形式自动创建
  • 格式: 

    Code Block
    languagego
    func PutBytes(path string, content []byte) error


  • 示例:

    Code Block
    languagego
    func ExamplePutBytes() {
    	// init
    	var (
    		fileName = "gfile_example.txt"
    		tempDir  = gfile.TempDir("gfile_example_content")
    		tempFile = gfile.Join(tempDir, fileName)
    	)
    
    	// write contents
    	gfile.PutBytes(tempFile, []byte("goframe example content"))
    
    	// read contents
    	fmt.Println(gfile.GetContents(tempFile))
    
    	// Output:
    	// goframe example content
    }


PutContentsAppend

  • 说明:追加字符串内容到指定文件,如果文件不存在将会递归的形式自动创建。
  • 格式: 

    Code Block
    languagego
    func PutContentsAppend(path string, content string) error


  • 示例:

    Code Block
    languagego
    func ExamplePutContentsAppend() {
    	// init
    	var (
    		fileName = "gfile_example.txt"
    		tempDir  = gfile.TempDir("gfile_example_content")
    		tempFile = gfile.Join(tempDir, fileName)
    	)
    
    	// write contents
    	gfile.PutContents(tempFile, "goframe example content")
    
    	// read contents
    	fmt.Println(gfile.GetContents(tempFile))
    
    	// It creates and append content string into specifies file path.
    	// It automatically creates directory recursively if it does not exist.
    	gfile.PutContentsAppend(tempFile, " append content")
    
    	// read contents
    	fmt.Println(gfile.GetContents(tempFile))
    
    	// Output:
    	// goframe example content
    	// goframe example content append content
    }


PutBytesAppend

  • 说明:追加字节内容到指定文件。如果文件不存在将会递归的形式自动创建。
  • 格式: 

    Code Block
    languagego
    func PutBytesAppend(path string, content []byte) error


  • 示例:

    Code Block
    languagego
    func ExamplePutBytesAppend() {
    	// init
    	var (
    		fileName = "gfile_example.txt"
    		tempDir  = gfile.TempDir("gfile_example_content")
    		tempFile = gfile.Join(tempDir, fileName)
    	)
    
    	// write contents
    	gfile.PutContents(tempFile, "goframe example content")
    
    	// read contents
    	fmt.Println(gfile.GetContents(tempFile))
    
    	// write contents
    	gfile.PutBytesAppend(tempFile, []byte(" append"))
    
    	// read contents
    	fmt.Println(gfile.GetContents(tempFile))
    
    	// Output:
    	// goframe example content
    	// goframe example content append
    }


GetNextCharOffset

  • 说明:从某个偏移量开始,获取文件中指定字符所在下标
  • 格式: 

    Code Block
    languagego
    func GetNextCharOffset(reader io.ReaderAt, char byte, start int64) int64


  • 示例:

    Code Block
    languagego
    func ExampleGetNextCharOffset() {
    	// init
    	var (
    		fileName = "gfile_example.txt"
    		tempDir  = gfile.TempDir("gfile_example_content")
    		tempFile = gfile.Join(tempDir, fileName)
    	)
    
    	// write contents
    	gfile.PutContents(tempFile, "goframe example content")
    	
    	f, err := gfile.OpenWithFlagPerm(tempFile, os.O_RDONLY, DefaultPermOpen)
    	defer f.Close()
    
    	// read contents
    	index := gfile.GetNextCharOffset(f, 'f', 0)
    	fmt.Println(index)
    
    	// Output:
    	// 2
    }


GetNextCharOffsetByPath

  • 说明:从某个偏移量开始,获取文件中指定字符所在下标
  • 格式: 

    Code Block
    languagego
    func GetNextCharOffsetByPath(path string, char byte, start int64) int64 


  • 示例:

    Code Block
    languagego
    func ExampleGetNextCharOffsetByPath() {
    	// init
    	var (
    		fileName = "gfile_example.txt"
    		tempDir  = gfile.TempDir("gfile_example_content")
    		tempFile = gfile.Join(tempDir, fileName)
    	)
    
    	// write contents
    	gfile.PutContents(tempFile, "goframe example content")
    
    	// read contents
    	index := gfile.GetNextCharOffsetByPath(tempFile, 'f', 0)
    	fmt.Println(index)
    
    	// Output:
    	// 2
    }



GetBytesTilCharByPath

  • 说明:以某个字符定位截取指定长度的文件内容以字节形式返回
  • 格式: 

    Code Block
    languagego
    func GetBytesTilCharByPath(path string, char byte, start int64) ([]byte, int64) 


  • 示例:

    Code Block
    languagego
    func ExampleGetBytesTilCharByPath() {
    	// init
    	var (
    		fileName = "gfile_example.txt"
    		tempDir  = gfile.TempDir("gfile_example_content")
    		tempFile = gfile.Join(tempDir, fileName)
    	)
    
    	// write contents
    	gfile.PutContents(tempFile, "goframe example content")
    
    	// read contents
    	fmt.Println(gfile.GetBytesTilCharByPath(tempFile, 'f', 0))
    
    	// Output:
    	// [103 111 102] 2
    }


GetBytesByTwoOffsetsByPath

  • 说明:用两个偏移量截取指定文件的内容以字节形式返回
  • 格式: 

    Code Block
    languagego
    func GetBytesByTwoOffsetsByPath(path string, start int64, end int64) []byte


  • 示例:

    Code Block
    languagego
    func ExampleGetBytesByTwoOffsetsByPath() {
    	// init
    	var (
    		fileName = "gfile_example.txt"
    		tempDir  = gfile.TempDir("gfile_example_content")
    		tempFile = gfile.Join(tempDir, fileName)
    	)
    
    	// write contents
    	gfile.PutContents(tempFile, "goframe example content")
    
    	// read contents
    	fmt.Println(gfile.GetBytesByTwoOffsetsByPath(tempFile, 0, 7))
    
    	// Output:
    	// [103 111 102 114 97 109 101]
    }


ReadLines

  • 说明:以字符串形式逐行读取文件内容
  • 格式: 

    Code Block
    languagego
    func ReadLines(file string, callback func(text string) error) error


  • 示例:

    Code Block
    languagego
    func ExampleReadLines() {
    	// init
    	var (
    		fileName = "gfile_example.txt"
    		tempDir  = gfile.TempDir("gfile_example_content")
    		tempFile = gfile.Join(tempDir, fileName)
    	)
    
    	// write contents
    	gfile.PutContents(tempFile, "L1 goframe example content\nL2 goframe example content")
    
    	// read contents
    	gfile.ReadLines(tempFile, func(text string) error {
    		// Process each line
    		fmt.Println(text)
    		return nil
    	})
    
    	// Output:
    	// L1 goframe example content
    	// L2 goframe example content
    }


ReadLinesBytes

  • 说明:以字节形式逐行读取文件内容
  • 格式: 

    Code Block
    languagego
    func ReadLinesBytes(file string, callback func(bytes []byte) error) error 


  • 示例:

    Code Block
    languagego
    func ExampleReadLinesBytes() {
    	// init
    	var (
    		fileName = "gfile_example.txt"
    		tempDir  = gfile.TempDir("gfile_example_content")
    		tempFile = gfile.Join(tempDir, fileName)
    	)
    
    	// write contents
    	gfile.PutContents(tempFile, "L1 goframe example content\nL2 goframe example content")
    
    	// read contents
    	gfile.ReadLinesBytes(tempFile, func(bytes []byte) error {
    		// Process each line
    		fmt.Println(bytes)
    		return nil
    	})
    
    	// Output:
    	// [76 49 32 103 111 102 114 97 109 101 32 101 120 97 109 112 108 101 32 99 111 110 116 101 110 116]
    	// [76 50 32 103 111 102 114 97 109 101 32 101 120 97 109 112 108 101 32 99 111 110 116 101 110 116]
    }


Truncate

  • 说明:裁剪文件为指定大小
  • 注意:如果给定文件路径是软链,将会修改源文件
  • 格式: 

    Code Block
    languagego
    func Truncate(path string, size int) error


  • 示例:

    Code Block
    languagego
    func ExampleTruncate(){
    	// init
    	var (
    		path = gfile.Join(gfile.TempDir("gfile_example_basic_dir"), "file1")
    	)
    
    	// Check whether the `path` size
    	stat, _ := gfile.Stat(path)
    	fmt.Println(stat.Size())
    
    	// Truncate file
    	gfile.Truncate(path, 0)
    
    	// Check whether the `path` size
    	stat, _ = gfile.Stat(path)
    	fmt.Println(stat.Size())
    
    	// Output:
    	// 13
    	// 0
    }



内容替换

ReplaceFile

  • 说明:替换指定文件的指定内容为新内容
  • 格式: 

    Code Block
    languagego
    func ReplaceFile(search, replace, path string) error 


  • 示例:

    Code Block
    languagego
    func ExampleReplaceFile() {
    	// init
    	var (
    		fileName = "gfile_example.txt"
    		tempDir  = gfile.TempDir("gfile_example_replace")
    		tempFile = gfile.Join(tempDir, fileName)
    	)
    
    	// write contents
    	gfile.PutContents(tempFile, "goframe example content")
    
    	// read contents
    	fmt.Println(gfile.GetContents(tempFile))
    
    	// It replaces content directly by file path.
    	gfile.ReplaceFile("content", "replace word", tempFile)
    
    	fmt.Println(gfile.GetContents(tempFile))
    
    	// Output:
    	// goframe example content
    	// goframe example replace word
    }


ReplaceFileFunc

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

    Code Block
    languagego
    func ReplaceFileFunc(f func(path, content string) string, path string) error


  • 示例:

    Code Block
    languagego
    func ExampleReplaceFileFunc() {
    	// init
    	var (
    		fileName = "gfile_example.txt"
    		tempDir  = gfile.TempDir("gfile_example_replace")
    		tempFile = gfile.Join(tempDir, fileName)
    	)
    
    	// write contents
    	gfile.PutContents(tempFile, "goframe example 123")
    
    	// read contents
    	fmt.Println(gfile.GetContents(tempFile))
    
    	// It replaces content directly by file path and callback function.
    	gfile.ReplaceFileFunc(func(path, content string) string {
    		// Replace with regular match
    		reg, _ := regexp.Compile(`\d{3}`)
    		return reg.ReplaceAllString(content, "[num]")
    	}, tempFile)
    
    	fmt.Println(gfile.GetContents(tempFile))
    
    	// Output:
    	// goframe example 123
    	// goframe example [num]
    }


ReplaceDir

  • 说明:扫描指定目录,替换符合条件的文件的指定内容为新内容
  • 格式: 

    Code Block
    languagego
    func ReplaceDir(search, replace, path, pattern string, recursive ...bool) error


  • 示例:

    Code Block
    languagego
    func ExampleReplaceDir() {
    	// init
    	var (
    		fileName = "gfile_example.txt"
    		tempDir  = gfile.TempDir("gfile_example_replace")
    		tempFile = gfile.Join(tempDir, fileName)
    	)
    
    	// write contents
    	gfile.PutContents(tempFile, "goframe example content")
    
    	// read contents
    	fmt.Println(gfile.GetContents(tempFile))
    
    	// It replaces content of all files under specified directory recursively.
    	gfile.ReplaceDir("content", "replace word", tempDir, "gfile_example.txt", true)
    
    	// read contents
    	fmt.Println(gfile.GetContents(tempFile))
    
    	// Output:
    	// goframe example content
    	// goframe example replace word
    }


ReplaceDirFunc

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

    Code Block
    languagego
    func ReplaceDirFunc(f func(path, content string) string, path, pattern string, recursive ...bool) error


  • 示例:

    Code Block
    languagego
    func ExampleReplaceDirFunc() {
    	// init
    	var (
    		fileName = "gfile_example.txt"
    		tempDir  = gfile.TempDir("gfile_example_replace")
    		tempFile = gfile.Join(tempDir, fileName)
    	)
    
    	// write contents
    	gfile.PutContents(tempFile, "goframe example 123")
    
    	// read contents
    	fmt.Println(gfile.GetContents(tempFile))
    
    	// It replaces content of all files under specified directory with custom callback function recursively.
    	gfile.ReplaceDirFunc(func(path, content string) string {
    		// Replace with regular match
    		reg, _ := regexp.Compile(`\d{3}`)
    		return reg.ReplaceAllString(content, "[num]")
    	}, tempDir, "gfile_example.txt", true)
    
    	fmt.Println(gfile.GetContents(tempFile))
    
    	// Output:
    	// goframe example 123
    	// goframe example [num]
    
    }


文件时间

MTime

  • 说明:获取路径修改时间
  • 格式: 

    Code Block
    languagego
    func MTime(path string) time.Time 


  • 示例:

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


MTimestamp

  • 说明:获取路径修改时间戳(秒)
  • 格式: 

    Code Block
    languagego
    func MTimestamp(path string) int64


  • 示例:

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


MTimestampMilli

  • 说明:获取路径修改时间戳(毫秒)
  • 格式: 

    Code Block
    languagego
    func MTimestampMilli(path string) int64


  • 示例:

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


文件大小

Size

  • 说明:获取路径大小,不进行格式化
  • 格式: 

    Code Block
    languagego
    func Size(path string) int64 


  • 示例:

    Code Block
    languagego
    func ExampleSize() {
    	// init
    	var (
    		fileName = "gfile_example.txt"
    		tempDir  = gfile.TempDir("gfile_example_size")
    		tempFile = gfile.Join(tempDir, fileName)
    	)
    
    	// write contents
    	gfile.PutContents(tempFile, "0123456789")
    	fmt.Println(gfile.Size(tempFile))
    
    	// Output:
    	// 10
    }


SizeFormat

  • 说明:获取路径大小,并格式化成硬盘容量
  • 格式: 

    Code Block
    languagego
    func SizeFormat(path string) string


  • 示例:

    Code Block
    languagego
    func ExampleSizeFormat() {
    	// init
    	var (
    		fileName = "gfile_example.txt"
    		tempDir  = gfile.TempDir("gfile_example_size")
    		tempFile = gfile.Join(tempDir, fileName)
    	)
    
    	// write contents
    	gfile.PutContents(tempFile, "0123456789")
    	fmt.Println(gfile.SizeFormat(tempFile))
    
    	// Output:
    	// 10.00B
    }


ReadableSize

  • 说明:获取给定路径容量大小,并格式化人类易读的硬盘容量格式
  • 格式: 

    Code Block
    languagego
    func ReadableSize(path string) string


  • 示例:

    Code Block
    languagego
    func ExampleReadableSize() {
    	// init
    	var (
    		fileName = "gfile_example.txt"
    		tempDir  = gfile.TempDir("gfile_example_size")
    		tempFile = gfile.Join(tempDir, fileName)
    	)
    
    	// write contents
    	gfile.PutContents(tempFile, "01234567899876543210")
    	fmt.Println(gfile.ReadableSize(tempFile))
    
    	// Output:
    	// 20.00B
    }


StrToSize

  • 说明:硬盘容量大小字符串转换为大小整形
  • 格式: 

    Code Block
    languagego
    func StrToSize(sizeStr string) int64


  • 示例:

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


FormatSize

  • 说明:大小整形转换为硬盘容量大小字符串`K、m、g、t、p、e、b`
  • 格式: 

    Code Block
    languagego
    func FormatSize(raw int64) string


  • 示例:

    Code Block
    languagego
    func ExampleFormatSize() {
    	sizeStr := gfile.FormatSize(104857600)
    	fmt.Println(sizeStr)
    	sizeStr0 := gfile.FormatSize(1024)
    	fmt.Println(sizeStr0)
    	sizeStr1 := gfile.FormatSize(999999999999999999)
    	fmt.Println(sizeStr1)
    
    	// Output:
    	// 100.00M
    	// 1.00K
    	// 888.18P
    }


文件排序

SortFiles

  • 说明:排序多个路径,按首字母进行排序,数字优先。
  • 格式: 

    Code Block
    languagego
    func SortFiles(files []string) []string


  • 示例:

    Code Block
    languagego
    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]
    }


文件检索

  • 说明:在指定目录(默认包含当前目录、运行目录、主函数目录;不会递归子目录)中搜索文件并返回真实路径。
  • 格式: 

    Code Block
    languagego
    func Search(name string, prioritySearchPaths ...string) (realPath string, err error) 


  • 示例:

    Code Block
    languagego
    func ExampleSearch() {
    	// init
    	var (
    		fileName = "gfile_example.txt"
    		tempDir  = gfile.TempDir("gfile_example_search")
    		tempFile = gfile.Join(tempDir, fileName)
    	)
    
    	// write contents
    	gfile.PutContents(tempFile, "goframe example content")
    
    	// search file
    	realPath, _ := gfile.Search(fileName, tempDir)
    	fmt.Println(gfile.Basename(realPath))
    
    	// Output:
    	// gfile_example.txt
    }


目录扫描

ScanDir

  • 说明:扫描指定目录,可扫描文件或目录,支持递归扫描。
  • 格式: 

    Code Block
    languagego
    func ScanDir(path string, pattern string, recursive ...bool) ([]string, error)


  • 示例:

    Code Block
    languagego
    func ExampleScanDir() {
    	// init
    	var (
    		fileName = "gfile_example.txt"
    		tempDir  = gfile.TempDir("gfile_example_scan_dir")
    		tempFile = gfile.Join(tempDir, fileName)
    
    		tempSubDir  = gfile.Join(tempDir, "sub_dir")
    		tempSubFile = gfile.Join(tempSubDir, fileName)
    	)
    
    	// write contents
    	gfile.PutContents(tempFile, "goframe example content")
    	gfile.PutContents(tempSubFile, "goframe example content")
    
    	// scans directory recursively
    	list, _ := gfile.ScanDir(tempDir, "*", true)
    	for _, v := range list {
    		fmt.Println(gfile.Basename(v))
    	}
    
    	// Output:
    	// gfile_example.txt
    	// sub_dir
    	// gfile_example.txt
    }


ScanDirFile

  • 说明:扫描指定目录的文件,支持递归扫描
  • 格式: 

    Code Block
    languagego
    func ScanDirFile(path string, pattern string, recursive ...bool) ([]string, error)


  • 示例:

    Code Block
    languagego
    func ExampleScanDirFile() {
    	// init
    	var (
    		fileName = "gfile_example.txt"
    		tempDir  = gfile.TempDir("gfile_example_scan_dir_file")
    		tempFile = gfile.Join(tempDir, fileName)
    
    		tempSubDir  = gfile.Join(tempDir, "sub_dir")
    		tempSubFile = gfile.Join(tempSubDir, fileName)
    	)
    
    	// write contents
    	gfile.PutContents(tempFile, "goframe example content")
    	gfile.PutContents(tempSubFile, "goframe example content")
    
    	// scans directory recursively exclusive of directories
    	list, _ := gfile.ScanDirFile(tempDir, "*.txt", true)
    	for _, v := range list {
    		fmt.Println(gfile.Basename(v))
    	}
    
    	// Output:
    	// gfile_example.txt
    	// gfile_example.txt
    }


ScanDirFunc

  • 说明:扫描指定目录(自定义过滤方法),可扫描文件或目录,支持递归扫描
  • 格式: 

    Code Block
    languagego
    func ScanDirFunc(path string, pattern string, recursive bool, handler func(path string) string) ([]string, error)


  • 示例:

    Code Block
    languagego
    func ExampleScanDirFunc() {
    	// init
    	var (
    		fileName = "gfile_example.txt"
    		tempDir  = gfile.TempDir("gfile_example_scan_dir_func")
    		tempFile = gfile.Join(tempDir, fileName)
    
    		tempSubDir  = gfile.Join(tempDir, "sub_dir")
    		tempSubFile = gfile.Join(tempSubDir, fileName)
    	)
    
    	// write contents
    	gfile.PutContents(tempFile, "goframe example content")
    	gfile.PutContents(tempSubFile, "goframe example content")
    
    	// scans directory recursively
    	list, _ := gfile.ScanDirFunc(tempDir, "*", true, func(path string) string {
    		// ignores some files
    		if gfile.Basename(path) == "gfile_example.txt" {
    			return ""
    		}
    		return path
    	})
    	for _, v := range list {
    		fmt.Println(gfile.Basename(v))
    	}
    
    	// Output:
    	// sub_dir
    }


ScanDirFileFunc

  • 说明:扫描指定目录的文件(自定义过滤方法),支持递归扫描。
  • 格式: 

    Code Block
    languagego
    func ScanDirFileFunc(path string, pattern string, recursive bool, handler func(path string) string) ([]string, error) 


  • 示例:

    Code Block
    languagego
    func ExampleScanDirFileFunc() {
    	// init
    	var (
    		fileName = "gfile_example.txt"
    		tempDir  = gfile.TempDir("gfile_example_scan_dir_file_func")
    		tempFile = gfile.Join(tempDir, fileName)
    
    		fileName1 = "gfile_example_ignores.txt"
    		tempFile1 = gfile.Join(tempDir, fileName1)
    
    		tempSubDir  = gfile.Join(tempDir, "sub_dir")
    		tempSubFile = gfile.Join(tempSubDir, fileName)
    	)
    
    	// write contents
    	gfile.PutContents(tempFile, "goframe example content")
    	gfile.PutContents(tempFile1, "goframe example content")
    	gfile.PutContents(tempSubFile, "goframe example content")
    
    	// scans directory recursively exclusive of directories
    	list, _ := gfile.ScanDirFileFunc(tempDir, "*.txt", true, func(path string) string {
    		// ignores some files
    		if gfile.Basename(path) == "gfile_example_ignores.txt" {
    			return ""
    		}
    		return path
    	})
    	for _, v := range list {
    		fmt.Println(gfile.Basename(v))
    	}
    
    	// Output:
    	// gfile_example.txt
    	// gfile_example.txt
    }


常用目录

Pwd

  • 说明:获取当前工作路径。
  • 格式: 

    Code Block
    languagego
    func Pwd() string


  • 示例:

    Code Block
    languagego
    func ExamplePwd() {
    	// Get absolute path of current working directory.
    	fmt.Println(gfile.Pwd())
    
    	// May Output:
    	// xxx/gf/os/gfile
    }


Home

  • 说明:获取运行用户的主目录
  • 格式: 

    Code Block
    languagego
    func Home(names ...string) (string, error) 


  • 示例:

    Code Block
    languagego
    func ExampleHome() {
    	// user's home directory
    	homePath, _ := gfile.Home()
    	fmt.Println(homePath)
    
    	// May Output:
    	// C:\Users\hailaz
    }


Temp

  • 说明:获取拼接系统临时路径后的绝对地址。

  • 格式: 

    Code Block
    languagego
    func Temp(names ...string) string


  • 示例:

    Code Block
    languagego
    func ExampleTempDir() {
    	// init
    	var (
    		fileName = "gfile_example_basic_dir"
    	)
    
    	// fetch an absolute representation of path.
    	path := gfile.Temp(fileName)
    
    	fmt.Println(path)
    
    	// Output:
    	// /tmp/gfile_example_basic_dir
    }


SelfPath

  • 说明:获取当前运行程序的绝对路径。

  • 格式: 

    Code Block
    languagego
    func SelfPath() string 


  • 示例:

    Code Block
    languagego
    func ExampleSelfPath() {
    
    	// Get absolute file path of current running process
    	fmt.Println(gfile.SelfPath())
    
    	// May Output:
    	// xxx/___github_com_gogf_gf_v2_os_gfile__ExampleSelfPath
    }


类型判断

IsDir

  • 说明:检查给定的路径是否是文件夹。
  • 格式: 

    Code Block
    languagego
    func IsDir(path string) bool


  • 示例:

    Code Block
    languagego
    func ExampleIsDir() {
    	// init
    	var (
    		path     = gfile.TempDir("gfile_example_basic_dir")
    		filePath = gfile.Join(gfile.TempDir("gfile_example_basic_dir"), "file1")
    	)
    	// Checks whether given `path` a directory.
    	fmt.Println(gfile.IsDir(path))
    	fmt.Println(gfile.IsDir(filePath))
    
    	// Output:
    	// true
    	// false
    }


IsFile

  • 说明:检查给定的路径是否是文件。
  • 格式: 

    Code Block
    languagego
    func IsFile(path string) bool


  • 示例:

    Code Block
    languagego
    func ExampleIsFile() {
    	// init
    	var (
    		filePath = gfile.Join(gfile.TempDir("gfile_example_basic_dir"), "file1")
    		dirPath  = gfile.TempDir("gfile_example_basic_dir")
    	)
    	// Checks whether given `path` a file, which means it's not a directory.
    	fmt.Println(gfile.IsFile(filePath))
    	fmt.Println(gfile.IsFile(dirPath))
    
    	// Output:
    	// true
    	// false
    }


权限操作

IsReadable

  • 说明:检查给定的路径是否可读。

  • 格式: 

    Code Block
    languagego
    func IsReadable(path string) bool 


  • 示例:

    Code Block
    languagego
    func ExampleIsReadable() {
    	// init
    	var (
    		path = gfile.Pwd() + gfile.Separator + "testdata/readline/file.log"
    	)
    
    	// Checks whether given `path` is readable.
    	fmt.Println(gfile.IsReadable(path))
    
    	// Output:
    	// true
    }


IsWritable

  • 说明:检查指定路径是否可写,如果路径是目录,则会创建临时文件检查是否可写,如果是文件则判断是否可以打开

  • 格式: 

    Code Block
    languagego
    func IsWritable(path string) bool 


  • 示例:

    Code Block
    languagego
    func ExampleIsWritable() {
    	// init
    	var (
    		path = gfile.Pwd() + gfile.Separator + "testdata/readline/file.log"
    	)
    
    	// Checks whether given `path` is writable.
    	fmt.Println(gfile.IsWritable(path))
    
    	// Output:
    	// true
    }


Chmod

  • 说明:使用指定的权限,更改指定路径的文件权限。

  • 格式: 

    Code Block
    languagego
    func Chmod(path string, mode os.FileMode) error


  • 示例:

    Code Block
    languagego
    func ExampleChmod() {
    	// init
    	var (
    		path = gfile.Join(gfile.TempDir("gfile_example_basic_dir"), "file1")
    	)
    
    	// Get a FileInfo describing the named file.
    	stat, err := gfile.Stat(path)
    	if err != nil {
    		fmt.Println(err.Error())
    	}
    	// Show original mode
    	fmt.Println(stat.Mode())
    
    	// Change file model
    	gfile.Chmod(path, gfile.DefaultPermCopy)
    
    	// Get a FileInfo describing the named file.
    	stat, _ = gfile.Stat(path)
    	// Show the modified mode
    	fmt.Println(stat.Mode())
    
    	// Output:
    	// -rw-r--r--
    	// -rwxrwxrwx
    }


文件/目录操作

Mkdir

  • 说明:创建文件夹,支持递归创建(建议采用绝对路径),创建后的文件夹权限为:drwxr-xr-x
  • 格式: 

    Code Block
    languagego
    func Mkdir(path string) error


  • 示例:

    Code Block
    languagego
    func ExampleMkdir() {
    	// init
    	var (
    		path = gfile.TempDir("gfile_example_basic_dir")
    	)
    
    	// Creates directory
    	gfile.Mkdir(path)
    
    	// Check if directory exists
    	fmt.Println(gfile.IsDir(path))
    
    	// Output:
    	// true
    }


Create

  • 说明:创建文件/文件夹,如果传入的路径中的文件夹不存在,则会自动创建文件夹以及文件,其中创建的文件权限为-rw-r–r–
  • 注意:如果需要创建文件的已存在,则会清空该文件的内容!
  • 格式: 

    Code Block
    languagego
    func Create(path string) (*os.File, error)


  • 示例:

    Code Block
    languagego
    func ExampleCreate() {
    	// init
    	var (
    		path     = gfile.Join(gfile.TempDir("gfile_example_basic_dir"), "file1")
    		dataByte = make([]byte, 50)
    	)
    	// Check whether the file exists
    	isFile := gfile.IsFile(path)
    
    	fmt.Println(isFile)
    
    	// Creates file with given `path` recursively
    	fileHandle, _ := gfile.Create(path)
    	defer fileHandle.Close()
    
    	// Write some content to file
    	n, _ := fileHandle.WriteString("hello goframe")
    
    	// Check whether the file exists
    	isFile = gfile.IsFile(path)
    
    	fmt.Println(isFile)
    	
    	// Reset file uintptr
    	unix.Seek(int(fileHandle.Fd()), 0, 0)
    	// Reads len(b) bytes from the File
    	fileHandle.Read(dataByte)
    
    	fmt.Println(string(dataByte[:n]))
    
    	// Output:
    	// false
    	// true
    	// hello goframe
    }


Open

  • 说明:以只读的方式打开文件/文件夹。
  • 格式: 

    Code Block
    languagego
    func Open(path string) (*os.File, error)


  • 示例:

    Code Block
    languagego
    func ExampleOpen() {
    	// init
    	var (
    		path     = gfile.Join(gfile.TempDir("gfile_example_basic_dir"), "file1")
    		dataByte = make([]byte, 4096)
    	)
    	// Open file or directory with READONLY model
    	file, _ := gfile.Open(path)
    	defer file.Close()
    
    	// Read data
    	n, _ := file.Read(dataByte)
    
    	fmt.Println(string(dataByte[:n]))
    
    	// Output:
    	// hello goframe
    }


OpenFile

  • 说明:以指定`flag`以及`perm`的方式打开文件/文件夹。
  • 格式: 

    Code Block
    languagego
    func OpenFile(path string, flag int, perm os.FileMode) (*os.File, error)


  • 示例:

    Code Block
    languagego
    func ExampleOpenFile() {
    	// init
    	var (
    		path     = gfile.Join(gfile.TempDir("gfile_example_basic_dir"), "file1")
    		dataByte = make([]byte, 4096)
    	)
    	// Opens file/directory with custom `flag` and `perm`
    	// Create if file does not exist,it is created in a readable and writable mode,prem 0777
    	openFile, _ := gfile.OpenFile(path, os.O_CREATE|os.O_RDWR, gfile.DefaultPermCopy)
    	defer openFile.Close()
    
    	// Write some content to file
    	writeLength, _ := openFile.WriteString("hello goframe test open file")
    
    	fmt.Println(writeLength)
    
    	// Read data
    	unix.Seek(int(openFile.Fd()), 0, 0)
    	n, _ := openFile.Read(dataByte)
    
    	fmt.Println(string(dataByte[:n]))
    
    	// Output:
    	// 28
    	// hello goframe test open file
    }


OpenWithFalg

  • 说明:以指定`flag`的方式打开文件/文件夹。
  • 格式: 

    Code Block
    languagego
    func OpenWithFlag(path string, flag int) (*os.File, error)


  • 示例:

    Code Block
    languagego
    func ExampleOpenWithFlag() {
    	// init
    	var (
    		path     = gfile.Join(gfile.TempDir("gfile_example_basic_dir"), "file1")
    		dataByte = make([]byte, 4096)
    	)
    
    	// Opens file/directory with custom `flag`
    	// Create if file does not exist,it is created in a readable and writable mode with default `perm` is 0666
    	openFile, _ := gfile.OpenWithFlag(path, os.O_CREATE|os.O_RDWR)
    	defer openFile.Close()
    
    	// Write some content to file
    	writeLength, _ := openFile.WriteString("hello goframe test open file with flag")
    
    	fmt.Println(writeLength)
    
    	// Read data
    	unix.Seek(int(openFile.Fd()), 0, 0)
    	n, _ := openFile.Read(dataByte)
    
    	fmt.Println(string(dataByte[:n]))
    
    	// Output:
    	// 38
    	// hello goframe test open file with flag
    }


OpenWithFalgPerm

  • 说明:以指定`flag`以及`perm`的方式打开文件/文件夹。
  • 格式: 

    Code Block
    languagego
    func OpenWithFlagPerm(path string, flag int, perm os.FileMode) (*os.File, error) 


  • 示例:

    Code Block
    languagego
    func ExampleOpenWithFlagPerm() {
    	// init
    	var (
    		path     = gfile.Join(gfile.TempDir("gfile_example_basic_dir"), "file1")
    		dataByte = make([]byte, 4096)
    	)
    
    	// Opens file/directory with custom `flag` and `perm`
    	// Create if file does not exist,it is created in a readable and writable mode with  `perm` is 0777
    	openFile, _ := gfile.OpenWithFlagPerm(path, os.O_CREATE|os.O_RDWR, gfile.DefaultPermCopy)
    	defer openFile.Close()
    
    	// Write some content to file
    	writeLength, _ := openFile.WriteString("hello goframe test open file with flag and perm")
    
    	fmt.Println(writeLength)
    
    	// Read data
    	unix.Seek(int(openFile.Fd()), 0, 0)
    	n, _ := openFile.Read(dataByte)
    
    	fmt.Println(string(dataByte[:n]))
    
    	// Output:
    	// 38
    	// hello goframe test open file with flag
    }


Stat

  • 说明:获取给定路径的文件详情。
  • 格式: 

    Code Block
    languagego
    func Stat(path string) (os.FileInfo, error)


  • 示例:

    Code Block
    languagego
    func ExampleStat() {
    	// init
    	var (
    		path = gfile.Join(gfile.TempDir("gfile_example_basic_dir"), "file1")
    	)
    	// Get a FileInfo describing the named file.
    	stat, _ := gfile.Stat(path)
    
    	fmt.Println(stat.Name())
    	fmt.Println(stat.IsDir())
    	fmt.Println(stat.Mode())
    	fmt.Println(stat.ModTime())
    	fmt.Println(stat.Size())
    	fmt.Println(stat.Sys())
    
    	// May Output:
    	// file1
    	// false
    	// -rwxr-xr-x
    	// 2021-12-02 11:01:27.261441694 +0800 CST
    	// &{16777220 33261 1 8597857090 501 20 0 [0 0 0 0] {1638414088 192363490} {1638414087 261441694} {1638414087 261441694} {1638413480 485068275} 38 8 4096 0 0 0 [0 0]}
    }


Copy

  • 说明:支持复制文件或目录
  • 格式: 

    Code Block
    languagego
    func Copy(src string, dst string) error 


  • 示例:

    Code Block
    languagego
    func ExampleCopy() {
    	// init
    	var (
    		srcFileName = "gfile_example.txt"
    		srcTempDir  = gfile.TempDir("gfile_example_copy_src")
    		srcTempFile = gfile.Join(srcTempDir, srcFileName)
    
    		// copy file
    		dstFileName = "gfile_example_copy.txt"
    		dstTempFile = gfile.Join(srcTempDir, dstFileName)
    
    		// copy dir
    		dstTempDir = gfile.TempDir("gfile_example_copy_dst")
    	)
    
    	// write contents
    	gfile.PutContents(srcTempFile, "goframe example copy")
    
    	// copy file
    	gfile.Copy(srcTempFile, dstTempFile)
    
    	// read contents after copy file
    	fmt.Println(gfile.GetContents(dstTempFile))
    
    	// copy dir
    	gfile.Copy(srcTempDir, dstTempDir)
    
    	// list copy dir file
    	fList, _ := gfile.ScanDir(dstTempDir, "*", false)
    	for _, v := range fList {
    		fmt.Println(gfile.Basename(v))
    	}
    
    	// Output:
    	// goframe example copy
    	// gfile_example.txt
    	// gfile_example_copy.txt
    }


CopyFile

  • 说明:复制文件
  • 格式: 

    Code Block
    languagego
    func CopyFile(src, dst string) (err error)


  • 示例:

    Code Block
    languagego
    func ExampleCopyFile() {
    	// init
    	var (
    		srcFileName = "gfile_example.txt"
    		srcTempDir  = gfile.TempDir("gfile_example_copy_src")
    		srcTempFile = gfile.Join(srcTempDir, srcFileName)
    
    		// copy file
    		dstFileName = "gfile_example_copy.txt"
    		dstTempFile = gfile.Join(srcTempDir, dstFileName)
    	)
    
    	// write contents
    	gfile.PutContents(srcTempFile, "goframe example copy")
    
    	// copy file
    	gfile.CopyFile(srcTempFile, dstTempFile)
    
    	// read contents after copy file
    	fmt.Println(gfile.GetContents(dstTempFile))
    	
    	// Output:
    	// goframe example copy
    }


CopyDir

  • 说明:支持复制文件或目录
  • 格式: 

    Code Block
    languagego
    func CopyDir(src string, dst string) error 
    说明:替换指定文件的指定内容为新内容


  • 示例:

    Code Block
    languagego
    func ExampleReplaceFileExampleCopyDir() {
    	// init
    	var (
    		srcTempDir  = gfile.TempDir("gfile_example_copy_src")
    		
    		// copy file
    		dstFileName = "gfile_example_copy.txt"
    	fileName := "123.txt"
    	tempDir :		dstTempFile = gfile.Join(srcTempDir, dstFileName)
    
    		// copy dir
    		dstTempDir = gfile.TempDir("gfile_example_copy_replacedst")
    	)
    	tempFile := gfile.Join(tempDir, fileName)
    
    	gfile.Mkdir(tempDir)
    	gfile.Create(tempFile// read contents after copy file
    	fmt.Println(gfile.GetContents(dstTempFile))
    
    	// writecopy contentsdir
    	gfile.PutContentsCopyDir(tempFilesrcTempDir, "test contents"dstTempDir)
    
    	// list copy readdir contentsfile
    	contentfList, _ := gfile.GetContents(tempFile)
    	fmt.Println(content)
    
    	gfile.ReplaceFileScanDir("test"dstTempDir, "replace word*", tempFilefalse)
    
    	content1	for _, v := gfile.GetContents(tempFile) range fList {
    		fmt.Println(content1)(gfile.Basename(v))
    	}
    
    	// Output:
    	// test contentsgfile_example.txt
    	// replace word contents
    }

ReplaceFileFunc

  • gfile_example_copy.txt
    }


Move

  • 说明:将src重命名为dst

  • 注意:如果dst已经存在并且是文件,将会被替换造成数据丢失!
  • 格式: 

    Code Block
    languagego
    func Move(src string, dst string) error 
    说明:使用自定义函数替换指定文件内容


  • 示例:

    Code Block
    languagego
    func 
  • ExampleReplaceFileFunc
  • ExampleMove() {
    	// init
    	
  • fileName := "123.txt" tempDir :=
  • var (
    		srcPath = gfile.Join(gfile.TempDir("gfile_example
  • _replace
  • _basic_dir"), "file1")
    	
  • tempFile
  • 	dstPath 
  • :
  • = gfile.Join(
  • tempDir, fileName)
  • gfile.
  • Mkdir(tempDir) gfile.Create(tempFile) // write contents gfile.PutContents(tempFile, "666 test contents 888 a1a2a3")
  • TempDir("gfile_example_basic_dir"), "file2")
    	)
    	// 
  • read contents content := gfile.GetContents(tempFile)
  • Check is file
    	fmt.Println
  • (content
  • (gfile.IsFile(dstPath))
    
    	// 
  • 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
  • Moves `src` to `dst` path.
    	// If `dst` already exists and is not a directory, it'll be replaced.
    	gfile.Move(srcPath, dstPath)
    
    	fmt.Println(gfile.IsFile(srcPath))
    	fmt.Println
  • (content1
  • (gfile.IsFile(dstPath))
    
    	// Output:
    	// 
  • 666 test contents 888 a1a2a3
  • false
    	// false
    	//
  • [num] test contents [num] a1a2a3 }

ReplaceDir

  •  true
    }


Rename

  • 说明:Move的别名,将src重命名为dst

  • 注意:如果dst已经存在并且是文件,将会被替换造成数据丢失!
  • 格式: 

    Code Block
    languagego
    func Rename(src string, dst string) error
    说明:扫描指定目录,替换符合条件的文件的指定内容为新内容


  • 示例:

    Code Block
    languagego
    func 
  • ExampleReplaceDir
  • ExampleRename() {
    	// init
    	
  • fileName := "123.txt" tempDir :
  • var (
    		srcPath = gfile.Join(gfile.TempDir("gfile_example_basic_
  • replace") tempFile := gfile.Join(tempDir, fileName) tempSubDir := gfile.Join(tempDir
  • dir"), "
  • sub_dir
  • file2")
    	
  • tempSubFile
  • 	dstPath 
  • :
  • = 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")
  • gfile.TempDir("gfile_example_basic_dir"), "file1")
    	)
    	// 
  • read contents content := gfile.GetContents(tempFile)
  • Check is file
    	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
  • (gfile.IsFile(dstPath))
    
    	//  renames (moves) `src` to `dst` path.
    	// If `dst` already exists and is not a directory, it'll be replaced.
    	gfile.Rename(srcPath, dstPath)
    
    	fmt.Println(gfile.IsFile(srcPath))
    	fmt.Println(
  • contentSub1
  • gfile.IsFile(dstPath))
    
    	// Output:
    	// 
  • test contents
  • false
    	// 
  • test contents
  • false
    	// 
  • replace word contents // replace word contents }

ReplaceDirFunc

  • true
    }


Remove

  • 说明:删除给定路径的文件或文件夹。

  • 格式: 

    Code Block
    languagego
    func Remove(path string) error


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

    Code Block
    languagego
    func 
  • ExampleReplaceDirFunc
  • ExampleRemove() {
    	// init
    	
  • fileName := "123.txt" tempDir :
  • var (
    		path = gfile.Join(gfile.TempDir("gfile_example
  • _replace
  • _basic_dir"), "file1")
    	
  • 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
  • // Checks whether given `path` a file, which means it's not a directory.
    	fmt.Println(gfile.IsFile(path))
    
    	// deletes all file/directory with `path` parameter.
    	gfile.Remove(path)
    
    	// 
  • write
  • Check 
  • contents
  • again
    	fmt.Println(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
  • IsFile(path))
    
    	// Output:
    	// true
    	// false
    }


IsEmpty

  • 说明:检查给定的路径,如果是文件夹则检查是否包含文件,如果是文件则检查文件大小是否为空。

  • 格式: 

    Code Block
    languagego
    func IsEmpty(path string) bool 


  • 示例:

    Code Block
    languagego
    func ExampleIsEmpty() {
    	// init
    	var (
    		path = gfile.Join(gfile.TempDir("gfile_example_basic_dir"), "file1")
    	)
    
    	// Check whether the `path` is empty
    	fmt.Println(gfile.IsEmpty(path))
    
    	// Truncate file
    	gfile.Truncate(path, 0)
    
    	// 
  • read contents content1 := gfile.GetContents(tempFile)
  • Check whether the `path` is empty
    	fmt.Println(
  • content1) contentSub1 :=
  • gfile.
  • GetContents
  • IsEmpty(
  • tempSubFile) fmt.Println(contentSub1
  • path))
    
    	// Output:
    	// 
  • 666 test contents 888 a1a2a3
  • false
    	// 
  • 666 test contents 888 a1a2a3 // [num] test contents [num] a1a2a3 // [num] test contents [num] a1a2a3 }

修改时间

MTime

  • true
    }


DirNames

  • 说明:获取给定路径下的文件列表,返回的是一个切片。

  • 格式: 

    Code Block
    languagego
    func DirNames(path string) ([]string, error)
    说明:获取路径修改时间


  • 示例:

    Code Block
    languagego
    func 
  • ExampleMTime
  • ExampleDirNames() {
    	
  • t :
  • // init
    	var (
    		path = gfile.
  • MTime
  • TempDir(
  • gfile.TempDir()
  • "gfile_example_basic_dir")
    	
  • fmt.Println(t
  • )
  • 
    	// 
  • May Output: // 2021-11-02 15:18:43.901141 +0800 CST }

ExampleMTimestamp

  • 说明:获取路径修改时间戳(秒)
  • 示例:

    Code Block
    languagego
    func ExampleMTimestamp() { t := gfile.MTimestamp(gfile.TempDir())
  • Get sub-file names of given directory `path`.
    	dirNames, _ := gfile.DirNames(path)
    
    	fmt.Println(
  • t
  • dirNames)
    
    	// May Output:
    	// 
  • 1635838398
  • [file1]
    }
ExampleMTimestampMilli

Glob

  • 说明:获取路径修改时间戳(毫秒)

    说明:模糊搜索给定路径下的文件列表,支持正则,第二个参数控制返回的结果是否带上绝对路径。

  • 示例:
  • 格式: 

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

大小

Size

  • 说明:获取路径大小
    pattern string, onlyNames ...bool) ([]string, error)


  • 示例:

    Code Block
    languagego
    func 
  • ExampleSize
  • ExampleGlob() {
    	
  • tempDir := gfile.TempDir("gfile_example") gfile.Mkdir(tempDir) size :
  • // init
    	var (
    		path = gfile.
  • Size
  • Pwd(
  • tempDir) fmt.Println(size)
  • ) + gfile.Separator + "*_example_basic_test.go"
    	)
    	//
  • Output:
  •  Get sub-file names of given directory `path`.
    	// 
  • 0 }

SizeFormat

  • 说明:获取路径大小,并格式化
  • 示例:

    Code Block
    languagego
    func ExampleSizeFormat() { tempDir
  • Only show file name
    	matchNames, _ := gfile.
  • TempDir("gfile_example") gfile.Mkdir(tempDir) sizeStr :
  • Glob(path, true)
    
    	fmt.Println(matchNames)
    
    	// Show full path of the file
    	matchNames, _ = gfile.
  • SizeFormat(tempDir
  • Glob(path, false)
    
    	fmt.Println(
  • sizeStr
  • matchNames)
    
    	// May Output:
    	// [gfile_z_example_basic_test.go]
    	// 
  • 0.00B }

ReadableSize

  • [xxx/gf/os/gfile/gfile_z_example_basic_test.go]
    }


Exists

  • 说明:检查给定的路径是否存在 。
  • 格式: 

    Code Block
    languagego
    func Exists(path string) bool


  • 说明:获取路径大小,并格式化人类易读
  • 示例:

    Code Block
    languagego
    func 
  • ExampleReadableSize
  • ExampleExists() {
    	
  • tempDir :=
  • // init
    	var (
    		path = gfile.Join(gfile.TempDir("gfile_example_basic_dir"), "file1")
    	
  • gfile.Mkdir(tempDir
  • )
    	
  • sizeStr := gfile.ReadableSize(tempDir)
  • // Checks whether given `path` exist.
    	fmt.Println(
  • sizeStr
  • gfile.Exists(path))
    
    	// Output:
    	// 
  • 0.00B
  • true
    }

StrToSize


Chdir

  • 说明:使用给定的路径,更改当前的工作路径。
  • 格式: 

    Code Block
    languagego
    func Chdir(dir string) error
    说明:大小字符串转换为大小整形


  • 示例:

    Code Block
    languagego
    func 
  • ExampleStrToSize
  • ExampleChdir() {
    	
  • size := gfile.StrToSize("100MB")
  • // init
    	var (
    		path = gfile.Join(gfile.TempDir("gfile_example_basic_dir"), "file1")
    	)
    	// Get current working directory
    	fmt.Println(gfile.Pwd(
  • size
  • ))
    
    	// 
  • Output: // 104857600 }

FormatSize

  • 说明:大小整形转换为大小字符串
  • 示例:

    Code Block
    languagego
    func ExampleFormatSize() { sizeStr := gfile.FormatSize(104857600) fmt.Println(sizeStr) sizeStr1 := gfile.FormatSize(999999999999999999)
  • Changes the current working directory to the named directory.
    	gfile.Chdir(path)
    
    	// Get current working directory
    	fmt.Println(
  • sizeStr1
  • gfile.Pwd())
    
    	// May Output:
    	// 
  • 100.00M
  • xxx/gf/os/gfile
    	// 
  • 888.18P
  • /tmp/gfile_example_basic_dir/file1
    }
排序

路径操作

SortFiles

Join

  • 说明:将多个字符串路径通过`/`进行连接。
  • 格式: 

  • 说明:排序多个路径
  • 示例:
  • Code Block
    languagego
    func 
  • ExampleSortFiles() { files := []string{ "/aaa/bbb/ccc.txt", "/aaa/bbb/", "/aaa/", "/aaa", "/aaa/ccc/ddd.txt", "/bbb", "/0123", "/ddd", "/ccc", } sortOut
  • Join(paths ...string) string 


  • 示例:

    Code Block
    languagego
    func ExampleJoin() {
    	// init
    	var (
    		dirPath  = gfile.TempDir("gfile_example_basic_dir")
    		filePath = "file1"
    	)
    
    	// Joins string array paths with file separator of current system.
    	joinString := gfile.
  • SortFiles(files)
  • Join(dirPath, filePath)
    
    	fmt.Println(
  • sortOut
  • joinString)
    
    	// Output:
    	// 
  • [
  • /
  • 0123 /aaa /aaa/ /aaa/bbb/ /aaa/bbb/ccc.txt /aaa/ccc/ddd.txt /bbb /ccc /ddd] }

搜索

  • tmp/gfile_example_basic_dir/file1
    }


Abs

  • 说明:返回路径的绝对路径。

  • 格式: 

    Code Block
    languagego
    func Abs(path string) string
    说明:在指定目录(默认包含当前目录、运行目录、主函数目录;不会递归子目录)中搜索文件并返回真实路径


  • 示例:

    Code Block
    languagego
    func 
  • ExampleSearch
  • ExampleAbs() {
    	// init
    	
  • fileName := "123.txt" tempDir :
  • var (
    		path = gfile.Join(gfile.TempDir("gfile_example_basic_dir")
  • tempFile := gfile.Join(tempDir
  • , 
  • fileName
  • "file1")
    	
  • gfile.Mkdir(tempDir
  • )
    
  • gfile.Create(tempFile)
  • 
    	// Get 
  • search file realPath, _ := gfile.Search(fileName, tempDir)
  • an absolute representation of path.
    	fmt.Println(gfile.
  • Basename
  • Abs(
  • realPath
  • path))
    
    	// Output:
    
  • // 123.txt }

扫描目录

ScanDir

  • 	// /tmp/gfile_example_basic_dir/file1
    }


RealPath

  • 说明:获取给定路径的绝对路径地址。

  • 注意:如果文件不存在则返回空。

  • 格式: 

    Code Block
    languagego
    func RealPath(path string) string
    说明:扫描指定目录,可扫描文件或目录,支持递归扫描


  • 示例:

    Code Block
    languagego
    func 
  • ExampleScanDir
  • ExampleRealPath() {
    	// init
    	
  • fileName := "123.txt" tempDir :=
  • var (
    		realPath  = gfile.Join(gfile.TempDir("gfile_example_basic_dir"), "file1")
    		
  • tempFile
  • worryPath 
  • :
  • = gfile.Join(
  • tempDir, fileName) tempSubDir :=
  • gfile.
  • Join(tempDir
  • TempDir("gfile_example_basic_dir"), "
  • sub_dir
  • worryFile")
    	
  • 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 {
  • )
    
    	// fetch an absolute representation of path.
    	fmt.Println(gfile.RealPath(realPath))
    	fmt.Println(gfile.RealPath(worryPath))
    
    	// Output:
    	// /tmp/gfile_example_basic_dir/file1
    	//
    }


SelfName

  • 说明:获取当前运行程序的名称。

  • 格式: 

    Code Block
    languagego
    func SelfName() string 


  • 示例:

    Code Block
    languagego
    func ExampleSelfName() {
    
    	// Get file name of current running process
    	fmt.Println(gfile.
  • Basename
  • SelfName(
  • v
  • ))
  • }
  • 
    
    	// May Output:
    	// 
  • 123.txt // sub_dir // 123.txt }

ScanDirFile

  • ___github_com_gogf_gf_v2_os_gfile__ExampleSelfName
    }


Basename

  • 说明:获取给定路径中的最后一个元素,包含扩展名。

  • 格式: 

    Code Block
    languagego
    func Basename(path string) string
    说明:扫描指定目录的文件,支持递归扫描


  • 示例:

    Code Block
    languagego
    func 
  • ExampleScanDirFile
  • ExampleBasename() {
    	// init
    	
  • fileName := "123.txt" tempDir :
  • var (
    		path = gfile.
  • TempDir
  • Pwd(
  • "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 {
  • Separator + "testdata/readline/file.log"
    	)
    
    	// Get the last element of path, which contains file extension.
    	fmt.Println(gfile.Basename(path))
    
    	// Output:
    	// file.log
    }


Name

  • 说明:获取给定路径中的最后一个元素,不包含扩展名。

  • 格式:

    Code Block
    languagego
    func Name(path string) string


  • 示例:

    Code Block
    languagego
    func ExampleName() {
    	// init
    	var (
    		path = gfile.Pwd() + gfile.Separator + "testdata/readline/file.log"
    	)
    
    	// Get the last element of path without file extension.
    	fmt.Println(gfile.
  • Basename
  • Name(
  • v
  • path))
  • }
  • 
    
    	// Output
  • : // 123.txt
  • :
    	// 
  • 123.txt
  • file
    }

ScanDirFunc


Dir

  • 说明:获取给定路径的目录部分,排除最后的元素。

  • 格式: 

    Code Block
    languagego
    func Dir(path string) string 
    说明:扫描指定目录(自定义过滤方法),可扫描文件或目录,支持递归扫描


  • 示例:

    Code Block
    languagego
    func 
  • ExampleScanDirFunc
  • ExampleDir() {
    	// init
    	
  • fileName := "123.txt" fileName1 := "1234.txt" tempDir :=
  • var (
    		path = gfile.Join(gfile.TempDir("gfile_example_
  • 1
  • basic_dir"), "file1")
    	
  • 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
  • // Get all but the last element of path, typically the path's directory.
    	fmt.Println(gfile.Dir(path))
    
    	// 
  • scans directory recursively
  • Output:
    	
  • list, _ := gfile.ScanDirFunc(tempDir, "123.txt,1234.txt,sub_dir", true, func
  • // /tmp/gfile_example_basic_dir
    }


Ext

  • 说明:获取给定路径的扩展名,包含`.`。

  • 格式: 

    Code Block
    languagego
    func Ext(path string) string


  • 示例:

    Code Block
    languagego
    func ExampleExt() {
    	
  • // 
  • ignores some files
  • init
    	var (
    		
  • if
  • path = gfile.
  • Basename
  • Pwd(
  • path
  • ) 
  • ==
  • + 
  • "1234
  • gfile.
  • txt" { return "
  • Separator + "testdata/readline/file.log"
    	
  • }
  • )
    
    	
  • return path }) for _, v := range list {
  • // Get the file name extension used by path.
    	fmt.Println(gfile.
  • Basename
  • Ext(
  • v
  • path))
  • }
  • 
    
    	// Output:
    	// 
  • 123.txt // sub_dir
  • .log
    }

ScanDirFileFunc


ExtName

  • 说明:获取给定路径的扩展名,不包含`.`。

  • 格式:  

    Code Block
    languagego
    func ExtName(path string) string
    说明:扫描指定目录的文件(自定义过滤方法),支持递归扫描


  • 示例:

    Code Block
    languagego
    func 
  • ExampleScanDirFileFunc
  • ExampleExtName() {
    	// init
    	
  • fileName := "123.txt" fileName1 := "1234.txt" tempDir := gfile.TempDir("gfile_example_1") tempFile :
  • var (
    		path = gfile.
  • Join
  • Pwd(
  • tempDir, fileName
  • )
  • tempSubDir :=
  •  + gfile.
  • Join(tempDir, "sub_dir") tempSubFile := gfile.Join(tempSubDir, fileName1) gfile.Mkdir(tempSubDir) gfile.Create(tempFile) gfile.Create(tempSubFile
  • Separator + "testdata/readline/file.log"
    	)
    
    	// Get the file name extension used by path but the result does not contains symbol '.'.
    	fmt.Println(gfile.ExtName(path))
    
    	// 
  • 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 }
  • Output:
    	// log
    }


MainPkgPath

  • 说明:获取main文件(主入口)所在的绝对路径,。

  • 注意:
    • 该方法仅在开发环境中可用,同时仅在源代码开发环境中有效,build二进制后将显示源代码的路径地址。
    • 第一次调用该方法时,如果处于异步的goroutine中,可能会无法获取主包的路径
  • 格式:  

    Code Block
    languagego
    func MainPkgPath() string


  • 示例:

    Code Block
    languagego
    func Test() {
    	fmt.Println("main pkg path on main :", gfile.MainPkgPath())
    	char := make(chan int, 1)
    	go func() {
    		fmt.Println("main pkg path on goroutine :", gfile.MainPkgPath())
    		char <- 1
    	}()
    	select {
    	case <-char:
    	}
    	// Output:
    	// /xxx/xx/xxx/xx
    	// /xxx/xx/xxx/xx
    }
    // 二进制包
    $ ./testDemo 
    main pkg path on main : /xxx/xx/xxx/xx
    main pkg path on goroutine : /xxx/xx/xxx/xx
    
    








Panel
titleContent Menu

Table of Contents