Go语言系列之标准库os

Posted 2020-12-11 zhangyafei

os包提供了操作系统的系列函数，这些接口不依赖平台。设计为Unix风格的，错误处理是go风格的；调用失败会返回错误值而非错误码。通常错误值里包含更多信息。

os包的接口在所有操作系统中都是一致的。非公用的属性可以从操作系统特定的syscall包获取。

一、操作系统基本命令

1. 相关方法

func Getwd() (dir string, err error) // 获取当前工作目录的根路径
func Chdir(dir string) error // 将工作目录修改为dir
func Chmod(name string, mode FileMode) error // 修改name文件或文件夹的权限（对应linux的chmod命令）
func Chown(name string, uid, gid int) error // 修改name文件或文件夹的用户和组（对应linux的chmod命令）
func Mkdir(name string, perm FileMode) error // 使用指定的权限和名称创建一个文件夹（对于linux的mkdir命令）
func MkdirAll(path string, perm FileMode) error // 使用指定的权限和名称创建一个文件夹，并自动创建父级目录（对于linux的mkdir -p目录）
func Rename(oldpath, newpath string) error // 修改一个文件或文件夹的文字（对应linux的mv命令）
func Remove(name string) error // 删除指定的文件夹或者目录  ,不能递归删除，只能删除一个空文件夹或一个文件（对应linux的 rm命令）

func RemoveAll(path string) error // 递归删除文件夹或者文件（对应linux的rm -rf命令）

2. 示例代码

func main() {
	// 为了减少代码的篇幅，基本所有的错误在这篇文字里面我都丢弃
	wd, _ := os.Getwd()
	println("获取当前工作目录的根路径:", wd)

	_ = os.Chdir(path.Join(wd, "go_os/demo1"))
	w, _ := os.Getwd()
	println("获取x修改后的当前工作目录的根路径:", w)

	_ = os.MkdirAll("dirs/dir1", 0777)
	_ = os.Mkdir("dirs/dir2", 0777)
	_ = os.Rename("dirs/dir1", "dirs/dir3")
	_ = os.Remove("dirs/dir2")
	_ = os.RemoveAll("dirs")

}

二、创建、写入、打开、读取文件

1. 相关方法

func Create(name string) (file *File, err error) // 创建一个空文件，注意当文件已经存在时，会直接覆盖掉原文件，不会报错
func Open(name string) (file *File, err error) // 打开一个文件,注意打开的文件只能读，不能写
func OpenFile(name string, flag int, perm FileMode) (file *File, err error) // 以指定的权限打开文件

2. 创建和写入文件

func main() {
	wd, _ := os.Getwd()
	file, _ := os.Create(wd + "/go_os/demo1/1.txt")
	defer file.Close()
	println(file.Name())
	file_info,_ := file.Stat()
	fmt.Println(file_info)
	_,_ = file.Write([]byte("hello world！
"))
	_,_ = file.WriteString("张亚飞")
}

3. 追加文件

func main()  {
	wd, _ := os.Getwd()
	f, err := os.OpenFile(wd + "/go_os/demo1/1.txt", os.O_RDWR|os.O_CREATE|os.O_APPEND, 0644)
	defer f.Close()
	if err != nil {
		// 打开文件失败处理
		fmt.Println(err)
		return

	}
	content := "
写入的文件内容"
	_,_ = f.Write([]byte(content))
}

4. 读取文件

func main(){
	wd, _ := os.Getwd()
	file, _ := os.Open(wd + "/go_os/demo1/1.txt")
	defer file.Close() // 不要忘记关闭文件
	b := make([]byte, 4) // 文件内容不多，我们一次性读4个字节，多读几次，不一次性读完
	var str string
	for {
		n, err := file.Read(b)
		if err != nil {
			if err == io.EOF { // EOF表示文件读取完毕
				break // 退出
			}
		}
		str += string(b[:n]) // 保存文件内容
	}
	println(str) // 打印文件
}

5. 查看文件信息

func main()  {
	wd, _ := os.Getwd()

	file, _ := os.Open(wd + "/go_os/demo1/1.txt") // 以只读的方式打开文件
	defer file.Close() // 不要忘记关闭文件
	// 获取文件的信息
	fInfo, _ := file.Stat()
	println("是否是一个目录:", fInfo.IsDir())
	println("文件的修改时间:", fInfo.ModTime().String())
	println("文件的名字:", fInfo.Name())
	println("文件的大小:", fInfo.Size())
	println("文件的权限:", fInfo.Mode().String())
	/*
	是否是一个目录: false
	文件的修改时间: 2020-06-17 09:52:05.7987495 +0800 CST
	文件的名字: 1.txt
	文件的大小: 24
	文件的权限: -rw-rw-rw-
	*/
}

三、获取操作系统信息

1. 相关方法

func Hostname() (name string, err error) // 获取主机名
func Getenv(key string) string // 获取某个环境变量
func Setenv(key, value string) error // 设置一个环境变量,失败返回错误，经测试当前设置的环境变量只在 当前进程有效（当前进程衍生的所以的go程都可以拿到，子go程与父go程的环境变量可以互相获取）；进程退出消失
func Clearenv() // 删除当前程序已有的所有环境变量。不会影响当前电脑系统的环境变量，这些环境变量都是对当前go程序而言的
func Exit(code int) // 让当前程序以给出的状态码（code）退出。一般来说，状态码0表示成功，非0表示出错。程序会立刻终止，defer的函数不会被执行。
func Getuid() int // 获取调用者的用户id
func Geteuid() int // 获取调用者的有效用户id
func Getgid() int // 获取调用者的组id
func Getegid() int // 获取调用者的有效组id
func Getgroups() ([]int, error) // 获取调用者所在的所有组的组id
func Getpid() int // 获取调用者所在进程的进程id
func Getppid() int // 获取调用者所在进程的父进程的进程id

2. 代码实现

func main()  {
	hostname, _ := os.Hostname()
	println("获取主机名,", hostname)

	println("获取gopath环境变量:", os.Getenv("GOPATH"))

	_ = os.Setenv("test", "test") // 设置环境变量
	println("获取上一步设置的test环境变量:", os.Getenv("test"))

	os.Clearenv() // 清除当前程序的所以环境变量
	println("获取清理后的环境变量test和GOPATH:", os.Getenv("test"), os.Getenv("GOPATH"))

	println("获取调用者的用户id", os.Getuid())
	println("获取调用者的有效用户id", os.Geteuid())
	println("获取调用者的组id", os.Getgid())
	println("获取调用者的有效组id", os.Getegid())

	sli, _ := os.Getgroups()
	println("获取调用者所在的所有组的组id", sli) //

	println("获取调用者所在进程的进程id", os.Getpid())
	println("获取调用者所在进程的父进程的进程id", os.Getppid())
	/*
	获取主机名, home-fei
	获取gopath环境变量: E:goproject
	获取上一步设置的test环境变量: test
	获取清理后的环境变量test和GOPATH:
	获取调用者的用户id -1
	获取调用者的有效用户id -1
	获取调用者的组id -1
	获取调用者的有效组id -1
	获取调用者所在的所有组的组id [0/0]0x0
	获取调用者所在进程的进程id 4968
	获取调用者所在进程的父进程的进程id 11588
	 */
}

四、其他

1. 相关方法

Exit() // 退出系统进程
func IsPathSeparator(c uint8) bool // 判断字c是否是一个路径分隔符
func IsExist(err error) bool // 判断一个错误是否表示一个文件或文件夹是否已存在，ErrExist和一些系统调用错误会使它返回真。
func IsNotExist(err error) bool // 判断一个错误是否表示一个文件或文件夹是否不存在，ErrNotExist和一些系统调用错误会使它返回真。
func IsPermission(err error) bool // 判断一个错误是否表示权限不足，ErrPermission和一些系统调用错误会使它返回真。

2. 示例代码

func exit()  {
	// 模拟条件
	if 1 != 2 {
		println("程序启动失败，xxx条件不满足！")
		os.Exit(1)
	}
	println("程序启动成功！")
}
// 程序启动失败，xxx条件不满足！

func os_path()  {
	print("判断 / \ : 是否是路径分隔符: ")
	println(os.IsPathSeparator(‘/‘), os.IsPathSeparator(‘\‘), os.IsPathSeparator(‘:‘))
}
// 判断 /  : 是否是路径分隔符: true true false

五、常用函数

1. 判断文件或目录是否存在

func main() {
	filePath := "E:/go"
	exist, err := PathIsExist(filePath)
	if err != nil{
		fmt.Printf("PathIsExists(%s),err(%v)
", filePath, err)
	}
	if exist {
		fmt.Printf("path %s 存在
",filePath)
	} else {
		fmt.Printf("path %s 不存在
", filePath)
		err := os.Mkdir(filePath, os.ModePerm)
		if err != nil {
			fmt.Printf("mkdir failed![%v]
", err)
		} else {
			fmt.Printf("mkdir success!
")
		}
	}
}

/*
   判断文件或文件夹是否存在
   如果返回的错误为nil,说明文件或文件夹存在
   如果返回的错误类型使用os.IsNotExist()判断为true,说明文件或文件夹不存在
   如果返回的错误为其它类型,则不确定是否在存在
*/
func PathIsExist(filePath string) (bool, error) {
	_, err := os.Stat(filePath)
	if err == nil { return true, nil }
	if os.IsNotExist(err) { return false, nil }
	return false, err
}

2. 循环创建文件夹

func CreateDir(dirs ...string) (err error) {
	for _, v := range dirs {
		exist, err := PathIsExist(v)
		if err != nil {
			log.Println(fmt.Sprintf("get dir error![%v]
", err))
			return err
		}
		if exist {
			log.Println(fmt.Sprintf("has dir![%v]
", v))
		} else {
			log.Println(fmt.Sprintf("no dir![%v]
", v))
			// 创建文件夹
			err = os.Mkdir(v, os.ModePerm)
			if err != nil {
				log.Println(fmt.Sprintf("mkdir error![%v]
",err))
			} else {
				log.Println("mkdir success!
")
			}
		}
	}
	return err
}