Chrome/Edge扩展declarativeNetRequest添加规则时ID不唯一错误排查

问题根源 #

调用chrome.declarativeNetRequest.updateDynamicRules添加规则时，若目标ID的规则已存在（比如扩展背景脚本重复加载、之前的规则未清理），就会触发ID不唯一的错误。哪怕用随机数，也可能因函数重复执行、随机数范围过小导致重复。

解决方案 #

方案1：固定ID+先删后加（推荐，易管理） #

每次添加规则前，先移除同ID的旧规则，确保ID唯一。代码示例：

// 自执行async函数，确保扩展启动时执行一次
(async function initBlockRule() {
  const RULE_ID = 1001; // 自定义固定ID，范围1-2^31-1
  const KEYWORD = "your-target-keyword"; // 替换成你的拦截关键词

  // 第一步：移除已存在的同ID规则
  try {
    await chrome.declarativeNetRequest.updateDynamicRules({
      removeRuleIds: [RULE_ID]
    });
  } catch (err) {
    // 如果规则不存在，捕获错误不影响后续执行
    console.log("No existing rule to remove:", err.message);
  }

  // 第二步：添加新规则
  try {
    await chrome.declarativeNetRequest.updateDynamicRules({
      addRules: [
        {
          id: RULE_ID,
          priority: 1, // 优先级可根据需求调整
          action: { type: "block" },
          condition: {
            urlFilter: `*${KEYWORD}*`, // 匹配包含关键词的URL
            resourceTypes: ["main_frame", "sub_frame"] // 拦截页面主框架和子框架请求，可按需添加其他类型
          }
        }
      ]
    });
    console.log("Block rule added successfully");
  } catch (err) {
    console.error("Failed to add rule:", err.message);
  }
})();

方案2：随机ID+检查唯一性 #

如果必须用随机ID，先获取所有已存在的动态规则，确保生成的ID不重复：

async function addUniqueBlockRule() {
  const KEYWORD = "your-target-keyword";
  let newRuleId;

  // 获取当前所有动态规则
  const existingRules = await chrome.declarativeNetRequest.getDynamicRules();
  const existingIds = existingRules.map(rule => rule.id);

  // 生成不重复的随机ID
  do {
    newRuleId = Math.floor(Math.random() * 1000000); // 扩大随机范围降低重复概率
  } while (existingIds.includes(newRuleId));

  // 添加规则
  await chrome.declarativeNetRequest.updateDynamicRules({
    addRules: [
      {
        id: newRuleId,
        priority: 1,
        action: { type: "block" },
        condition: {
          urlFilter: `*${KEYWORD}*`,
          resourceTypes: ["main_frame", "sub_frame", "script"]
        }
      }
    ]
  });
}

// 调用函数执行
addUniqueBlockRule();

关键注意事项 #

1. 权限配置：确保manifest.json中声明了必要权限：

{
  "manifest_version": 3,
  "permissions": ["declarativeNetRequest"],
  "host_permissions": ["<all_urls>"],
  "background": {
    "service_worker": "background.js"
  }
}

2. async函数执行：自执行async函数末尾的括号必须保留，否则函数不会运行；如果不想用自执行，也可以单独定义函数后调用（如方案2的写法）。
3. 规则优先级：如果有多个拦截规则，注意调整priority值，数值越高优先级越高。

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