Go語言封裝一個Cron定時任務管理器

更新時間：2024年12月20日 08:57:29 作者：熬了夜的程序員

在現(xiàn)代應用中,定時任務是非常常見的需求,無論是用于定時清理數(shù)據(jù),還是定時執(zhí)行系統(tǒng)維護任務,下面我們就來使用Go語言封裝一個Cron定時任務管理器吧

介紹

在現(xiàn)代應用中，定時任務是非常常見的需求，無論是用于定時清理數(shù)據(jù)、定時發(fā)送郵件，還是定時執(zhí)行系統(tǒng)維護任務。Go語言作為一門現(xiàn)代編程語言，提供了多種方法來實現(xiàn)定時任務。本文將重點介紹如何在Go中封裝一個Cron定時任務管理器，幫助開發(fā)者高效管理定時任務。

目標

我們將通過使用 github.com/robfig/cron/v3 庫來實現(xiàn)一個簡潔、靈活的定時任務調度器。該庫支持基于 Cron 表達式的任務調度，我們將基于該庫封裝出一個簡單的 API，供開發(fā)者在實際項目中使用。

項目背景

Cron 表達式是一種用來表示時間計劃的格式，它通常由 5 或 6 個字段組成，表示一個特定的時間點或時間間隔。Go中的 robfig/cron 庫提供了非常便利的接口來處理這些表達式，并能夠定期執(zhí)行任務。

我們的目標是封裝一個 Crontab 結構體，它將管理所有的定時任務，支持任務的添加、刪除、查詢以及啟動和停止功能。

代碼分析

下面是一個簡單的 Cron 定時任務調度器的封裝代碼。它基于 robfig/cron 庫并擴展了一個 Crontab 結構體，提供了一些常用的操作方法。

代碼實現(xiàn)

package crontab

import (
	"github.com/pkg/errors"
	cron "github.com/robfig/cron/v3"
	"sync"
)

// Crontab crontab struct
type Crontab struct {
	inner *cron.Cron
	ids   map[string]cron.EntryID
	mutex *sync.RWMutex
}

// NewCrontab new crontab
func NewCrontab() *Crontab {
	return &Crontab{
		inner: cron.New(cron.WithSeconds()), // 支持秒級別的Cron表達式
		ids:   make(map[string]cron.EntryID),
		mutex: new(sync.RWMutex),
	}
}

// IDs 獲取所有有效的Cron任務ID
func (c *Crontab) IDs() []string {
	c.mutex.RLock()
	defer c.mutex.RUnlock()

	validIDs := make([]string, 0, len(c.ids))
	invalidIDs := make([]string, 0)
	for sid, eid := range c.ids {
		if e := c.inner.Entry(eid); e.ID != eid {
			invalidIDs = append(invalidIDs, sid)
			continue
		}
		validIDs = append(validIDs, sid)
	}

	// 清理無效的任務ID
	for _, id := range invalidIDs {
		delete(c.ids, id)
	}

	return validIDs
}

// Start 啟動定時任務調度器
func (c *Crontab) Start() {
	c.inner.Start()
}

// Stop 停止定時任務調度器
func (c *Crontab) Stop() {
	c.inner.Stop()
}

// DelByID 根據(jù)ID刪除定時任務
func (c *Crontab) DelByID(id string) error {
	c.mutex.Lock()
	defer c.mutex.Unlock()

	eid, ok := c.ids[id]
	if !ok {
		return errors.Errorf("crontab id not exists!")
	}
	c.inner.Remove(eid)
	delete(c.ids, id)

	return nil
}

// AddByID 根據(jù)ID添加定時任務
// spec 是Cron表達式，cmd 是執(zhí)行的任務
func (c *Crontab) AddByID(id, spec string, cmd cron.Job) error {
	c.mutex.Lock()
	defer c.mutex.Unlock()

	if _, ok := c.ids[id]; ok {
		return errors.Errorf("crontab id exists!")
	}
	eid, err := c.inner.AddJob(spec, cmd)
	if err != nil {
		return err
	}
	c.ids[id] = eid
	return nil
}

// AddByFunc 根據(jù)ID添加函數(shù)作為定時任務
func (c *Crontab) AddByFunc(id, spec string, f func()) error {
	c.mutex.Lock()
	defer c.mutex.Unlock()

	if _, ok := c.ids[id]; ok {
		return errors.Errorf("crontab id exists!")
	}
	eid, err := c.inner.AddFunc(spec, f)
	if err != nil {
		return err
	}
	c.ids[id] = eid
	return nil
}

// IsExists 判斷某個任務ID是否已存在
func (c *Crontab) IsExists(jid string) bool {
	c.mutex.RLock()
	defer c.mutex.RUnlock()

	_, exist := c.ids[jid]
	return exist
}

主要功能

NewCrontab(): 初始化一個新的 Crontab 實例，內部使用 cron.New() 來創(chuàng)建一個 Cron 調度器，支持秒級別的 Cron 表達式。

IDs(): 獲取當前所有有效的定時任務ID。會清理掉無效的任務ID。

Start(): 啟動 Cron 調度器，開始執(zhí)行所有的定時任務。

Stop(): 停止 Cron 調度器，暫停定時任務的執(zhí)行。

DelByID(id): 根據(jù)任務ID刪除定時任務。

AddByID(id, spec, cmd): 根據(jù) Cron 表達式添加一個新的定時任務。任務ID必須唯一。

AddByFunc(id, spec, f): 將一個函數(shù)作為定時任務來添加，使用 Cron 表達式來指定執(zhí)行頻率。

IsExists(jid): 判斷某個定時任務ID是否存在。

Cron表達式解析

Cron 表達式是定時任務調度中常見的表示方式，它由五個或六個字段組成，每個字段代表一個時間單位。標準的 Cron 表達式格式如下：

* * * * * *
│ │ │ │ │ │
│ │ │ │ │ └─ 星期幾 (0 - 7) (0或7代表星期天)
│ │ │ │ └──── 月份 (1 - 12)
│ │ │ └────── 日 (1 - 31)
│ │ └──────── 小時 (0 - 23)
│ └────────── 分鐘 (0 - 59)
└──────────── 秒 (0 - 59)

例子

* * * * * *：每秒執(zhí)行一次任務
0 * * * * *：每分鐘的第0秒執(zhí)行一次任務
0 0 * * * *：每天午夜執(zhí)行一次任務
0 0 1 * * *：每月的第一天執(zhí)行一次任務

使用示例

以下是如何使用封裝好的 Crontab 類型來管理定時任務的示例：

package main

import (
	"fmt"
	"github.com/robfig/cron/v3"
	"time"
	"your_project/crontab"
)

func main() {
	// 創(chuàng)建一個新的 Crontab 實例
	c := crontab.NewCrontab()

	// 定義一個定時任務
	task := func() {
		fmt.Println("Task executed at", time.Now())
	}

	// 添加定時任務
	err := c.AddByFunc("task1", "*/5 * * * * *", task) // 每5秒執(zhí)行一次
	if err != nil {
		fmt.Println("Error adding task:", err)
		return
	}

	// 啟動任務調度器
	c.Start()

	// 等待一段時間后停止
	time.Sleep(20 * time.Second)
	c.Stop()

	// 刪除任務
	err = c.DelByID("task1")
	if err != nil {
		fmt.Println("Error deleting task:", err)
	}
}