Agenda同名Cron Job被覆盖问题：如何创建多实例？

你遇到的问题是Agenda默认会将同名且无唯一标识的任务视为同一个，导致新任务覆盖旧任务。要实现同名但携带不同job.attrs.data的多个任务，有两种可靠的解决方式：

1. 为每个任务指定唯一jobId #

Agenda支持在创建任务时传入jobId参数，只要这个ID全局唯一，即使任务名称相同，也会被当作独立任务存储。你可以用业务数据里的唯一标识（比如用户ID、任务周期）拼接出jobId。

示例代码：

// 第一个用户的定期储蓄任务数据
const user1Savings = {
  userId: 'u_001',
  saveAmount: 600,
  cycle: 'monthly'
};

// 创建任务时指定唯一jobId
agenda.schedule('2024-06-01', 'regular-savings', user1Savings, {
  jobId: `savings_${user1Savings.userId}_${user1Savings.cycle}`
});

// 第二个用户的任务，jobId不同，不会被覆盖
const user2Savings = {
  userId: 'u_002',
  saveAmount: 1200,
  cycle: 'weekly'
};

agenda.schedule('2024-05-28', 'regular-savings', user2Savings, {
  jobId: `savings_${user2Savings.userId}_${user2Savings.cycle}`
});

2. 用unique选项自定义唯一性规则 #

如果不想手动生成jobId，可以在定义任务时设置unique选项，指定基于data中字段的唯一性判断规则。只有当指定字段完全相同时，Agenda才会覆盖任务，否则创建新任务。

示例代码：

// 定义任务时配置unique规则
agenda.define('regular-savings', {
  unique: {
    name: 'savings_unique_idx',
    fields: ['data.userId', 'data.cycle']
  }
}, async (job) => {
  // 执行储蓄任务逻辑
  const { userId, saveAmount, cycle } = job.attrs.data;
  console.log(`执行${userId}的${cycle}储蓄任务，金额：${saveAmount}`);
});

// 创建两个不同的任务，userId或cycle不同就不会被覆盖
agenda.schedule('2024-06-01', 'regular-savings', {
  userId: 'u_001',
  saveAmount: 600,
  cycle: 'monthly'
});

agenda.schedule('2024-05-28', 'regular-savings', {
  userId: 'u_001',
  saveAmount: 300,
  cycle: 'weekly'
});

注意事项 #

• 无论用哪种方式，都要保证唯一性标识（jobId或unique字段组合）在业务场景下不会重复，否则依然会出现覆盖。
• 使用unique选项时，Agenda会自动在MongoDB集合中创建唯一索引，若之前手动修改过索引，需要确认索引是否正确。
• 任务执行逻辑中，务必从job.attrs.data读取对应任务的业务数据，确保每个任务执行正确的逻辑。

内容的提问来源于stack exchange，提问作者Jdavydz