从零开始编写一个 chrome 扩展

webstore-extensions.jpg

Chrome 是 web 开发人员必备的浏览器没有之一。

要编写一个 chrome 浏览器扩展也只需要(基本的)html,js ,css 这些 web 开发的基本能力。

下面先看一下一个 chrome 扩展的项目结构吧:

├── images
│   ├── icon-128.png
│   └── icon-16.png
├── manifest.json
├── options.html
├── popup.html
└── scripts
    ├── background.js

从文件结构来看,其实所谓的 chrome 扩展也就是一个类似 webapp 的东西。

其中最重要的就是 manifest.json 这个配置文件了,其中包含了扩展的一些元数据,

包含名称,版本,图标,权限,各类入口文件等信息。

在上面的例子中,options.html 是配置项的界面,popup.html 是扩展弹出页的界面,而 background.js 相当于扩展的后台进程,可以独立执行逻辑或者给前端(popup)提供数据。

一般来说对于扩展或者插件类应用的编写采取任务驱动的方式是最适合的。下面我们就以一个『send to gitlab issue』的扩展为例,来讲解一下 chrome 扩展的开发流程。

这个扩展的功能类似于 pocket 这个稍后阅读的服务,只不过 pocket 这类应用都只能对保存的网页做出『已读』或者『未读』的区分,而对于一篇技术文章,很难说到底读懂了多少,理解消化的程度让我很难把一篇技术文章标记为『已读』,这就造成了我的 pocket 中未读数量只增不减,到头来等于没有整理。

所以我打算写一个扩展,可以根据当前网页链接创建一个 gitlab 的 issue ,gitlab 的 issue 相对而言,可以有更大的空间做笔记,也可以很方便的直接把文章中的知识学以致用后和 gitlab 上托管的项目代码直接关联,而且 Milestone 配合 label 的分类也比 pocket 单纯的 tag 要强不少,更别提还能和别人一起讨论了。

那么先分析一下需求,作为一个用户,当我看到一篇不错的技术文章,我想把它记录到 gitlab 上,然后下班后仔细研读,做笔记,并和同事们讨论一下。于是我点击了 chrome 浏览器右上角的 『send to gitlab issue』图标,弹出了一个小页面,里面预先填好了文章的标题和 url,我可以稍微修改(或�不做),然后点击保存,那么这篇文章就被记录到(预先配置好的)gitlab 服务器上了。

对于这样一个小项目,可以先从一个最简的 demo 开始,先让扩展在浏览器上『占有一席之地』,然后点击后可以弹出一个小的 ui 界面。

别急着创建配置文件和 html 页面,懒惰是程序员的一种美德,先使用 这个 基于 yeoman 的 chrome 扩展 generator 来生成项目骨架(还支持 es2015 哦)。

然后在 manifest.json 中指定扩展的弹出页面文件:

"browser_action": {
  "default_popup": "popup.html"
}

然后创建 popup.html 文件,编写 html 内容,一般样式文件直接在 header 中即可,而 js 文件 必须 从外部引用,不能直接写在 html 中。

<body>
  <p id="flash">

  </p>
  <input type="text" id="popup_title" placeholder="标题"/>
  <textarea type="text" id="popup_url" placeholder="url">
  </textarea>
  <br />
  <button type="button" id="popup_button">发送</button>
  <script src="scripts/app.js"></script>
</body>

现在可以打开 chrome 浏览器的扩展管理页面,如图勾选载入开发中的扩展,选定项目的 app 目录,就能看到浏览器的右上角出现了我们正在开发的扩展了。

load-extension.png

一切顺利的话,点击图标,就会出现我们编写的 html 页面了。

popup.png

好了让我们进入下一步,获取当前页面的标题和 url。很明显这两个数据需要通过 chrome 提供的接口才能获取,这里我本来采用的是在 background.js 中直接去获取 dom 树的内容,可是测试后发现,background.js 获取的总是第一个页面的内容,当切换 tab 页后数据也不会改变。结果还是老老实实地看文档,找到了下面的这段代码:

chrome.tabs.query({
  active: true,
  currentWindow: true
}, (tabs) => {
  document.getElementById('popup_title').value = tabs[0].title;
  document.getElementById('popup_url').value = tabs[0].url;
});

chrome 提供了获取当前激活的 tab 页面的接口,于是我们就能获取到当前 tab 页的 title 和 url 了, 顺便把他们自动填充到页面的 input 框中。

注意这里需要配置扩展的权限,加入对 tab 的访问权限才行,在 manifest.json 中加入:

"permissions": ["tabs"]

之后的工作就是把 input 框的内容传递给 gitlab 了,关于 gitlab 的接口调用不是本文重点,可以直接参考官方的文档。gitlab 对外暴露 RESTful 的 http 接口,不需要任何 sdk 也可以很方便地调用。

document.getElementById('popup_button').addEventListener('click', function() {
  createGitlabIssue(localStorage.options_project_id,
    document.getElementById('popup_title').value,
    document.getElementById('popup_url').value)
});

一开始我先把 gitlab 相关配置都硬编码到了扩展中,跑通流程后当然就不能直接就这样提交,需要把它们做成配置项。

chrome 扩展可以自定义一个配置页面,在 manifest.json 中加入:

"options_page": "options.html",

然后创建 options.html 文件,并编写 html 内容:

<body>
  <p id="flash"></p>
  gitlab host: <input type="text" id="options_host" placeholder="gitlab host" />
  <br />
  project id: <input type="text" id="options_project_id" placeholder="project id" />
  <br />
  private token: <input type="text" id="options_token" placeholder="private token" />
  <br />
  <button type="button" id="options_save">save</button>
  <script src="scripts/options.js"></script>
</body>
options.png

然后编写 options.js 文件,把配置项持久化到 localStorage 中:

var options_host = localStorage.options_host
document.getElementById('options_host').value = options_host;
var options_project_id = localStorage.options_project_id
document.getElementById('options_project_id').value = options_project_id;
var options_token = localStorage.options_token
document.getElementById('options_token').value = options_token;

document.getElementById('options_save').onclick = function() {
  localStorage.options_host = document.getElementById('options_host').value;
  localStorage.options_project_id = document.getElementById('options_project_id').value;
  localStorage.options_token = document.getElementById('options_token').value;
  document.getElementById('flash').innerHTML = '保存成功';
}

现在如果右键点击扩展的图标的话,就能看到『选项』这个菜单是可点击的:

settings.png

然后在处理 gitlab 的 api 调用时,动态读取配置内容即可。

这样一来,一个简单的 chrome 扩展就这样完成了。当然还有很多细节需要打磨。

项目地址:https://github.com/teddy-ma/send-to-gitlab-issue ,欢迎各类 issue 和 pr。

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

推荐阅读更多精彩内容

  • WebSocket-Swift Starscream的使用 WebSocket 是 HTML5 一种新的协议。它实...
    香橙柚子阅读 23,724评论 8 183
  • chrome扩展开发入门教程 最近在开发chrome插件,看到一篇非常适合入门的教程,特记录一下 注:转载 本文首...
    谢大见阅读 6,413评论 1 25
  • 作为一名刚刚毕业的大学生,可能还没来得及褪去身上残留的一点点稚气,就已马不停蹄的步入这个残酷而又充满惊喜的社会!刚...
    冰棍就辣条阅读 693评论 0 0
  • 1. 打记事起,父亲就是一个非常孝敬长辈的人。每年七月半,他都会用亲自裁好的白纸包装好火纸,很讲究的写一些话寄给已...
    黄慧云yun阅读 764评论 0 3