types

package
v0.19.4 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 1, 2026 License: Apache-2.0, Apache-2.0 Imports: 18 Imported by: 0

Documentation

Overview

* @Author: kamalyes 501893067@qq.com * @Date: 2026-07-30 00:00:00 * @LastEditors: kamalyes 501893067@qq.com * @LastEditTime: 2026-07-30 00:00:00 * @FilePath: \go-toolbox\pkg\sqlbuilder\types\compressed.go * @Description: 数据库压缩存储类型——字段级透明 gzip 压缩，多 DB 方言适配 * * Copyright (c) 2025 by kamalyes, All Rights Reserved.

* @Author: kamalyes 501893067@qq.com * @Date: 2025-11-11 00:00:00 * @LastEditors: kamalyes 501893067@qq.com * @LastEditTime: 2026-05-08 15:00:00 * @FilePath: \go-toolbox\pkg\sqlbuilder\types\helpers.go * @Description: 内部辅助函数 * * Copyright (c) 2025 by kamalyes, All Rights Reserved.

* @Author: kamalyes 501893067@qq.com * @Date: 2025-11-11 00:00:00 * @LastEditors: kamalyes 501893067@qq.com * @LastEditTime: 2026-05-08 15:05:00 * @FilePath: \go-toolbox\pkg\sqlbuilder\types\json.go * @Description: JSON - 泛型 JSON 类型，支持任意可序列化类型的数据库存储 * * Copyright (c) 2025 by kamalyes, All Rights Reserved.

* @Author: kamalyes 501893067@qq.com * @Date: 2025-11-11 00:00:00 * @LastEditors: kamalyes 501893067@qq.com * @LastEditTime: 2026-05-08 15:15:19 * @FilePath: \go-toolbox\pkg\sqlbuilder\types\map_any.go * @Description: MapAny - 任意类型 Map，支持数据库 JSON 序列化 * * Copyright (c) 2025 by kamalyes, All Rights Reserved.

* @Author: kamalyes 501893067@qq.com * @Date: 2026-07-25 00:00:00 * @LastEditors: kamalyes 501893067@qq.com * @LastEditTime: 2026-07-25 00:00:00 * @FilePath: \go-toolbox\pkg\sqlbuilder\types\optional.go * @Description: Optional[T] - 通用可选值容器，支持 nil-safe 链式操作 * * Copyright (c) 2026 by kamalyes, All Rights Reserved.

* @Author: kamalyes 501893067@qq.com * @Date: 2026-05-09 00:00:00 * @LastEditors: kamalyes 501893067@qq.com * @LastEditTime: 2026-05-11 12:57:50 * @FilePath: \go-toolbox\pkg\sqlbuilder\types\proto_json.go * @Description: ProtoJSON - 泛型 protobuf JSON 类型，支持 protobuf 消息的数据库存储 * * Copyright (c) 2026 by kamalyes, All Rights Reserved.

* @Author: kamalyes 501893067@qq.com * @Date: 2025-11-11 00:00:00 * @LastEditors: kamalyes 501893067@qq.com * @LastEditTime: 2026-05-08 15:00:00 * @FilePath: \go-toolbox\pkg\sqlbuilder\types\slice.go * @Description: Slice - 泛型切片类型，支持数据库 JSON 序列化 * * Copyright (c) 2025 by kamalyes, All Rights Reserved.

* @Author: kamalyes 501893067@qq.com * @Date: 2025-11-11 00:00:00 * @LastEditors: kamalyes 501893067@qq.com * @LastEditTime: 2026-05-08 15:00:00 * @FilePath: \go-toolbox\pkg\sqlbuilder\types\string_slice.go * @Description: StringSlice - 字符串切片，支持数据库 JSON 序列化和分隔符解析 * * Copyright (c) 2025 by kamalyes, All Rights Reserved.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func MapAnyToJSONString 

func MapAnyToJSONString(payload MapAny) string

MapAnyToJSONString 将 MapAny 转换为 JSON 字符串

func MapAnyToStruct 

func MapAnyToStruct(payload MapAny) *structpb.Struct

MapAnyToStruct 将 MapAny 转换为 structpb.Struct

func MapAnyToStructTarget 

func MapAnyToStructTarget(m MapAny, target interface{}) error

MapAnyToStructTarget 将 MapAny 转换为 Go struct target 必须是指针类型

func MapJSON 

func MapJSON[T any, U any](j JSON[T], fn func(T) *U) *U

MapJSON 当 Data 非 nil 时应用转换函数，返回 *U Data 为 nil 时返回 nil；fn 内部可返回 nil 主动中断链路 适用于链式访问嵌套指针字段，配合 MapPtr 实现深层取值 （命名为 MapJSON 是为避免与 slice.go 中 Slice 的 Map 函数冲突）

示例（单层）： 

fb := types.MapJSON(agentLine.Tracking, func(t *TrackingConfig) *FacebookConfig {
    return t.Facebook
})
if fb != nil {
    params.TrackID = fb.PixelId
}

注：Go 方法不支持额外类型参数，因此以泛型函数形式提供

func MapPtr 

func MapPtr[T any, U any](ptr *T, fn func(*T) *U) *U

MapPtr 对普通指针 *T 应用转换函数，返回 *U ptr 为 nil 时返回 nil；fn 接收 *T（指针）便于调用指针接收者方法 fn 内部可返回 nil 主动中断链路 用于在 MapJSON 之后继续链式穿透嵌套指针字段

示例（深层链式：Tracking → Facebook → PixelId）： 

fb := types.MapJSON(agentLine.Tracking, func(t *TrackingConfig) *FacebookConfig {
    return t.Facebook
})
pixel := types.MapPtr(fb, func(f *FacebookConfig) *string {
    return types.Ptr(f.PixelId)
})
if pixel != nil {
    params.TrackID = *pixel
}

func Ptr 

func Ptr[T any](v T) *T

Ptr 取值的地址，便于在 Map/MapPtr 的回调中返回字段的指针

示例： 

types.MapPtr(fb, func(f *FacebookConfig) *string {
    return types.Ptr(f.PixelId)
})

func StructToMapString 

func StructToMapString(payload *structpb.Struct) map[string]string

StructToMapString 将 structpb.Struct 转换为 map[string]string 标量值直接格式化为字符串，复合类型（嵌套 struct/list）序列化为 JSON 字符串

Types

type CompressedText 

type CompressedText string

func (CompressedText) GormDBDataType 

func (CompressedText) GormDBDataType(db *gorm.DB, field *schema.Field) string

GormDBDataType 按方言返回列类型：ClickHouse→String，MySQL→LONGTEXT，其他→TEXT

func (CompressedText) GormDataType 

func (CompressedText) GormDataType() string

GormDataType 实现 schema.GormDataTypeInterface：声明逻辑数据类型为 string 必须实现：否则 gorm schema 解析时 DataType 为空，字段会被误判为关联关系（parseRelation 报错）

func (*CompressedText) Scan 

func (c *CompressedText) Scan(value interface{}) error

Scan 实现 sql.Scanner：透明解压（兼容未压缩历史数据）

func (CompressedText) String 

func (c CompressedText) String() string

String 返回底层字符串值

func (CompressedText) Value 

func (c CompressedText) Value() (driver.Value, error)

Value 实现 driver.Valuer：空值返回 nil，非空值 gzip 压缩并添加 GZIP: 前缀

type CompressedTextMap 

type CompressedTextMap map[string][]string

func CompressedTextMapFromMap 

func CompressedTextMapFromMap(m map[string][]string) CompressedTextMap

FromMap 从原生 map[string][]string 创建（零拷贝）

func (CompressedTextMap) GormDBDataType 

func (CompressedTextMap) GormDBDataType(db *gorm.DB, field *schema.Field) string

GormDBDataType 按方言返回列类型：全部返回 TEXT/String（map 压缩为 JSON 字符串存储）

func (CompressedTextMap) GormDataType 

func (CompressedTextMap) GormDataType() string

GormDataType 实现 schema.GormDataTypeInterface：声明逻辑数据类型为 string 必须实现：Map 底层类型无法被 gorm 推导 DataType，空 DataType 会被误判为关联关系导致解析失败

func (*CompressedTextMap) Scan 

func (c *CompressedTextMap) Scan(value interface{}) error

Scan 实现 sql.Scanner：透明解压后 JSON 反序列化

func (CompressedTextMap) ToMap 

func (c CompressedTextMap) ToMap() map[string][]string

ToMap 转为原生 map[string][]string（零拷贝，底层类型相同）

func (CompressedTextMap) Value 

func (c CompressedTextMap) Value() (driver.Value, error)

Value 实现 driver.Valuer：nil 返回 nil；非 nil 先 JSON 序列化再 gzip 压缩

type JSON 

type JSON[T any] struct {
	Data T
}

JSON 泛型 JSON 类型，支持任意可序列化类型

func (*JSON[T]) Append 

func (j *JSON[T]) Append(items ...any)

Append 追加元素（仅对切片类型有效）

func (JSON[T]) Clone 

func (j JSON[T]) Clone() JSON[T]

Clone 克隆数据

func (*JSON[T]) Get 

func (j *JSON[T]) Get() T

Get 获取数据

func (JSON[T]) GetOrDefault 

func (j JSON[T]) GetOrDefault(defaultValue T) T

GetOrDefault 获取数据，如果 Data 为 nil 则返回 defaultValue

func (JSON[T]) GetOrZero 

func (j JSON[T]) GetOrZero() T

GetOrZero 获取数据，如果 Data 为 nil 则返回 T 的零值

func (JSON[T]) IfPresent 

func (j JSON[T]) IfPresent(fn func(T))

IfPresent 当 Data 非 nil 时执行回调（Java Optional 风格） 用于消除 `if x.Data != nil { ... }` 这类样板代码

func (JSON[T]) IsEmpty 

func (j JSON[T]) IsEmpty() bool

IsEmpty 判断是否为空（切片长度为0或数据为零值）

func (JSON[T]) IsNil 

func (j JSON[T]) IsNil() bool

IsNil 判断 Data 是否为 nil 仅对指针、接口、切片、map、channel、函数类型有效（通过反射安全判断） 值类型（struct、int、string 等）永远返回 false

func (JSON[T]) IsPresent 

func (j JSON[T]) IsPresent() bool

IsPresent 判断 Data 是否非 nil（IsNil 的反向）

func (JSON[T]) Len 

func (j JSON[T]) Len() int

Len 获取数据长度（仅对切片类型有效）

func (*JSON[T]) Scan 

func (j *JSON[T]) Scan(value interface{}) error

func (*JSON[T]) Set 

func (j *JSON[T]) Set(data T)

Set 设置数据

func (JSON[T]) ToOptional 

func (j JSON[T]) ToOptional() Optional[T]

ToOptional 将 JSON[T] 转换为 Optional[T]，便于使用 MapOpt/FlatMapOpt 等单子操作 Data 为 nil 时返回空 Optional

func (JSON[T]) Value 

func (j JSON[T]) Value() (driver.Value, error)

type MapAny 

type MapAny map[string]any

MapAny 任意类型的 Map，支持数据库 JSON 序列化

func ProtoToMap 

func ProtoToMap(message proto.Message) MapAny

ProtoToMap 将 protobuf 消息转换为 MapAny

func StructToMapAny 

func StructToMapAny(payload *structpb.Struct) MapAny

StructToMapAny 将 structpb.Struct 转换为 MapAny

func StructToMapAnyFromStruct 

func StructToMapAnyFromStruct(v interface{}) MapAny

StructToMapAny 将 Go struct 转换为 MapAny 使用 JSON 序列化/反序列化实现，支持任意 struct 类型

func (MapAny) Clone 

func (m MapAny) Clone() MapAny

Clone 克隆一个新的 Map

func (MapAny) Delete 

func (m MapAny) Delete(key string) MapAny

Delete 删除指定 key

func (MapAny) Each 

func (m MapAny) Each(fn func(key string, value any))

Each 遍历所有键值对

func (MapAny) Filter 

func (m MapAny) Filter(fn func(key string, value any) bool) MapAny

Filter 过滤键值对

func (MapAny) Get 

func (m MapAny) Get(key string, defaultValue ...any) any

Get 获取指定 key 的值，支持默认值

func (MapAny) GetBool 

func (m MapAny) GetBool(key string, defaultValue ...bool) bool

GetBool 获取布尔值

func (MapAny) GetInt 

func (m MapAny) GetInt(key string, defaultValue ...int) int

GetInt 获取整数值

func (MapAny) GetInt32 

func (m MapAny) GetInt32(key string, defaultValue ...int32) int32

GetInt32 获取 int32 值

func (MapAny) GetMap 

func (m MapAny) GetMap(key string, defaultValue ...MapAny) MapAny

GetMap 获取 MapAny 值

func (MapAny) GetString 

func (m MapAny) GetString(key string, defaultValue ...string) string

GetString 获取字符串值

func (MapAny) Has 

func (m MapAny) Has(key string) bool

Has 检查 key 是否存在

func (MapAny) IsEmpty 

func (m MapAny) IsEmpty() bool

IsEmpty 判断 Map 是否为空

func (MapAny) Keys 

func (m MapAny) Keys() []string

Keys 获取所有 key

func (MapAny) Len 

func (m MapAny) Len() int

Len 获取 Map 长度

func (MapAny) Map 

func (m MapAny) Map(fn func(key string, value any) (string, any)) MapAny

Map 映射转换

func (MapAny) Merge 

func (m MapAny) Merge(other MapAny) MapAny

Merge 合并另一个 Map

func (*MapAny) Scan 

func (m *MapAny) Scan(value interface{}) error

func (MapAny) Set 

func (m MapAny) Set(key string, value any) MapAny

Set 设置值

func (MapAny) Value 

func (m MapAny) Value() (driver.Value, error)

func (MapAny) Values 

func (m MapAny) Values() []any

Values 获取所有 value

type Optional 

type Optional[T any] struct {
	// contains filtered or unexported fields
}

Optional[T] 通用可选值容器，支持 nil-safe 链式操作

设计要点：

  • 内部用 present 标记区分"空"与"零值"，对值类型（int/struct）也能正确表达缺失
  • 对指针类型 T=*V 同样适用，present=false 优先判定为空
  • 提供 Map / FlatMap / Filter 等单子操作，便于深层嵌套字段的链式访问

与 JSON[T] 的关系：JSON[T] 主要服务于数据库读写，Optional[T] 服务于业务层 nil-safe 访问 通过 JSON[T].ToOptional() 进行桥接

func Empty 

func Empty[T any]() Optional[T]

Empty 创建空 Optional

func FlatMapOpt 

func FlatMapOpt[T any, U any](o Optional[T], fn func(T) Optional[U]) Optional[U]

FlatMapOpt 单子绑定，fn 返回 Optional[U]

func MapOpt 

func MapOpt[T any, U any](o Optional[T], fn func(T) *U) Optional[U]

MapOpt 转换为 Optional[U]，fn 返回 *U 便于主动中断链路（返回 nil 即视为空） 注意：Go 方法不支持额外类型参数，因此单子操作以泛型函数形式提供

示例： 

fb := types.MapOpt(types.OfNullable(tracking), func(t *TrackingConfig) *FacebookConfig {
    return t.Facebook
})

func Of 

func Of[T any](v T) Optional[T]

Of 创建一个非空 Optional

func OfNullable 

func OfNullable[T any](v *T) Optional[T]

OfNullable 接受指针 *T，nil 时返回空 Optional；非 nil 时解引用装入 Optional[T] 适用于"从指针提取值"场景

func OfNullablePtr 

func OfNullablePtr[T any](v *T) Optional[*T]

OfNullablePtr 接受指针 *T，nil 时返回空 Optional[*T]；非 nil 时装入指针本身 与 OfNullable 的区别：OfNullable 解引用得到 Optional[T]，OfNullablePtr 保留 Optional[*T] 适用于"链式穿透多层可空指针字段"场景（配合 FlatMapOpt）

func (Optional[T]) Filter 

func (o Optional[T]) Filter(pred func(T) bool) Optional[T]

Filter 谓词为 false（或空 Optional）时返回空 Optional

func (Optional[T]) Get 

func (o Optional[T]) Get() *T

Get 返回值的指针；空 Optional 返回 nil

func (Optional[T]) GetOrDefault 

func (o Optional[T]) GetOrDefault(defaultValue T) T

GetOrDefault 获取值，空 Optional 返回 defaultValue

func (Optional[T]) GetOrZero 

func (o Optional[T]) GetOrZero() T

GetOrZero 获取值，空 Optional 返回 T 的零值

func (Optional[T]) IfPresent 

func (o Optional[T]) IfPresent(fn func(T))

IfPresent 有值时执行回调，无值时跳过

func (Optional[T]) IfPresentOrElse 

func (o Optional[T]) IfPresentOrElse(action func(T), emptyAction func())

IfPresentOrElse 有值时执行 action，无值时执行 emptyAction

func (Optional[T]) IsNil 

func (o Optional[T]) IsNil() bool

IsNil 是否为空（IsPresent 的反向）

func (Optional[T]) IsPresent 

func (o Optional[T]) IsPresent() bool

IsPresent 是否有值

func (Optional[T]) OrElse 

func (o Optional[T]) OrElse(defaultValue T) T

OrElse 与 GetOrDefault 等价（Java Optional 习惯命名）

type ProtoJSON 

type ProtoJSON[T any] struct {
	Data T
}

ProtoJSON 泛型 protobuf JSON 类型，支持 protobuf 消息的数据库存储

func (*ProtoJSON[T]) Clone 

func (p *ProtoJSON[T]) Clone() ProtoJSON[T]

Clone 克隆数据

func (*ProtoJSON[T]) Get 

func (p *ProtoJSON[T]) Get() T

Get - 获取结构体字段值

func (*ProtoJSON[T]) IsEmpty 

func (p *ProtoJSON[T]) IsEmpty() bool

IsEmpty 判断是否为空

func (*ProtoJSON[T]) Scan 

func (p *ProtoJSON[T]) Scan(value interface{}) error

Scan - 从数据库值扫描 protobuf JSON 类型

func (*ProtoJSON[T]) Set 

func (p *ProtoJSON[T]) Set(data T)

Set - 设置 protobuf JSON 类型值

func (*ProtoJSON[T]) Value 

func (p *ProtoJSON[T]) Value() (driver.Value, error)

Value - 将 protobuf JSON 类型转换为数据库值

type ProtoJSONMap 

type ProtoJSONMap[T proto.Message] struct {
	Fields map[string]ProtoJSON[T]
}

ProtoJSONMap - 泛型 protobuf JSON 类型，支持 protobuf 消息的数据库存储

func NewProtoJSONMap 

func NewProtoJSONMap[T proto.Message]() *ProtoJSONMap[T]

NewProtoJSONMap - 创建一个新的 protobuf JSON 类型映射

func (*ProtoJSONMap[T]) Clear 

func (p *ProtoJSONMap[T]) Clear()

Clear 清空所有键值对

func (*ProtoJSONMap[T]) Clone 

func (p *ProtoJSONMap[T]) Clone() ProtoJSONMap[T]

Clone 克隆一个新的映射

func (*ProtoJSONMap[T]) Delete 

func (p *ProtoJSONMap[T]) Delete(key string)

Delete 删除指定键

func (*ProtoJSONMap[T]) Get 

func (p *ProtoJSONMap[T]) Get(key string) T

Get - 获取指定键的 protobuf JSON 类型值

func (*ProtoJSONMap[T]) Has 

func (p *ProtoJSONMap[T]) Has(key string) bool

Has 检查键是否存在

func (*ProtoJSONMap[T]) IsEmpty 

func (p *ProtoJSONMap[T]) IsEmpty() bool

IsEmpty 判断是否为空

func (*ProtoJSONMap[T]) Keys 

func (p *ProtoJSONMap[T]) Keys() []string

Keys - 获取所有键

func (*ProtoJSONMap[T]) Len 

func (p *ProtoJSONMap[T]) Len() int

Len 获取键值对数量

func (*ProtoJSONMap[T]) Scan 

func (p *ProtoJSONMap[T]) Scan(value interface{}) error

func (*ProtoJSONMap[T]) Set 

func (p *ProtoJSONMap[T]) Set(key string, data T)

Set - 设置指定键的 protobuf JSON 类型值

func (ProtoJSONMap[T]) Value 

func (p ProtoJSONMap[T]) Value() (driver.Value, error)

Value - 将 protobuf JSON 类型转换为数据库值

type Slice 

type Slice[T any] []T

Slice 泛型切片类型

func Map 

func Map[T any, R any](s Slice[T], fn func(T) R) Slice[R]

Map 映射转换

func (*Slice[T]) Append 

func (s *Slice[T]) Append(items ...T) Slice[T]

Append 追加元素

func (Slice[T]) Clone 

func (s Slice[T]) Clone() Slice[T]

Clone 克隆切片

func (Slice[T]) Filter 

func (s Slice[T]) Filter(fn func(T) bool) Slice[T]

Filter 过滤元素

func (Slice[T]) Len 

func (s Slice[T]) Len() int

Len 获取长度

func (*Slice[T]) Scan 

func (s *Slice[T]) Scan(value interface{}) error

func (Slice[T]) Value 

func (s Slice[T]) Value() (driver.Value, error)

type StringSlice 

type StringSlice []string

StringSlice 字符串切片，支持数据库 JSON 序列化

func ParseStringSlice 

func ParseStringSlice(input []string) StringSlice

ParseStringSlice 从混合格式解析字符串切片 支持数组或分隔字符串 (分号;换行符\n)

func (*StringSlice) Append 

func (s *StringSlice) Append(items ...string) StringSlice

Append 追加元素

func (StringSlice) Clone 

func (s StringSlice) Clone() StringSlice

Clone 克隆一个新的切片

func (StringSlice) Contains 

func (s StringSlice) Contains(item string) bool

Contains 检查是否包含指定元素

func (StringSlice) Filter 

func (s StringSlice) Filter(fn func(string) bool) StringSlice

Filter 过滤元素

func (*StringSlice) FromDelimitedString 

func (s *StringSlice) FromDelimitedString(input string, delimiters ...string) StringSlice

FromDelimitedString 从分隔符字符串创建 StringSlice 支持多种分隔符: 分号(;)、换行符(\n)、逗号(,) 自动去除空白字符和空字符串

func (StringSlice) IndexOf 

func (s StringSlice) IndexOf(item string) int

IndexOf 查找元素索引，未找到返回 -1

func (StringSlice) Join 

func (s StringSlice) Join(sep string) string

Join 连接为字符串

func (StringSlice) Map 

func (s StringSlice) Map(fn func(string) string) StringSlice

Map 映射转换

func (*StringSlice) Remove 

func (s *StringSlice) Remove(item string) StringSlice

Remove 移除指定元素（第一个匹配的）

func (*StringSlice) RemoveAt 

func (s *StringSlice) RemoveAt(index int) StringSlice

RemoveAt 移除指定索引的元素

func (*StringSlice) Scan 

func (s *StringSlice) Scan(value interface{}) error

func (StringSlice) Unique 

func (s StringSlice) Unique() StringSlice

Unique 去重

func (StringSlice) Value 

func (s StringSlice) Value() (driver.Value, error)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.