egg中开启定时任务

很多时候我们的项目需要一个定时任务, 让程序定时去做一些事情, egg.js框架为我们提供了一套机制来让定时任务的编写和维护更加优雅, 下面我们就写一个小例子来看看egg.js怎么实现一个定时任务功能

##### 编写一个定时任务

在egg.js中, 所有的定时任务都统一放在app/schedule目录下, 在这个目录下创建的每个文件都是一个定时任务, 说白了就是你只要在这里创建一个文件, egg.js框架就会把它当做一个定时任务去执行

创建/app/schedule/log.js

```

module.exports = {

  schedule: {

    interval: '10s', // 任务的间隔时间, 这个定义的10秒执行一次

    type: 'all', // 指定所有的 worker都需要执行

  },

  async task(ctx) {

    // 这里编写我们要执行的任务代码, 我们这里就打印一下当前时间的试试

    console.log("任务执行 : "+ new Date().toString());

  },

};

```

就这就可以了? 对, 就这就可以了, 就是这么简单

运行项目, 这个时候每隔10秒钟就会打印一条日志

```

任务执行 : Sat Aug 03 2019 10:31:52 GMT+0800 (GMT+08:00)

任务执行 : Sat Aug 03 2019 10:32:02 GMT+0800 (GMT+08:00)

任务执行 : Sat Aug 03 2019 10:32:12 GMT+0800 (GMT+08:00)

```

##### 定时任务的方式

定时任务的方式有两种, 分别是interval和cron, 上面我们的例子使用的是interval的定时方式

- interval

这种定时方式定时任务会间隔指定时间去执行一次

interval的值有两种类型, 一种是数字类型, 单位是毫秒, 比如1000, 就代表每隔1000毫秒执行一次定时任务, 另外一种是字符类型, 例如'5s'就代表每隔5秒, '3m'就代表每隔3分钟执行一次定时任务

- cron

定时任务会按照cron表达式在特定时间点执行

```

*    *    *    *    *    *

┬    ┬    ┬    ┬    ┬    ┬

│    │    │    │    │    |

│    │    │    │    │    └ day of week (0 - 7) (0 or 7 is Sun)

│    │    │    │    └───── month (1 - 12)

│    │    │    └────────── day of month (1 - 31)

│    │    └─────────────── hour (0 - 23)

│    └──────────────────── minute (0 - 59)

└───────────────────────── second (0 - 59, optional)

```

cron: '0 0 */3 * * *', 意思就是每隔3个小时执行一次

##### 类型

框架提供的定时任务默认支持两种类型,worker 和 all

worker类型:每台机器上只有一个worker 会执行这个定时任务,每次执行定时任务的 worker 的选择是随机的

all类型:每台机器上的每个worker 都会执行这个定时任务

#### 执行日志

执行日志会输出到 ${appInfo.root}/logs/{app_name}/egg-schedule.log,默认不会输出到控制台

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,558评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,002评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 159,036评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,024评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,144评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,255评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,295评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,068评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,478评论 1 305
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,789评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,965评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,649评论 4 336
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,267评论 3 318
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,982评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,223评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,800评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,847评论 2 351

推荐阅读更多精彩内容