README
¶
氖-Ne
[氖-Ne] Go开发实用库
获取
go get -u github.com/noble-gase/ne
包含
| 模块 | 说明 |
|---|---|
| array | 数组的常用方法 |
| hashes | 封装便于使用 |
| crypts | 封装便于使用(支持aes&rsa) |
| mutex | 基于 Redis 的分布式锁 |
| validator | 支持汉化和自定义规则 |
| linklist | 一个并发安全的双向列表 |
| errgroup | 基于官方版本改良，支持并发协程数量控制 |
| values | 用于处理 k-v 格式化的场景，如：生成签名串等 |
| coord | 距离、方位角、经纬度与平面直角坐标系的相互转化 |
| images | 图片处理，如：缩略图、裁切、标注等 |
| protos | 实现 url.Values 和 proto.Message 的相互转换 |
| leveltree | 基于泛型的菜单和组织单位等分类层级树 |
| timewheel | 简单实用的单层时间轮(支持一次性和多次重试任务) |
| retry | 重试封装 |
| steps | 分批次处理切片 |
| 辅助方法 | IP、file、time、string、version-compare 等 |
⚠️ 注意：如需支持协程并发复用的
errgroup请使用 👉 氙-Xe
Enjoy 😊
Documentation
¶
Index ¶
- Constants
- Variables
- func AddSlashes(s string) string
- func BindJSON(r *http.Request, obj any) error
- func BindProto(r *http.Request, msg proto.Message) error
- func ContentType(h http.Header) string
- func CreateFile(filename string) (*os.File, error)
- func DebugLogger(options ...zap.Option) *zap.Logger
- func ExcelColumnIndex(name string) int
- func IP2Long(ip string) uint32
- func IsUniqueDuplicateError(err error) bool
- func Long2IP(ip uint32) string
- func MarshalNoEscapeHTML(v any) ([]byte, error)
- func MyTimeEncoder(t time.Time, e zapcore.PrimitiveArrayEncoder)
- func NewDB(cfg *DBConfig) (*sql.DB, error)
- func NewHttpClient() *http.Client
- func NewLogger(cfg *LogConfig) *zap.Logger
- func Nonce(size uint8) string
- func OpenFile(filename string) (*os.File, error)
- func QuoteMeta(s string) string
- func StripSlashes(s string) string
- func Transaction(ctx context.Context, db *sql.DB, ...) (err error)
- func VersionCompare(rangeVer, curVer string) (bool, error)
- func WeekAround(layout string, now time.Time) (monday, sunday string)
- type DBConfig
- type LogConfig
- type M
- type Mutex
- type Size
- type X
Constants ¶
View Source
const ( HeaderAccept = "Accept" HeaderAuthorization = "Authorization" HeaderContentType = "Content-Type" )
View Source
const ( ContentText = "text/plain; charset=utf-8" ContentJSON = "application/json" ContentXML = "application/xml" ContentForm = "application/x-www-form-urlencoded" ContentStream = "application/octet-stream" ContentMultipartForm = "multipart/form-data" )
View Source
const ( // B - Byte size B Size = 1 // KiB - KibiByte size KiB = 1024 * B // MiB - MebiByte size MiB = 1024 * KiB // GiB - GibiByte size GiB = 1024 * MiB // TiB - TebiByte size TiB = 1024 * GiB )
View Source
const MaxFormMemory = 32 << 20
Variables ¶
View Source
var ErrLockNil = errors.New("redlock: lock not acquired")
ErrLockNil 未获取到锁
View Source
var GMT8 = time.FixedZone("CST", 8*3600)
GMT8 东八区时区
View Source
var RestyClient = resty.NewWithClient(NewHttpClient())
RestyClient default client for http request
Functions ¶
func ContentType ¶
func CreateFile ¶
CreateFile 创建或清空指定的文件 文件已存在，则清空；文件或目录不存在，则以0775权限创建
func ExcelColumnIndex ¶
ExcelColumnIndex 返回Excel列名对应的序号，如：A=0，B=1，AA=26，AB=27
func IsUniqueDuplicateError ¶
IsUniqueDuplicateError 判断是否「唯一索引冲突」错误
func MarshalNoEscapeHTML ¶
MarshalNoEscapeHTML 不带HTML转义的JSON序列化
func MyTimeEncoder ¶
func MyTimeEncoder(t time.Time, e zapcore.PrimitiveArrayEncoder)
MyTimeEncoder 自定义时间格式化
func Transaction ¶
func Transaction(ctx context.Context, db *sql.DB, fn func(ctx context.Context, tx *sql.Tx) error) (err error)
Transaction 执行数据库事物
func VersionCompare ¶
VersionCompare 语义化的版本比较
支持：
>
>=
=
!=
<
<=
| (or)
& (and)
示例(rangeVer)：
1.0.0
=1.0.0
>2.0.0
!=4.0.4
>=1.0.0&<2.0.0
<2.0.0|>3.0.0
Types ¶
type DBConfig ¶
type DBConfig struct {
// Driver 驱动名称
Driver string
// DSN 数据源名称
//
// [-- MySQL] username:password@tcp(localhost:3306)/dbname?timeout=10s&charset=utf8mb4&collation=utf8mb4_general_ci&parseTime=True&loc=Local
// [Postgres] host=localhost port=5432 user=root password=secret dbname=test search_path=schema connect_timeout=10 sslmode=disable
// [- SQLite] file::memory:?cache=shared
DSN string
// MaxOpenConns 设置最大可打开的连接数
MaxOpenConns int
// MaxIdleConns 连接池最大闲置连接数
MaxIdleConns int
// ConnMaxLifetime 连接的最大生命时长
ConnMaxLifetime time.Duration
// ConnMaxIdleTime 连接最大闲置时间
ConnMaxIdleTime time.Duration
}
DBConfig 数据库初始化配置
type LogConfig ¶
type LogConfig struct {
// Filename 日志名称
Filename string
// Level 日志级别
Level zapcore.Level
// MaxSize 当前文件多大时轮替；默认：100MB
MaxSize int
// MaxAge 轮替的旧文件最大保留时长；默认：不限
MaxAge int
// MaxBackups 轮替的旧文件最大保留数量；默认：不限
MaxBackups int
// Compress 轮替的旧文件是否压缩；默认：不压缩
Compress bool
// Stderr 是否输出到控制台
Stderr bool
// Options Zap日志选项
Options []zap.Option
}
LogConfig 日志初始化配置
type Mutex ¶
type Mutex interface {
// Lock 获取锁；未获取到会返回`ErrLockNil`
Lock(ctx context.Context) error
// TryLock 尝试获取锁；未获取到会返回`ErrLockNil`
TryLock(ctx context.Context, attempts int, interval time.Duration) error
// UnLock 释放锁
UnLock(ctx context.Context) error
}
Mutex 分布式锁
Source Files
¶
Directories
Click to show internal directories.
Click to hide internal directories.