利用Go語言快速實現一個極簡任務調度系統

Posted on by

引子

任務調度（Task Scheduling）是很多軟件系統中的重要組成部分，字面上的意思是按照一定要求分配運行一些通常時間較長的腳本或程序。在爬蟲管理平臺 Crawlab 中，任務調度是其中的核心模塊，相信不少朋友會好奇如何編寫一個任務調度系統。本篇文章會教讀者用 Go 語言編寫一個非常簡單的任務調度系統。

思路

我們首先理清一下思路，開發最小化任務調度器需要什麼。

  • 交互界面（API）
  • 定時任務（Cron）
  • 任務執行（Execute Tasks）

整個流程如下：

我們通過 API 創建定時任務，執行器根據定時任務標準定期執行腳本。

實戰

交互界面

首先我們來搭個架子。在項目目錄下創建一個 main.go 文件，並輸入以下內容。其中 gin 是非常流行的 Go 語言 API 引擎。

package main
​
import (
  "fmt"
  "github.com/gin-gonic/gin"
  "os"
)
​
func main() {
  // api engine
  app := gin.New()
​
  // api routes
  app.GET("/jobs", GetJobs)
  app.POST("/jobs", AddJob)
  app.DELETE("/jobs", DeleteJob)
​
  // run api on port 9092
  if err := app.Run(":9092"); err != nil {
    _, err = fmt.Fprintln(os.Stderr, err)
    os.Exit(1)
  }
}

然後添加 api.go 文件，輸入以下內容，註意，這裡沒有任何代碼實現，隻是加入瞭占位區域。

package main
​
import "github.com/gin-gonic/gin"
​
func GetJobs(c *gin.Context) {
  // TODO: implementation here
}
​
func AddJob(c *gin.Context) {
  // TODO: implementation here
}
​
func DeleteJob(c *gin.Context) {
  // TODO: implementation here
}

定時任務

然後是任務調度的核心，定時任務。這裡我們使用 robfig/cron，Go 語言比較流行的定時任務庫。

現在創建 cron.go 文件，輸入以下內容。其中 Cron 就是 robfig/cron 庫中的 Cron 類生成的實例。

package main
​
import "github.com/robfig/cron"
​
func init() {
  // start to run
  Cron.Run()
}
​
// Cron create a new cron.Cron instance
var Cron = cron.New()

現在創建好瞭主要定時任務實例，就可以將核心邏輯添加在剛才的 API 占位區域瞭。

同樣是 api.go ，將核心代碼添加進來。

package main
​
import (
  "github.com/gin-gonic/gin"
  "github.com/robfig/cron/v3"
  "net/http"
  "strconv"
)
​
func GetJobs(c *gin.Context) {
  // return a list of cron job entries
  var results []map[string]interface{}
  for _, e := range Cron.Entries() {
    results = append(results, map[string]interface{}{
      "id":   e.ID,
      "next": e.Next,
    })
  }
  c.JSON(http.StatusOK, Cron.Entries())
}
​
func AddJob(c *gin.Context) {
  // post JSON payload
  var payload struct {
    Cron string `json:"cron"`
    Exec string `json:"exec"`
  }
  if err := c.ShouldBindJSON(&payload); err != nil {
    c.AbortWithStatus(http.StatusBadRequest)
    return
  }
​
  // add cron job
  eid, err := Cron.AddFunc(payload.Cron, func() {
    // TODO: implementation here
  })
  if err != nil {
    c.AbortWithStatusJSON(http.StatusInternalServerError, map[string]interface{}{
      "error": err.Error(),
    })
    return
  }
​
  c.AbortWithStatusJSON(http.StatusOK, map[string]interface{}{
    "id": eid,
  })
}
​
func DeleteJob(c *gin.Context) {
  // cron job entry id
  id := c.Param("id")
  eid, err := strconv.Atoi(id)
  if err != nil {
    c.AbortWithStatus(http.StatusBadRequest)
    return
  }
​
  // remove cron job
  Cron.Remove(cron.EntryID(eid))
​
  c.AbortWithStatus(http.StatusOK)
}

在這段代碼中，我們實現瞭大部分邏輯，隻在 AddJob 的 Cron.AddFunc 中第二個參數裡，剩下最後一部分執行任務的代碼。下面將來實現一下。

任務執行

現在需要添加任務執行的代碼邏輯，咱們創建 exec.go 文件，輸入以下內容。這裡我們用到瞭 Go 語言內置的 shell 運行管理庫 os/exec，可以執行任何 shell 命令。

package main
​
import (
  "fmt"
  "os"
  "os/exec"
  "strings"
)
​
func ExecuteTask(execCmd string) {
  // execute command string parts, delimited by space
  execParts := strings.Split(execCmd, " ")
​
  // executable name
  execName := execParts[0]
​
  // execute command parameters
  execParams := strings.Join(execParts[1:], " ")
​
  // execute command instance
  cmd := exec.Command(execName, execParams)
​
  // run execute command instance
  if err := cmd.Run(); err != nil {
    _, err = fmt.Fprintln(os.Stderr, err)
    fmt.Println(err.Error())
  }
}

好瞭，現在我們將這部分執行代碼邏輯放到之前的占位區域中。

...
  // add cron job
  eid, _ := Cron.AddFunc(payload.Cron, func() {
    ExecuteTask(payload.Exec)
  })
...

代碼效果

OK，大功告成！現在我們可以試試運行這個極簡的任務調度器瞭。

在命令行中敲入 go run .，API 引擎就啟動起來瞭。

[GIN-debug] [WARNING] Running in "debug" mode. Switch to "release" mode in production.
 - using env:   export GIN_MODE=release
 - using code:  gin.SetMode(gin.ReleaseMode)
​
[GIN-debug] GET    /jobs                     --> main.GetJobs (1 handlers)
[GIN-debug] POST   /jobs                     --> main.AddJob (1 handlers)
[GIN-debug] DELETE /jobs/:id                 --> main.DeleteJob (1 handlers)
[GIN-debug] [WARNING] You trusted all proxies, this is NOT safe. We recommend you to set a value.
Please check https://pkg.go.dev/github.com/gin-gonic/gin#readme-don-t-trust-all-proxies for details.
[GIN-debug] Listening and serving HTTP on :9092

現在打開另一個命令行窗口，輸入 curl -X POST -d '{"cron":"* * * * *","exec":"touch /tmp/hello.txt"}' http://localhost:9092/jobs，會得到如下返回結果。表示已經生成瞭相應的定時任務，任務 ID 為 1，每分鐘跑一次，會更新一次 /tmp/hello.txt。

{"id":1}

在這個命令行窗口中輸入 curl http://localhost:9092/jobs。

[{"id":1,"next":"2022-10-03T12:46:00+08:00"}]

這表示下一次執行是 1 分鐘之後。

等待一分鐘，執行 ls -l /tmp/hello.txt，得到如下結果。

-rw-r–r–  1 marvzhang  wheel     0B Oct  3 12:46 /tmp/hello.txt

也就是說，執行成功瞭，大功告成！

總結

本篇文章通過將 Go 語言幾個庫簡單組合，就開發出瞭一個極簡的任務調度系統。所用到的核心庫:

  • gin
  • robfig/cron
  • os/exec

整個代碼示例倉庫在 GitHub 上: https://github.com/tikazyq/codao-code/tree/main/2022-10/go-task-scheduler

到此這篇關於利用Go語言快速實現一個極簡任務調度系統的文章就介紹到這瞭,更多相關Go語言實現任務調度系統內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：