跳转到主要内容
将 JSON 资源用于规则集和 managed schema 等扩展功能,并享受校验与可预测的输出处理。 Extension.js 会处理 manifest 引用的 JSON 资源,并针对已知的功能类型对其进行校验。在开发期它会监视这些文件,并在需要时输出对应的产物。

JSON 能力

JSON 支持

常见的 manifest 字段:

manifest.json 中的 JSON 声明示例

manifest.json 中的 JSON 声明示例:

输出路径

Extension.js 会按功能上下文输出 JSON 资源(例如 DNR 与 storage schema 输出):

开发期行为

  • Extension.js 会把 manifest 引用的 JSON 文件作为文件依赖跟踪。
  • 编辑 JSON 会触发重新编译。
  • 当 manifest 的修改添加、移除或重命名 JSON 引用时,正在运行的 extension dev 会话会自行重启编译器。

校验行为

Extension.js 会校验:
  • 所引用资源的 JSON 语法
  • DNR 规则集形状(基于数组的规则集期望)
  • Managed storage schema 形状(基于对象的期望)

Chrome 拒绝的规则集

Chromium 构建会对两种 declarativeNetRequest 规则集形态发出警告。Chrome 会因为其中任何一种拒绝加载整个扩展,而 Firefox 能加载同一个文件。
  • 重复的规则 id:同一个规则集里有两条规则共用一个 id。
  • Chrome 无法编译的 regexFilter:过滤器里用了先行断言、后行断言或反向引用。
这两条都是警告而不是错误,因为同一个文件在 Firefox 上是合法的。Firefox 和 Safari 构建不会打印任何内容。

环境占位符

在编译期,Extension.js 会替换输出 .json 资源中的 $EXTENSION_* 占位符,使用的逻辑与静态 HTML 占位符替换相同。

最佳实践

  • 让 manifest 引用的 JSON 聚焦于浏览器所需的资源格式。
  • 在持续集成(CI)中校验 JSON 资源,再进行打包。
  • 在 manifest 中优先使用稳定的文件路径,因为每次路径变化都会让 dev 会话重启编译器。
  • 对于代码消费的应用数据,请把 JS/TS 模块中的 JSON 导入与 manifest 资源 JSON 分开处理。

下一步