utils

package

v1.0.4 Latest Latest Go to latest Published: Jun 22, 2026 License: MIT Imports: 25 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/EthanCodeCraft/xlgo-core

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func AppendFile(path string, data []byte) error
func Base64Decode(s string) ([]byte, error)
func Base64Encode(data []byte) string
func Base64URLDecode(s string) ([]byte, error)
func Base64URLEncode(data []byte) string
func CalcOffset(page, pageSize int) int
func CalcPageCount(total, pageSize int64) int64
func CopyFile(dst, src string) error
func DefaultIfBlank(s, def string) string
func DirExists(path string) bool
func EndOfDay(t time.Time) time.Time
func EndOfMonth(t time.Time) time.Time
func EnsureDir(path string) error
func EqualsIgnoreCase(a, b string) bool
func FileExists(path string) bool
func FileSize(path string) (int64, error)
func FormatDate(t time.Time) string
func FormatDateTime(t time.Time) string
func FormatTime(t time.Time, layout string) string
func FormatTimeOnly(t time.Time) string
func FromTimestamp(timestamp int64) time.Time
func FromUnix(unix int64) time.Time
func GetDateInt(t time.Time) int
func HTTPGet(url string, params map[string]string) ([]byte, error)
func HTTPPost(url string, params map[string]string) ([]byte, error)
func HTTPPostJSON(url string, data any) ([]byte, error)
func HasChinese(s string) bool
func HashFile(path string, newHash func() hash.Hash) (string, error)
func IsAllBlank(strs ...string) bool
func IsAlpha(s string) bool
func IsAlphanumeric(s string) bool
func IsAnyBlank(strs ...string) bool
func IsBlank(s string) bool
func IsChinese(s string) bool
func IsEmail(email string) bool
func IsEmpty(v any) bool
func IsIDCard(id string) bool
func IsIPv4(ip string) bool
func IsNotBlank(s string) bool
func IsNumeric(s string) bool
func IsPhone(phone string) bool
func JSONMarshal(v any) ([]byte, error)
func MD5(s string) string
func MD5Bytes(data []byte) string
func Nl2br(s string, isXhtml bool) string
func NowTimestamp() int64
func NowUnix() int64
func ParseDateInt(date int) time.Time
func ParseTime(timeStr, layout string) (time.Time, error)
func RandDigit(n int) string
func RandInt(min, max int) int
func RandInt64(min, max int64) int64
func RandString(n int) string
func ReadFile(path string) ([]byte, error)
func RemoveFile(path string) error
func SHA1(s string) string
func SHA256(s string) string
func SHA256Bytes(data []byte) string
func StartOfDay(t time.Time) time.Time
func StartOfMonth(t time.Time) time.Time
func StartOfWeek(t time.Time) time.Time
func StrLen(s string) int
func Substr(s string, start, length int) string
func ToFloat64(s string) float64
func ToFloat64Default(s string, def float64) float64
func ToInt(s string) int
func ToInt64(s string) int64
func ToInt64Default(s string, def int64) int64
func ToIntDefault(s string, def int) int
func ToString(n int) string
func ToString64(n int64) string
func ToUint64(s string) uint64
func ToUint64Default(s string, def uint64) uint64
func Trim(s string) string
func URLDecode(s string) (string, error)
func URLEncode(s string) string
func UUID() string
func UUIDParse(s string) (uuid.UUID, error)
func UUIDShort() string
func UUIDValid(s string) bool
func WriteFile(path string, data []byte) error
type HTTPClient
- func DefaultHTTPClient() *HTTPClient
- func NewHTTPClient() *HTTPClient
- func NewHTTPClientWithConfig(cfg HTTPClientConfig) *HTTPClient
- func (c *HTTPClient) Close()
- func (c *HTTPClient) Delete(urlStr string) ([]byte, error)
- func (c *HTTPClient) DoWithResponse(req *http.Request) (*http.Response, error)
- func (c *HTTPClient) Get(urlStr string, params map[string]string) ([]byte, error)
- func (c *HTTPClient) Post(urlStr string, params map[string]string) ([]byte, error)
- func (c *HTTPClient) PostJSON(urlStr string, data any) ([]byte, error)
- func (c *HTTPClient) Put(urlStr string, data any) ([]byte, error)
- func (c *HTTPClient) Request(method, urlStr string, body []byte) ([]byte, error)
- func (c *HTTPClient) SetCookie(key, value string) *HTTPClient
- func (c *HTTPClient) SetHeader(key, value string) *HTTPClient
- func (c *HTTPClient) SetHeaders(headers map[string]string) *HTTPClient
- func (c *HTTPClient) SetSkipTLS(skip bool) *HTTPClient
- func (c *HTTPClient) SetTimeout(timeout time.Duration) *HTTPClient
- func (c *HTTPClient) Upload(urlStr string, files []UploadFile, params map[string]string) ([]byte, error)
- func (c *HTTPClient) UploadFromBytes(urlStr string, fieldName string, filename string, data []byte, ...) ([]byte, error)
type HTTPClientConfig
type URLBuilder
- func ParseURL(rawURL string) (*URLBuilder, error)
- func (b *URLBuilder) AddQueries(params map[string]string) *URLBuilder
- func (b *URLBuilder) AddQuery(key, value string) *URLBuilder
- func (b *URLBuilder) Build() *url.URL
- func (b *URLBuilder) SetHost(host string) *URLBuilder
- func (b *URLBuilder) SetPath(path string) *URLBuilder
- func (b *URLBuilder) SetQuery(key, value string) *URLBuilder
- func (b *URLBuilder) SetScheme(scheme string) *URLBuilder
- func (b *URLBuilder) String() string
type UploadFile

Constants ¶

This section is empty.

Variables ¶

View Source

var DefaultHTTPClientConfig = HTTPClientConfig{
	Timeout:             30 * time.Second,
	MaxIdleConns:        100,
	IdleConnTimeout:     90 * time.Second,
	MaxConnsPerHost:     10,
	MaxIdleConnsPerHost: 10,
	SkipTLSVerify:       true,
}

DefaultHTTPClientConfig 默认配置

Functions ¶

func AppendFile ¶

func AppendFile(path string, data []byte) error

AppendFile 追加内容到文件

func Base64Decode ¶

func Base64Decode(s string) ([]byte, error)

Base64Decode Base64 解码

func Base64Encode ¶

func Base64Encode(data []byte) string

Base64Encode Base64 编码

func Base64URLDecode ¶

func Base64URLDecode(s string) ([]byte, error)

Base64URLDecode URL 安全的 Base64 解码

func Base64URLEncode ¶

func Base64URLEncode(data []byte) string

Base64URLEncode URL 安全的 Base64 编码

func CalcOffset ¶

func CalcOffset(page, pageSize int) int

CalcOffset 计算分页偏移量

func CalcPageCount ¶

func CalcPageCount(total, pageSize int64) int64

CalcPageCount 计算总页数

func CopyFile ¶

func CopyFile(dst, src string) error

CopyFile 复制文件

func DefaultIfBlank ¶

func DefaultIfBlank(s, def string) string

DefaultIfBlank 如果字符串为空或空白，返回默认值

func DirExists ¶

func DirExists(path string) bool

DirExists 检查目录是否存在

func EndOfDay ¶

func EndOfDay(t time.Time) time.Time

EndOfDay 返回指定时间当天的结束时间 (23:59:59.999999999)

func EndOfMonth ¶

func EndOfMonth(t time.Time) time.Time

EndOfMonth 返回指定时间当月的结束时间

func EnsureDir ¶

func EnsureDir(path string) error

EnsureDir 确保目录存在，不存在则创建

func EqualsIgnoreCase ¶

func EqualsIgnoreCase(a, b string) bool

EqualsIgnoreCase 不区分大小写比较字符串

func FileExists ¶

func FileExists(path string) bool

FileExists 检查文件是否存在

func FileSize ¶

func FileSize(path string) (int64, error)

FileSize 获取文件大小

func FormatDate ¶

func FormatDate(t time.Time) string

FormatDate 格式化为日期 "2006-01-02"

func FormatDateTime ¶

func FormatDateTime(t time.Time) string

FormatDateTime 格式化为标准日期时间 "2006-01-02 15:04:05"

func FormatTime ¶

func FormatTime(t time.Time, layout string) string

FormatTime 格式化时间

func FormatTimeOnly ¶

func FormatTimeOnly(t time.Time) string

FormatTimeOnly 格式化为时间 "15:04:05"

func FromTimestamp ¶

func FromTimestamp(timestamp int64) time.Time

FromTimestamp 毫秒时间戳转 time.Time

func FromUnix ¶

func FromUnix(unix int64) time.Time

FromUnix 秒级时间戳转 time.Time

func GetDateInt ¶

func GetDateInt(t time.Time) int

GetDateInt 返回 yyyyMMdd 格式的日期整数

func HTTPGet ¶

func HTTPGet(url string, params map[string]string) ([]byte, error)

HTTPGet 使用默认客户端发送 GET 请求

func HTTPPost ¶

func HTTPPost(url string, params map[string]string) ([]byte, error)

HTTPPost 使用默认客户端发送 POST 请求

func HTTPPostJSON ¶

func HTTPPostJSON(url string, data any) ([]byte, error)

HTTPPostJSON 使用默认客户端发送 JSON POST 请求

func HasChinese ¶

func HasChinese(s string) bool

HasChinese 检查字符串是否包含中文字符

func HashFile ¶

func HashFile(path string, newHash func() hash.Hash) (string, error)

HashFile 计算文件的哈希值

func IsAllBlank ¶

func IsAllBlank(strs ...string) bool

IsAllBlank 检查所有字符串是否都为空或空白

func IsAlpha ¶

func IsAlpha(s string) bool

IsAlpha 检查字符串是否全部为字母

func IsAlphanumeric ¶

func IsAlphanumeric(s string) bool

IsAlphanumeric 检查字符串是否全部为字母或数字

func IsAnyBlank ¶

func IsAnyBlank(strs ...string) bool

IsAnyBlank 检查多个字符串中是否有任意一个为空或空白

func IsBlank ¶

func IsBlank(s string) bool

IsBlank 检查字符串是否为空或仅包含空白字符

func IsChinese ¶

func IsChinese(s string) bool

IsChinese 检查字符串是否全部为中文字符

func IsEmail ¶

func IsEmail(email string) bool

IsEmail 检查是否为有效的邮箱地址

func IsEmpty ¶

func IsEmpty(v any) bool

IsEmpty 检查任意类型是否为空值支持: string, []T, map[K]V, nil, 零值

func IsIDCard ¶

func IsIDCard(id string) bool

IsIDCard 检查是否为有效的中国身份证号（18位）注意: 仅校验格式，不校验校验位

func IsIPv4 ¶

func IsIPv4(ip string) bool

IsIPv4 检查是否为有效的 IPv4 地址

func IsNotBlank ¶

func IsNotBlank(s string) bool

IsNotBlank 检查字符串是否非空且不全是空白字符

func IsNumeric ¶

func IsNumeric(s string) bool

IsNumeric 检查字符串是否全部为数字

func IsPhone ¶

func IsPhone(phone string) bool

IsPhone 检查是否为有效的中国大陆手机号注意: 正则基于当前号段，新号段开放时需更新

func JSONMarshal ¶

func JSONMarshal(v any) ([]byte, error)

JSONMarshal 内部 JSON 序列化函数

func MD5 ¶

func MD5(s string) string

MD5 计算字符串的 MD5 哈希值注意: 不应用于密码存储

func MD5Bytes ¶

func MD5Bytes(data []byte) string

MD5Bytes 计算字节数组的 MD5 哈希值

func Nl2br ¶

func Nl2br(s string, isXhtml bool) string

Nl2br 将换行符替换为 <br> 标签

func NowTimestamp ¶

func NowTimestamp() int64

NowTimestamp 返回当前毫秒时间戳

func NowUnix ¶

func NowUnix() int64

NowUnix 返回当前秒级时间戳

func ParseDateInt ¶

func ParseDateInt(date int) time.Time

ParseDateInt 将 yyyyMMdd 格式的整数转为时间

func ParseTime ¶

func ParseTime(timeStr, layout string) (time.Time, error)

ParseTime 解析时间字符串

func RandDigit ¶

func RandDigit(n int) string

RandDigit 生成指定长度的随机数字字符串

func RandInt ¶

func RandInt(min, max int) int

RandInt 返回 [min, max) 范围内的随机整数

func RandInt64 ¶

func RandInt64(min, max int64) int64

RandInt64 返回 [min, max) 范围内的随机 int64

func RandString ¶

func RandString(n int) string

RandString 生成指定长度的随机字符串（字母+数字）

func ReadFile ¶

func ReadFile(path string) ([]byte, error)

ReadFile 读取文件内容

func RemoveFile ¶

func RemoveFile(path string) error

RemoveFile 删除文件（忽略不存在的错误）

func SHA1 ¶

func SHA1(s string) string

SHA1 计算字符串的 SHA1 哈希值注意: 不应用于密码存储

func SHA256 ¶

func SHA256(s string) string

SHA256 计算字符串的 SHA256 哈希值

func SHA256Bytes ¶

func SHA256Bytes(data []byte) string

SHA256Bytes 计算字节数组的 SHA256 哈希值

func StartOfDay ¶

func StartOfDay(t time.Time) time.Time

StartOfDay 返回指定时间当天的开始时间 (00:00:00)

func StartOfMonth ¶

func StartOfMonth(t time.Time) time.Time

StartOfMonth 返回指定时间当月的开始时间

func StartOfWeek ¶

func StartOfWeek(t time.Time) time.Time

StartOfWeek 返回指定时间当周的开始时间（周一为第一天）

func StrLen ¶

func StrLen(s string) int

StrLen 获取字符串的 Unicode 字符数

func Substr ¶

func Substr(s string, start, length int) string

Substr 截取子字符串（按 Unicode 字符计数）参数: start 起始位置（支持负数从末尾计算），length 截取长度

func ToFloat64 ¶

func ToFloat64(s string) float64

ToFloat64 字符串转 float64，失败返回 0

func ToFloat64Default ¶

func ToFloat64Default(s string, def float64) float64

ToFloat64Default 字符串转 float64，失败返回默认值

func ToInt ¶

func ToInt(s string) int

ToInt 字符串转 int，失败返回 0

func ToInt64 ¶

func ToInt64(s string) int64

ToInt64 字符串转 int64，失败返回 0

func ToInt64Default ¶

func ToInt64Default(s string, def int64) int64

ToInt64Default 字符串转 int64，失败返回默认值

func ToIntDefault ¶

func ToIntDefault(s string, def int) int

ToIntDefault 字符串转 int，失败返回默认值

func ToString ¶

func ToString(n int) string

ToString 整数转字符串

func ToString64 ¶

func ToString64(n int64) string

ToString64 int64 转字符串

func ToUint64 ¶

func ToUint64(s string) uint64

ToUint64 字符串转 uint64，失败返回 0

func ToUint64Default ¶

func ToUint64Default(s string, def uint64) uint64

ToUint64Default 字符串转 uint64，失败返回默认值

func Trim ¶

func Trim(s string) string

Trim 去除字符串首尾的空白字符（包括空格、制表符、换行符）

func URLDecode ¶

func URLDecode(s string) (string, error)

URLDecode URL 解码

func URLEncode ¶

func URLEncode(s string) string

URLEncode URL 编码

func UUID ¶

func UUID() string

UUID 生成 UUID v4 字符串

func UUIDParse ¶

func UUIDParse(s string) (uuid.UUID, error)

UUIDParse 解析 UUID 字符串

func UUIDShort ¶

func UUIDShort() string

UUIDShort 生成短 UUID（无横线）

func UUIDValid ¶

func UUIDValid(s string) bool

UUIDValid 检查 UUID 字符串是否有效

func WriteFile ¶

func WriteFile(path string, data []byte) error

WriteFile 写入文件内容（覆盖）

Types ¶

type HTTPClient ¶

type HTTPClient struct {
	// contains filtered or unexported fields
}

HTTPClient HTTP 客户端封装

func DefaultHTTPClient ¶

func DefaultHTTPClient() *HTTPClient

DefaultHTTPClient 获取全局默认 HTTP 客户端

func NewHTTPClient ¶

func NewHTTPClient() *HTTPClient

NewHTTPClient 创建 HTTP 客户端

func NewHTTPClientWithConfig ¶

func NewHTTPClientWithConfig(cfg HTTPClientConfig) *HTTPClient

NewHTTPClientWithConfig 使用自定义配置创建 HTTP 客户端

func (*HTTPClient) Close ¶

func (c *HTTPClient) Close()

Close 关闭客户端（释放连接池资源）

func (*HTTPClient) Delete ¶

func (c *HTTPClient) Delete(urlStr string) ([]byte, error)

Delete 发送 DELETE 请求

func (*HTTPClient) DoWithResponse ¶

func (c *HTTPClient) DoWithResponse(req *http.Request) (*http.Response, error)

DoWithResponse 执行请求并返回完整响应

func (*HTTPClient) Get ¶

func (c *HTTPClient) Get(urlStr string, params map[string]string) ([]byte, error)

Get 发送 GET 请求

func (*HTTPClient) Post ¶

func (c *HTTPClient) Post(urlStr string, params map[string]string) ([]byte, error)

Post 发送 POST 请求（form 表单格式）

func (*HTTPClient) PostJSON ¶

func (c *HTTPClient) PostJSON(urlStr string, data any) ([]byte, error)

PostJSON 发送 POST 请求（JSON 格式）

func (*HTTPClient) Put ¶

func (c *HTTPClient) Put(urlStr string, data any) ([]byte, error)

Put 发送 PUT 请求（JSON 格式）

func (*HTTPClient) Request ¶

func (c *HTTPClient) Request(method, urlStr string, body []byte) ([]byte, error)

Request 发送自定义请求

func (*HTTPClient) SetCookie ¶

func (c *HTTPClient) SetCookie(key, value string) *HTTPClient

SetCookie 设置 Cookie

func (*HTTPClient) SetHeader ¶

func (c *HTTPClient) SetHeader(key, value string) *HTTPClient

SetHeader 设置请求头

func (*HTTPClient) SetHeaders ¶

func (c *HTTPClient) SetHeaders(headers map[string]string) *HTTPClient

SetHeaders 批量设置请求头

func (*HTTPClient) SetSkipTLS ¶

func (c *HTTPClient) SetSkipTLS(skip bool) *HTTPClient

SetSkipTLS 设置是否跳过 TLS 验证注意: 修改 TLS 配置需要重新创建 Transport

func (*HTTPClient) SetTimeout ¶

func (c *HTTPClient) SetTimeout(timeout time.Duration) *HTTPClient

SetTimeout 设置超时时间

func (*HTTPClient) Upload ¶

func (c *HTTPClient) Upload(urlStr string, files []UploadFile, params map[string]string) ([]byte, error)

Upload 上传文件

func (*HTTPClient) UploadFromBytes ¶

func (c *HTTPClient) UploadFromBytes(urlStr string, fieldName string, filename string, data []byte, params map[string]string) ([]byte, error)

UploadFromBytes 从字节数据上传文件

type HTTPClientConfig ¶

type HTTPClientConfig struct {
	Timeout             time.Duration // 请求超时时间
	MaxIdleConns        int           // 最大空闲连接数
	IdleConnTimeout     time.Duration // 空闲连接超时时间
	MaxConnsPerHost     int           // 每个主机最大连接数
	MaxIdleConnsPerHost int           // 每个主机最大空闲连接数
	SkipTLSVerify       bool          // 是否跳过 TLS 验证
}

HTTPClientConfig HTTP 客户端配置

type URLBuilder ¶

type URLBuilder struct {
	// contains filtered or unexported fields
}

URLBuilder URL 构建器

func ParseURL ¶

func ParseURL(rawURL string) (*URLBuilder, error)

ParseURL 解析 URL 字符串

func (*URLBuilder) AddQueries ¶

func (b *URLBuilder) AddQueries(params map[string]string) *URLBuilder

AddQueries 批量添加查询参数

func (*URLBuilder) AddQuery ¶

func (b *URLBuilder) AddQuery(key, value string) *URLBuilder

AddQuery 添加单个查询参数

func (*URLBuilder) Build ¶

func (b *URLBuilder) Build() *url.URL

Build 构建最终的 URL

func (*URLBuilder) SetHost ¶

func (b *URLBuilder) SetHost(host string) *URLBuilder

SetHost 设置主机

func (*URLBuilder) SetPath ¶

func (b *URLBuilder) SetPath(path string) *URLBuilder

SetPath 设置路径

func (*URLBuilder) SetQuery ¶

func (b *URLBuilder) SetQuery(key, value string) *URLBuilder

SetQuery 设置查询参数（覆盖同名参数）

func (*URLBuilder) SetScheme ¶

func (b *URLBuilder) SetScheme(scheme string) *URLBuilder

SetScheme 设置协议（http/https）

func (*URLBuilder) String ¶

func (b *URLBuilder) String() string

String 返回 URL 字符串

type UploadFile ¶

type UploadFile struct {
	FieldName string // 表单字段名
	FilePath  string // 文件路径
}

UploadFile 上传文件信息

Source Files ¶

View all Source files

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