gocron

README

计划任务通用服务

功能如下：

• 提供标准web界面管理任务，列表任务，可手动触发任务。
• 提供http handler，自定义url管理路径。
• 提供方法添加任务，删除任务，列表任务。
• 提供http json格式任务列表接口。
• 提供手动触发http接口。
• 触发的任务正在运行，此次触发动作会被忽略。
• 前面的任务没有执行完毕，后面启动的任务会被跳过。

集成

gocron.HandlerFunc()提供标准的http.HandlerFunc， 凡是支持添加http.HandlerFunc为路由方法的路由都能使用。

集成到http web页面, 示例代码：

// crontab service toolkit
http.HandleFunc("/crontab/", cron.HandlerFunc())

/crontab/是管理路径，路径确定后，会有下面三个地址可以使用：

1. /crontab/joblist 任务管理页面。
2. /crontab/triggerjob?jobid=111 触发任务接口，111是任务ID，返回json数据{"code":200,"data":"success","msg":""}。
3. /crontab/joblist.json 任务列表json数据。

任务列表json数据格式，示例数据如下：

{
  "code": 200,
  "data": [
    {
      "job_id": 1,
      "cron_exp": "*/1 * * * * *",
      "description": "test list",
      "prev_at": 1630398420,
      "next_at": 1630398421,
      "trigger_at": 1,
      "running_count": true
    },
    {
      "job_id": 2,
      "cron_exp": "*/2 * * * * *",
      "description": "test list",
      "prev_at": 1630398420,
      "next_at": 1630398422,
      "trigger_at": 0,
      "running_count": 0
    }
  ],
  "msg": ""
}

数据说明：

code：200 代表成功，其它代码代表失败，失败的时候msg是错误信息。 

job_id：任务ID

cron_exp：任务执行周期crontab表达式，除了5位标准crontab写法，还支持6位写法，第一位是秒。

description：添加任务的时候，任务描述信息。

prev_at：unix秒时间戳，上次执行启动时间，不一定真的被执行，如果前面的任务没结束，
         执行会被跳过，这里的是周期启动时间。

next_at：unix秒时间戳，下次执行的时间。

trigger_at：unix秒时间戳，手动触发时间，触发的任务正在运行，此次触发动作会被忽略。

running_count：任务是在运行的数量，0代表没有运行。互斥模式下：1代表正在运行；非互斥模式下：表示同一个任务正在并行执行的数量。

cron包提供下面方法

具体用法参数，可以看IDE代码提示。

gocron.TriggerJob()
gocron.GetJob()
gocron.JobList()
gocron.AddJob()
gocron.RemoveJob()
gocron.HandlerFunc()

添加一个计划任务示例：

jobID, err := gocron.AddJob(Job{
CronExp:     "* * * * * *",
Description: "test list",
Mutex: true,
Executor: func () {

},
})

管理界面截图，先睹为快

管理列表

执行历史

Documentation

Index

• Variables
• func AddJob(job Job) (jobID int, err error)
• func HandlerFilter(job Job) func(ctx gcore.Ctx) error
• func HandlerFunc() http.HandlerFunc
• func NewLogger() *logger
• func RemoveJob(jobID int) (err error)
• func SetHandlerFilter(handlerFilter func(ctx gcore.Ctx) error)
• func TriggerJob(jobID int)
• type CrontabManager
  • func NewCrontabManager() *CrontabManager
  • func (s *CrontabManager) AddJob(job Job) (jobID int, err error)
  • func (s *CrontabManager) ExistsJob(jobID int) bool
  • func (s *CrontabManager) GetJob(jobID int) (jobItem *JobItem)
  • func (s *CrontabManager) HandlerFilter() func(ctx gcore.Ctx) error
  • func (s *CrontabManager) HandlerFunc() http.HandlerFunc
  • func (s *CrontabManager) JobList() (jobItems []*JobItem)
  • func (s *CrontabManager) RemoveJob(jobID int) (err error)
  • func (s *CrontabManager) SetHandlerFilter(handlerFilter func(ctx gcore.Ctx) error)
  • func (s *CrontabManager) Start() *CrontabManager
  • func (s *CrontabManager) Stop() *CrontabManager
  • func (s *CrontabManager) TriggerJob(jobID int) (err error)
• type Job
  • func (s *Job) MetricsRunData() (d []MetricsRunDataItem)
• type JobItem
  • func GetJob(jobID int) (jobItem *JobItem)
  • func JobList() []*JobItem
• type MetricsRunDataItem

Variables

var (
	DefaultLogger = NewLogger()
)

Functions

func AddJob

func AddJob(job Job) (jobID int, err error)

func HandlerFilter

func HandlerFilter(job Job) func(ctx gcore.Ctx) error

func HandlerFunc

func HandlerFunc() http.HandlerFunc

func NewLogger

func NewLogger() *logger

func RemoveJob

func RemoveJob(jobID int) (err error)

func SetHandlerFilter

func SetHandlerFilter(handlerFilter func(ctx gcore.Ctx) error)

func TriggerJob

func TriggerJob(jobID int)

Types

type CrontabManager

type CrontabManager struct {
	// contains filtered or unexported fields
}

func NewCrontabManager

func NewCrontabManager() *CrontabManager

func (*CrontabManager) AddJob

func (s *CrontabManager) AddJob(job Job) (jobID int, err error)

func (*CrontabManager) ExistsJob

func (s *CrontabManager) ExistsJob(jobID int) bool

func (*CrontabManager) GetJob

func (s *CrontabManager) GetJob(jobID int) (jobItem *JobItem)

func (*CrontabManager) HandlerFilter

func (s *CrontabManager) HandlerFilter() func(ctx gcore.Ctx) error

func (*CrontabManager) HandlerFunc

func (s *CrontabManager) HandlerFunc() http.HandlerFunc

func (*CrontabManager) JobList

func (s *CrontabManager) JobList() (jobItems []*JobItem)

func (*CrontabManager) RemoveJob

func (s *CrontabManager) RemoveJob(jobID int) (err error)

func (*CrontabManager) SetHandlerFilter

func (s *CrontabManager) SetHandlerFilter(handlerFilter func(ctx gcore.Ctx) error)

func (*CrontabManager) Start

func (s *CrontabManager) Start() *CrontabManager

func (*CrontabManager) Stop

func (s *CrontabManager) Stop() *CrontabManager

func (*CrontabManager) TriggerJob

func (s *CrontabManager) TriggerJob(jobID int) (err error)

type Job

type Job struct {
	CronExp     string
	Description string
	Executor    func()
	Mutex       bool
	//MaxMetricsDataLen, value 0 means 100 will be used.
	MaxMetricsDataLen int
	// contains filtered or unexported fields
}

func (*Job) MetricsRunData

func (s *Job) MetricsRunData() (d []MetricsRunDataItem)

type JobItem

type JobItem struct {
	JobID        int    `json:"job_id"`
	CronExp      string `json:"cron_exp"`
	Description  string `json:"description"`
	PrevAt       int64  `json:"prev_at"`
	NextAt       int64  `json:"next_at"`
	TriggerAt    int64  `json:"trigger_at"`
	RunningCount int64  `json:"running_count"`
	Mutex        bool   `json:"mutex"`
	TriggerCount uint64 `json:"trigger_count"`
	RawJob       *Job   `json:"-"`
}

func GetJob

func GetJob(jobID int) (jobItem *JobItem)

func JobList

func JobList() []*JobItem

type MetricsRunDataItem

type MetricsRunDataItem struct {
	StartAt time.Time `json:"start_at"`
	EndAt   time.Time `json:"end_at"`
	Skipped bool      `json:"skipped"`
}