helper

package
v0.13.3 Latest Latest
Warning

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

Go to latest
Published: Nov 2, 2025 License: MIT Imports: 26 Imported by: 1

README

Helper 组件

Helper 组件提供丰富的工具函数,包括数据类型转换、字符串处理、文件操作、JSON处理、货币计算、SSH密钥管理等常用功能。

概述

Helper 组件是一个功能丰富的工具库,为 Go 开发提供各种常用功能的封装。组件采用模块化设计,包含多个专门的功能模块,每个模块都提供简单易用的 API 接口。

功能特性

  • 数据类型转换:支持各种数据类型之间的安全转换
  • 字符串处理:提供丰富的字符串操作功能,支持多字节字符
  • JSON处理:强大的 JSON 序列化和反序列化功能
  • 文件操作:文件路径处理、文件状态检查等实用功能
  • 货币计算:精确的货币计算,支持加减乘除等操作
  • SSH密钥管理:SSH 密钥的生成和获取
  • 数组和Map操作:提供数组和 Map 的常用操作方法
  • 工具函数:各种实用工具函数

快速开始

安装
go get github.com/jcbowen/jcbaseGo/component/helper
基本使用示例
package main

import (
    "fmt"
    "github.com/jcbowen/jcbaseGo/component/helper"
)

func main() {
    // 数据类型转换示例
    convert := helper.Convert{Value: "123"}
    number := convert.ToInt()
    fmt.Printf("字符串转数字: %d\n", number)

    // 字符串处理示例
    str := helper.NewStr("hello world")
    upper := str.ToUpper()
    fmt.Printf("字符串转大写: %s\n", upper)

    // JSON处理示例
    jsonStr := `{"name":"张三","age":25}`
    jsonHelper := helper.Json(jsonStr)
    var data map[string]interface{}
    jsonHelper.ToStruct(&data)
    fmt.Printf("JSON解析结果: %+v\n", data)

    // 货币计算示例
    money := helper.Money("100.50")
    fmt.Printf("货币金额: %s\n", money.FloatString("¥", "元"))
}
数据类型转换示例
package main

import (
    "fmt"
    "github.com/jcbowen/jcbaseGo/component/helper"
)

func main() {
    // 字符串转数字
    convert := helper.Convert{Value: "123.45"}
    fmt.Printf("字符串转int: %d\n", convert.ToInt())
    fmt.Printf("字符串转float64: %.2f\n", convert.ToFloat64())

    // 数字转字符串
    convert = helper.Convert{Value: 123.45}
    fmt.Printf("数字转字符串: %s\n", convert.ToString())

    // 布尔值转换
    convert = helper.Convert{Value: "true"}
    fmt.Printf("字符串转bool: %t\n", convert.ToBool())

    // 文件权限转换
    convert = helper.Convert{Value: "0644"}
    fmt.Printf("字符串转FileMode: %o\n", convert.ToFileMode())
}
字符串处理示例
package main

import (
    "fmt"
    "github.com/jcbowen/jcbaseGo/component/helper"
)

func main() {
    // 创建字符串对象
    str := helper.NewStr("Hello World 你好世界")

    // 基本操作
    fmt.Printf("原始字符串: %s\n", str.String)
    fmt.Printf("转大写: %s\n", str.ToUpper())
    fmt.Printf("转小写: %s\n", str.ToLower())
    fmt.Printf("字节长度: %d\n", str.ByteLength())

    // 子字符串操作
    fmt.Printf("截取前5个字符: %s\n", str.ByteSubstr(0, 5))
    fmt.Printf("截断为10个字符: %s\n", str.Truncate(10, "..."))

    // 字符串检查
    fmt.Printf("是否以Hello开头: %t\n", str.StartsWith("Hello", true))
    fmt.Printf("是否以世界结尾: %t\n", str.EndsWith("世界", true))

    // 分割字符串
    parts := str.Explode(" ", true, false)
    fmt.Printf("按空格分割: %v\n", parts)

    // 单词统计
    fmt.Printf("单词数量: %d\n", str.CountWords())

    // Base64编码
    encoded := str.Base64UrlEncode()
    fmt.Printf("Base64编码: %s\n", encoded)
    
    decoded, _ := helper.NewStr(encoded).Base64UrlDecode()
    fmt.Printf("Base64解码: %s\n", decoded)

    // HTML转义
    htmlStr := helper.NewStr(`<script>alert("xss")</script>`)
    fmt.Printf("HTML转义: %s\n", htmlStr.EscapeHTML())

    // 驼峰转下划线
    camelStr := helper.NewStr("helloWorldTest")
    fmt.Printf("驼峰转下划线: %s\n", camelStr.ConvertCamelToSnake())
}
JSON处理示例
package main

import (
    "fmt"
    "github.com/jcbowen/jcbaseGo/component/helper"
)

type User struct {
    Name string `json:"name"`
    Age  int    `json:"age"`
}

func main() {
    // 从字符串解析JSON
    jsonStr := `{"name":"张三","age":25}`
    jsonHelper := helper.Json(jsonStr)
    
    var user User
    jsonHelper.ToStruct(&user)
    fmt.Printf("解析结果: %+v\n", user)

    // 从结构体生成JSON
    newUser := User{Name: "李四", Age: 30}
    jsonHelper = helper.Json(newUser)
    var jsonString string
    jsonHelper.ToString(&jsonString)
    fmt.Printf("生成的JSON: %s\n", jsonString)

    // 从Map生成JSON
    data := map[string]interface{}{
        "name": "王五",
        "age":  35,
        "tags": []string{"go", "programming"},
    }
    jsonHelper = helper.Json(data)
    jsonHelper.ToString(&jsonString)
    fmt.Printf("Map生成的JSON: %s\n", jsonString)

    // 从文件读取JSON
    // jsonHelper = helper.JsonFile("config.json")
    // var config map[string]interface{}
    // jsonHelper.ToStruct(&config)
    // fmt.Printf("配置文件: %+v\n", config)

    // 生成JSON文件
    // jsonHelper.MakeFile("output.json").ToString(&jsonString)
}
文件操作示例
package main

import (
    "fmt"
    "github.com/jcbowen/jcbaseGo/component/helper"
)

func main() {
    // 创建文件对象
    file := helper.NewFile(&helper.File{Path: "/path/to/file.txt"})

    // 文件状态检查
    fmt.Printf("文件是否存在: %t\n", file.Exists())
    fmt.Printf("是否是目录: %t\n", file.IsDir())
    fmt.Printf("是否是文件: %t\n", file.IsFile())
    fmt.Printf("是否为空: %t\n", file.IsEmpty())
    fmt.Printf("是否可读: %t\n", file.IsReadable())
    fmt.Printf("是否可写: %t\n", file.IsWritable())

    // 路径操作
    absPath, _ := file.GetAbsPath()
    fmt.Printf("绝对路径: %s\n", absPath)
    fmt.Printf("文件名: %s\n", file.Basename(".txt"))
    fmt.Printf("目录名: %s\n", file.DirName())

    // 目录操作
    dir := helper.NewFile(&helper.File{Path: "/path/to/directory"})
    exists, err := dir.DirExists(true)
    if err != nil {
        fmt.Printf("目录操作错误: %v\n", err)
    } else {
        fmt.Printf("目录存在或已创建: %t\n", exists)
    }
}
货币计算示例
package main

import (
    "fmt"
    "github.com/jcbowen/jcbaseGo/component/helper"
)

func main() {
    // 创建货币对象
    money1 := helper.Money("100.50")  // 100.50元
    money2 := helper.Money(50.25)     // 50.25元

    // 基本操作
    fmt.Printf("金额1: %s\n", money1.FloatString("¥", ""))
    fmt.Printf("金额2: %s\n", money2.FloatString("¥", ""))

    // 加法
    result := money1.Add(money2)
    fmt.Printf("加法结果: %s\n", result.FloatString("¥", ""))

    // 减法
    result = money1.Subtract(helper.Money("20.00"))
    fmt.Printf("减法结果: %s\n", result.FloatString("¥", ""))

    // 乘法
    result = money1.Multiply(1.1) // 增加10%
    fmt.Printf("乘法结果: %s\n", result.FloatString("¥", ""))

    // 除法
    result = money1.Divide(2) // 除以2
    fmt.Printf("除法结果: %s\n", result.FloatString("¥", ""))

    // 比较操作
    fmt.Printf("金额1 > 金额2: %t\n", money1.GreaterThan(money2))
    fmt.Printf("金额1 < 金额2: %t\n", money1.LessThan(money2))
    fmt.Printf("金额1 == 金额2: %t\n", money1.Equals(money2))

    // 错误处理
    money3 := helper.Money("invalid")
    if err := money3.GetError(); err != nil {
        fmt.Printf("错误信息: %v\n", err)
    }
}
SSH密钥管理示例
package main

import (
    "fmt"
    "github.com/jcbowen/jcbaseGo/component/helper"
)

func main() {
    // 获取SSH公钥
    pubKey, err := helper.GetSSHKey()
    if err != nil {
        fmt.Printf("获取SSH密钥错误: %v\n", err)
        
        // 生成新的SSH密钥
        if err := helper.GenerateSSHKey(); err != nil {
            fmt.Printf("生成SSH密钥错误: %v\n", err)
        } else {
            fmt.Println("SSH密钥生成成功")
            
            // 重新获取公钥
            pubKey, err = helper.GetSSHKey()
            if err != nil {
                fmt.Printf("重新获取SSH密钥错误: %v\n", err)
            }
        }
    }

    if pubKey != "" {
        fmt.Printf("SSH公钥: %s\n", pubKey)
    }
}
数组和Map操作示例
package main

import (
    "fmt"
    "github.com/jcbowen/jcbaseGo/component/helper"
)

func main() {
    // 数组操作
    arr := []string{"apple", "banana", "orange", "grape"}
    arrHelper := helper.SetArrStr(arr).DoSort()
    
    fmt.Printf("原始数组: %v\n", arr)
    fmt.Printf("排序后数组: %v\n", arrHelper.ArrayValue())
    
    // 数组差异
    otherArr := []string{"banana", "grape", "pear"}
    diff := arrHelper.ArrayDiff(otherArr)
    fmt.Printf("数组差异: %v\n", diff)
    
    // 数组交集
    intersect := arrHelper.ArrayIntersect(otherArr)
    fmt.Printf("数组交集: %v\n", intersect)

    // Map操作
    data := map[string]interface{}{
        "name": "张三",
        "age":  25,
        "city": "北京",
    }
    mapHelper := helper.NewMap(data).DoSort()
    
    fmt.Printf("原始Map: %+v\n", data)
    fmt.Printf("排序后Map: %+v\n", mapHelper.GetData())
    fmt.Printf("Map键: %v\n", mapHelper.ArrayKeys())
    fmt.Printf("Map值: %v\n", mapHelper.ArrayValues())
}
工具函数示例
package main

import (
    "fmt"
    "github.com/jcbowen/jcbaseGo/component/helper"
)

func main() {
    // 字符串替换
    result, err := helper.StrReplace("world", "Go", "hello world", -1)
    if err != nil {
        fmt.Printf("字符串替换错误: %v\n", err)
    } else {
        fmt.Printf("字符串替换结果: %s\n", result)
    }

    // 检查字符串开头和结尾
    str := "hello world"
    fmt.Printf("是否以hello开头: %t\n", helper.StringStartWith(str, "hello"))
    fmt.Printf("是否以world结尾: %t\n", helper.StringEndWith(str, "world"))

    // 检查元素是否在数组中
    arr := []string{"apple", "banana", "orange"}
    fmt.Printf("apple是否在数组中: %t\n", helper.InArray("apple", arr))
    fmt.Printf("grape是否在数组中: %t\n", helper.InArray("grape", arr))

    // 通配符匹配
    pattern := "*.go"
    filename := "main.go"
    fmt.Printf("文件名 %s 是否匹配模式 %s: %t\n", 
        filename, pattern, helper.MatchWildcard(pattern, filename, false))
}

详细功能说明

Convert 类型转换模块

提供安全的数据类型转换功能:

  • ToString(): 将任意类型转换为字符串
  • ToInt(): 转换为 int 类型
  • ToInt64(): 转换为 int64 类型
  • ToFloat64(): 转换为 float64 类型
  • ToBool(): 转换为 bool 类型
  • ToFileMode(): 转换为文件权限类型
  • ToArrByte(): 转换为字节数组
Str 字符串处理模块

提供丰富的字符串操作功能:

  • 字节操作: ByteLength(), ByteSubstr()
  • 字符串截断: Truncate(), TruncateWords()
  • 字符串检查: StartsWith(), EndsWith()
  • 字符串分割: Explode(), CountWords()
  • 编码解码: Base64UrlEncode(), Base64UrlDecode()
  • 格式转换: ToUpper(), ToLower(), ConvertCamelToSnake()
  • 安全处理: EscapeHTML(), TrimSpace()
JsonHelper JSON处理模块

强大的 JSON 序列化和反序列化功能:

  • 多数据源支持: 字符串、结构体、Map、文件
  • 链式操作: 支持方法链式调用
  • 文件操作: 支持 JSON 文件的读取和生成
  • 错误处理: 完善的错误处理机制
File 文件操作模块

文件路径和状态操作:

  • 文件状态: Exists(), IsDir(), IsFile(), IsEmpty()
  • 权限检查: IsReadable(), IsWritable(), IsExecutable()
  • 路径操作: GetAbsPath(), Basename(), DirName()
  • 目录管理: DirExists()
MoneyHelper 货币计算模块

精确的货币计算功能:

  • 多种输入格式: 字符串、数字
  • 数学运算: Add(), Subtract(), Multiply(), Divide()
  • 比较操作: GreaterThan(), LessThan(), Equals()
  • 格式化输出: FloatString()
  • 错误处理: GetError()
SSH 密钥管理

SSH 密钥的生成和获取:

  • 密钥获取: GetSSHKey()
  • 密钥生成: GenerateSSHKey()
  • 自动创建: 密钥不存在时自动生成
数组和Map操作

提供数组和 Map 的常用操作方法:

  • 数组操作: ArrayValue(), ArrayDiff(), ArrayIntersect()
  • Map操作: ArrayKeys(), ArrayValues(), GetData()
  • 排序支持: DoSort()

高级用法

组合使用示例
package main

import (
    "fmt"
    "github.com/jcbowen/jcbaseGo/component/helper"
)

func main() {
    // 组合使用多个模块
    data := map[string]interface{}{
        "amount": "100.50",
        "currency": "CNY",
        "description": "商品购买",
    }

    // 使用Json模块处理数据
    jsonHelper := helper.Json(data)
    var jsonString string
    jsonHelper.ToString(&jsonString)
    
    // 使用字符串模块处理描述
    desc := helper.NewStr(data["description"].(string))
    truncatedDesc := desc.Truncate(10, "...")
    
    // 使用货币模块处理金额
    amount := helper.Money(data["amount"])
    formattedAmount := amount.FloatString("¥", "")
    
    fmt.Printf("JSON数据: %s\n", jsonString)
    fmt.Printf("描述: %s\n", truncatedDesc)
    fmt.Printf("金额: %s\n", formattedAmount)
}
错误处理最佳实践
package main

import (
    "fmt"
    "github.com/jcbowen/jcbaseGo/component/helper"
)

func ProcessPayment(amountStr string) error {
    // 货币转换和验证
    money := helper.Money(amountStr)
    if err := money.GetError(); err != nil {
        return fmt.Errorf("金额格式错误: %v", err)
    }
    
    // 金额验证
    if money.LessThan(helper.Money("0.01")) {
        return fmt.Errorf("金额不能小于0.01元")
    }
    
    // 处理支付逻辑...
    fmt.Printf("支付金额: %s\n", money.FloatString("¥", ""))
    
    return nil
}

func main() {
    amounts := []string{"100.50", "invalid", "0.00"}
    
    for _, amount := range amounts {
        fmt.Printf("处理金额: %s\n", amount)
        if err := ProcessPayment(amount); err != nil {
            fmt.Printf("处理失败: %v\n", err)
        } else {
            fmt.Println("处理成功")
        }
        fmt.Println()
    }
}

性能优化建议

  1. 避免不必要的转换: 在可能的情况下直接使用原始类型
  2. 重用对象: 对于频繁使用的对象,考虑重用而不是重复创建
  3. 批量操作: 对于数组和Map操作,使用批量方法减少循环次数
  4. 错误检查: 在使用结果前检查错误,避免无效操作
  5. 内存管理: 对于大文件操作,注意及时关闭文件句柄

安全考虑

  • 输入验证: 所有外部输入都应该进行验证
  • 文件权限: 文件操作时注意权限设置
  • 内存安全: 避免内存泄漏和缓冲区溢出
  • 错误处理: 完善的错误处理防止程序崩溃

API 参考

Convert 类型
type Convert struct {
    Value interface{}
}

func (c Convert) ToString() string
func (c Convert) ToInt() int
func (c Convert) ToInt64() int64
func (c Convert) ToFloat64() float64
func (c Convert) ToBool() bool
func (c Convert) ToFileMode() os.FileMode
func (c Convert) ToArrByte() []byte
func (c Convert) ToNumber() (interface{}, bool)
Str 类型
type Str struct {
    String  string
    // ... 其他字段
}

func NewStr(str string) *Str
func (s *Str) ByteLength() int
func (s *Str) ByteSubstr(start int, length int) string
func (s *Str) Truncate(length int, suffix string) string
func (s *Str) StartsWith(prefix string, caseSensitive bool) bool
func (s *Str) EndsWith(suffix string, caseSensitive bool) bool
func (s *Str) Explode(delimiter string, trim bool, skipEmpty bool) []string
func (s *Str) Base64UrlEncode() string
func (s *Str) Base64UrlDecode() (string, error)
func (s *Str) EscapeHTML() string
func (s *Str) ConvertCamelToSnake() string
JsonHelper 类型
type JsonHelper struct {
    // ... 字段
}

func Json(input interface{}) *JsonHelper
func JsonFile(path string) *JsonHelper
func (jh *JsonHelper) ToStruct(newStruct interface{}) *JsonHelper
func (jh *JsonHelper) ToString(newStr *string) *JsonHelper
func (jh *JsonHelper) MakeFile(filepath string) *JsonHelper
File 类型
type File struct {
    Path string
    Perm os.FileMode
}

func NewFile(args ...any) *File
func (fh *File) Exists() bool
func (fh *File) IsDir() bool
func (fh *File) GetAbsPath() (string, error)
func (fh *File) Basename(suffix string) string
func (fh *File) DirName() string
func (fh *File) DirExists(createIfNotExists bool) (bool, error)
MoneyHelper 类型
type MoneyHelper struct {
    Amount int64
}

func Money(input interface{}) *MoneyHelper
func (m *MoneyHelper) SetAmount(value interface{}) *MoneyHelper
func (m *MoneyHelper) Add(other *MoneyHelper) *MoneyHelper
func (m *MoneyHelper) Subtract(other *MoneyHelper) *MoneyHelper
func (m *MoneyHelper) Multiply(factor float64) *MoneyHelper
func (m *MoneyHelper) Divide(divisor float64) *MoneyHelper
func (m *MoneyHelper) FloatString(parts ...string) string
func (m *MoneyHelper) GreaterThan(other *MoneyHelper) bool
func (m *MoneyHelper) GetError() error
工具函数
func GetSSHKey() (string, error)
func GenerateSSHKey() error
func SetArrStr(str []string) *ArrStr
func NewMap(mapData map[string]interface{}) *MapHelper
func StrReplace(search interface{}, replace interface{}, subject interface{}, count int) (interface{}, error)
func StringStartWith(str, prefix string) bool
func StringEndWith(str, suffix string) bool
func InArray(needle interface{}, haystack []string) bool
func MatchWildcard(pattern, s string, caseSensitive bool) bool

版本历史

  • v1.0.0:初始版本,包含完整的工具函数集合
  • 支持数据类型转换、字符串处理、JSON处理、文件操作、货币计算等功能

贡献指南

欢迎提交 Issue 和 Pull Request 来改进 Helper 组件。

许可证

Helper 组件遵循 MIT 许可证。

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Base64Decode

func Base64Decode(str string) (string, error)

Base64Decode base64解密

func Base64Encode

func Base64Encode(str string) string

Base64Encode base64加密

func BuildYii2RedisCacheKey added in v0.10.2

func BuildYii2RedisCacheKey(key string, args ...string) string

BuildYii2RedisCacheKey 生成一个规范化的缓存键,支持可选的前缀参数。 逻辑同yii2的yii\caching\Cache::buildKey

参数说明: - key: 需要规范化的缓存键字符串。 - args: 可选参数,args[0] 为缓存键的前缀字符串。

处理逻辑:

  1. 如果 key 只包含字母和数字,且长度不超过 32 个字符, 则直接返回前缀加 key。
  2. 否则对 key 进行 MD5 哈希处理, 返回前缀加哈希字符串,保证缓存键长度和格式统一。

该方法适用于缓存键的标准化处理,避免因 key 格式差异导致缓存失效。

func CalculateAge added in v0.8.0

func CalculateAge(args ...interface{}) (int, error)

CalculateAge 计算年龄的多功能方法 支持以下两种调用方式: 1. CalculateAge(year, month, day int) (int, error) 2. CalculateAge(dateString string) (int, error)

func CheckAndSetDefault

func CheckAndSetDefault(i interface{}) error

CheckAndSetDefault 检查结构体中的字段是否为空,如果为空则设置为默认值 常见问题:如果发现默认值赋值失败,但是又没有出现报错,可以看看是不是传递的指针的指针

func CompareNumber

func CompareNumber(a, b interface{}) int

CompareNumber 比较两个值,如果 a < b 返回 -1,如果 a == b 返回 0,如果 a > b 返回 1,如果错误则 panic

func CompareVersion added in v0.10.7

func CompareVersion(a string, b string) (result int, level int)

CompareVersion 版本号比较(支持x.y.z,降级为数值分段比较,不足段补0;非法段按0处理) 参数:

  • a: 版本号A
  • b: 版本号B

返回:

  • result: 比较结果(1 表示a>b;0表示相等;-1表示a<b)
  • level: 差异级别(从1开始,表示第几级版本号差异;0表示无差异)

func CopyStruct

func CopyStruct(src, dst interface{})

CopyStruct 复制结构体,将 src 的值复制到 dst

用法:CopyStruct(&src, &dst)

注意:src、dst 必须是一个指针

func FindAvailablePort added in v0.9.1

func FindAvailablePort(startPort string) string

FindAvailablePort 查找可用端口 从指定端口开始,如果端口被占用则递增端口号,直到找到可用端口 未指定端口的情况下默认使用8080

func GenerateSSHKey

func GenerateSSHKey() error

GenerateSSHKey 生成 SSH 密钥

func GetFieldNameByJSONTag

func GetFieldNameByJSONTag(objType reflect.Type, jsonKey string) string

GetFieldNameByJSONTag 根据 JSON 标记获取结构体字段名

func GetHostInfo

func GetHostInfo(req *http.Request) string

GetHostInfo 从http.Request中获取hostInfo

func GetSSHKey

func GetSSHKey() (string, error)

GetSSHKey 获取 SSH 密钥,如果不存在则生成

func InArray

func InArray(val interface{}, array interface{}) (exists bool)

InArray 检查某个值是否存在于切片中 val 是要检查的值 array 是要检查的切片 exists 是返回的布尔值,表示 val 是否存在于 array 中

func IsEmptyValue

func IsEmptyValue(val interface{}) bool

IsEmptyValue 检查值是否为空

func IsError

func IsError(errs []error) bool

IsError 判断[]error是否存在错误

func MapToStruct

func MapToStruct(mapData interface{}, obj interface{})

MapToStruct 通过reflect将map转换为结构体

func MatchWildcard

func MatchWildcard(pattern, s string, caseSensitive bool) bool

MatchWildcard 检查字符串是否匹配给定的通配符模式

func Max

func Max(numbers ...interface{}) interface{}

Max 返回可变参数中最大的值

func Min

func Min(numbers ...interface{}) interface{}

Min 返回可变参数中最小的值

func ParseChineseIDCard added in v0.8.0

func ParseChineseIDCard(idCard string) (gender string, age int, birthDay string, regionCode string, sequenceCode string, err error)

ParseChineseIDCard 解析中国大陆身份证号码,提取性别、年龄、生日、出生地等信息

func ParseIP

func ParseIP(s string) (net.IP, int)

ParseIP 解析IP地址,输出是ipv4或ipv6 0: invalid ip 4: ipv4 6: ipv6

func Random

func Random(length int, args ...bool) string

Random 生成随机字符

参数:

  • length (必需): 随机字符长度。
  • numericOnly (可选): 如果为 true,则只包含数字字符。

返回值:

  • string: 生成的随机字符串。

示例:

randomString := Random(16)
randomString := Random(16, true)

func StrReplace

func StrReplace(search interface{}, replace interface{}, subject interface{}, count int) (interface{}, error)

StrReplace 类似于php中的str_replace

func StringEndWith

func StringEndWith(str, suffix string) bool

StringEndWith 判断字符串是否以某个字符串结尾

func StringStartWith

func StringStartWith(str, prefix string) bool

StringStartWith 判断字符串是否以某个字符串开头

func StructMerge

func StructMerge(dst interface{}, src ...interface{}) error

StructMerge 函数将多个源结构体中的非零值合并到目标结构体中。 源结构体按照传入顺序反向合并,后面的源结构体会覆盖前面的。 目标结构体 (dst) 必须是指向结构体的指针,所有源结构体 (src) 必须是与目标结构体类型相同的指针。

参数:

  • dst: 一个指向目标结构体的指针,非零值将合并到该结构体中。
  • src: 一个变参,包含多个指向源结构体的指针,非零值将从这些源结构体中提取。

返回值:

  • error: 如果 dst 不是指向结构体的指针,或任何 src 元素不是与 dst 类型相同的结构体指针,则返回错误。

func StructToMap

func StructToMap(obj interface{}, useJsonTag bool) map[string]interface{}

StructToMap 通过reflect将结构体转换为map

func TraceCaller added in v0.8.0

func TraceCaller()

TraceCaller 打印当前函数及其调用者的信息。

该函数会获取当前执行的函数名称和调用该函数的位置(文件和行号)。 如果无法获取当前函数或调用者的信息,将会打印错误信息并返回。

注意: - `runtime.Caller(1)` 获取的是TraceCaller的调用者信息。 - `runtime.Caller(2)` 获取的是TraceCaller的调用者的调用者信息,即调用链的上一层。

输出格式为: Function: <当前函数名称> was called from <调用者函数名称>, file: <调用者文件路径>, line: <调用者行号>

Types

type ArrStr

type ArrStr struct {
	Arr  []string // 数组
	Sort bool     // 执行ArrayValue方法时是否排序
}

func SetArrStr

func SetArrStr(str []string) *ArrStr

func (*ArrStr) ArrayDiff

func (a *ArrStr) ArrayDiff(oArr ...[]string) (diff []string)

func (*ArrStr) ArrayIntersect

func (a *ArrStr) ArrayIntersect(oArr ...[]string) (intersects []string)

func (*ArrStr) ArrayValue

func (a *ArrStr) ArrayValue() (value []string)

func (*ArrStr) DoSort

func (a *ArrStr) DoSort() *ArrStr

DoSort 设置ArrayValue方法¬是否排序

type Convert

type Convert struct {
	Value interface{}
}

func (Convert) ToArrByte

func (c Convert) ToArrByte() []byte

ToArrByte 将变量转为[]byte类型

func (Convert) ToBool

func (c Convert) ToBool() bool

ToBool 将变量转为bool类型

func (Convert) ToFileMode

func (c Convert) ToFileMode() os.FileMode

ToFileMode 将变量转为os.FileMode类型

func (Convert) ToFloat64

func (c Convert) ToFloat64() float64

ToFloat64 将变量转为float64

func (Convert) ToInt

func (c Convert) ToInt() int

ToInt 将变量转为int类型

func (Convert) ToInt8 added in v0.11.1

func (c Convert) ToInt8() int8

ToInt8 将变量转为int8类型

func (Convert) ToInt64 added in v0.8.0

func (c Convert) ToInt64() int64

ToInt64 将变量转为int64类型

func (Convert) ToNumber

func (c Convert) ToNumber() (interface{}, bool)

ToNumber 将字符串变量转为数字类型

func (Convert) ToString

func (c Convert) ToString() string

ToString 将变量转为字符串 浮点型 3.0将会转换成字符串3, "3" 非数值或字符类型的变量将会被转换成JSON格式字符串

func (Convert) ToUint

func (c Convert) ToUint() uint

ToUint 将变量转为uint类型

func (Convert) ToUint64 added in v0.8.0

func (c Convert) ToUint64() uint64

ToUint64 将变量转为uint64类型

type File

type File struct {
	Path string      `json:"path"`
	Perm os.FileMode `json:"perm" default:"0755"`
}

func NewFile

func NewFile(args ...any) *File

func (*File) Basename

func (fh *File) Basename(suffix string) string

Basename 返回路径的最后一个名字组件

func (*File) CopyFile

func (fh *File) CopyFile(targetPath string, overwrite bool, copyAttr bool) error

CopyFile 复制文件到指定位置,可设置是否覆盖,可设置是否复制文件属性

func (*File) CopyFileAttr

func (fh *File) CopyFileAttr(targetFile string) error

CopyFileAttr 复制文件属性到目标文件

func (*File) CreateFile

func (fh *File) CreateFile(content []byte, overwrite bool) error

CreateFile 创建文件,可设置文件权限,可设置是否覆盖

func (*File) DirExists

func (fh *File) DirExists(createIfNotExists bool) (exists bool, err error)

DirExists 判断目录是否存在,可选在不存在时是否创建目录

func (*File) DirName

func (fh *File) DirName() string

DirName 获取目录部分

func (*File) Exists

func (fh *File) Exists() bool

Exists 检查文件是否存在

func (*File) GetAbsPath

func (fh *File) GetAbsPath() (string, error)

GetAbsPath 获取绝对路径

func (*File) IsDir

func (fh *File) IsDir() bool

IsDir 判断是否是目录

func (*File) IsEmpty

func (fh *File) IsEmpty() bool

IsEmpty 判断文件或目录是否为空

func (*File) IsEmptyDir

func (fh *File) IsEmptyDir() bool

IsEmptyDir 判断目录是否为空

func (*File) IsEmptyFile

func (fh *File) IsEmptyFile() bool

IsEmptyFile 判断文件是否为空

func (*File) IsExecutable

func (fh *File) IsExecutable() bool

IsExecutable 判断文件是否可执行

func (*File) IsFile

func (fh *File) IsFile() bool

IsFile 判断是否是文件

func (*File) IsHidden

func (fh *File) IsHidden() bool

IsHidden 判断文件是否隐藏

func (*File) IsReadable

func (fh *File) IsReadable() bool

IsReadable 判断文件是否可读

func (fh *File) IsSymlink() bool

IsSymlink 判断是否是软链接

func (*File) IsWritable

func (fh *File) IsWritable() bool

IsWritable 判断文件是否可写

func (*File) JsonToData

func (fh *File) JsonToData(data *interface{}) error

JsonToData 将文件中的json数据解析到data中

func (*File) Remove

func (fh *File) Remove() error

Remove 删除文件或目录

type JsonHelper

type JsonHelper struct {
	Struct interface{}            // 结构体
	String string                 // JSON字符串
	Map    map[string]interface{} // Map
	// contains filtered or unexported fields
}

func Json

func Json(input interface{}) *JsonHelper

Json 根据传入的未知类型实例化JsonHelper

func JsonFile

func JsonFile(path string) *JsonHelper

JsonFile 根据传入的文件路径读取JSON文件并实例化JsonHelper

func JsonMap deprecated

func JsonMap(jsonMap map[string]interface{}) *JsonHelper

Deprecated: 使用 Json 代替

func JsonString deprecated

func JsonString(jsonString string) *JsonHelper

Deprecated: 使用 Json 代替

func JsonStruct deprecated

func JsonStruct(jsonStruct interface{}) *JsonHelper

Deprecated: 使用 Json 代替

func (*JsonHelper) Errors

func (jh *JsonHelper) Errors() []error

Errors 获取错误信息列表

func (*JsonHelper) HasError

func (jh *JsonHelper) HasError() bool

HasError 判断是否有错误

func (*JsonHelper) MakeFile

func (jh *JsonHelper) MakeFile(filepath string) *JsonHelper

MakeFile 设置是否生成JSON文件及其路径

func (*JsonHelper) ToFile

func (jh *JsonHelper) ToFile() *JsonHelper

ToFile 将JSON字符串输出为文件

func (*JsonHelper) ToMap

func (jh *JsonHelper) ToMap(newMap *map[string]interface{}) *JsonHelper

ToMap 将JSON字符串或结构体转换为Map

func (*JsonHelper) ToString

func (jh *JsonHelper) ToString(newStr *string) *JsonHelper

ToString 将结构体或Map转换为JSON字符串

func (*JsonHelper) ToStruct

func (jh *JsonHelper) ToStruct(newStruct interface{}) *JsonHelper

ToStruct 将JSON数据转换为结构体

type MapHelper

type MapHelper struct {
	Data map[string]interface{}
	Keys []string
	Sort bool
}

func NewMap

func NewMap(mapData map[string]interface{}) *MapHelper

func SetMapStrInterface

func SetMapStrInterface(data map[string]interface{}) *MapHelper

SetMapStrInterface Deprecated: 请使用 NewMap

func (*MapHelper) ArrayKeys

func (d *MapHelper) ArrayKeys() []string

func (*MapHelper) ArrayValues

func (d *MapHelper) ArrayValues() []interface{}

func (*MapHelper) DoSort

func (d *MapHelper) DoSort() *MapHelper

func (*MapHelper) GetData

func (d *MapHelper) GetData() map[string]interface{}

type MoneyHelper

type MoneyHelper struct {
	Amount int64 `json:"amount" default:"0"` // 单位为厘,1000为1元
	// contains filtered or unexported fields
}

func Money

func Money(input interface{}) *MoneyHelper

func (*MoneyHelper) Add

func (m *MoneyHelper) Add(other *MoneyHelper) *MoneyHelper

Add 加法操作

func (*MoneyHelper) Divide

func (m *MoneyHelper) Divide(divisor float64) *MoneyHelper

Divide 除法操作

func (*MoneyHelper) Equals

func (m *MoneyHelper) Equals(other *MoneyHelper) bool

Equals 比较相等

func (*MoneyHelper) FloatString

func (m *MoneyHelper) FloatString(parts ...string) string

FloatString 输出字符串金额,接受前缀和后缀 参数:

parts - 可变参数列表,第一个参数表示前缀,第二个参数表示后缀,如果省略则不添加

func (*MoneyHelper) GetError

func (m *MoneyHelper) GetError() error

GetError 返回当前的错误

func (*MoneyHelper) GreaterThan

func (m *MoneyHelper) GreaterThan(other *MoneyHelper) bool

GreaterThan 比较大小

func (*MoneyHelper) LessThan

func (m *MoneyHelper) LessThan(other *MoneyHelper) bool

LessThan 比较大小

func (*MoneyHelper) Multiply

func (m *MoneyHelper) Multiply(factor float64) *MoneyHelper

Multiply 乘法操作

func (*MoneyHelper) SetAmount

func (m *MoneyHelper) SetAmount(value interface{}) *MoneyHelper

SetAmount 设置金额,接受不同格式的输入

func (*MoneyHelper) Subtract

func (m *MoneyHelper) Subtract(other *MoneyHelper) *MoneyHelper

Subtract 减法操作

type Str

type Str struct {
	String  string
	Float64 float64
	Float32 float32
	Int64   int64
	Int32   int32
	Int16   int16
	Int8    int8
	Int     int
	Uint64  uint64
	Uint32  uint32
	Uint16  uint16
	Uint8   uint8
	Uint    uint
}

func NewStr

func NewStr(str string) *Str

func (*Str) Base64UrlDecode

func (s *Str) Base64UrlDecode() (string, error)

Base64UrlDecode 解码 URL 和文件名安全的 Base64 编码字符串

func (*Str) Base64UrlEncode

func (s *Str) Base64UrlEncode() string

Base64UrlEncode 对字符串进行 URL 和文件名安全的 Base64 编码

func (*Str) ByteLength

func (s *Str) ByteLength() int

ByteLength 返回给定字符串的字节数

func (*Str) ByteSubstr

func (s *Str) ByteSubstr(start int, length int) string

ByteSubstr 返回从 start 开始、长度为 length 的子字符串

func (*Str) ConvertCamelToSnake

func (s *Str) ConvertCamelToSnake() string

ConvertCamelToSnake 转换驼峰字符串为下划线字符串

func (*Str) CountWords

func (s *Str) CountWords() int

CountWords 计算字符串中的单词数

func (*Str) EndsWith

func (s *Str) EndsWith(suffix string, caseSensitive bool) bool

EndsWith 检查字符串是否以指定的子字符串结尾

func (*Str) EscapeHTML

func (s *Str) EscapeHTML() string

EscapeHTML escapes HTML characters in the value to prevent XSS

func (*Str) Explode

func (s *Str) Explode(delimiter string, trim bool, skipEmpty bool) []string

Explode 按分隔符分割字符串,选项修剪值并跳过空值

func (*Str) FloatToString

func (s *Str) FloatToString() *Str

FloatToString 安全地将浮点数转换为字符串

func (*Str) MbUcFirst

func (s *Str) MbUcFirst() string

MbUcFirst 将字符串的第一个字符大写(支持多字节)

func (*Str) MbUcWords

func (s *Str) MbUcWords() string

MbUcWords 将字符串中的每个单词的第一个字符大写(支持多字节)

func (*Str) SetFloat64

func (s *Str) SetFloat64(number float64) *Str

SetFloat64 设置float64值

func (*Str) StartsWith

func (s *Str) StartsWith(prefix string, caseSensitive bool) bool

StartsWith 检查字符串是否以指定的子字符串开头

func (*Str) ToLower

func (s *Str) ToLower() string

ToLower converts the value to a lower case string

func (*Str) ToUpper

func (s *Str) ToUpper() string

ToUpper converts the value to an upper case string

func (*Str) Trim

func (s *Str) Trim(cutSet string) string

Trim returns a slice of the string s with all leading and trailing Unicode code points contained in cutSet removed.

func (*Str) TrimSpace

func (s *Str) TrimSpace() string

TrimSpace removes leading and trailing white spaces from the value

func (*Str) Truncate

func (s *Str) Truncate(length int, suffix string) string

Truncate 将字符串截断为指定的字符数

func (*Str) TruncateWords

func (s *Str) TruncateWords(count int, suffix string) string

TruncateWords 将字符串截断为指定的单词数

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL