golang croncli 定時器命令詳解

更新時間：2022年03月18日 08:59:57 作者：千里之行，始于足下

定時器是執(zhí)行任務(wù)時的常用功能，配置系統(tǒng)的定時任務(wù)太麻煩，所以就想用golang簡單實現(xiàn)一個定時器命令，包括定時器命令格式、定時執(zhí)行命令的相關(guān)知識，感興趣的朋友跟隨小編一起看看吧

定時器命令格式

定時器的參數(shù)包括：

$ croncli -h
定時器命令

Usage:
  croncli [flags]

Flags:
  -c, --cron string     支持標(biāo)準(zhǔn)的crontab 表達(dá)式, ex. * * * * * *
                        各個 * 號的含義:
                        - 秒
                        - 分鐘
                        - 小時
                        - 每月的第幾天
                        - 月
                        - 每周的第幾天
  -h, --help            help for croncli
  -m, --mode string     任務(wù)執(zhí)行模式:
                        - delay(如果上一次任務(wù)還未執(zhí)行完成（耗時太長），則等待上一次任務(wù)完成之后再執(zhí)行)
                        - skip(如果上一次任務(wù)還未完成，則跳過此次執(zhí)行)
      --norecover       是否捕獲任務(wù)的 panic 錯誤, 默認(rèn) false
      --os string       系統(tǒng)類型，nx=linux win=windows，默認(rèn)nx (default "nx")
  -r, --repeat string   重復(fù)規(guī)則, ex. 1s(每秒重復(fù)),1m(每分鐘重復(fù)),1h(每小時重復(fù))

其中控制執(zhí)行時機的參數(shù)有2個：

-c, --corn 參數(shù)內(nèi)容是crontab 表達(dá)式，之后的命令按照這個crontab
-r, --repeat 這個參數(shù)相當(dāng)于cron參數(shù)的簡化版，用來設(shè)置命令的重復(fù)執(zhí)行

這2個參數(shù)同時使用的話，同時生效。也就是說，命令既重復(fù)執(zhí)行，也按照crontab設(shè)置的規(guī)則執(zhí)行。

另外，-m, --mode 參數(shù)只能是 delay 和 skip，含義參見上面的help說明。

定時執(zhí)行命令

單個命令

對于單個命令，執(zhí)行方式如下：（通過 Ctrl+C 結(jié)束程序運行）

$ croncli --repeat 2s date
- Press Ctrl+C to terminate
OUTPUT>>>>>
Wed 16 Mar 2022 10:45:08 AM CST

OUTPUT>>>>>
Wed 16 Mar 2022 10:45:10 AM CST

OUTPUT>>>>>
Wed 16 Mar 2022 10:45:12 AM CST

^Cinterrupt

上面的命令用 --repeat 參數(shù)，等價于下面的 --cron 參數(shù)：

$ croncli --cron "*/2 * * * * *" date
- Press Ctrl+C to terminate
OUTPUT>>>>>
Wed 16 Mar 2022 10:50:42 AM CST

OUTPUT>>>>>
Wed 16 Mar 2022 10:50:44 AM CST

OUTPUT>>>>>
Wed 16 Mar 2022 10:50:46 AM CST

^Cinterrupt

多個命令

執(zhí)行多個命令時，需要注意的是，多個命令要用單引號或者雙引號括起來。

$ croncli --cron "*/2 * * * * *" "date; uname -r"
- Press Ctrl+C to terminate
OUTPUT>>>>>
Wed 16 Mar 2022 10:54:38 AM CST
5.10.0-10-amd64

Wed 16 Mar 2022 10:54:40 AM CST
Wed 16 Mar 2022 10:54:42 AM CST
^Cinterrupt

這里的** "date; uname -r"** 要用雙引號括起來，如果沒有這個雙引號，就變成2個命令，
一個是 croncli --cron "*/2 * * * * *" date，一個是 uname -r。

windows系統(tǒng)下的使用

首先編譯一個windows下的可執(zhí)行文件。

GOOS=windows GOARCH=amd64 go build

然后執(zhí)行：

D:\share>croncli.exe -r 2s --os win echo %date%
- Press Ctrl+C to terminate
OUTPUT>>>>>
2022/03/17

OUTPUT>>>>>
2022/03/17

OUTPUT>>>>>
2022/03/17

OUTPUT>>>>>
2022/03/17

interrupt

特殊情況處理

定時命令執(zhí)行出現(xiàn)panic

執(zhí)行的命令中出現(xiàn)崩潰錯誤是，如果不處理，會導(dǎo)致整個定時器停止，比如：

$ croncli -r 2s --norecover cat file-not-existed
- Press Ctrl+C to terminate
panic: exit status 126

goroutine 34 [running]:
main.CmdJob.Run({{0x592e82, 0x2}, {0xc0000b40f0, 0x2, 0x5}})
        /home/wangyubin/projects/golang/croncli/cmdjob.go:22 +0xb3
github.com/robfig/cron/v3.(*Cron).startJob.func1()
        /home/wangyubin/projects/gopath/pkg/mod/github.com/robfig/cron/v3@v3.0.0/cron.go:307 +0x6a
created by github.com/robfig/cron/v3.(*Cron).startJob
        /home/wangyubin/projects/gopath/pkg/mod/github.com/robfig/cron/v3@v3.0.0/cron.go:305 +0xb2

默認(rèn)不帶 --norecover 參數(shù)時，命令崩潰這不會導(dǎo)致定時器的中止，比如：

$ croncli -r 2s  cat file-not-existed
- Press Ctrl+C to terminate
cron: 2022/03/17 00:52:40 panic, error=exit status 126, stack=...
goroutine 22 [running]:
github.com/robfig/cron/v3.Recover.func1.1.1()
        /home/wangyubin/projects/gopath/pkg/mod/github.com/robfig/cron/v3@v3.0.0/chain.go:45 +0x85
panic({0x587da0, 0xc000024040})
        /usr/local/go/src/runtime/panic.go:1038 +0x215
main.CmdJob.Run({{0x592e82, 0x2}, {0xc0000c2040, 0x2, 0x4}})
        /home/wangyubin/projects/golang/croncli/cmdjob.go:22 +0xb3
github.com/robfig/cron/v3.Recover.func1.1()
        /home/wangyubin/projects/gopath/pkg/mod/github.com/robfig/cron/v3@v3.0.0/chain.go:53 +0x73
github.com/robfig/cron/v3.FuncJob.Run(0x0)
        /home/wangyubin/projects/gopath/pkg/mod/github.com/robfig/cron/v3@v3.0.0/cron.go:131 +0x1a
github.com/robfig/cron/v3.(*Cron).startJob.func1()
        /home/wangyubin/projects/gopath/pkg/mod/github.com/robfig/cron/v3@v3.0.0/cron.go:307 +0x6a
created by github.com/robfig/cron/v3.(*Cron).startJob
        /home/wangyubin/projects/gopath/pkg/mod/github.com/robfig/cron/v3@v3.0.0/cron.go:305 +0xb2
cron: 2022/03/17 00:52:42 panic, error=exit status 126, stack=...
goroutine 5 [running]:
github.com/robfig/cron/v3.Recover.func1.1.1()
        /home/wangyubin/projects/gopath/pkg/mod/github.com/robfig/cron/v3@v3.0.0/chain.go:45 +0x85
panic({0x587da0, 0xc0000241a0})
        /usr/local/go/src/runtime/panic.go:1038 +0x215
main.CmdJob.Run({{0x592e82, 0x2}, {0xc0000c2040, 0x2, 0x4}})
        /home/wangyubin/projects/golang/croncli/cmdjob.go:22 +0xb3
github.com/robfig/cron/v3.Recover.func1.1()
        /home/wangyubin/projects/gopath/pkg/mod/github.com/robfig/cron/v3@v3.0.0/chain.go:53 +0x73
github.com/robfig/cron/v3.FuncJob.Run(0x0)
        /home/wangyubin/projects/gopath/pkg/mod/github.com/robfig/cron/v3@v3.0.0/cron.go:131 +0x1a
github.com/robfig/cron/v3.(*Cron).startJob.func1()
        /home/wangyubin/projects/gopath/pkg/mod/github.com/robfig/cron/v3@v3.0.0/cron.go:307 +0x6a
created by github.com/robfig/cron/v3.(*Cron).startJob
        /home/wangyubin/projects/gopath/pkg/mod/github.com/robfig/cron/v3@v3.0.0/cron.go:305 +0xb2
^Cinterrupt

雖然命令因為錯誤崩潰，定時器仍然會定時重新執(zhí)行命令，直到主動使用 Ctrl+C 來退出。

定時命令執(zhí)行時間過長

還有一種異常的情況時，如果命令執(zhí)行時間過長，也就是這次的命令還沒執(zhí)行完，卻已經(jīng)到了下次命令的執(zhí)行的時間。

這時，我們可以通過 --mode 參數(shù)控制下次命令的執(zhí)行。
一種是讓下次命令等待這次命令執(zhí)行完再執(zhí)行（--mode delay)，這樣就會導(dǎo)致后續(xù)所有的命令都延遲執(zhí)行，比如：

$ croncli -r 2s --mode delay "date; sleep 3"
- Press Ctrl+C to terminate
OUTPUT>>>>>
Thu 17 Mar 2022 01:10:04 AM CST

Thu 17 Mar 2022 01:10:07 AM CST
Thu 17 Mar 2022 01:10:10 AM CST
^Cinterrupt

所有的命令都等上一個執(zhí)行完（需要3秒）才執(zhí)行，所以命令執(zhí)行間隔是3秒。

還有一種情況是忽略這次的命令執(zhí)行（--mode skip），比如：

$ croncli -r 2s --mode skip "date; sleep 3"
- Press Ctrl+C to terminate
OUTPUT>>>>>
Thu 17 Mar 2022 01:11:56 AM CST

Thu 17 Mar 2022 01:12:00 AM CST
Thu 17 Mar 2022 01:12:04 AM CST
^Cinterrupt

由于每次命令執(zhí)行需要3秒，所以這個命令的下一個命令（間隔2s）都忽略執(zhí)行了，只有下下個命令（間隔4s）才能輪到執(zhí)行。