Manifest.json 基本结构 - Javascript

简介

一个网站或者浏览器扩展需要告诉浏览器或者操作系统一些元数据信息，例如名称、版本、描述、图标和权限等。在 Web 网站和浏览器扩展中，这些元数据信息都被保存在 manifest.json 文件中。本文将讲解 manifest.json 文件的基本结构和常用字段说明。

manifest.json 基本结构

manifest.json 文件是一个纯文本文件，可以使用任何文本编辑器进行编辑。manifest.json 文件的基本结构如下：

{
  "manifest_version": 2,
  "name": "My Extension",
  "version": "1.0",
  "description": "A brief description of my extension.",
  "icons": {
    "16": "icon16.png",
    "32": "icon32.png",
    "48": "icon48.png",
    "128": "icon128.png"
  },
  "permissions": [
    "http://localhost/*"
  ],
  "background": {
    "scripts": ["background.js"],
    "persistent": false
  },
  "content_scripts": [
    {
      "matches": [ "<all_urls>" ],
      "js": ["content.js"],
      "css": ["content.css"]
    }
  ],
  "browser_action": {
    "default_icon": "icon.png",
    "default_title": "My Extension",
    "default_popup": "popup.html"
  }
}

manifest.json 字段说明

下面是 manifest.json 文件的一些常用字段说明：

manifest_version

指定 manifest 文件版本号，必须为整数。目前必须指定为2。

name

扩展或者应用的名称。

version

扩展或者应用的版本号。

description

扩展或者应用的描述。

icons

指定扩展或者应用的图标。这个字段可以是一个对象，也可以是一个字符串。如果是字符串，就代表扩展或者应用的默认图标。

permissions

指定扩展或者应用需要的权限，例如数据访问、执行 JavaScript 等。这个字段是一个数组，可以包含多个权限。权限的详细说明可以查看 Chrome API 文档。

background

指定扩展或者应用的后台脚本。这个字段是一个对象，具体包含以下两个属性：

• scripts：指定需要加载的 JavaScript 脚本文件。
• persistent：指定后台脚本是否一直运行。如果设置为 false，那么后台脚本将在不活动一段时间后自动终止。

content_scripts

指定扩展或者应用需要注入到页面中的代码。这个字段是一个数组，可以包含多个对象，每个对象代表一个需要注入的脚本。每个对象具体包含以下几个属性：

• matches：一个数组，指定需要注入代码的页面 URL 匹配规则。
• js：一个数组，指定需要注入的 JavaScript 文件。
• css：一个数组，指定需要注入的 CSS 文件。

browser_action

指定扩展或者应用的浏览器动作。这个字段是一个对象，具体包含以下三个属性：

• default_icon：扩展或者应用的默认图标。
• default_title：扩展或者应用的默认标题。
• default_popup：扩展或者应用的默认浏览器动作。当用户单击浏览器工具栏图标时会打开的 HTML 页面。

以上就是 manifest.json 文件的一些基本结构和常用字段说明。通过了解 manifest.json 文件的结构和字段含义，我们可以更加深入地了解 Web 网站和浏览器扩展的开发流程。