【教程向】从零开始创建浏览器插件（二）深入理解 Chrome 扩展的 manifest.json 配置文件

第二步：深入理解 Chrome 扩展的 manifest.json 配置文件

上一次我们已经着手完成了一个自己的浏览器插件，链接在这里：我是链接

在本篇博客中，我们将更详细地探讨 Chrome 扩展中的 manifest.json 文件。这个文件是每个浏览器扩展不可或缺的核心，它不仅定义了扩展的基本元数据，而且还规定了扩展的行为和权限。我们将深入探讨各种常用配置，并提供具体的代码示例以帮助您更好地理解和运用这些配置。

manifest.json 基本结构

每个 Chrome 扩展的 manifest.json 文件都必须包含以下基本字段：

• manifest_version (必需)：指明 manifest 文件的版本。目前版本为 3。
• name (必需)：扩展程序的名称。
• version (必需)：扩展程序的版本号。

一个简单的 manifest.json 文件看起来像这样：

{
  "manifest_version": 3,
  "name": "Sample Extension",
  "version": "1.0"
}

常用配置详解

描述和图标

• description：对扩展功能的简短描述。
• icons：一个对象，定义了一系列图标，这些图标将在扩展目录、地址栏旁的扩展按钮以及其他界面中使用。

"description": "A simple Chrome extension example.",
"icons": {
  "16": "icon16.png",
  "48": "icon48.png",
  "128": "icon128.png"
}

背景脚本

• background：包含 service_worker 指向的脚本在扩展安装后立即持续运行，通常用于处理事件监听和维持扩展的生命周期。

"background": {
  "service_worker": "background.js"
}

弹出页面

• action：定义扩展的默认弹出行为，包括弹窗页面路径与默认图标。

"action": {
  "default_popup": "popup.html",
  "default_icon": "icon48.png"
}

权限

• permissions：扩展请求访问的 API 权限和其他特权。

"permissions": [
  "storage",
  "tabs",
  "http://*/*",
  "https://*/*"
]

内容脚本

• content_scripts：定义在特定页面自动注入的脚本和CSS。你可以指定脚本和CSS应应用到的网页URL模式。

"content_scripts": [
  {
    "matches": ["http://*.example.com/*", "https://*.example.com/*"],
    "js": ["content.js"],
    "css": ["style.css"]
  }
]

选项页面

• options_page 或 options_ui：指定一个HTML文件，用于配置扩展的选项。

"options_ui": {
  "page": "options.html",
  "open_in_tab": true
}

主机权限

• host_permissions：允许扩展访问列表中的网站。

"host_permissions": [
  "http://*/*",
  "https://*/*"
]

小结

manifest.json 文件是浏览器扩展的核心，通过它可以精细地控制扩展的各种行为和权限设置。了解并正确使用这些配置项将帮助你高效地开发功能复杂的扩展程序。记得根据扩展的特定需求选择合适的配置项，以确保功能的实现和用户的安全。

希望这篇文章能帮助你更深入地理解和使用 manifest.json，并创建出功能强大、用户友好的 Chrome 扩展！