Golang 可选字段辅助工具 - pointer 库使用指南

在 Go 语言中，处理可选字段时通常需要使用指针类型，但直接使用指针语法会让代码变得冗长。pointer 库是一个简化基本类型可选字段创建的辅助工具，它可以帮助我们更简洁地创建基本类型的指针。

安装 pointer 库

go get github.com/AlekSi/pointer

基本使用方法

pointer 库提供了 To 系列函数来创建各种基本类型的指针：

package main

import (
	"fmt"
	"github.com/AlekSi/pointer"
)

func main() {
	// 创建各种基本类型的指针
	intPtr := pointer.ToInt(42)
	floatPtr := pointer.ToFloat64(3.14)
	stringPtr := pointer.ToString("hello")
	boolPtr := pointer.ToBool(true)
	
	fmt.Println(*intPtr)    // 输出: 42
	fmt.Println(*floatPtr)  // 输出: 3.14
	fmt.Println(*stringPtr) // 输出: hello
	fmt.Println(*boolPtr)   // 输出: true
}

主要功能

1. 创建指针

pointer 库支持所有基本类型的指针创建：

// 整数类型
i8 := pointer.ToInt8(8)
i16 := pointer.ToInt16(16)
i32 := pointer.ToInt32(32)
i64 := pointer.ToInt64(64)

// 无符号整数类型
u8 := pointer.ToUint8(8)
u16 := pointer.ToUint16(16)
u32 := pointer.ToUint32(32)
u64 := pointer.ToUint64(64)

// 浮点数
f32 := pointer.ToFloat32(3.14)
f64 := pointer.ToFloat64(3.1415926)

// 其他类型
str := pointer.ToString("golang")
b := pointer.ToBool(true)
t := pointer.ToTime(time.Now())

2. 获取指针值或默认值

package main

import (
	"fmt"
	"github.com/AlekSi/pointer"
)

func main() {
	var nilInt *int
	
	// 获取指针值，如果为nil则返回默认值
	v1 := pointer.GetInt(nilInt)       // 返回 0
	v2 := pointer.GetInt(nilInt, 42)   // 返回 42
	
	fmt.Println(v1, v2)
}

3. 比较指针值

package main

import (
	"fmt"
	"github.com/AlekSi/pointer"
)

func main() {
	a := pointer.ToInt(10)
	b := pointer.ToInt(10)
	c := pointer.ToInt(20)
	
	fmt.Println(pointer.Equal(a, b)) // true
	fmt.Println(pointer.Equal(a, c)) // false
}

4. 解引用指针

package main

import (
	"fmt"
	"github.com/AlekSi/pointer"
)

func main() {
	var nilInt *int
	val := pointer.Deref(nilInt, 100) // 如果nilInt为nil，返回100
	
	fmt.Println(val) // 输出: 100
}

实际应用示例

结构体中的可选字段

package main

import (
	"fmt"
	"github.com/AlekSi/pointer"
)

type User struct {
	ID        int
	Name      string
	Age       *int      // 可选字段
	IsActive  *bool     // 可选字段
	LastLogin *string   // 可选字段
}

func main() {
	// 创建用户，只设置必填字段
	user1 := User{
		ID:   1,
		Name: "Alice",
	}
	
	// 创建用户，设置所有字段
	user2 := User{
		ID:        2,
		Name:      "Bob",
		Age:       pointer.ToInt(30),
		IsActive:  pointer.ToBool(true),
		LastLogin: pointer.ToString("2023-01-01"),
	}
	
	fmt.Printf("%+v\n", user1)
	fmt.Printf("%+v\n", user2)
	
	// 安全访问可选字段
	age := pointer.GetInt(user1.Age, -1) // 返回-1，因为Age是nil
	fmt.Println("Alice's age:", age)
}

JSON 序列化/反序列化

package main

import (
	"encoding/json"
	"fmt"
	"github.com/AlekSi/pointer"
)

type Config struct {
	Host     string
	Port     *int    `json:"port,omitempty"`
	Timeout  *int    `json:"timeout,omitempty"`
	Debug    *bool   `json:"debug,omitempty"`
}

func main() {
	// 序列化
	cfg := Config{
		Host:    "localhost",
		Port:    pointer.ToInt(8080),
		Debug:   pointer.ToBool(false),
		// Timeout 保持nil
	}
	
	data, _ := json.MarshalIndent(cfg, "", "  ")
	fmt.Println(string(data))
	
	// 反序列化
	jsonStr := `{"host":"example.com","timeout":30}`
	var cfg2 Config
	json.Unmarshal([]byte(jsonStr), &cfg2)
	
	fmt.Printf("%+v\n", cfg2)
	fmt.Println("Port is set:", cfg2.Port != nil) // false
	fmt.Println("Timeout:", pointer.GetInt(cfg2.Timeout)) // 30
}

总结

pointer 库的主要优点：

1. 简化了基本类型指针的创建语法
2. 提供了安全的指针解引用方法
3. 支持指针值的比较
4. 特别适合处理结构体中的可选字段
5. 与 JSON 序列化/反序列化配合良好

相比直接使用 & 操作符创建指针，pointer 库的代码更清晰易读，特别是在处理大量可选字段时能显著提高代码的可维护性。