GoFrame入门教程 GoFrame 唯一数-guid

2024-02-25 开发教程 GoFrame入门教程匿名 3℃

guid提供了更简便更高性能的唯一数生成功能。

guid模块的设计目的在于提供一种使用更简便、性能更高效且能满足绝大多数业务场景的唯一数生成。guid的设计比较简单，详情可参考实现源码。

使用方式：

import "github.com/gogf/gf/v2/util/guid"

接口文档：

https://pkg.go.dev/github.com/gogf/gf/v2/util/guid

基本介绍

guid通过S方法生成32字节的唯一数，该方法定义如下：

func S(data ...[]byte) string

1、通过不带任何参数的方式使用，该方法生成的唯一数将会有以下方式构成：

MAC(7) + PID(4) + TimestampNano(12) + Sequence(3) + RandomString(6)

其中：

MAC表示当前机器的MAC地址哈希值，由7个字节构成；
PID表示当前机器的进程ID哈希值，由4个字节构成；
TimestampNano表示当前的纳秒时间戳哈希值，由12个字节构成；
Sequence表示当前进程并发安全的序列号，由3个字节构成；
RandomString表示随机数，由6个字节构成；

2、通过自定义任何参数的方式使用，该方法生成的唯一数将会有以下方式构成：

Data(7/14) + TimestampNano(12) + Sequence(3) + RandomString(3/10)

主要说明：

Data表示自定义的参数，参数类型为[]byte，最多支持2个参数输入，由7或14个字节构成；
需要注意的是，输入的自定义参数需要在业务上具有一定的唯一识别性，使得生成的唯一数更有价值；
不管每一个[]byte参数长度为多少，最终都将通过哈希方式生成7个字节的哈希值。
TimestampNano表示当前的纳秒时间戳哈希值，由12个字节构成；
Sequence表示当前进程并发安全的序列号，由3个字节构成；
RandomString表示随机数，由3或者10个字节构成，即:
- 如果给定1个自定义参数，那么剩余的字节将会使用随机数占位，长度为10个字节；
- 如果给定2个自定义参数，那么剩余的字节将会使用随机数占位，长度为3个字节；

示例1，基本使用

package main
import (
	"fmt"
	"github.com/gogf/gf/v2/util/guid"
)
func main() {
	fmt.Printf("TraceId: %s", guid.S())
}

执行后，输出结果为：

TraceId: oa9sdw03dk0c35q9bdwcnz42p00trwfr

示例2，自定义参数

我们的SessionId生成需要具有比较好的唯一性，且需要防止轻易的碰撞，因此可以使用以下方式：

func CreateSessionId(r *ghttp.Request) string {
    var (
        address = request.RemoteAddr
        header  = fmt.Sprintf("%v", request.Header)
    )
    return guid.S([]byte(address), []byte(header))
}

可以看到，SessionId需要依靠自定义的两个输入参数RemoteAddr, Header来生成，这两个参数在业务上具有一定的唯一识别性，且通过guid.S方法的设计构成，生成的唯一数将会非常随机且唯一，既满足了业务需要也保证了安全。

上一节： GoFrame 随机数-grand

下一节： GoFrame 元数据-gmeta

"GoFrame入门教程"的目录

GoFrame入门教程 GoFrame 唯一数-guid

基本介绍

示例1，基本使用

示例2，自定义参数