Github: github.com/iflamed/schedule
这个库需要配合 crontab 使用，不会长期运行在进程中，方便随时更新部署新任务。

开发过程中，使用了Github Action 进行单元测试，自动化更新覆盖率 Badge，编写了详细文档，代码覆盖率达到100%。希望大家给个Star。

Schedule inspired laravel

A simple scheduler for golang, inspired with laravel’s task scheduling, use it with crontab.

Run with crontab

After you build your project, you can use it with crontab like below.

* * * * * /path/to/your/schedule >> /dev/null 2>&1

Features

• You can integrate to your self project;
• Multiple frequency options;
• Day and time constraints;
• Custom logger;
• context.Context integration;
• Panic recover;
• Run task in go routine;
• Custom timezone;
• 100% code coverage;

Installation

go get -u github.com/iflamed/schedule

Getting Started

Custom logger

Logger interface

type Logger interface {
    Error(msg string, e any)
    Debugf(msg string, n int32)
    Debug(msg string)
}

The default logger

type DefaultLogger struct {
}

func (d *DefaultLogger) Error(msg string, r any) {
    log.Println(msg, r)
}

func (d *DefaultLogger) Debug(msg string) {
    log.Println(msg)
}

func (d *DefaultLogger) Debugf(msg string, i int32) {
    log.Printf(msg, i)
}

Create scheduler instance

s := NewScheduler(context.Background(), time.UTC)
s.Daily().CallFunc(func(ctx context.Context) {
    log.Println("Task finished.")
    return
})
s.DailyAt("09:00").Call(NewDefaultTask(func(ctx context.Context) {
    log.Println("Task finished at 09:00")
}))
s.Start()

⚠️You should set frequency first, then call the Call and CallFunc method to run task.

⚠️s.Start() method must call at last, it will wait all task finished when process exit.

Schedule Frequency Options

There are many more task schedule frequencies that you may assign to a task:

Schedule constraints

Schedule example

package main

import (
    "context"
    "github.com/iflamed/schedule"
    "log"
    "time"
)

func main() {
    s := schedule.NewScheduler(context.Background(), time.UTC)
    s.Daily().CallFunc(func(ctx context.Context) {
        log.Println("Task finished.")
    })
    s.DailyAt("09:00").Call(schedule.NewDefaultTask(func(ctx context.Context) {
        log.Println("Task finished at 09:00")
    }))
    s.EveryMinute().Sundays().Call(schedule.NewDefaultTask(func(ctx context.Context) {
        log.Println("Task finished at 09:00")
    }))
    s.EveryMinute().Sundays().Between("12:00", "20:00").Call(schedule.NewDefaultTask(func(ctx context.Context) {
        log.Println("Task finished at 09:00")
    }))
    s.Start()
}