Go語言封裝一個(gè)Cron定時(shí)任務(wù)管理器
介紹
在現(xiàn)代應(yīng)用中,定時(shí)任務(wù)是非常常見的需求,無論是用于定時(shí)清理數(shù)據(jù)、定時(shí)發(fā)送郵件,還是定時(shí)執(zhí)行系統(tǒng)維護(hù)任務(wù)。Go語言作為一門現(xiàn)代編程語言,提供了多種方法來實(shí)現(xiàn)定時(shí)任務(wù)。本文將重點(diǎn)介紹如何在Go中封裝一個(gè)Cron定時(shí)任務(wù)管理器,幫助開發(fā)者高效管理定時(shí)任務(wù)。
目標(biāo)
我們將通過使用 github.com/robfig/cron/v3 庫來實(shí)現(xiàn)一個(gè)簡潔、靈活的定時(shí)任務(wù)調(diào)度器。該庫支持基于 Cron 表達(dá)式的任務(wù)調(diào)度,我們將基于該庫封裝出一個(gè)簡單的 API,供開發(fā)者在實(shí)際項(xiàng)目中使用。
項(xiàng)目背景
Cron 表達(dá)式是一種用來表示時(shí)間計(jì)劃的格式,它通常由 5 或 6 個(gè)字段組成,表示一個(gè)特定的時(shí)間點(diǎn)或時(shí)間間隔。Go中的 robfig/cron 庫提供了非常便利的接口來處理這些表達(dá)式,并能夠定期執(zhí)行任務(wù)。
我們的目標(biāo)是封裝一個(gè) Crontab 結(jié)構(gòu)體,它將管理所有的定時(shí)任務(wù),支持任務(wù)的添加、刪除、查詢以及啟動(dòng)和停止功能。
代碼分析
下面是一個(gè)簡單的 Cron 定時(shí)任務(wù)調(diào)度器的封裝代碼。它基于 robfig/cron 庫并擴(kuò)展了一個(gè) Crontab 結(jié)構(gòu)體,提供了一些常用的操作方法。
代碼實(shí)現(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表達(dá)式
ids: make(map[string]cron.EntryID),
mutex: new(sync.RWMutex),
}
}
// IDs 獲取所有有效的Cron任務(wù)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)
}
// 清理無效的任務(wù)ID
for _, id := range invalidIDs {
delete(c.ids, id)
}
return validIDs
}
// Start 啟動(dòng)定時(shí)任務(wù)調(diào)度器
func (c *Crontab) Start() {
c.inner.Start()
}
// Stop 停止定時(shí)任務(wù)調(diào)度器
func (c *Crontab) Stop() {
c.inner.Stop()
}
// DelByID 根據(jù)ID刪除定時(shí)任務(wù)
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添加定時(shí)任務(wù)
// spec 是Cron表達(dá)式,cmd 是執(zhí)行的任務(wù)
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ù)作為定時(shí)任務(wù)
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 判斷某個(gè)任務(wù)ID是否已存在
func (c *Crontab) IsExists(jid string) bool {
c.mutex.RLock()
defer c.mutex.RUnlock()
_, exist := c.ids[jid]
return exist
}
主要功能
NewCrontab(): 初始化一個(gè)新的 Crontab 實(shí)例,內(nèi)部使用 cron.New() 來創(chuàng)建一個(gè) Cron 調(diào)度器,支持秒級別的 Cron 表達(dá)式。
IDs(): 獲取當(dāng)前所有有效的定時(shí)任務(wù)ID。會(huì)清理掉無效的任務(wù)ID。
Start(): 啟動(dòng) Cron 調(diào)度器,開始執(zhí)行所有的定時(shí)任務(wù)。
Stop(): 停止 Cron 調(diào)度器,暫停定時(shí)任務(wù)的執(zhí)行。
DelByID(id): 根據(jù)任務(wù)ID刪除定時(shí)任務(wù)。
AddByID(id, spec, cmd): 根據(jù) Cron 表達(dá)式添加一個(gè)新的定時(shí)任務(wù)。任務(wù)ID必須唯一。
AddByFunc(id, spec, f): 將一個(gè)函數(shù)作為定時(shí)任務(wù)來添加,使用 Cron 表達(dá)式來指定執(zhí)行頻率。
IsExists(jid): 判斷某個(gè)定時(shí)任務(wù)ID是否存在。
Cron表達(dá)式解析
Cron 表達(dá)式是定時(shí)任務(wù)調(diào)度中常見的表示方式,它由五個(gè)或六個(gè)字段組成,每個(gè)字段代表一個(gè)時(shí)間單位。標(biāo)準(zhǔn)的 Cron 表達(dá)式格式如下:
* * * * * *
│ │ │ │ │ │
│ │ │ │ │ └─ 星期幾 (0 - 7) (0或7代表星期天)
│ │ │ │ └──── 月份 (1 - 12)
│ │ │ └────── 日 (1 - 31)
│ │ └──────── 小時(shí) (0 - 23)
│ └────────── 分鐘 (0 - 59)
└──────────── 秒 (0 - 59)
例子
- * * * * * *:每秒執(zhí)行一次任務(wù)
- 0 * * * * *:每分鐘的第0秒執(zhí)行一次任務(wù)
- 0 0 * * * *:每天午夜執(zhí)行一次任務(wù)
- 0 0 1 * * *:每月的第一天執(zhí)行一次任務(wù)
使用示例
以下是如何使用封裝好的 Crontab 類型來管理定時(shí)任務(wù)的示例:
package main
import (
"fmt"
"github.com/robfig/cron/v3"
"time"
"your_project/crontab"
)
func main() {
// 創(chuàng)建一個(gè)新的 Crontab 實(shí)例
c := crontab.NewCrontab()
// 定義一個(gè)定時(shí)任務(wù)
task := func() {
fmt.Println("Task executed at", time.Now())
}
// 添加定時(shí)任務(wù)
err := c.AddByFunc("task1", "*/5 * * * * *", task) // 每5秒執(zhí)行一次
if err != nil {
fmt.Println("Error adding task:", err)
return
}
// 啟動(dòng)任務(wù)調(diào)度器
c.Start()
// 等待一段時(shí)間后停止
time.Sleep(20 * time.Second)
c.Stop()
// 刪除任務(wù)
err = c.DelByID("task1")
if err != nil {
fmt.Println("Error deleting task:", err)
}
}
總結(jié)
通過使用 robfig/cron 庫并封裝成一個(gè)簡單易用的 Crontab 類型,我們可以非常方便地在 Go 項(xiàng)目中管理定時(shí)任務(wù)。Cron 表達(dá)式為我們提供了靈活的時(shí)間配置,幫助開發(fā)者應(yīng)對復(fù)雜的定時(shí)任務(wù)調(diào)度需求。
在實(shí)際應(yīng)用中,我們可以根據(jù)需要擴(kuò)展 Crontab 類型,支持更多功能,如任務(wù)狀態(tài)監(jiān)控、任務(wù)重試等,進(jìn)一步提高定時(shí)任務(wù)管理的效率。
到此這篇關(guān)于Go語言封裝一個(gè)Cron定時(shí)任務(wù)管理器的文章就介紹到這了,更多相關(guān)Go封裝Cron定時(shí)任務(wù)內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
golang 兩個(gè)go程輪流打印一個(gè)切片的實(shí)現(xiàn)
這篇文章主要介紹了golang 兩個(gè)go程輪流打印一個(gè)切片的實(shí)現(xiàn),文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2020-10-10
golang實(shí)現(xiàn)aes-cbc-256加密解密功能
這篇文章主要介紹了golang實(shí)現(xiàn)aes-cbc-256加密解密功能,本文給大家介紹的非常詳細(xì),對大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2023-04-04
Go實(shí)現(xiàn)MD5加密的三種方法小結(jié)
本文主要介紹了Go實(shí)現(xiàn)MD5加密的三種方法小結(jié),文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2023-03-03

