实践中所用到的go的原生包的一些操作的相关记录｜ 青训营笔记

这篇博客主要是为了记录自己在实践中遇到的一些包的相关API的使用，主要是为了给自己以后能回来看一下怎么用，等整理的足够多了将再进行一次分类，分享出来大家可以看一下这些基本操作，共勉。

Contex包

ctx, cancel := context.WithCancel(context.Background())

在Go语言中，context包提供了一种机制，用于在不同的Goroutine之间传递请求作用域和取消信号。context.WithCancel函数是context包中的一个函数，用于创建一个新的带有取消功能的Context对象。

context.WithCancel函数的定义如下：

func WithCancel(parent Context) (ctx Context, cancel CancelFunc)

该函数接收一个parent参数，表示新创建的Context对象的父Context对象。函数返回两个值：一个新的Context对象和一个用于取消该Context对象的CancelFunc函数。

下面是一个使用context.WithCancel函数创建新的Context对象并取消它的示例代码：

package main

import (
	"context"
	"fmt"
	"time"
)

func main() {
	// 创建一个带有取消功能的Context对象
	ctx, cancel := context.WithCancel(context.Background())

	// 启动一个Goroutine，模拟一个长时间运行的任务
	go func() {
		for {
			select {
			case <-ctx.Done(): // 如果Context对象被取消，则退出循环
				fmt.Println("Task cancelled")
				return
			default: // 如果Context对象未被取消，则继续执行任务
				fmt.Println("Task running")
				time.Sleep(1 * time.Second)
			}
		}
	}()

	// 等待5秒钟后取消Context对象
	time.Sleep(5 * time.Second)
	cancel()
	fmt.Println("Context cancelled")
}

在这个例子中，我们首先使用context.Background函数创建了一个基础的Context对象，然后使用context.WithCancel函数创建一个带有取消功能的Context对象，并返回一个CancelFunc函数用于取消该对象。接着，我们启动一个Goroutine，模拟一个长时间运行的任务，该任务会在每秒钟输出一次"Task running"，并检查Context对象是否被取消，如果被取消，则退出循环。然后，我们等待5秒钟后调用cancel函数来取消Context对象，并输出"Context cancelled"。

当我们运行该程序时，会看到以下输出：

Task running
Task running
Task running
Task running
Task running
Context cancelled
Task cancelled

可以看到，在取消Context对象后，Goroutine退出了循环，并输出了"Task cancelled"。

os包

os.UserHomeDir()

os.UserHomeDir() 是 Go 语言标准库中的一个函数，用于获取当前用户的主目录路径。该函数在不同的操作系统中具有不同的实现，可以自动适应 Windows、Linux 和 macOS 等操作系统。

例如，在 Linux 系统中，os.UserHomeDir() 返回当前用户的主目录路径，例如 /home/user；在 Windows 系统中，os.UserHomeDir() 返回类似于 C:\Users\UserName 的路径。

以下是一个示例，展示了如何使用 os.UserHomeDir() 函数来获取当前用户的主目录路径：

import (
    "fmt"
    "os"
)

func main() {
    homeDir, err := os.UserHomeDir()
    if err != nil {
        panic(err)
    }
    fmt.Println("Home directory:", homeDir)
}

在这个示例中，我们使用 os.UserHomeDir() 函数获取当前用户的主目录路径，并将其打印到控制台上。如果获取主目录路径时发生错误，程序将会抛出一个异常。

func (file *File) Stat() (FileInfo, error)

这是一个Go语言的方法，用于获取文件的元信息。具体来说，该方法会返回一个FileInfo接口类型的值，该值包含了文件的名称、大小、修改时间等元信息。如果操作成功，则该方法会返回FileInfo和nil；如果操作失败，则返回nil和一个非nil的error。

该方法的函数签名如下：

func (file *File) Stat() (FileInfo, error)

其中，File是一个类型，代表一个文件；FileInfo是一个接口类型，用于描述文件的元信息；error是一个类型，用于表示错误信息。

例如，在以下示例中，我们可以使用Stat方法获取一个文件的元信息：

package main

import (
    "fmt"
    "os"
)

func main() {
    // 打开一个文件
    file, err := os.Open("example.txt")
    if err != nil {
        fmt.Println(err)
        return
    }
    // 获取文件的元信息
    fileInfo, err := file.Stat()
    if err != nil {
        fmt.Println(err)
        return
    }
    // 打印文件的元信息
    fmt.Println("File name:", fileInfo.Name())
    fmt.Println("File size:", fileInfo.Size())
    fmt.Println("File mode:", fileInfo.Mode())
    fmt.Println("Modification time:", fileInfo.ModTime())
}

在该示例中，我们先打开一个文件，然后使用Stat方法获取文件的元信息，并最终打印出这些元信息。