介紹Go 標準庫 os 常用導出函數,結構體及其方法。
import os
os 包提供了不依賴平臺的操作系統函數接口。錯誤處理設計為go 風格,失敗的調用會返回錯誤值而非錯誤碼。通常錯誤值里包含更多信息。
1. os 常用導出函數
-
func Hostname() (name string, err error)
// Hostname返回內核提供的主機名 -
func Environ() []string
// Environ返回表示環境變量的格式為"key=value"的字符串的切片拷貝 -
func Getenv(key string) string
// Getenv檢索并返回名為key的環境變量的值 -
func Getpid() int
// Getpid返回調用者所在進程的進程ID -
func Exit(code int)
// Exit讓當前程序以給出的狀態碼code退出。一般來說,狀態碼0表示成功,非0表示出錯。程序會立刻終止,defer的函數不會被執行 -
func Stat(name string) (fi FileInfo, err error)
// 獲取文件信息 -
func Getwd() (dir string, err error)
// Getwd返回一個對應當前工作目錄的根路徑 -
func Mkdir(name string, perm FileMode) error
// 使用指定的權限和名稱創建一個目錄 -
func MkdirAll(path string, perm FileMode) error
// 使用指定的權限和名稱創建一個目錄,包括任何必要的上級目錄,并返回nil,否則返回錯誤 -
func Remove(name string) error
// 刪除name指定的文件或目錄 -
func TempDir() string
// 返回一個用于保管臨時文件的默認目錄 -
var Args []string
Args保管了命令行參數,第一個是程序名。
$GOPATH/src/github.com/ironxu/go_note/library/os/os.go
源碼如下:
// go 標準庫 os
package main
import (
"fmt"
"os"
)
func main() {
// 預定義變量, 保存命令行參數
fmt.Println(os.Args)
// 獲取host name
fmt.Println(os.Hostname())
fmt.Println(os.Getpid())
// 獲取全部環境變量
env := os.Environ()
for k, v := range env {
fmt.Println(k, v)
}
// 終止程序
// os.Exit(1)
// 獲取一條環境變量
fmt.Println(os.Getenv("PATH"))
// 獲取當前目錄
dir, err := os.Getwd()
fmt.Println(dir, err)
// 創建目錄
err = os.Mkdir(dir+"/new_file", 0755)
fmt.Println(err)
// 創建目錄
err = os.MkdirAll(dir+"/new", 0755)
fmt.Println(err)
// 刪除目錄
err = os.Remove(dir + "/new_file")
err = os.Remove(dir + "/new")
fmt.Println(err)
// 創建臨時目錄
tmp_dir := os.TempDir()
fmt.Println(tmp_dir)
}
2. File 結構體
-
func Create(name string) (file *File, err error)
// Create采用模式0666(任何人都可讀寫,不可執行)創建一個名為name的文件,如果文件已存在會截斷它(為空文件) -
func Open(name string) (file *File, err error)
// Open打開一個文件用于讀取。如果操作成功,返回的文件對象的方法可用于讀取數據;對應的文件描述符具有O_RDONLY模式 -
func (f *File) Stat() (fi FileInfo, err error)
// Stat返回描述文件f的FileInfo類型值 -
func (f *File) Readdir(n int) (fi []FileInfo, err error)
// Readdir讀取目錄f的內容,返回一個有n個成員的[]FileInfo,這些FileInfo是被Lstat返回的,采用目錄順序 -
func (f *File) Read(b []byte) (n int, err error)
// Read方法從f中讀取最多len(b)字節數據并寫入b -
func (f *File) WriteString(s string) (ret int, err error)
// 向文件中寫入字符串 -
func (f *File) Sync() (err error)
// Sync遞交文件的當前內容進行穩定的存儲。一般來說,這表示將文件系統的最近寫入的數據在內存中的拷貝刷新到硬盤中穩定保存 -
func (f *File) Close() error
// Close關閉文件f,使文件不能用于讀寫
$GOPATH/src/github.com/ironxu/go_note/library/os/file.go
源碼如下:
// go 標準庫 os.File
package main
import (
"fmt"
"os"
"time"
)
func main() {
// 獲取當前目錄
dir, err := os.Getwd()
fmt.Println(dir, err)
file := dir + "/new"
var fh *os.File
fi, _ := os.Stat(file)
if fi == nil {
fh, _ = os.Create(file) // 文件不存在就創建
} else {
fh, _ = os.OpenFile(file, os.O_RDWR, 0666) // 文件存在就打開
}
w := []byte("hello go language" + time.Now().String())
n, err := fh.Write(w)
fmt.Println(n, err)
// 設置下次讀寫位置
ret, err := fh.Seek(0, 0)
fmt.Println("當前文件指針位置", ret, err)
b := make([]byte, 128)
n, err = fh.Read(b)
fmt.Println(n, err, string(b))
fh.Close()
}
3. FileInfo 結構體
FileInfo用來描述一個文件對象
結構體定義:
type FileInfo interface {
Name() string // base name of the file
Size() int64 // length in bytes for regular files; system-dependent for others
Mode() FileMode // file mode bits
ModTime() time.Time // modification time
IsDir() bool // abbreviation for Mode().IsDir()
Sys() interface{} // underlying data source (can return nil)
}
-
func Stat(name string) (fi FileInfo, err error)
// Stat 返回描述文件的FileInfo。如果指定的文件對象是一個符號鏈接,返回的FileInfo描述該符號鏈接指向的文件的信息,本函數會嘗試跳轉該鏈接 -
func Lstat(name string) (fi FileInfo, err error)
// Lstat 返回描述文件對象的FileInfo。如果指定的文件對象是一個符號鏈接,返回的FileInfo描述該符號鏈接的信息,本函數不會試圖跳轉該鏈接。
使用示例:
fi, _ := os.Stat(file)
if fi == nil {
fh, _ = os.Create(file) // 文件不存在就創建
} else {
fh, _ = os.OpenFile(file, os.O_RDWR, 0666) // 文件存在就打開
}
參考
可以關注我的微博了解更多信息: