调整为新的timer模式 增加每个task内具体方法的描述方便对接后续的页面控制

Author: piexlMax

server/initialize/timer.go

@@ -19,7 +19,7 @@ func Timer() {
 if err != nil {
 fmt.Println("timer error:", err)
 }
-}, option...)
+}, "定时清理数据库【日志，黑名单】内容", option...)
 if err != nil {
 fmt.Println("add timer error:", err)
 }

server/utils/timer/timed_task.go

@@ -1,92 +1,152 @@
 package timer
 
 import (
-"sync"
-
 "github.com/robfig/cron/v3"
+"sync"
 )
 
+type GVA_Timer interface {
+Timer
+FindTaskList() map[string]*taskManager
+AddTaskByFuncWithSecond(taskName string, spec string, fun func(), Desc string, option ...cron.Option) (cron.EntryID, error)
+AddTaskByJobWithSeconds(taskName string, spec string, job interface{ Run() }, Desc string, option ...cron.Option) (cron.EntryID, error)
+}
+
 type Timer interface {
-AddTaskByFunc(taskName string, spec string, task func(), option ...cron.Option) (cron.EntryID, error)
-AddTaskByJob(taskName string, spec string, job interface{ Run() }, option ...cron.Option) (cron.EntryID, error)
-FindCron(taskName string) (*cron.Cron, bool)
+AddTaskByFunc(taskName string, spec string, task func(), Desc string, option ...cron.Option) (cron.EntryID, error)
+AddTaskByJob(taskName string, spec string, job interface{ Run() }, Desc string, option ...cron.Option) (cron.EntryID, error)
+FindCron(taskName string) (*taskManager, bool)
 StartTask(taskName string)
 StopTask(taskName string)
 Remove(taskName string, id int)
 Clear(taskName string)
 Close()
 }
 
+type task struct {
+EntryID cron.EntryID
+Spec string
+Desc string
+}
+
+type taskManager struct {
+corn *cron.Cron
+tasks map[cron.EntryID]*task
+}
+
 // timer 定时任务管理
 type timer struct {
-taskList map[string]*cron.Cron
+taskList map[string]*taskManager
 sync.Mutex
 }
 
 // AddTaskByFunc 通过函数的方法添加任务
-func (t *timer) AddTaskByFunc(taskName string, spec string, task func(), option ...cron.Option) (cron.EntryID, error) {
+func (t *timer) AddTaskByFunc(taskName string, spec string, fun func(), Desc string, option ...cron.Option) (cron.EntryID, error) {
 t.Lock()
 defer t.Unlock()
 if _, ok := t.taskList[taskName]; !ok {
-t.taskList[taskName] = cron.New(option...)
+tasks := make(map[cron.EntryID]*task)
+t.taskList[taskName] = &taskManager{
+corn: cron.New(option...),
+tasks: tasks,
+}
+}
+id, err := t.taskList[taskName].corn.AddFunc(spec, fun)
+t.taskList[taskName].corn.Start()
+t.taskList[taskName].tasks[id] = &task{
+EntryID: id,
+Spec: spec,
+Desc: Desc,
 }
-id, err := t.taskList[taskName].AddFunc(spec, task)
-t.taskList[taskName].Start()
 return id, err
 }
 
 // AddTaskByFuncWithSeconds 通过函数的方法使用WithSeconds添加任务
-func (t *timer) AddTaskByFuncWhithSecond(taskName string, spec string, task func(), option ...cron.Option) (cron.EntryID, error) {
+func (t *timer) AddTaskByFuncWithSecond(taskName string, spec string, fun func(), Desc string, option ...cron.Option) (cron.EntryID, error) {
 t.Lock()
 defer t.Unlock()
 option = append(option, cron.WithSeconds())
 if _, ok := t.taskList[taskName]; !ok {
-t.taskList[taskName] = cron.New(option...)
+tasks := make(map[cron.EntryID]*task)
+t.taskList[taskName] = &taskManager{
+corn: cron.New(option...),
+tasks: tasks,
+}
+}
+id, err := t.taskList[taskName].corn.AddFunc(spec, fun)
+t.taskList[taskName].corn.Start()
+t.taskList[taskName].tasks[id] = &task{
+EntryID: id,
+Spec: spec,
+Desc: Desc,
 }
-id, err := t.taskList[taskName].AddFunc(spec, task)
-t.taskList[taskName].Start()
 return id, err
 }
 
 // AddTaskByJob 通过接口的方法添加任务
-func (t *timer) AddTaskByJob(taskName string, spec string, job interface{ Run() }, option ...cron.Option) (cron.EntryID, error) {
+func (t *timer) AddTaskByJob(taskName string, spec string, job interface{ Run() }, Desc string, option ...cron.Option) (cron.EntryID, error) {
 t.Lock()
 defer t.Unlock()
 if _, ok := t.taskList[taskName]; !ok {
-t.taskList[taskName] = cron.New(option...)
+tasks := make(map[cron.EntryID]*task)
+t.taskList[taskName] = &taskManager{
+corn: cron.New(option...),
+tasks: tasks,
+}
+}
+id, err := t.taskList[taskName].corn.AddJob(spec, job)
+t.taskList[taskName].corn.Start()
+t.taskList[taskName].tasks[id] = &task{
+EntryID: id,
+Spec: spec,
+Desc: Desc,
 }
-id, err := t.taskList[taskName].AddJob(spec, job)
-t.taskList[taskName].Start()
 return id, err
 }
 
 // AddTaskByJobWithSeconds 通过接口的方法添加任务
-func (t *timer) AddTaskByJobWithSeconds(taskName string, spec string, job interface{ Run() }, option ...cron.Option) (cron.EntryID, error) {
+func (t *timer) AddTaskByJobWithSeconds(taskName string, spec string, job interface{ Run() }, Desc string, option ...cron.Option) (cron.EntryID, error) {
 t.Lock()
 defer t.Unlock()
 option = append(option, cron.WithSeconds())
 if _, ok := t.taskList[taskName]; !ok {
-t.taskList[taskName] = cron.New(option...)
+tasks := make(map[cron.EntryID]*task)
+t.taskList[taskName] = &taskManager{
+corn: cron.New(option...),
+tasks: tasks,
+}
+}
+id, err := t.taskList[taskName].corn.AddJob(spec, job)
+t.taskList[taskName].corn.Start()
+t.taskList[taskName].tasks[id] = &task{
+EntryID: id,
+Spec: spec,
+Desc: Desc,
 }
-id, err := t.taskList[taskName].AddJob(spec, job)
-t.taskList[taskName].Start()
 return id, err
 }
 
 // FindCron 获取对应taskName的cron 可能会为空
-func (t *timer) FindCron(taskName string) (*cron.Cron, bool) {
+func (t *timer) FindCron(taskName string) (*taskManager, bool) {
 t.Lock()
 defer t.Unlock()
 v, ok := t.taskList[taskName]
 return v, ok
 }
 
+// FindTaskList 获取所有的任务列表
+func (t *timer) FindTaskList() map[string]*taskManager {
+t.Lock()
+defer t.Unlock()
+return t.taskList
+}
+
 // StartTask 开始任务
 func (t *timer) StartTask(taskName string) {
 t.Lock()
 defer t.Unlock()
 if v, ok := t.taskList[taskName]; ok {
-v.Start()
+v.corn.Start()
 }
 }
 
@@ -95,7 +155,7 @@ func (t *timer) StopTask(taskName string) {
 t.Lock()
 defer t.Unlock()
 if v, ok := t.taskList[taskName]; ok {
-v.Stop()
+v.corn.Stop()
 }
 }
 
@@ -104,7 +164,8 @@ func (t *timer) Remove(taskName string, id int) {
 t.Lock()
 defer t.Unlock()
 if v, ok := t.taskList[taskName]; ok {
-v.Remove(cron.EntryID(id))
+v.corn.Remove(cron.EntryID(id))
+delete(v.tasks, cron.EntryID(id))
 }
 }
 
@@ -113,7 +174,7 @@ func (t *timer) Clear(taskName string) {
 t.Lock()
 defer t.Unlock()
 if v, ok := t.taskList[taskName]; ok {
-v.Stop()
+v.corn.Stop()
 delete(t.taskList, taskName)
 }
 }
@@ -123,10 +184,10 @@ func (t *timer) Close() {
 t.Lock()
 defer t.Unlock()
 for _, v := range t.taskList {
-v.Stop()
+v.corn.Stop()
 }
 }
 
-func NewTimerTask() Timer {
-return &timer{taskList: make(map[string]*cron.Cron)}
+func NewTimerTask() GVA_Timer {
+return &timer{taskList: make(map[string]*taskManager)}
 }

server/utils/timer/timed_task_test.go

@@ -26,7 +26,7 @@ func TestNewTimerTask(t *testing.T) {
 _tm := tm.(*timer)
 
 {
-_, err := tm.AddTaskByFunc("func", "@every 1s", mockFunc)
+_, err := tm.AddTaskByFunc("func", "@every 1s", mockFunc, "测试mockfunc")
 assert.Nil(t, err)
 _, ok := _tm.taskList["func"]
 if !ok {
@@ -35,7 +35,7 @@ func TestNewTimerTask(t *testing.T) {
 }
 
 {
-_, err := tm.AddTaskByJob("job", "@every 1s", job)
+_, err := tm.AddTaskByJob("job", "@every 1s", job, "测试job mockfunc")
 assert.Nil(t, err)
 _, ok := _tm.taskList["job"]
 if !ok {
@@ -64,4 +64,9 @@ func TestNewTimerTask(t *testing.T) {
 t.Error("find func")
 }
 }
+{
+a := tm.FindTaskList()
+b, c := tm.FindCron("job")
+fmt.Println(a, b, c)
+}
 }