浏览器插件开发-manifest文件解读

调研资料

manifest.json 官方文档

Chrome Extension API

360浏览器的插件文档中文, 虽然内核差不多但是不一定与 Chrome api 一致, 可以作为参考

manifest.json 配置说明

manifest.json 用于描述 Chrome 插件的源数据，配置信息等，基本内容如下

{
    "name": "名称",
    "description": "描述",
    "version": "打包完成后用于判断插件是否需要更新",
    "manifest_version": 2,
    "browser_action": {
        "default_popup": "xxx.html 右上角点击后的弹窗，可以用一个页面定义",
        "default_icon": "xxx.png 显示在右上角的图标button"
    },
}

配置项简介

1. manifest_version 必填

清单文件格式的版本， Chrome 18 开发写 2 即可

2. name 必填

插件名称

3. version 必填

插件版本，发布新版本后，浏览器会比较其已安装的插件的版本，有更新的版本则会自动更新

4. description

插件的描述，132个字符限制

5. icons

插件的图标，可以用在 Chrome 商店展示(128 * 128) | 插件管理界面 (48 * 48) | 扩展页图标 (16 * 16) 最好是 png 格式

6. browser_action

可以用来定义点击图标后展示的窗口，对应接口 chrome.browserAction，这项配置与 page_action 是对立的，只能二选一，以下是 browser_action 子项的配置

　　default_icon: Object | string 一个或者一组图标的路径

　　default_title 设置 tooltip

　　default_popup 指定弹出的窗口，可以是任意 html

　　badges “徽章” 就是小图标上的一个标记，用来展示一些状态

7. page_action

代表可以在当前页面执行的操作，不活动时显示灰色,对应接口 chrome.pageAction

　　default_icon: Object | string 一个或者一组图标的路径

　　可用 pageAction.(show|hide) 改变插件活动状态

　　browser_action 和 page_action都用来定义放置在工具栏右上角的图标点击情况，但是两者的活动状态展示 | 点击后的展示 | 主要负责场景是不一致的

猜测 browser_action 适用于用户需要点击图标后在弹窗中操作的场景 page_action 试用与在后台运行，重要工作是监听用户行为的插件

官方建议：如果要实现的功能只针对某一个页面有用则建议使用 page_action 否则使用 browser_action

8. background

用来定义后台脚本部分

扩展是基于事件的程序，这些事件包括导航到新页面、删除书签、或者关闭选项卡，扩展在他们的后台脚本中监视这些事件，然后用指定的指令进行响应

关于后台脚本的状态

　　1、首次下载后或者更新后被加载

　　2、后台脚本下载后会处于休眠状态，直到它侦听的某个事件被触发，

　　3、侦听到事件后，会使用指定的指令响应（怎么相应自定义）

以下情况会需要调用到后台脚本

　　1、扩展首次下载或者版本更新

　　2、后台脚本中正在监听事件，并且这事件被触发了

　　3、content_script 或者其他扩展中调用了 sendMessage

　　4、当前扩展中的其他部分，例如弹窗中调用了 runtime.getBackgroundPage

后台脚本定义选项

{
    ...
    "background": {
        "scripts": ["bg1.js", "bg2.js"], // 后台脚本可以注册多个
        "persistent": false // 是否是持久的，一般为 false, 某些特殊情况需要参考文档 
    }
}

事件过滤器，有些事件支持事件过滤，比如选项卡的切换可以监听

// background.js
chrome.webNavigation.onCompleted.addListener(function () {}, {
    url: [{urlMatches: 'http://www.baidu.com'}] // 过滤
});

9. chrome setting 修改 | chrome 用户界面展示修改 | chrome 一些内置页面的替换

　　1、setting 使用 chrome_settings_overrides 配置，详细配置查看文档

　　2、用户界面使用 chrome_ui_overrides 配置，详细配置查看文档,可以设置一些书签方面的规则

　　3、内置页面替换使用 chrome_url_overrides 配置，详细配置查看文档，标签页、历史页、新 tab 都可替换

10. commands

可以通过 commands 选项定义触发扩展事件的快捷键

{
    ...,
    commands: {
        "xxx": {
            "suggested_key": {
                "default": "Ctrl+X",
                "mac": "Command+X",
                "windows": "Ctrl+X"
            }
        },
        "_execute_browser_action": {...},
        "_execute_page_action": {...}
    }
}

操作快捷键后，插件后台会监听到对应的事件

// background.js
chrome.commands.onCommand.addListener(function(command) {});

注意：\ _execute_browser_action \ _execute_page_action 这两个命令不会被监听，他们是触发 popup 弹出的，要监听窗口弹出事件可以使用 popup_page 的onDomReady

11. content_scripts

content_script 在一个特殊的环境中运行，可以称之为隔离环境，在这里可以访问所注入页面的DOM，但是不能访问里边的任何 javascript 变量和函数，反之，页面中的js 也不能访问 content_script 中的变量和函数

访问目标网站的 DOM ，可以用来进行通信

分为两种情况，一种是声明型注入脚本，使用 content_scripts 配置项，另一种是编程方式注入使用 permissions: ["activeTab"] 选项，

1、声明型注入脚本 content_scripts 值可以是一个数组，设置不同站点的不同注入文件

　　1）需要设置 matches: ["http://"] 指定匹配的网址，

　　2）js 设置注入脚本

　　3）css 设置注入样式

　　4）run_at 定义注入要本的时机 document_idle 表示浏览器帮你把握时机，会在 DOM 完成与 window.onload 之后注入；document_start 在 CSS 注入之后，其他任何脚本或者　　　 DOM 之前注入；document.end DOM 完成之后立即注入，但是在图像等资源之前

2、编程方式注入，不需要指定可访问的域名，可以针对当前活动的选项卡运行，获取临时访问权限 permissions: ["tabs"] 编程方式注入会在 chrome.tabs.executeScript(tabId, 　　details, callback) 接口中详细介绍

通信案例，通过 content_script 与页面共享 DOM，来实现页面与扩展间的通信

// page.js 页面中触发一个postMessage

document.getElementById('btn').addEventListener('click', () => {
    window.postMessage({type: 'TO_CONNECT_EXTERNAL', data: 'data'});
})

// content_script.js 中做中转

var port = chrome.runtime.connect();

window.addEventListener('message', (e) => {
    if (e.source !== window) {return};

    if (event.data.type && (event.data.type == "FROM_PAGE")) {
        port.postMessage(event.data.data); // 发消息给扩展
    }
}, false);

12. `externally_connectable`

这项配置直接实现网站与插件间通信，但是需要在 manifest.json 中作出如下配置

{
    "externally_connectable": {
        "matches": ["http://*.xx.com"] // 只有匹配的网站才可以通信
    }
}

// page.js 中发出请求

var editorExtensionId = "abcdefghijklmnoabcdefhijklmnoabc";

chrome.runtime.sendMessage(
    editorExtensionId, 
    {type: 'MsgFromPage', msg: 'Hello, I am page~'}, 
    function(response) {
      console.log(response);
    }
);

// background.js

chrome.runtime.onMessageExternal.addListener(function(request, sender, sendResponse) {
  // 可以针对sender做一些白名单检查
  // sendResponse返回响应
  if (request.type == 'MsgFromPage') {
    sendResponse({tyep: 'MsgFromChrome', msg: 'Hello, I am chrome extension~'});
  }
});

13. offline_enabled

扩展是否需要离线工作，默认为 true, 当chrome 检测到离线时，程序会被高亮显示

14. permissions | optional_permissions

声明权限（插件实现基础功能所需要的） | 可选权限（插件中可选的特性所需要的），两者的子配置项是一样的

选项的值是一个数组，代表每一个权限，权限可以是已知的权限字符串也可以是一个主机的匹配模式
权限字符串大多都对应着一个同名的 chrome[permissionName] API,全部的权限字符串可以点击上边链接查看，一下列出常用的权限

activeTab 允许用户在调用扩展时临时访问当前活动的选项卡，
background 后台权限，可以用来增加Chrome 运行时间，即开机即运行（虽然是不可见的）
bookmarks 书签操作权限
browsingData 浏览器数据操作权限，主要用来清除浏览器数据 cookie storage 等
contentSettings 浏览器设置权限
contextMenus 上下文菜单添加权限
cookies cookie 的查询、修改、onChange 监听
history 浏览器历史记录操作权限
storage chrome.storage 的使用权限（注意不是浏览器的 localStorage）
tabs 选项卡权限，允许创建、修改、重新排列选项卡
webNavigation 请求进行过程中的操作权限
webRequest | webRequestBlocking 开放 正在运行请求的 拦截、阻塞、或修改的权限

15. web_accessible_resources

指定打包资源的的路径字符串数组，这些资源是在扩展中是可用了，例如 content_script会用到的资源等,

16. content_security_policy

内容安全策略, 默认的安全策略为 script-src 'self'; object-src 'self' 他会有如下限制

　　1\禁止 eval 及相关函数

　　2\禁止内联<script>块和内联事件处理程序(例如，<button onclick="…">)

　　3\只有扩展包内的脚本和资源才会被加载！通过Web即时下载的将不会被加载

可以通过白名单使用通配符设置哪些外部资源是可以访问的（仅支持 https），如下

"content_security_policy": "script-src 'self' https://*.xxx.com; object-src 'self'"

浏览器插件开发-manifest文件解读调研资料manifest.json 官方文档Chrome Extension API360浏览器的插件文档中文, 虽然内核差不多但是不一定与 Chrome api 一致, 可以作为参考Chrome 官方案例库案例如何实现网页和Chrome插件之间的通信消息传递manifest.json 配置说明manifest.json 用于描述 Chrome 插件的源数据，配置信息等，基本内容如下
{ "name": "名称", "description": "描述", "version": "打包完成后用于判断插件是否需要更新", "manifest_version": 2, "browser_action": { "default_popup": "xxx.html 右上角点击后的弹窗，可以用一个页面定义", "default_icon": "xxx.png 显示在右上角的图标button" },}12345678910配置项简介1. manifest_version 必填清单文件格式的版本， Chrome 18 开发写 2 即可
2. name 必填插件名称
3. version 必填插件版本，发布新版本后，浏览器会比较其已安装的插件的版本，有更新的版本则会自动更新
4. description插件的描述，132个字符限制
5. icons插件的图标，可以用在 Chrome 商店展示(128 * 128) | 插件管理界面 (48 * 48) | 扩展页图标 (16 * 16) 最好是 png 格式
6. browser_action可以用来定义点击图标后展示的窗口，对应接口 chrome.browserAction，这项配置与 page_action 是对立的，只能二选一，以下是 browser_action 子项的配置
default_icon: Object | string 一个或者一组图标的路径default_title 设置 tooltipdefault_popup 指定弹出的窗口，可以是任意 htmlbadges “徽章” 就是小图标上的一个标记，用来展示一些状态7. page_action代表可以在当前页面执行的操作，不活动时显示灰色,对应接口 chrome.pageAction
default_icon: Object | string 一个或者一组图标的路径可用 pageAction.(show|hide) 改变插件活动状态browser_action 和 page_action都用来定义放置在工具栏右上角的图标点击情况，但是两者的活动状态展示 | 点击后的展示 | 主要负责场景是不一致的
猜测 browser_action 适用于用户需要点击图标后在弹窗中操作的场景 page_action 试用与在后台运行，重要工作是监听用户行为的插件
官方建议：如果要实现的功能只针对某一个页面有用则建议使用 page_action 否则使用 browser_action
8. background用来定义后台脚本部分
扩展是基于事件的程序，这些事件包括导航到新页面、删除书签、或者关闭选项卡，扩展在他们的后台脚本中监视这些事件，然后用指定的指令进行响应
关于后台脚本的状态
首次下载后或者更新后被加载后台脚本下载后会处于休眠状态，直到它侦听的某个事件被触发，侦听到事件后，会使用指定的指令响应（怎么相应自定义）以下情况会需要调用到后台脚本
扩展首次下载或者版本更新后台脚本中正在监听事件，并且这事件被触发了content_script 或者其他扩展中调用了 sendMessage当前扩展中的其他部分，例如弹窗中调用了 runtime.getBackgroundPage后台脚本定义选项
{ ... "background": { "scripts": ["bg1.js", "bg2.js"], // 后台脚本可以注册多个 "persistent": false // 是否是持久的，一般为 false, 某些特殊情况需要参考文档 }}
12345678事件过滤器，有些事件支持事件过滤，比如选项卡的切换可以监听
// background.jschrome.webNavigation.onCompleted.addListener(function () {}, { url: [{urlMatches: 'http://www.baidu.com'}] // 过滤});12349. chrome setting 修改 | chrome 用户界面展示修改 | chrome 一些内置页面的替换setting 使用 chrome_settings_overrides 配置，详细配置查看文档用户界面使用 chrome_ui_overrides 配置，详细配置查看文档,可以设置一些书签方面的规则内置页面替换使用 chrome_url_overrides 配置，详细配置查看文档，标签页、历史页、新 tab 都可替换10. commands可以通过 commands 选项定义触发扩展事件的快捷键
{ ..., commands: { "xxx": { "suggested_key": { "default": "Ctrl+X", "mac": "Command+X", "windows": "Ctrl+X" } }, "_execute_browser_action": {...}, "_execute_page_action": {...} }}1234567891011121314操作快捷键后，插件后台会监听到对应的事件
// background.jschrome.commands.onCommand.addListener(function(command) {});12注意：\ _execute_browser_action \ _execute_page_action 这两个命令不会被监听，他们是触发 popup 弹出的，要监听窗口弹出事件可以使用 popup_page 的onDomReady
11. content_scriptscontent_script 在一个特殊的环境中运行，可以称之为隔离环境，在这里可以访问所注入页面的DOM，但是不能访问里边的任何 javascript 变量和函数，反之，页面中的js 也不能访问 content_script 中的变量和函数
访问目标网站的 DOM ，可以用来进行通信
分为两种情况，一种是声明型注入脚本，使用 content_scripts 配置项，另一种是编程方式注入使用 permissions: ["activeTab"] 选项，
声明型注入脚本 content_scripts 值可以是一个数组，设置不同站点的不同注入文件需要设置 matches: ["http://"] 指定匹配的网址，js 设置注入脚本css 设置注入样式run_at 定义注入要本的时机 document_idle 表示浏览器帮你把握时机，会在 DOM 完成与 window.onload 之后注入；document_start 在 CSS 注入之后，其他任何脚本或者 DOM 之前注入；document.end DOM 完成之后立即注入，但是在图像等资源之前编程方式注入，不需要指定可访问的域名，可以针对当前活动的选项卡运行，获取临时访问权限 permissions: ["tabs"] 编程方式注入会在 chrome.tabs.executeScript(tabId, details, callback) 接口中详细介绍通信案例，通过 content_script 与页面共享 DOM，来实现页面与扩展间的通信
// page.js 页面中触发一个postMessage
document.getElementById('btn').addEventListener('click', () => { window.postMessage({type: 'TO_CONNECT_EXTERNAL', data: 'data'});})
// content_script.js 中做中转
var port = chrome.runtime.connect();
window.addEventListener('message', (e) => { if (e.source !== window) {return};
if (event.data.type && (event.data.type == "FROM_PAGE")) { port.postMessage(event.data.data); // 发消息给扩展 }}, false);
12345678910111213141516171812. externally_connectable这项配置直接实现网站与插件间通信，但是需要在 manifest.json 中作出如下配置
{ "externally_connectable": { "matches": ["http://*.xx.com"] // 只有匹配的网站才可以通信 }}12345// page.js 中发出请求
var editorExtensionId = "abcdefghijklmnoabcdefhijklmnoabc";
chrome.runtime.sendMessage( editorExtensionId, {type: 'MsgFromPage', msg: 'Hello, I am page~'}, function(response) { console.log(response); });
// background.js
chrome.runtime.onMessageExternal.addListener(function(request, sender, sendResponse) { // 可以针对sender做一些白名单检查 // sendResponse返回响应 if (request.type == 'MsgFromPage') { sendResponse({tyep: 'MsgFromChrome', msg: 'Hello, I am chrome extension~'}); }});
1234567891011121314151617181920212213. offline_enabled扩展是否需要离线工作，默认为 true, 当chrome 检测到离线时，程序会被高亮显示
14. permissions | optional_permissions声明权限（插件实现基础功能所需要的） | 可选权限（插件中可选的特性所需要的），两者的子配置项是一样的
选项的值是一个数组，代表每一个权限，权限可以是已知的权限字符串也可以是一个主机的匹配模式权限字符串大多都对应着一个同名的 chrome[permissionName] API,全部的权限字符串可以点击上边链接查看，一下列出常用的权限
activeTab 允许用户在调用扩展时临时访问当前活动的选项卡，background 后台权限，可以用来增加Chrome 运行时间，即开机即运行（虽然是不可见的）bookmarks 书签操作权限browsingData 浏览器数据操作权限，主要用来清除浏览器数据 cookie storage 等contentSettings 浏览器设置权限contextMenus 上下文菜单添加权限cookies cookie 的查询、修改、onChange 监听history 浏览器历史记录操作权限storage chrome.storage 的使用权限（注意不是浏览器的 localStorage）tabs 选项卡权限，允许创建、修改、重新排列选项卡webNavigation 请求进行过程中的操作权限webRequest | webRequestBlocking 开放正在运行请求的拦截、阻塞、或修改的权限15. web_accessible_resources指定打包资源的的路径字符串数组，这些资源是在扩展中是可用了，例如 content_script会用到的资源等,
16. content_security_policy内容安全策略, 默认的安全策略为 script-src 'self'; object-src 'self' 他会有如下限制
禁止 eval 及相关函数禁止内联<script>块和内联事件处理程序(例如，<button onclick="…">)只有扩展包内的脚本和资源才会被加载！通过Web即时下载的将不会被加载可以通过白名单使用通配符设置哪些外部资源是可以访问的（仅支持 https），如下
"content_security_policy": "script-src 'self' https://*.xxx.com; object-src 'self'"
点赞收藏分享
————————————————版权声明：本文为CSDN博主「mjzhang1993」的原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接及本声明。原文链接：https://blog.csdn.net/mjzhang1993/article/details/84848899

posted @ 2019-12-28 22:41 mingruqi 阅读(1633) 评论(0) 编辑收藏举报

刷新页面返回顶部

ming

浏览器插件开发-manifest文件解读

12. externally_connectable

公告

12. `externally_connectable`