Chrome 插件开发学习总结

1. 参考文档

2. 文件结构

文件结构.png

3. manifest.json

3.1 配置项

Name Description
manifest_version 清单文件的版本,这个必须写,而且必须是2
name 插件的名称
version 插件的版本
description 插件描述
icons 插件详情页面图标
background 会一直常驻的后台JS或后台页面
browser_action 浏览器右上角图标以及popup页面等设置,browser_action、page_action、app必须三选一
page_action 需要直接注入页面的JS
permissions 权限申请
homepage_url 主页地址
options_page 插件配置页

3.2 background

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

{
    "background":
    {
        "page": "background.html"
        //"scripts": ["js/background.js"]
    },
}

3.3 content-scripts

Chrome插件中向页面注入脚本的一种形式,借助content-scripts我们可以实现通过配置的方式轻松向指定页面注入js和css

{
    "content_scripts": 
    [
        {
            //"matches": ["http://*/*", "https://*/*"],
            // "<all_urls>" 表示匹配所有地址
            "matches": ["<all_urls>"],
            // 多个JS按顺序注入
            "js": ["js/jquery-1.8.3.js", "js/content-script.js"],
            // css注入
            "css": ["css/custom.css"],
            // 代码注入的时间,可选值: "document_start", "document_end", or "document_idle",最后一个表示页面空闲时,默认document_idle
            "run_at": "document_start"
        }
    ],
}
Name Description
matches 必须。 定义哪些页面需要注入content script
js 可选。 需要向页面中注入的javascript文件,按定义顺序注入。
run_at 可选。 控制content script注入的时机。可以是document_start,document_end或者document_idle。</br>缺省时是document_idle
all_frames 可选。控制是在匹配页面的所有frame中运行还是只在最上层的frame中运行。</br>缺省是false,也就是只在最上层frame中运行。
include_globs 可选。控制将content_script注入到哪些匹配的页面中
exclude_globs 可选。控制将content_script注入到哪些匹配的页面中。

3.4 homepage url

开发者或者插件主页设置

"homepage_url": "http://zha-spstv-w10:4000/#/overall"
home_page.png

3.5 options page

options页设置

"options_page": "html/options.html",
option_page.png

3.6 覆盖特定页面

使用替代页,可以将Chrome默认的一些特定页面替换掉,改为使用扩展提供的页面。

扩展可以替代如下页面:

  • 书签管理器(bookmarks):从工具菜单上点击书签管理器时访问的页面,或者从地址栏直接输入 chrome://bookmarks
  • 历史记录(history):从工具菜单上点击历史记录时访问的页面,或者从地址栏直接输入 chrome://history
  • 新标签页(newtabs):当创建新标签的时候访问的页面,或者从地址栏直接输入 chrome://newtab

注意:

  • 一个扩展只能替代一个页面。
  • 如果你替代隐身窗口的页面,请注意要在manifest中将 incognito 属性指定为 "spanning"。
  • 不能替代隐身窗口的新标签页。
{
    "chrome_url_overrides": {
    "newtab": "html/newtab.html",
    // "history": "history.html",
    // "bookmarks": "bookmarks.html"
  },
}

3.7 桌面通知

3.8 Omnibox

omnibox 应用程序界面允许向Google Chrome的地址栏注册一个关键字,地址栏也叫omnibox。当用户输入你的扩展关键字,用户开始与你的扩展交互。每个击键都会发送给你的扩展,扩展提供建议作为相应的响应。

 "omnibox": { "keyword" : "go" }, 
omnibox.png

4. contextMenus

  • type (optional enumerated string ["normal", "checkbox", "radio", "separator"] )

    右键菜单项的类型。默认为“normal”。

  • title ( optional string )

    右键菜单项的显示文字;除非为“separator”类型,否则此参数是必须的。

  • checked ( optional boolean )

    checkbox或者radio的初始状态:true代表选中,false代表未选中。在给定的radio中只能有一个处于选中状态。

  • contexts ( optional array of string ["all", "page", "frame", "selection", "link", "editable", "image", "video", "audio"] )

    右键菜单项将会在这个列表指定的上下文类型中显示。默认为“page”。

  • onclick ( optional function )

    当菜单项被点击时触发的函数。

5. Permissions权限列表

https://blog.csdn.net/guoqiankunmiss/article/details/110491523

Name Description
notifications 扩展程序访问chrome.notifications API
background 具有后台权限,可以在后台运行,直到退出chrome
bookmarks 扩展程序访问chrome.bookmarks API的权限
contentSettings 扩展程序访问chrome.contentSettings API
contextMenus 开启右键菜单权限,扩展程序访问chrome.contextMenus API
notifications 开启桌面通知权限,扩展程序可以访问chrome.notifications API
webRequest 开启web请求权限,扩展程序可以访问chrome.webRequest API
webRequestBlocking 扩展程序以阻止方式使用chrome.webRequest API
cookies 扩展程序访问chrome.cookies API。
debugger 扩展程序访问chrome.debugger API
history 扩展程序访问chrome.history

6. 结合vue-cli3开发Chrome插件

6.1 搭建环境

  1. 安裝vue-cli3:npm install -g @vue/cli
  2. 创建一个vue-cli3项目:vue create vue-extension,对话流程选择默认就行。
  3. 安装vue-cli-plugin-chrome-ext插件:vue add chrome-ext,根据安装对话选项设置好。
  4. 安装element-ui:npm install element-ui
  5. npm install babel-plugin-component -D

6.2 运行项目

  1. npm run build-watch 运行开发环境
  2. npm run build 运行生产环境编译打包
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 193,968评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,682评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,254评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,074评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 60,964评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,055评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,484评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,170评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,433评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,512评论 2 308
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,296评论 1 325
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,184评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,545评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,880评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,150评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,437评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,630评论 2 335

推荐阅读更多精彩内容