[Node] Agenda 中文文档 定时任务调度系统[基础篇]

node cron 动态任务调度,不同timeZone配置 node cron 定时任务调度,timezone 配置 阅读详情

Agenda简介

Agenda是一个定时任务管理模块,它将node中的定时任务存储在数据库中(官方文档推荐使用mongoDB),通过事件回调与监听实现定时任务调度。

使用步骤概述

总的来说分4步:

  • 初始化(new Agenda(..))
  • 定义任务(agenda.define(..))
  • 配置任务(agenda.every(..))
  • 最后设置事件监听(agenda.on(..)
const Agenda = require('agenda')
const connection_options = {
  db: {
    address: 'mongodb://127.0.0.1:27017/agenda',
    collection: 'agendaJobs',
    options: { server: { auto_reconnect: true } },
  },
}
// 初始化agenda
let agenda = new Agenda(connection_options)
agenda
  .name('AGENDA TEST - ' + process.pid)
  .defaultConcurrency(5)
  .defaultLockLifetime(10000)
// 定义任务
agenda.define('updateCampaignTimeout', { priority: 'high', concurrency: 3 }, (job, done) => {
  dbp_job.updateCampaignTimeoutTick()
    .then(() => done())
    .catch((error) => { throw error })
})
// 配置任务(需要在ready事件中完成)
agenda.on('ready', () => {
  agenda.every('00 09 18 * * *', 'updateCampaignTimeout', {}, {timezone: 'Asia/Shanghai'})
  console.log('agenda测试开始,启动完毕')
  agenda.start()
})
// 设置监听
agenda.on('start', (job) => {
  console.log('检测到job启动: ', job.attrs.name)
})

agenda.on('complete', (job) => {
  console.log('检测到job完成: ', job.attrs.name)
})

agenda.on('success', (job) => {
  console.log('检测到job成功: ', job.attrs.name)
})

agenda.on('fail', (job) => {
  console.log('检测到job失败: ', job.attrs.name)
  console.log('失败时间: ', job.attrs.failedAt)
  console.log('失败原因: ', job.attrs.failReason)
  agenda.stop()
})
// 最后,优雅的退出方案
function graceful() {
  agenda.stop(() => {
    console.log('检测到退出')
    process.exit(0);
  });
}

process.on('SIGTERM', graceful);
process.on('SIGINT', graceful);

步骤详述

初始化

完整参数表点我

初始化有两种方案:

  • 通过完整的参数传递
  • 链式初始化(推荐使用)

部分说明:

  • .database(url, [collectionName])连接数据库,例如agenda.database('mongodb://127.0.0.1:27017/agenda', 'agendaJobs'),其中collectionName可省略,默认值为agendaJobs
  • .name(string)jobs存储于数据库中会有lastModifiedBy字段,存储调度这个任务的agenda名字
  • .processEvery(interval)用于设置agenda轮询数据库检测是否有新的任务加入的扫描时间
  • .defaultLockLimit(number)设置默认值,agenda调度任务时会锁定该任务,防止其他agenda重复执行任务,当任务超出lockLifetime或调用done时会解锁任务,define新任务时如果设置.lockLimit(number)则会覆盖默认值。该值用于设置锁定任务的数量,默认为0,即无限制
  • .defaultLockLifetime(number)上面说了,当任务被调度时会被锁定,当任务调用完毕执行done()后会解锁,或者执行的时间很长,超出了lockLifetime也会解锁,同样,define其他任务时如果设置了lockLifetime参数,会覆盖掉默认值

定义任务

agenda.define(jobName, [options], fn)

agenda.define('updateCampaignTimeout', { priority: 'high', concurrency: 3 }, (job, done) => {
  dbp_job.updateCampaignTimeoutTick()
    .then(() => done())
    .catch((error) => { throw error })
})
参数说明:

jobName
类型String,用于存储于数据库中的name字段,同时配置任务和设置监听会使用到该参数

options
可配置concurrency、lockLimit、lockLifetime、priority,前文都已说过,
priority为任务优先级:lowest|low|normal|high|highest|number,前五个是字符串,传入后会被转为数字,依次对应:-20|-10|0|10|20

fn(job, done):
* 配置任务时,会设置每次执行任务需要传入的参数,该参数都被放在了job.attrs.data中,
* 任务出错,会调用job.fail(reason)方法,其中的reason可以是字符串或Error,当调用此方法时,会设置job.attrs.failedAt为当前时间(ISO),job.attrs.failReason为reason或Error.message
* 对于异步任务,必须调用done方法告知任务结束
* 对于同步任务,省略为fn(job)即可


配置任务

agenda.every(interval, name, [data], [options], [cb])

agenda.every('00 09 18 * * *', 'updateCampaignTimeout', {}, {timezone: 'Asia/Shanghai'})
agenda.every('30 seconds', 'updateCampaignOverBudget')
agenda.every('1 minutes', 'synchronizeBudget')
参数说明

interval
可以是字符串,或cron时间,注意:官方Agenda文档说明的cron时间格式已过时,现在的cron时间格式为

* * * * * *
| | | | | | 
| | | | | +-- Day of the Week   (range: 0-6, 0 standing for Monday)
| | | | +---- Month             (range: 0-11)
| | | +------ Day of the Month  (range: 1-31)
| | +-------- Hour              (range: 0-23)
| +---------- Minute            (range: 0-59)
+------------ Second            (range: 0-59)

设置每隔几分钟的任务用'5 minutes'就好了,但是如果设置每天的什么时候运行,就要使用cron设置,且要注意时区(在options中设置)!!

name
就是任务的名字,一定要对应,可以是字符串数组,这样的话多个任务就使用同一个配置

data
是一个Object,在define任务时通过job.attrs.data获取该对象

options
注意,要设置options必须先设置data,所以data可以传空Object{},在options中可以设置的有timezone,必须是可识别的时区字符串,默认为'America/New_York,而在我们的时区,必须要设置对时区,才能正常运行定时任务!我们的时区字符串是Asia/Shanghai

完整时区查询戳我(维基百科)

cb
当job成功被加入数据库时会调用回调函数


设置监听

agenda.on('ready', () => {
  // agenda.every('5 seconds', 'say hello')
  agenda.every('00 09 18 * * *', 'updateCampaignTimeout', {}, {timezone: 'Asia/Shanghai'})
  agenda.every('30 seconds', 'updateCampaignOverBudget')
  agenda.every('1 minutes', 'synchronizeBudget')
  agenda.purge((err, numRemoved) => {
    console.log('旧任务被移除: ', numRemoved)
  })
  console.log('agenda测试开始,启动完毕')
  agenda.start()
})

agenda.on('fail', (job) => {
  console.log('检测到job失败: ', job.attrs.name)
  console.log('失败时间: ', job.attrs.failedAt)
  console.log('失败原因: ', job.attrs.failReason)
  agenda.stop()
})

可以监听的事件有:

  • 'ready', function()
  • 'start', function(job)
  • 'start:job name', function(job)
  • 'complete', function(job)
  • 'complete:job name', function(job)
  • 'success', function(job)
  • 'success:job name', function(job)
  • 'fail', function(err, job)
  • 'fail: job name', function(err, job)

其中比较重要的事件就是ready了,当agenda初始化完毕成功连接数据库后,会发出ready事件,此时就要通过监听该事件,在ready时间中对define过的任务配置时间等参数,最后调用agenda.start()启动agenda

我们发现,在ready事件中,我们还调用了agenda.purge(cb),这个函数是清理数据库中的旧任务(即这此运行程序没有被define到的job)


注意事项

  • agenda在mongoDB中的存储方式:
{
    "_id" : ObjectId("5981983d9b85994179fc98c9"),
    "name" : "updateCampaignTimeout",
    "type" : "single",
    "data" : {

    },
    "priority" : 10,
    "repeatInterval" : "00 09 18 * * *",
    "repeatTimezone" : "Asia/Shanghai",
    "lastModifiedBy" : "AGENDA TEST - 97807",
    "nextRunAt" : ISODate("2017-08-03T10:09:00.011Z"),
    "lockedAt" : null,
    "lastRunAt" : ISODate("2017-08-02T10:09:00.011Z"),
    "lastFinishedAt" : ISODate("2017-08-02T10:09:00.076Z"),
    "failReason" : "failed to calculate nextRunAt due to invalid repeat interval",
    "failCount" : 1,
    "failedAt" : ISODate("2017-08-02T09:44:54.551Z")
}
  • 重复启动agenda时,会更新对应的项,而不是覆盖,只要任务名相同,就不会在数据库中创建新的数据项,也不会删除旧的job(该次执行程序没有define到的job),除非在ready事件中调用agenda.purge

  • 在配置任务(agenda.every)时一定要注意时区的设置

  • agenda.every配置失败时(传入的interval不对等原因),会返回undefined,正常情况下返回job对象

  • 关于job对象:

Job {
  agenda:
   EventEmitter {
     _name: 'AGENDA TEST - 97807',
     _processEvery: 5000,
     _defaultConcurrency: 5,
     _maxConcurrency: 20,
     _defaultLockLimit: 0,
     _lockLimit: 0,
     _definitions:
      { updateCampaignTimeout: [Object],
        updateCampaignOverBudget: [Object],
        synchronizeBudget: [Object] },
     _runningJobs: [],
     _lockedJobs: [],
     _jobQueue: [],
     _defaultLockLifetime: 10000,
     _isLockingOnTheFly: false,
     _jobsToLock: [],
     _events:
      { ready: [Function],
        start: [Function],
        complete: [Function],
        success: [Function],
        fail: [Function] },
     _eventsCount: 5,
     _mdb:
      Db {
        domain: null,
        _events: {},
        _eventsCount: 0,
        _maxListeners: undefined,
        s: [Object],
        serverConfig: [Getter],
        bufferMaxEntries: [Getter],
        databaseName: [Getter] },
     _collection: Collection { s: [Object] } },
  attrs:
   { name: 'updateCampaignTimeout',
     data: {},
     type: 'single',
     priority: 10,
     nextRunAt: moment.parseZone("2017-08-02T18:09:00.009+08:00"),
     repeatInterval: '00 09 18 * * *',
     repeatTimezone: 'Asia/Shanghai' } }
  • 官方README的CRON格式过时了,最新的CRON格式请见上文

待补充……

Node.js-Agenda一个用于Node.js的轻量级作业调度库 Agenda 一个用于Node.js的轻量级作业调度库 立即下载

相关推荐

Node.js-nodejs定时调度任务

nodejs定时调度任务

使用Node.js实现一个定时任务调度中心

在日常开发中共,除了给前端开发接口,还要写一些定时处理任务,比如每天定时非所有用户推送消息。一个成熟的定时任务调度中心,是可以通过管理系统来管理所有任务的信息,可以动态更改任务执行时间和立即执行等。公司最近业务需求需要一个定时任务调度中心的系统,但搜索全网没有找到一个Node开发的定时任务调度中心系统,所以自己实现一个定时任务调度中心系统。

Jerry_zpon的博客 2690

osgearth2.10 demo功能介绍

osgearth-2.10 demo: 说明: 1、运行环境win7 x64 旗舰版,CPU i5-6400 8核,8G内存; 2、括号内是对应demo的测试参数(.earth); 3、配置OSG_FILE_PATH; 4、参数命令行可以查看各个demo需要的输入参数; 5、前缀说明:gui界面程序、cmd控制台程序、non功能未知; 6、程序后括号里的non表示不需要通过命令行输入参数; 示例: 1、gui:osgearth_3pv(simple.earth):相机与地球的投影关系,Range表示相机

rach09的专栏 2425

推荐一款强大的定时任务库——node-schedule

如果你在开发中需要实现定时任务的功能,那么不妨尝试一下 `node-schedule` 这款开源的定时任务库。 ## 项目简介 `node-schedule` 是一个用于 Node.js 的简单、灵活的定时任务库。它可以让你轻松地创建一次性或者周期性的定时任务,支持多种复杂的调度策略。 ## 应用场景 你可以使用 `node-schedule` 来实现以下应用场景: - 定时发送邮件/短...

gitblog_00038的博客 970

ArcMap新手必看:Shape属性中的点ZM值到底是什么?如何快速处理

本文深入解析ArcMap中Shape属性中的点ZM值,揭示其在GIS数据中的隐藏维度作用,包括Z值(高程值)和M值(测量值)。针对ZM值可能引发的服务发布问题,提供三种高效处理方案,帮助新手快速掌握数据导入时的ZM值管控策略及精准去除方法。

weixin_42561476的博客 432

ECU-TEST 快速入门

ECU-TEST 是由位于德国德累斯顿的TraceTronic公司开发的一款用于嵌入式系统测试验证软件工具。自从2003年首次发布ECU-TEST ,该软件成为了汽车ECU开发的标准工具 ,同时也逐步成为了重型机械和工业自动化开发的标准工具 。该软件是起源自于一个控制单元的系统化测试的项目研究,从而为从德累斯顿工业大学脱离出来的TraceTronic公司奠定了基础。ECU-TEST旨在完成测试案例的规范化、评估、求解和归档。得益于该软件包含大量的自动化测试方法使得测试案例的所有必要功能如创建、求解和评估

wangying202的博客 1万+

Nodejs-Agenda简单的例子

Nodejs-Agenda简单的例子

SolitudeAlma的博客 813

Windows10环境下激活虚拟环境报错【source : 无法将“source”项识别为 cmdlet、函数、脚本文件或可运行程序的名称】

在使用Django创建Web程序前,需要创建一个虚拟的工作环境,在使用【source ll_env/bin/activate】命令激活虚拟环境时报错:source : 无法将“source”项识别为 cmdlet、函数、脚本文件或可运行程序的名称。请检查名称的拼写,如果包括路径,请确保路径正确,然后再试一次。所在位置 行:1 字符: 2。

提供C#相关开发 、云计算、运维测试、网络安全相关技术分享与服务,有意向可联系。 1万+

Node Schedule 终极指南:如何掌握 Node.js 任务调度神器

Node Schedule 是一款功能强大的 Node.js 任务调度库,它提供了类似 cron 但更灵活的定时任务调度功能。无论是简单的定时执行还是复杂的周期性任务,Node Schedule 都能轻松应对,成为 Node.js 开发者必备的任务调度工具。😊 ## 📋 为什么选择 Node Schedule? 与传统的 setInterval 或 setTimeout 不同,Node S

gitblog_00708的博客 1077

电能质量仿真:电能质量改善措施仿真_(12).电能质量改善措施综合仿真案例

假设我们有一个微电网系统,该系统包含分布式电源(如光伏板、风力发电机)、储能设备、负荷和电网连接。电压波动:由于负荷的波动和分布式电源的间歇性输出,系统电压出现了不稳定的情况。谐波污染:非线性负荷和逆变器的运行导致系统中出现了显著的谐波污染。频率偏差:分布式电源的波动和负荷的突变导致系统频率出现了偏差。我们需要通过仿真来评估这些问题的影响,并提出相应的改善措施。

2401_87715305的博客 1361

计算机组成原理(第三版)唐朔飞-第八章CPU的结构和功能-课后习题

8.1CPU有哪些功能?画出其结构框图并简要说明每个部件的作用。

weixin_45735391的博客 6万+

nodejs 实现定时任务 node-schedule

一、安装node-schedule 二、导入node-schedule 创建timedTask.js 文件,以下代码都会写在里面

奇点的博客 4402

【华为OD机试】真题E卷-一种字符串压缩表示的解压(C++)

有一种简易压缩算法:针对全部为小写英文字母组成的字符串,将其中连续超过两个相同字母的部分压缩为连续个数加该字母,其他部分保持原样不变。例如:字符串aaabbccccd 经过压缩变成字符串 3abb4cd请您编写解压函数,根据输入的字符串, 判断其是否为合法压缩过的字符串若输入合法则输出解压缩后的字符串 否则输出字符串!error来报告错误。

u014481728的博客 895

Agendash完全指南:一站式管理Agenda任务的终极仪表盘

Agendash是Agenda任务调度系统的可视化管理仪表盘,提供直观的界面帮助开发者轻松监控、管理和调度任务。作为Agenda生态系统的重要组成部分,Agendash让复杂的任务管理变得简单直观,即使是新手也能快速上手。 ## 为什么选择Agendash? Agendash作为Agenda的官方管理界面,提供了丰富的功能来简化任务调度流程。无论是监控任务状态、创建新任务,还是搜索和筛选特定任

gitblog_00409的博客 1109

杰理接入第三方升级协议OTA教程

本教程介绍了使用dual_bank_updata_api.h接口接入第三方协议进行固件升级的方法。主要内容包括:INI配置要求(需启用双备份并强制4K对齐)、7个核心API接口功能说明及参数详解(初始化、空间检查、数据写入、校验等)、标准升级流程步骤(初始化→检查→写入→校验→引导→清理)。特别强调了4K对齐配置的重要性以避免数据丢失,并提供了被动升级流程图。该方案支持用户自定义协议接入,需严格按照流程调用接口完成升级。

qq_42014563的博客 1432

C# WinForm 基于DirectShow.dll编写的程序,可边预览边保存视频,音频和图片

基于微软的DirectShow.dll的二次开发1.自动识别连接的摄像头跟麦克风且可以对其进行选择(默认选中第一个)2.可录制wmv和avi两种格式的视频并且都带有音频,avi可以录制的分辨率和帧数进行选择,wmv默认进行了淸晰度优化如不喜欢可去除代码中有相关提示3.可在预览点开之后进行拍照,也可边录制视频边拍照4.添加了视频和音频的压缩功能(酌情使用)这次二次开发发现C#对DirectShow的相关信息太少,这次做完也不敢藏私共享出来,还望大家指正

为什么选择Agendash?探索这款Agenda仪表盘的独特优势 [特殊字符]

在Node.js生态系统中,任务调度和作业队列管理是后端开发的重要环节。Agendash作为一款专为Agenda.js设计的现代化仪表盘工具,为开发者提供了直观、高效的任务管理体验。这款开源工具不仅简化了作业监控流程,还通过强大的搜索功能和响应式界面,让任务调度管理变得更加轻松便捷。 ## 什么是Agendash?快速了解这款强大的任务管理工具 Agendash是一个基于Web的仪表盘,专门用

gitblog_00235的博客 444

精雕软件(JDpaint) 5.5 绿色版

精雕软件(JDpaint) 5.5 绿色版精雕软件(JDpaint) 5.5 绿色版精雕软件(JDpaint) 5.5 绿色版

Bulletproof Node.js开发工具链:10个必备工具与插件推荐

Bulletproof Node.js是一个开源的Node.js项目架构,旨在为开发者提供一个健壮、可扩展的API开发基础框架。这个项目采用了现代化的开发工具链,让Node.js开发变得更加简单高效。在本文中,我们将深入探讨Bulletproof Node.js的核心工具链配置,帮助您构建更可靠的Node.js应用。 ## 🛡️ 什么是Bulletproof Node.js? Bulletp

gitblog_00802的博客 1126

锂电池充电器电路设计 里面有电路

锂电池充电器电路设计 里面有电路 3.7V升压到5V电路设计。

OV9734 DATASHEET,完整规格书

OV9734完整规格书,包括电气参数,尺寸规格,寄存器配置表等

realism-effects高级特性探索:镜头畸变与闪耀效果的创意应用

realism-effects是一款强大的开源图形渲染增强库,提供了多种高级视觉效果实现方案,帮助开发者轻松为3D场景添加电影级视觉质感。本文将深入探索其中的镜头畸变与闪耀效果,带您了解如何利用这些特性创造出令人惊艳的视觉体验。 ## 为什么选择realism-effects? 在现代3D渲染中,真实感不仅仅来自于精细的模型和材质,更需要通过各种光学效果模拟真实世界的物理现象。realism-

gitblog_00387的博客 790

推荐使用 Kue-Scheduler:智能的 Node.js 调度利器

推荐使用 Kue-Scheduler:智能的 Node.js 调度利器 Kue-Scheduler 是一款基于 Redis 的 Node.js 工具,专为 Automattic 的 Kue 框架打造,用于处理定时任务和调度。它借鉴了 Agenda 的设计理念,并在系统重启后能够自动恢复计划。无论你是新手还是经验丰富的开发者,这个库都将为你提供简单且强大的任务调度解决方案。 1. 项目介绍 Kue-...

gitblog_00078的博客 457

在nodejs中实现调度任务

在nodejs中实现调度任务

qq_42880714的博客 1879

Czkawka 免费磁盘清理教程:快速定位重复文件、空文件夹与相似图片

Czkawka 是一款用 Rust 编写的免费开源磁盘清理工具,能扫描目录找出重复文件、空文件夹、相似图片和相似视频,然后批量删除、移动或重命名。它支持 Mac、Windows 和 Linux,运行时不联网,扫描结果全部留在本机。 ## 存储告急时,手动翻目录为什么总漏东西 系统弹出"存储空间不足"时,大多数人会打开文件管理器逐层翻找。但重复的备份、藏在深层路径里的空目录、几十张几乎一样的截图

gitblog_00225的博客 168

推荐开源项目:Agenda - 轻量级Node.js作业调度库

在寻找一款能够轻松管理定时任务的Node.js库吗?Agenda或许就是你需要的答案。这个经过重写的TypeScript版本不仅提供了强大的功能,还保持了轻量级的特性,让你的工作更加得心应手。 ## 项目介绍 Agenda是一款基于MongoDB的轻量级作业调度库,其主要目标是让在Node.js中创建和管理计划任务变得简单易行。它支持类型注解,且内置了对MongoDB 5.x的支持,以及Mon...

gitblog_00031的博客 1074

Agenda - 一个功能强大的任务管理工具

Agenda 是一个开源的任务和事件管理项目,主要使用 JavaScript 编程语言开发,通过 Node.js 运行。该项目旨在提供一个简单直观的界面,帮助用户管理日常任务和事件。 ## 1. 项目基础介绍及主要编程语言 Agenda 是基于 Node.js 开发的,使用 Express 框架构建 Web 界面,并采用 MongoDB 作为数据库进行数据存储。项目通过 Socket.IO 实

gitblog_00557的博客 633

Nodejs定时任务Node Schedule

https://www.npmjs.com/package/node-schedule

sun 531

XXLJOB调度平台——定时任务调度、日志管理平台

核心设计目标:开发迅速、学习简单、轻量级、易扩展。

Williams10的博客 3514
上一篇: [Leetcode/Javascript] 461.Hamming Distance
下一篇: [Linux] 服务器镜像定时备份解决方案 crontab+rsync+flock
EnergyOverflow
博客等级 码龄10年 1粉丝 15原创
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付:10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值