Golang优雅访问协程上下文信息的高性能插件库routine的使用

routine库封装并提供了一些易于使用、非竞争、高性能的goroutine上下文访问接口，可以帮助您更优雅地访问协程上下文信息。

介绍

Golang语言从一开始设计就极力避免开发者接触协程上下文的概念，包括获取协程goid、协程在进程中的状态、协程上下文的存储等。routine的核心目标是为Golang世界引入goroutine local storage。

安装

go get github.com/timandy/routine

使用示例

获取协程ID(goid)

package main

import (
	"fmt"
	"time"

	"github.com/timandy/routine"
)

func main() {
	goid := routine.Goid()
	fmt.Printf("当前协程ID: %v\n", goid)
	go func() {
		goid := routine.Goid()
		fmt.Printf("子协程ID: %v\n", goid)
	}()

	// 等待子协程执行完成
	time.Sleep(time.Second)
}

输出结果：

当前协程ID: 1
子协程ID: 6

使用ThreadLocal

package main

import (
	"fmt"
	"time"

	"github.com/timandy/routine"
)

var threadLocal = routine.NewThreadLocal[string]()
var inheritableThreadLocal = routine.NewInheritableThreadLocal[string]()

func main() {
	threadLocal.Set("hello world")
	inheritableThreadLocal.Set("Hello world2")
	fmt.Println("threadLocal:", threadLocal.Get())
	fmt.Println("inheritableThreadLocal:", inheritableThreadLocal.Get())

	// 子协程无法读取之前赋值的"hello world"
	go func() {
		fmt.Println("goroutine中的threadLocal:", threadLocal.Get())
		fmt.Println("goroutine中的inheritableThreadLocal:", inheritableThreadLocal.Get())
	}()

	// 通过Go/GoWait/GoWaitResult函数启动新的子协程，可以自动传递当前协程的所有可继承变量
	routine.Go(func() {
		fmt.Println("通过Go启动的goroutine中的threadLocal:", threadLocal.Get())
		fmt.Println("通过Go启动的goroutine中的inheritableThreadLocal:", inheritableThreadLocal.Get())
	})

	// 也可以通过WrapTask/WrapWaitTask/WrapWaitResultTask函数创建任务，自动捕获当前协程的所有可继承变量
	task := routine.WrapTask(func() {
		fmt.Println("通过WrapTask创建的任务中的threadLocal:", threadLocal.Get())
		fmt.Println("通过WrapTask创建的任务中的inheritableThreadLocal:", inheritableThreadLocal.Get())
	})
	go task.Run()

	// 等待子协程执行完成
	time.Sleep(time.Second)
}

输出结果：

threadLocal: hello world
inheritableThreadLocal: Hello world2
goroutine中的threadLocal: 
goroutine中的inheritableThreadLocal: 
通过Go启动的goroutine中的threadLocal: 
通过Go启动的goroutine中的inheritableThreadLocal: Hello world2
通过WrapTask创建的任务中的threadLocal: 
通过WrapTask创建的任务中的inheritableThreadLocal: Hello world2

主要API

Goid() uint64

获取当前goroutine的ID

NewThreadLocalT any ThreadLocal[T]

创建新的ThreadLocal实例，初始值为类型T的零值

NewThreadLocalWithInitial[T any](supplier Supplier[T]) ThreadLocal[T]

创建新的ThreadLocal实例，初始值为supplier()方法的返回值

NewInheritableThreadLocalT any ThreadLocal[T]

创建新的可继承ThreadLocal实例，初始值为类型T的零值

NewInheritableThreadLocalWithInitial[T any](supplier Supplier[T]) ThreadLocal[T]

创建新的可继承ThreadLocal实例，初始值为supplier()方法的返回值

WrapTask(fun Runnable) FutureTask[any]

创建新任务并捕获当前goroutine的inheritableThreadLocals

WrapWaitTask(fun CancelRunnable) FutureTask[any]

创建新任务并捕获当前goroutine的inheritableThreadLocals

WrapWaitResultTask[TResult any](fun CancelCallable[TResult]) FutureTask[TResult]

创建新任务并捕获当前goroutine的inheritableThreadLocals

Go(fun Runnable)

启动新协程并自动复制当前协程的所有上下文inheritableThreadLocals数据

GoWait(fun CancelRunnable) FutureTask[any]

启动新协程并自动复制当前协程的所有上下文inheritableThreadLocals数据

GoWaitResult[TResult any](fun CancelCallable[TResult]) FutureTask[TResult]

启动新协程并自动复制当前协程的所有上下文inheritableThreadLocals数据

垃圾回收

routine为每个协程分配一个thread结构，存储与协程相关的上下文变量信息。当协程执行完成并退出时，g.labels将被设置为nil，不再引用thread结构。thread结构将在下一次GC时被回收。