mirror of
https://gitee.com/johng/gf.git
synced 2024-12-10 18:32:44 +08:00
210 lines
5.9 KiB
Go
210 lines
5.9 KiB
Go
// Copyright 2018 gf Author(https://github.com/gogf/gf). All Rights Reserved.
|
|
//
|
|
// This Source Code Form is subject to the terms of the MIT License.
|
|
// If a copy of the MIT was not distributed with this file,
|
|
// You can obtain one at https://github.com/gogf/gf.
|
|
|
|
package gcron
|
|
|
|
import (
|
|
"errors"
|
|
"fmt"
|
|
"github.com/gogf/gf/g/container/garray"
|
|
"github.com/gogf/gf/g/container/gmap"
|
|
"github.com/gogf/gf/g/container/gtype"
|
|
"github.com/gogf/gf/g/os/glog"
|
|
"github.com/gogf/gf/g/os/gtimer"
|
|
"time"
|
|
)
|
|
|
|
// 定时任务管理对象
|
|
type Cron struct {
|
|
idGen *gtype.Int64 // 用于唯一名称生成
|
|
status *gtype.Int // 定时任务状态(0: 未执行; 1: 运行中; 2: 已停止; -1:删除关闭)
|
|
entries *gmap.StringInterfaceMap // 所有的定时任务项
|
|
logPath *gtype.String // 日志文件输出目录
|
|
logLevel *gtype.Int // 日志输出等级
|
|
}
|
|
|
|
// 创建自定义的定时任务管理对象
|
|
func New() *Cron {
|
|
return &Cron {
|
|
idGen : gtype.NewInt64(),
|
|
status : gtype.NewInt(STATUS_RUNNING),
|
|
entries : gmap.NewStringInterfaceMap(),
|
|
logPath : gtype.NewString(),
|
|
logLevel : gtype.NewInt(glog.LEVEL_PROD),
|
|
}
|
|
}
|
|
|
|
// 设置日志输出路径
|
|
func (c *Cron) SetLogPath(path string) {
|
|
c.logPath.Set(path)
|
|
}
|
|
|
|
// 获取设置的日志输出路径
|
|
func (c *Cron) GetLogPath() string {
|
|
return c.logPath.Val()
|
|
}
|
|
|
|
// 设置日志输出等级。
|
|
func (c *Cron) SetLogLevel(level int) {
|
|
c.logLevel.Set(level)
|
|
}
|
|
|
|
// 获取日志输出等级。
|
|
func (c *Cron) GetLogLevel() int {
|
|
return c.logLevel.Val()
|
|
}
|
|
|
|
// 添加定时任务
|
|
func (c *Cron) Add(pattern string, job func(), name ... string) (*Entry, error) {
|
|
if len(name) > 0 {
|
|
if c.Search(name[0]) != nil {
|
|
return nil, errors.New(fmt.Sprintf(`cron job "%s" already exists`, name[0]))
|
|
}
|
|
}
|
|
return c.addEntry(pattern, job, false, gDEFAULT_TIMES, name...)
|
|
}
|
|
|
|
// 添加单例运行定时任务
|
|
func (c *Cron) AddSingleton(pattern string, job func(), name ... string) (*Entry, error) {
|
|
if entry, err := c.Add(pattern, job, name ...); err != nil {
|
|
return nil, err
|
|
} else {
|
|
entry.SetSingleton(true)
|
|
return entry, nil
|
|
}
|
|
}
|
|
|
|
// 添加只运行一次的定时任务
|
|
func (c *Cron) AddOnce(pattern string, job func(), name ... string) (*Entry, error) {
|
|
if entry, err := c.Add(pattern, job, name ...); err != nil {
|
|
return nil, err
|
|
} else {
|
|
entry.SetTimes(1)
|
|
return entry, nil
|
|
}
|
|
}
|
|
|
|
// 添加运行指定次数的定时任务
|
|
func (c *Cron) AddTimes(pattern string, times int, job func(), name ... string) (*Entry, error) {
|
|
if entry, err := c.Add(pattern, job, name ...); err != nil {
|
|
return nil, err
|
|
} else {
|
|
entry.SetTimes(times)
|
|
return entry, nil
|
|
}
|
|
}
|
|
|
|
// 延迟添加定时任务
|
|
func (c *Cron) DelayAdd(delay time.Duration, pattern string, job func(), name ... string) {
|
|
gtimer.AddOnce(delay, func() {
|
|
if _, err := c.Add(pattern, job, name ...); err != nil {
|
|
panic(err)
|
|
}
|
|
})
|
|
}
|
|
|
|
// 延迟添加单例定时任务
|
|
func (c *Cron) DelayAddSingleton(delay time.Duration, pattern string, job func(), name ... string) {
|
|
gtimer.AddOnce(delay, func() {
|
|
if _, err := c.AddSingleton(pattern, job, name ...); err != nil {
|
|
panic(err)
|
|
}
|
|
})
|
|
}
|
|
|
|
// 延迟添加运行指定次数的定时任务
|
|
func (c *Cron) DelayAddOnce(delay time.Duration, pattern string, job func(), name ... string) {
|
|
gtimer.AddOnce(delay, func() {
|
|
if _, err := c.AddOnce(pattern, job, name ...); err != nil {
|
|
panic(err)
|
|
}
|
|
})
|
|
}
|
|
|
|
// 延迟添加只运行一次的定时任务
|
|
func (c *Cron) DelayAddTimes(delay time.Duration, pattern string, times int, job func(), name ... string) {
|
|
gtimer.AddOnce(delay, func() {
|
|
if _, err := c.AddTimes(pattern, times, job, name ...); err != nil {
|
|
panic(err)
|
|
}
|
|
})
|
|
}
|
|
|
|
// 检索指定名称的定时任务
|
|
func (c *Cron) Search(name string) *Entry {
|
|
if v := c.entries.Get(name); v != nil {
|
|
return v.(*Entry)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// 开启定时任务执行(可以指定特定名称的一个或若干个定时任务)
|
|
func (c *Cron) Start(name...string) {
|
|
if len(name) > 0 {
|
|
for _, v := range name {
|
|
if entry := c.Search(v); entry != nil {
|
|
entry.Start()
|
|
}
|
|
}
|
|
} else {
|
|
c.status.Set(STATUS_READY)
|
|
}
|
|
}
|
|
|
|
// 停止定时任务执行(可以指定特定名称的一个或若干个定时任务)
|
|
func (c *Cron) Stop(name...string) {
|
|
if len(name) > 0 {
|
|
for _, v := range name {
|
|
if entry := c.Search(v); entry != nil {
|
|
entry.Stop()
|
|
}
|
|
}
|
|
} else {
|
|
c.status.Set(STATUS_STOPPED)
|
|
}
|
|
}
|
|
|
|
// 根据指定名称删除定时任务。
|
|
func (c *Cron) Remove(name string) {
|
|
if v := c.entries.Get(name); v != nil {
|
|
v.(*Entry).Close()
|
|
}
|
|
}
|
|
|
|
// 关闭定时任务
|
|
func (c *Cron) Close() {
|
|
c.status.Set(STATUS_CLOSED)
|
|
}
|
|
|
|
// 获取所有已注册的定时任务数量
|
|
func (c *Cron) Size() int {
|
|
return c.entries.Size()
|
|
}
|
|
|
|
// 获取所有已注册的定时任务项(按照注册时间从小到大进行排序)
|
|
func (c *Cron) Entries() []*Entry {
|
|
array := garray.NewSortedArraySize(c.entries.Size(), func(v1, v2 interface{}) int {
|
|
entry1 := v1.(*Entry)
|
|
entry2 := v2.(*Entry)
|
|
if entry1.Time.Nanosecond() > entry2.Time.Nanosecond() {
|
|
return 1
|
|
}
|
|
return -1
|
|
}, true)
|
|
c.entries.RLockFunc(func(m map[string]interface{}) {
|
|
for _, v := range m {
|
|
array.Add(v.(*Entry))
|
|
}
|
|
})
|
|
entries := make([]*Entry, array.Len())
|
|
array.RLockFunc(func(array []interface{}) {
|
|
for k, v := range array {
|
|
entries[k] = v.(*Entry)
|
|
}
|
|
})
|
|
return entries
|
|
}
|