os.File

Go标准库os包提供了操纵操作系统的能力

对于文件和目录的操作,Go提供两种类型分别是os.File结构和os.FileInfo接口。

type File struct {
    *file // os specific
}

os.File代表一个打开的文件对象句柄,即文件描述符。

os.File类型代表了操作系统中的文件,在UNIX操作系统中一切都是文件,比如文本文件、二进制文件、压缩文件、目录、符号连接、物理设备、命名管道、套接字等。

os.File类型拥有的都是指针方法,指针实现了很多io包中的接口。对于io包中最核心的三个接口io.Readerio.Writerio.Closer*os.File类型都实现了。

os.File类型机器指针类型的值,不但可以通过各种方式来读写文件内容,还可以寻找并设定下一次读写的起始索引位置,此外还可以随时对文件进行关闭。

要操作文件就需要先获取os.File类型的指针值,os包提供了4个获取指针值的函数。

函数 返回 描述
os.Create *os.File 覆盖式创建
os.NewFile *os.File 创建文件
os.Open *os.File 打开文件
os.OpenFile *os.File 打开文件

os.Create

func Create(name string) (*File, error) {
    return OpenFile(name, O_RDWR|O_CREATE|O_TRUNC, 0666)
}

os.Create()的函数原型是OpenFile(name, O_RDWR|O_CREATE|O_TRUNC, 0666),以可读写、可创建、内容清空的方式创建指定名称的文件。

文件标志位 描述
O_RDWR 以读写模式打开文件
O_CREATE 若文件不存在则创建全新文件
O_TRUNC 若可能打开时清空文件
  • os.Create()会根据给定的路径创建一个全新的文件,返回*os.File和错误值。通过返回值*os.File可以对相应文件进行读写操作。
  • 使用os.Create()创建的文件,对操作系统中所有用户都是可读写的。
  • os.Create()采用0666(任何人都可读可写不可执行)权限模式来创建文件

文件路径

  • 若给定路径的文件已存在,则会先清空现有文件中的内容,再将文件的*os.File返回。
  • 若路径不存在则会返回一个*os.PathError类型的错误值。

创建结果

  • 创建成功,会返回文件对象用于I/O操作,对应的文件描述符具有O_RDWR模式。
  • 创建失败,错误原因可能是路径不存在、权限不足、打开文件数量超过上限、磁盘空间不足等,错误底层类型为*PathError

例如:创建一个文件

tmpdir := os.TempDir()
filename := filepath.Join(tmpdir, "test.log")

file, err := os.Create(filename)
defer file.Close()
if err != nil {
    log.Fatalln(err)
}
fmt.Printf("%+v\n", file) //&{file:0xc00011e780}

file.WriteString("hello world")

buf, err := os.ReadFile(filename)
if err != nil {
    log.Fatalln(err)
}
fmt.Printf("%s\n", buf) //hello world

defer os.Remove(filename)

文件打开

os.Open

os.Open会打开一个文件用来读取

  • 若打开成功则会返回文件对象,对应的文件描述符具有O_RDONLY只读模式,使用返回的文件对象可用于读取数据。
  • 若打开出错,返回的错误对象底层类型为*PathError
func Open(name string) (*File, error) {
    return OpenFile(name, O_RDONLY, 0)
}

os.OpenFile

  • os.OpenFile是相对底层的文件打开函数,使用时建议优先采用os.Openos.Create
  • os.OpenFile支持使用指定模式和权限打开文件,打开成功则返回文件描述符可用于I/O,
func OpenFile(name string, flag int, perm FileMode) (*File, error) {
    testlog.Open(name)
    f, err := openFileNolog(name, flag, perm)
    if err != nil {
        return nil, err
    }
    f.appendMode = flag&O_APPEND != 0

    return f, nil
}
参数 描述
name 文件名称,若不在当前路径下运行则需添加具体路径。
flag 打开标记/打开方式/文件处理参数
perm 权限控制,Windows无效。

打开标记 flag

打开标记 描述
O_RDONLY 以只读模式打开文件
O_WRONLY 以只写模式打开文件
O_RDWR 以读写模式打开文件
O_APPEND 以追加模式打开文件,即写操作时将数据附加到文件末尾。
O_CREATE 若文件不存在则创建
O_EXCL 与O_CREATE配合用于新建文件,文件必须不存在有效,若文件存在则出错。
O_SYNC 以同步方式打开,不使用缓存直接写入磁盘,在一系列写操作时每次都要等待上次I/O操作完成后才能再继续。
O_TRUNC 打开时清空文件
打开标记 描述
os.O_WRONLY|os.O_CREATE|os.O_EXCL 若文件已存在则打开失败
os.O_WRONLY|os.O_CREATE 若文件已存在则覆盖式写入,不会清空原文件,而是从头直接覆盖写入。
os.O_WRONLY|os.O_CREATE|os.O_APPEND 若文件已存在则向尾部添加来写入

权限控制 perm

os.FileMode代表文件模式和权限位,不同字位在所有操作系统中都具有相同的含义,因此文件信息可以在不同操作系统之间安全移植。但并不是所有位都能用于所有的操作系统,唯一共有的是用于表示目录的ModeDir位。

文件权限 描述
os.ModeDir 文件夹模式
os.ModeAppend 追加模式
os.ModeExclusive 单独使用
os.ModeTemporary 临时文件
os.ModeSymlink 象征性的关联
os.ModeDevice 设备文件
os.NamePipe 命令管道
os.ModeSocket UNIX主机套接字
os.ModeSetuid 设置uid
os.ModeSetgid 设置gid
os.ModeCharDevice UNIX字符设备,当设备模式为set时。
os.ModeSticky 粘性模式
os.Irregular 非常规模式
os.ModeType 比特位覆盖
os.ModePerm 权限位

例如:创建文件并追加内容

//创建文件并追加内容
func FileAppend(name string, content string) (int, error){
    f,err := os.OpenFile(name, os.O_CREATE|os.O_RDWR|os.O_APPEND, os.ModeAppend | os.ModePerm)
    if err!=nil {
        return 0,err
    }
    defer f.Close()

    n,err := f.WriteString(content)
    if err!=nil{
        return 0, err
    }
    return n, nil
}
func main(){
    n,err := FileAppend("file.txt", "hello world")
    if err!=nil {
        fmt.Println(err)
        return
    }
    fmt.Println(n)
}

例如:同时创建多级目录和其下的文件

//同时创建多级目录及其下文件
func Mkfile(dirpath string, filename string, content string) error {
    err := os.MkdirAll(dirpath, os.ModePerm)
    log.Println(1, err)
    if err!=nil {
        return err
    }

    filename = path.Join(dirpath, filename)
    f,err := os.OpenFile(filename, os.O_RDWR|os.O_CREATE|os.O_TRUNC, 0666)
    log.Println(2, err)
    defer f.Close()
    if err!=nil {
        return err
    }

    _,err = f.WriteString(content)
    log.Println(3, err)
    if err!=nil {
        return err
    }

    return nil
}

关闭文件 os.Close

os.Close()用于关闭文件描述符,使文件不能读写。

func (f *File) Close() error {
    if f == nil {
        return ErrInvalid
    }
    return f.file.close()
}

文件存在

os.IsNotExist

os.IsNotExists()接收一个错误对象来判断一个文件或目录是否不存在,最终返回布尔值。

func IsNotExist(err error) bool

例如:判断文件是否存在

//判断文件是否存在
func FileExists(file string) bool {
    _,err := os.Stat(file)
    if os.IsNotExist(err) {
        return false
    }
    return true
}

os.IsExist

os.IsExists()接收一个错误对象来判断一个文件或目录是否存在,最终返回布尔值。

func IsExist(err error) bool

例如:判断文件是否存在

//判断文件是否存在
func FileExists(file string) bool {
    if _,err := os.Stat(file); os.IsExist(err) {
        return true
    }
    return false
}
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,015评论 4 362
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,262评论 1 292
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,727评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,986评论 0 205
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,363评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,610评论 1 219
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,871评论 2 312
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,582评论 0 198
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,297评论 1 242
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,551评论 2 246
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,053评论 1 260
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,385评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,035评论 3 236
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,079评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,841评论 0 195
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,648评论 2 274
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,550评论 2 270

推荐阅读更多精彩内容