✨ init project

2025-04-09 12:17:33 +08:00
parent 6840d5d5e3
commit f6622a4e98
392 changed files with 55744 additions and 3 deletions
--- a/utils/timer/timed_task.go
+++ b/utils/timer/timed_task.go
@@ -0,0 +1,229 @@
+package timer
+
+import (
+	"github.com/robfig/cron/v3"
+	"sync"
+)
+
+type Timer interface {
+	// 寻找所有Cron
+	FindCronList() map[string]*taskManager
+	// 添加Task 方法形式以秒的形式加入
+	AddTaskByFuncWithSecond(cronName string, spec string, fun func(), taskName string, option ...cron.Option) (cron.EntryID, error) // 添加Task Func以秒的形式加入
+	// 添加Task 接口形式以秒的形式加入
+	AddTaskByJobWithSeconds(cronName string, spec string, job interface{ Run() }, taskName string, option ...cron.Option) (cron.EntryID, error)
+	// 通过函数的方法添加任务
+	AddTaskByFunc(cronName string, spec string, task func(), taskName string, option ...cron.Option) (cron.EntryID, error)
+	// 通过接口的方法添加任务 要实现一个带有 Run方法的接口触发
+	AddTaskByJob(cronName string, spec string, job interface{ Run() }, taskName string, option ...cron.Option) (cron.EntryID, error)
+	// 获取对应taskName的cron 可能会为空
+	FindCron(cronName string) (*taskManager, bool)
+	// 指定cron开始执行
+	StartCron(cronName string)
+	// 指定cron停止执行
+	StopCron(cronName string)
+	// 查找指定cron下的指定task
+	FindTask(cronName string, taskName string) (*task, bool)
+	// 根据id删除指定cron下的指定task
+	RemoveTask(cronName string, id int)
+	// 根据taskName删除指定cron下的指定task
+	RemoveTaskByName(cronName string, taskName string)
+	// 清理掉指定cronName
+	Clear(cronName string)
+	// 停止所有的cron
+	Close()
+}
+
+type task struct {
+	EntryID  cron.EntryID
+	Spec     string
+	TaskName string
+}
+
+type taskManager struct {
+	corn  *cron.Cron
+	tasks map[cron.EntryID]*task
+}
+
+// timer 定时任务管理
+type timer struct {
+	cronList map[string]*taskManager
+	sync.Mutex
+}
+
+// AddTaskByFunc 通过函数的方法添加任务
+func (t *timer) AddTaskByFunc(cronName string, spec string, fun func(), taskName string, option ...cron.Option) (cron.EntryID, error) {
+	t.Lock()
+	defer t.Unlock()
+	if _, ok := t.cronList[cronName]; !ok {
+		tasks := make(map[cron.EntryID]*task)
+		t.cronList[cronName] = &taskManager{
+			corn:  cron.New(option...),
+			tasks: tasks,
+		}
+	}
+	id, err := t.cronList[cronName].corn.AddFunc(spec, fun)
+	t.cronList[cronName].corn.Start()
+	t.cronList[cronName].tasks[id] = &task{
+		EntryID:  id,
+		Spec:     spec,
+		TaskName: taskName,
+	}
+	return id, err
+}
+
+// AddTaskByFuncWithSecond 通过函数的方法使用WithSeconds添加任务
+func (t *timer) AddTaskByFuncWithSecond(cronName string, spec string, fun func(), taskName string, option ...cron.Option) (cron.EntryID, error) {
+	t.Lock()
+	defer t.Unlock()
+	option = append(option, cron.WithSeconds())
+	if _, ok := t.cronList[cronName]; !ok {
+		tasks := make(map[cron.EntryID]*task)
+		t.cronList[cronName] = &taskManager{
+			corn:  cron.New(option...),
+			tasks: tasks,
+		}
+	}
+	id, err := t.cronList[cronName].corn.AddFunc(spec, fun)
+	t.cronList[cronName].corn.Start()
+	t.cronList[cronName].tasks[id] = &task{
+		EntryID:  id,
+		Spec:     spec,
+		TaskName: taskName,
+	}
+	return id, err
+}
+
+// AddTaskByJob 通过接口的方法添加任务
+func (t *timer) AddTaskByJob(cronName string, spec string, job interface{ Run() }, taskName string, option ...cron.Option) (cron.EntryID, error) {
+	t.Lock()
+	defer t.Unlock()
+	if _, ok := t.cronList[cronName]; !ok {
+		tasks := make(map[cron.EntryID]*task)
+		t.cronList[cronName] = &taskManager{
+			corn:  cron.New(option...),
+			tasks: tasks,
+		}
+	}
+	id, err := t.cronList[cronName].corn.AddJob(spec, job)
+	t.cronList[cronName].corn.Start()
+	t.cronList[cronName].tasks[id] = &task{
+		EntryID:  id,
+		Spec:     spec,
+		TaskName: taskName,
+	}
+	return id, err
+}
+
+// AddTaskByJobWithSeconds 通过接口的方法添加任务
+func (t *timer) AddTaskByJobWithSeconds(cronName string, spec string, job interface{ Run() }, taskName string, option ...cron.Option) (cron.EntryID, error) {
+	t.Lock()
+	defer t.Unlock()
+	option = append(option, cron.WithSeconds())
+	if _, ok := t.cronList[cronName]; !ok {
+		tasks := make(map[cron.EntryID]*task)
+		t.cronList[cronName] = &taskManager{
+			corn:  cron.New(option...),
+			tasks: tasks,
+		}
+	}
+	id, err := t.cronList[cronName].corn.AddJob(spec, job)
+	t.cronList[cronName].corn.Start()
+	t.cronList[cronName].tasks[id] = &task{
+		EntryID:  id,
+		Spec:     spec,
+		TaskName: taskName,
+	}
+	return id, err
+}
+
+// FindCron 获取对应cronName的cron 可能会为空
+func (t *timer) FindCron(cronName string) (*taskManager, bool) {
+	t.Lock()
+	defer t.Unlock()
+	v, ok := t.cronList[cronName]
+	return v, ok
+}
+
+// FindTask 获取对应cronName的cron 可能会为空
+func (t *timer) FindTask(cronName string, taskName string) (*task, bool) {
+	t.Lock()
+	defer t.Unlock()
+	v, ok := t.cronList[cronName]
+	if !ok {
+		return nil, ok
+	}
+	for _, t2 := range v.tasks {
+		if t2.TaskName == taskName {
+			return t2, true
+		}
+	}
+	return nil, false
+}
+
+// FindCronList 获取所有的任务列表
+func (t *timer) FindCronList() map[string]*taskManager {
+	t.Lock()
+	defer t.Unlock()
+	return t.cronList
+}
+
+// StartCron 开始任务
+func (t *timer) StartCron(cronName string) {
+	t.Lock()
+	defer t.Unlock()
+	if v, ok := t.cronList[cronName]; ok {
+		v.corn.Start()
+	}
+}
+
+// StopCron 停止任务
+func (t *timer) StopCron(cronName string) {
+	t.Lock()
+	defer t.Unlock()
+	if v, ok := t.cronList[cronName]; ok {
+		v.corn.Stop()
+	}
+}
+
+// RemoveTask 从cronName 删除指定任务
+func (t *timer) RemoveTask(cronName string, id int) {
+	t.Lock()
+	defer t.Unlock()
+	if v, ok := t.cronList[cronName]; ok {
+		v.corn.Remove(cron.EntryID(id))
+		delete(v.tasks, cron.EntryID(id))
+	}
+}
+
+// RemoveTaskByName 从cronName 使用taskName 删除指定任务
+func (t *timer) RemoveTaskByName(cronName string, taskName string) {
+	fTask, ok := t.FindTask(cronName, taskName)
+	if !ok {
+		return
+	}
+	t.RemoveTask(cronName, int(fTask.EntryID))
+}
+
+// Clear 清除任务
+func (t *timer) Clear(cronName string) {
+	t.Lock()
+	defer t.Unlock()
+	if v, ok := t.cronList[cronName]; ok {
+		v.corn.Stop()
+		delete(t.cronList, cronName)
+	}
+}
+
+// Close 释放资源
+func (t *timer) Close() {
+	t.Lock()
+	defer t.Unlock()
+	for _, v := range t.cronList {
+		v.corn.Stop()
+	}
+}
+
+func NewTimerTask() Timer {
+	return &timer{cronList: make(map[string]*taskManager)}
+}
--- a/utils/timer/timed_task_test.go
+++ b/utils/timer/timed_task_test.go
@@ -0,0 +1,72 @@
+package timer
+
+import (
+	"fmt"
+	"testing"
+	"time"
+
+	"github.com/stretchr/testify/assert"
+)
+
+var job = mockJob{}
+
+type mockJob struct{}
+
+func (job mockJob) Run() {
+	mockFunc()
+}
+
+func mockFunc() {
+	time.Sleep(time.Second)
+	fmt.Println("1s...")
+}
+
+func TestNewTimerTask(t *testing.T) {
+	tm := NewTimerTask()
+	_tm := tm.(*timer)
+
+	{
+		_, err := tm.AddTaskByFunc("func", "@every 1s", mockFunc, "测试mockfunc")
+		assert.Nil(t, err)
+		_, ok := _tm.cronList["func"]
+		if !ok {
+			t.Error("no find func")
+		}
+	}
+
+	{
+		_, err := tm.AddTaskByJob("job", "@every 1s", job, "测试job mockfunc")
+		assert.Nil(t, err)
+		_, ok := _tm.cronList["job"]
+		if !ok {
+			t.Error("no find job")
+		}
+	}
+
+	{
+		_, ok := tm.FindCron("func")
+		if !ok {
+			t.Error("no find func")
+		}
+		_, ok = tm.FindCron("job")
+		if !ok {
+			t.Error("no find job")
+		}
+		_, ok = tm.FindCron("none")
+		if ok {
+			t.Error("find none")
+		}
+	}
+	{
+		tm.Clear("func")
+		_, ok := tm.FindCron("func")
+		if ok {
+			t.Error("find func")
+		}
+	}
+	{
+		a := tm.FindCronList()
+		b, c := tm.FindCron("job")
+		fmt.Println(a, b, c)
+	}
+}