Alarm如何起作用

本人github

Chrome 扩展的 chrome.alarms API 允许你在指定的时间后或以指定的时间间隔触发事件。这个 API 非常适合用于在后台执行定时任务，尤其是当 Service Worker 可能会被挂起或停止时。

创建 Alarm

你可以使用 chrome.alarms.create 方法创建一个新的 Alarm。这个方法接受两个参数：Alarm 的名称（可选）和一个对象，该对象定义了 Alarm 的行为。

• 一次性 Alarm：使用 delayInMinutes 参数设置一次性 Alarm。

  chrome.alarms.create('oneTimeAlarm', {
        
         delayInMinutes: 1 });
  

• 重复 Alarm：使用 periodInMinutes 参数设置重复 Alarm。

  chrome.alarms.create('repeatingAlarm', {
        
         periodInMinutes: 1 });
  

监听 Alarm

使用 chrome.alarms.onAlarm 事件监听器来处理 Alarm 触发时的行为。

chrome.alarms.onAlarm.addListener(function(alarm) {
    
    
  if (alarm.name === 'oneTimeAlarm') {
    
    
    // 执行一次性 Alarm 的逻辑
  } else if (alarm.name === 'repeatingAlarm') {
    
    
    // 执行重复 Alarm 的逻辑
  }
});

获取和清除 Alarm

• 获取所有 Alarm：使用 chrome.alarms.getAll 方法。

  chrome.alarms.getAll(function(alarms) {
        
        
    console.log(alarms);
  });
  

• 清除 Alarm：使用 chrome.alarms.clear 方法。

  chrome.alarms.clear('oneTimeAlarm');
  

示例

下面是一个简单的示例，演示如何使用 Alarm API 创建一个一次性的 Alarm。

// 创建一个将在1分钟后触发的一次性 Alarm
chrome.alarms.create('oneTimeAlarm', {
    
     delayInMinutes: 1 });

// 监听 Alarm
chrome.alarms.onAlarm.addListener(function(alarm) {
    
    
  if (alarm.name === 'oneTimeAlarm') {
    
    
    // 执行你的代码，例如发送通知
    chrome.notifications.create('notificationId', {
    
    
      type: 'basic',
      iconUrl: 'icon.png',
      title: 'Alarm Triggered',
      message: 'Your one-time alarm was triggered.'
    });
  }
});

这样，即使你的 Service Worker 被挂起或停止，Alarm 仍然会在指定的时间触发。这使得 Alarm API 成为执行定时任务的可靠方式。希望这能帮助你理解如何使用 Chrome 扩展中的 Alarm API！如果你有更多问题或需要进一步的澄清，请随时提问。