核心介绍

manifest.json-(主要配置文件相当于package.json文件）

这是一个Chrome插件最重要也是必不可少的文件，用来配置所有和插件相关的配置，必须放在根目录。其中，manifest_version、name、version3个是必不可少的，description和icons是推荐的。

1. {// 清单文件的版本，这个必须写，而且必须是2
2. "manifest_version": 2,
3. // 插件的名称
4. "name": "demo",
5. // 插件的版本
6. "version": "1.0.0",
7. // 插件描述
8. "description": "简单的Chrome扩展demo",
9. // 图标，一般偷懒全部用一个尺寸的也没问题
10. "icons":
11. {
12. "16": "img/icon.png",
13. "48": "img/icon.png",
14. "128": "img/icon.png"
15. },
16. // 会一直常驻的后台JS或后台页面
17. "background":
18. {
19. // 2种指定方式，如果指定JS，那么会自动生成一个背景页
20. "page": "background.html"
21. //"scripts": ["js/background.js"]
22. },
23. // 浏览器右上角图标设置，browser_action、page_action、app必须三选一
24. "browser_action":
25. {
26. "default_icon": "img/icon.png",
27. // 图标悬停时的标题，可选
28. "default_title": "这是一个示例Chrome插件",
29. "default_popup": "popup.html"
30. },
31. // 当某些特定页面打开才显示的图标
32. /*"page_action":
33. {
34. "default_icon": "img/icon.png",
35. "default_title": "我是pageAction",
36. "default_popup": "popup.html"
37. },*/
38. // 需要直接注入页面的JS
39. "content_scripts":
40. [
41. {
42. //"matches": ["http://*/*", "https://*/*"],
43. // "<all_urls>" 表示匹配所有地址
44. "matches": ["<all_urls>"],
45. // 多个JS按顺序注入
46. "js": ["js/jquery-1.8.3.js", "js/content-script.js"],
47. // JS的注入可以随便一点，但是CSS的注意就要千万小心了，因为一不小心就可能影响全局样式
48. "css": ["css/custom.css"],
49. // 代码注入的时间，可选值： "document_start", "document_end", or "document_idle"，最后一个表示页面空闲时，默认document_idle
50. "run_at": "document_start"
51. },
52. // 这里仅仅是为了演示content-script可以配置多个规则
53. {
54. "matches": ["*://*/*.png", "*://*/*.jpg", "*://*/*.gif", "*://*/*.bmp"],
55. "js": ["js/show-image-content-size.js"]
56. }
57. ],
58. // 权限申请
59. "permissions":
60. [
61. "contextMenus", // 右键菜单
62. "tabs", // 标签
63. "notifications", // 通知
64. "webRequest", // web请求
65. "webRequestBlocking",
66. "storage", // 插件本地存储
67. "http://*/*", // 可以通过executeScript或者insertCSS访问的网站
68. "https://*/*" // 可以通过executeScript或者insertCSS访问的网站
69. ],
70. // 普通页面能够直接访问的插件资源列表，如果不设置是无法直接访问的
71. "web_accessible_resources": ["js/inject.js"],
72. // 插件主页，这个很重要，不要浪费了这个免费广告位
73. "homepage_url": "https://www.baidu.com",
74. // 覆盖浏览器默认页面
75. "chrome_url_overrides":
76. {
77. // 覆盖浏览器默认的新标签页
78. "newtab": "newtab.html"
79. },
80. // Chrome40以前的插件配置页写法
81. "options_page": "options.html",
82. // Chrome40以后的插件配置页写法，如果2个都写，新版Chrome只认后面这一个
83. "options_ui":
84. {
85. "page": "options.html",
86. // 添加一些默认的样式，推荐使用
87. "chrome_style": true
88. },
89. // 向地址栏注册一个关键字以提供搜索建议，只能设置一个关键字
90. "omnibox": { "keyword" : "go" },
91. // 默认语言
92. "default_locale": "zh_CN",
93. // devtools页面入口，注意只能指向一个HTML文件，不能是JS文件
94. "devtools_page": "devtools.html"
95. }

content-scripts(主要是获取当前页面的dom元素，当前页面不是指插件页面，就是浏览器打开的页面）

所谓content-scripts，其实就是Chrome插件中向页面注入脚本的一种形式（虽然名为script，其实还可以包括css的），借助content-scripts我们可以实现通过配置的方式轻松向指定页面注入JS和CSS（如果需要动态注入，可以参考下文），最常见的比如：广告屏蔽、页面CSS定制，等等。

在manifest.json中写入

1. {
2. // 需要直接注入页面的JS
3. "content_scripts":
4. [
5. {
6. //"matches": ["http://*/*", "https://*/*"],
7. // "<all_urls>" 表示匹配所有地址
8. "matches": ["<all_urls>"],
9. // 多个JS按顺序注入
10. "js": ["js/jquery-1.8.3.js", "js/content-script.js"],
11. // JS的注入可以随便一点，但是CSS的注意就要千万小心了，因为一不小心就可能影响全局样式
12. "css": ["css/custom.css"],
13. // 代码注入的时间，可选值： "document_start", "document_end", or "document_idle"，最后一个表示页面空闲时，默认document_idle
14. "run_at": "document_start"
15. }
16. ],
17. }

background（后台页面，可跨域）

后台（姑且这么翻译吧），是一个常驻的页面，它的生命周期是插件中所有类型页面中最长的，它随着浏览器的打开而打开，随着浏览器的关闭而关闭，所以通常把需要一直运行的、启动就运行的、全局的代码放在background里面。

background的权限非常高，几乎可以调用所有的Chrome扩展API（除了devtools），而且它可以无限制跨域，也就是可以跨域访问任何网站而无需要求对方设置CORS。

在manifest.json中写入

1. {
2. // 会一直常驻的后台JS或后台页面
3. "background":
4. {
5. // 2种指定方式，如果指定JS，那么会自动生成一个背景页
6. "page": "background.html"
7. //"scripts": ["js/background.js"]
8. },
9. }

event-pages(功能等同于background,区别不是长时间挂载）

这里顺带介绍一下event-pages，它是一个什么东西呢？鉴于background生命周期太长，长时间挂载后台可能会影响性能，所以Google又弄一个event-pages，在配置文件上，它与background的唯一区别就是多了一个persistent参数：

在manifest.json中写入

1. {
2. "background":
3. {
4. "scripts": ["event-page.js"],
5. "persistent": false
6. },
7. }

popup

popup是点击browser_action或者page_action图标时打开的一个小窗口网页，焦点离开网页就立即关闭，一般用来做一些临时性的交互。

在manifest.json中写入

1. {
2. "browser_action":
3. {
4. "default_icon": "img/icon.png",
5. // 图标悬停时的标题，可选
6. "default_title": "这是一个示例Chrome插件",
7. "default_popup": "popup.html"
8. }
9. }

injected-script（可以是页面访问插件的资源函数）

这里的injected-script是我给它取的，指的是通过DOM操作的方式向页面注入的一种JS。为什么要把这种JS单独拿出来讨论呢？又或者说为什么需要通过这种方式注入JS呢？

这是因为content-script有一个很大的“缺陷”，也就是无法访问页面中的JS，虽然它可以操作DOM，但是DOM却不能调用它，也就是无法在DOM中通过绑定事件的方式调用content-script中的代码（包括直接写onclick和addEventListener2种方式都不行），但是，“在页面上添加一个按钮并调用插件的扩展API”是一个很常见的需求，那该怎么办呢？其实这就是本小节要讲的。

在manifest.json中写入

1. {
2. // 普通页面能够直接访问的插件资源列表，如果不设置是无法直接访问的
3. "web_accessible_resources": ["js/inject.js"],
4. }