pkg.gl

可以将数字包括小数 转成 字符串

- 小数我们只实现了 float64 您需要先转float64; String(float64(小数))

- error 标注类型

- 实现 String() string 函数方法的 对象，包含指针，和值类型

- io.Reader 接口

- 当然更包含 字符串本身

StrPos(source string, str_piece string) int ｜字符串位置查找

在某个字符串中查找一个字符串片段的位置；return -1:未找到; >=0 :返回具体位置序号

抄袭PHP 的标准函数库

StrBegin(str string, sep string) string ｜截取某个字符串片段以前的字符串

    str := "hello world go tips"
    if StrBegin(str, "o") != "hell" {
        t.Error("strings StrPos expect hell")
    }
    if StrBegin(str, "tip") != "hello world go " {
        t.Error("strings StrPos expect 'hello world go '")
    }

StrEnd(str, sep string) string | 截取某个字符串片段以后的字符串

    str := "hello world go tips"
    if StrEnd(str, "o") != " world go tips" {
        t.Error("strings StrPos expect: world go tips")
    }
    if StrEnd(str, "tip") != "s" {
        t.Error("strings StrPos expect:s")
    }

date

格式：2006-01-02 15:04:05

StrToTimestamp(str string) int64 | 字符串转时间戳

TimestampToStr(timestamp int64) string | 时间戳转字符串

spinLock 无IO 锁

实现了sync.Locker 接口

    mu := spinlock.New()
    mu.Lock()
    // do something thread unsafe
    defer mu.Unlock()

common functions

IsNil(i interface{}) bool | 正确的判断 nil 和空接口的nil

ConfigWithViper(file_name_any string) *viper.Viper ｜快速，要求不高的使用viper

FUNC_NAME(f interface{}) string ｜获取函数名

IS_FUNC(fn interface{}) bool | 是否是函数

IS_SLICE(s interface{}) bool ｜是否是切片

IS_STRUCT(stu interface{}) bool | 是否是结构体

IfThree(false)("yes", "no") | 简短的if 方式争取一行做完，比较适合接口类，否则还需要写类型转换

每次使用也是多消耗了内存的

Any2Int64(v any) int64 ｜转int64

Int(v any) int ｜转 int

GetRootPath() string ｜获取 go 服务执行文件对应目录

logf.Logger

主要是定义了比较通用的日志接口，多数框架上都是实现的这个;一般不会为日志定义太多接口函数

为了不统一就把接口定义提取出来，不必每个项目都写，还不知道是不是一样 method

logf.Logger 定义

    type Logger interface {
        Printf(string, ...any)
        Print(...any)
    }

loger struct | 以fmt 简单的实现了 Logger 接口

json package

接口与标准的是一样的，值得拿出来的原因是：防止数字总会专成 float64 ，我们以 int 为主

safe package

名字叫的并不贴切

安全的int型Map

仅仅做了key是int 的 map ；并发安全，用的比较多，所以单独写出来了，其他类型的没怎么重复用过；就没放进去

最重要的是有了 sync.Map 高性能的安全map

    type QuickIntMap struct {
        data   map[int]any
        splock sync.Locker
    }

Slice 自定义系列

这也是写 go-tips 的由来；总结之后写的业务，确实能简化，减少代码量，和bug少些。避免反复写一堆比较函数；使用更简短的代码去建立不同数组对象的关系。

增加常用整数类型的切片操作，查找，合并，删除，比较等
可以直接互相强制转换标准复杂类型，这里的

    s1 := []string{"1", "2", "3"}
    ss1 := SliceString(s1) // 强制转化标准类型
    []string(ss1) // 强制转化 自定义 SliceX 类型

仅仅提供 []string, []intX, []Value; Value 是自定义类型

    type Value interface {
        Value() int64
    }

可以支持原生golang 的语法 [:], append,copy 等操作
多数组简易合并，是否 unique 都可以使用不同的方法
只有SliceValue 稍微有些不同，但使用起来仍然让人挺惊讶的

1. type SliceString []string | 字符串切片

可以直接强转标准类型

    s1 := []string{"1", "2", "3"}
    ss1 := SliceString(s1)

支持的Methods

    func (this *SliceString) Append(val string)
    func (this *SliceString) AppendUnqiue(val string) 
    func (this *SliceString) AppendArr(arrs ...[]string)
    func (this *SliceString) Del(val string) int
    func (this *SliceString) DelKey(k int) string 
    func (this *SliceString) Reset() 
    func (this *SliceString) Len() int 
    func (this *SliceString) In(val string) int 
    func (this *SliceString) Join(sep string) string 
    func (this *SliceString) Range(fn func(i int, val string) bool)

同样支持[]string 的所有操作

2. type SliceIntX []intX 系列

其中X包含：int,int32,int64;其他的int16 类似uint等都没去实现
可以与标准类型互换
支持类型

    type SliceInt []int
    type SliceInt32 []int32
    type SliceInt64 []int64

方法

以 SliceInt 为例子

    func (this *SliceInt) Append(val int)
    func (this *SliceInt) AppendUnqiue(val int) 
    func (this *SliceInt) AppendArr(arrs ...[]int)
    func (this *SliceInt) Del(val int) int
    func (this *SliceInt) DelKey(k int) int
    func (this *SliceInt) Reset()
    func (this *SliceInt) Len() int
    func (this *SliceInt) In(val int) int
    func (this *SliceInt) Join(sep string) string
    func (this *SliceInt) Range(fn func(i, val int) bool)

3. type SliceValue []Value ｜加了一个变相的可比较类型，以实现通用化

Value 是自定义接口，任何实现它的方法的，都可以用

    type Value interface {
        Value() int64
    }

SliceValue 就无法直接互换类型了
除了copy 同样支持 slice 的标准操作
方法

    func (this *SliceValue) Append(val Value)
    func (this *SliceValue) AppendUnqiue(val Value)
    func (this *SliceValue) AppendArr(arrs ...[]Value) 
    func (this *SliceValue) Del(val Value) int 
    func (this *SliceValue) DelKey(k int) Value 
    func (this *SliceValue) Reset() 
    func (this *SliceValue) Len() int 
    func (this *SliceValue) In(val Value) int 
    func (this *SliceValue) Range(fn func(i int, val Value) bool)

异步事件 module_event 模块

使用：最好的教程就是 event_test内的测试代码

    go get github.com/slclub/go-tips/events/module_event

特性：

    1. 异步
    2. 可以选择模式，是所有事件handle 并发 还是 同步
    3. 自定义线程池，可以嵌入 实现下 module_event.AsyncSubmiter 接口即可;默认使用ants

simple example:

func TestEventCommon(t *testing.T) {
	// new  创建事件监视器
    eventMonitor := NewEvent(&Option{})
    
    // register 绑定消息ID 和Handle 且绑定到 该 监视器中
    eventMonitor.Register(EventHandle(handleLogin), &TEST_EVENT_ID_LOGIN)                        // register fail
    eventMonitor.Register(EventHandle(handleLogout), &TEST_EVENT_ID_LOGOUT)                      // register fail
    eventMonitor.Register(EventHandle(handleTrace), &TEST_EVENT_ID_LOGIN, &TEST_EVENT_ID_LOGOUT) // regsiter fail
    eventMonitor.Register(EventHandle(handleLogout), nil)                                        // register fail
    eventMonitor.Register(HandleConvert(anotherHandle), &TEST_EVENT_ID_ANOTHER)                  // register ok
    
    // trigger 触发 提交事件
    eventMonitor.Submit(&EventOper{&TEST_EVENT_ID_LOGIN, "", []any{t, 1, 2, "event"}}) // ok
    eventMonitor.Trigger(&TEST_EVENT_ID_ANOTHER, t, 3, "gold")
    
    // emit 执行所提交的事件
    eventMonitor.Emit()
    time.Sleep(10 * time.Millisecond)
    
    // release 释放
    eventMonitor.Close()
}

$$ 使用步骤如下：

创建事件监视器

这是最简单且是异步并发处理的

    eventMonitor := NewEvent(&Option{})

注册事件

定义消息ID

    var (
        TEST_EVENT_ID_LOGIN   EVENT_ID_STRING = "TEST.LOGIN"
        TEST_EVENT_ID_LOGOUT  EVENT_ID_STRING = "TEST.LOGOUT"
        TEST_EVENT_ID_ANOTHER EVENT_ID_INT    = 1001
    )

有关消息ID 的详细信息可以看源码，或者看下面消息ID小结中。

注册到事件监视器中

    // register
    eventMonitor.Register(EventHandle(handleLogin), &TEST_EVENT_ID_LOGIN)                        // register fail
    eventMonitor.Register(EventHandle(handleLogout), &TEST_EVENT_ID_LOGOUT)                      // register fail
    eventMonitor.Register(EventHandle(handleTrace), &TEST_EVENT_ID_LOGIN, &TEST_EVENT_ID_LOGOUT) // regsiter fail
    eventMonitor.Register(EventHandle(handleLogout), nil)                                        // register fail
    eventMonitor.Register(HandleConvert(anotherHandle), &TEST_EVENT_ID_ANOTHER)                  // register ok

在适当的异步的位置执行发射函数

    eventMonitor.Emit()

如果用定时执轮训的方式，就不需要单独去执行发射函数 Emit

安全释放

    eventMonitor.Close()

so easy

事件消息ID 类型

所有的消息ID 都要实现 EventValue 接口

    type EventValue interface {
        Value() string
    }

系统默认支持2中消息类型，简单点说就是基于系统的类型衍生一下

    // 事件ID 分两种，都继承了 EventValue
    type EVENT_ID_INT int
    type EVENT_ID_STRING string

消息Handle

同样也定义了类型，但不用担心, 还是挺好用

    type EventHandle func(oper *EventOper)

可以用 HandleConvert 把 func(args ...any) 转化成EventHandle; module event直接提供的函数

函数签名如下

HandleConvert(fn func(args ...any)) EventHandle

一个Handle 可以对应多个事件ID

事件ID 和事件Handle 是多对多的关系

事件监视器控制，和自定义部分

用 Option 初始化 Event

Option 的定义在源码中很清楚

example

    eventMonitor := NewEvent(&Option{
        InOrder:        false,  // 是否让所有事件 顺序同步执行
        TimeTickPeriod: time.Duration(10 * time.Millisecond), //不启用轮训机制 设置成0 即可
        Submiter:       antsPool(), // 植入自己的携程池
    })

Custom routine pool

实现接口 AsyncSubmiter 赋值给 Option.Sumiter

    // routine pool interface
    // please remenber use Release method to free your memory of pool
    type AsyncSubmiter interface {
        Submit(func()) error
        Release()
    }