Chrome是個非常牛逼的瀏覽器,速度快,界面清爽,對開發(fā)人員友好。而且提供了種類齊全且高質(zhì)的插件。今天我們就來簡單聊一聊如何開發(fā)chrome插件。
在具體的開發(fā)之前,我們先來科普一些基礎(chǔ)知識。
現(xiàn)階段的chrome的應(yīng)用商店中,將插件(這里說的插件指代chrome應(yīng)用的所有分類,下文亦同)分為如下幾種,包括應(yīng)用、游戲、擴展程序、主題背景。而且插件的種類多種多樣,保羅萬象,基本上都能找到你想要的功能的插件。
在應(yīng)用商店中下載下來的插件基本上都是以.crx
為文件后綴,該文件其實就是一個壓縮包,包括插件所需要的html、css、javascript、圖片資源等等文件。
下圖是FEHelper的插件包解壓后的文件,
其中,
manifest.json
是整個插件的功能及文件配置清單,非常重要。static
目錄是放置整個插件的靜態(tài)資源文件的,包括css、js、圖片等等資源template
目錄是放置整個插件的功能頁面模板的。_locales
目錄是放置整個插件的國際化語言腳本的。一般來說,清單文件manifest.json
文件是必須的,且必須放在插件開發(fā)目錄的根目錄上。其他的目錄都可以自定義。
這個插件安裝好的用戶界面如下圖,
圖中的每一個鏈接都是一個功能項,點擊后將會打開一個chrome-extension下的頁面,url類似這樣,
chrome-extension://pkgccpejnmalmdinmhkkfafefagiiiad/template/fehelper_endecode.html
而這些頁面其實就是我們之前看到的template
中的模板文件。
manifest.json
文件清單文件的作用是提供插件的各種信息,例如插件能夠做的事情,以及插件的文件配置等等信息。下面是一個清單文件的示例,
{
"name": "我的擴展程序",
"version": "2.1",
"manifest_version": 2,
"description": "從Google獲得信息。",
"icons": {
"128": "icon_128.png"
},
"background": {
"persistent": false,
"scripts": ["bg.js"]
},
"permissions": ["http://*.google.com/", "https://*.google.com/"],
"browser_action": {
"default_title": "",
"default_icon": "icon_19.png",
"default_popup": "popup.html"
}
}
mianfest.json
文件每個字段都有其特殊的含義。
chrome插件一般有兩種用戶界面,一種是瀏覽器按鈕,一種是頁面地址欄按鈕。前者稱之為Browser Actions,后者被稱之為Page Actions。
這是page actions:
這是browser actions:
Page Actions 與 Browser Actions 的區(qū)別就是 Page Actions 并不是在每個頁面上都是有用的,它必須在特定的頁面中插件功能才能使用。
這兩種用戶面界面分別對應(yīng)manifest.json
中的browser_action
和page_action
字段。
彈出窗口一般用于插件和用戶的交互,而后臺頁面一般用于插件本身做一些額外的事情。比如有時候,插件需要聯(lián)網(wǎng)進行數(shù)據(jù)同步等操作,這種操作用戶是無感知的,所有就要求插件需要有一個后臺頁面來運行這部分的邏輯。
其實后臺頁面還可以分為持久運行的后端頁面和事件頁面,這里對這兩者就不多做說明了,更多的內(nèi)容可以參閱具體的文檔。
chrome插件的相關(guān)知識,遠遠不止上面介紹的幾點,比如郵件菜單、插件與瀏覽器之間的交互、內(nèi)容安全(CSP)、消息傳遞、國際化、部署與托管等等方面,由于篇幅原因,這里將不會作過多的描述。
有了上面的基礎(chǔ)知識之后,我們就可以嘗試自己來做一個chrome插件玩玩了。
首先我們新建一個文件夾叫做todo-plugin
,作為插件開發(fā)的工作目錄,然后在目錄中新建清單文件,manifest.json
文件內(nèi)容如下,
{
"name": "todo-plugin",
"version": "0.9.0",
"manifest_version": 2,
"description": "chrome plugin demo",
"browser_action": {
"default_icon": "icon.png",
"default_title": "Todo List",
"default_popup": "popup.html"
}
}
在清單文件中,我們定義了插件的名稱、版本、描述,插件的瀏覽器按鈕行為以及插件所需要注入的腳本文件。按鈕行為中還包括了默認的按鈕圖標、按鈕標題(鼠標懸停時顯示)以及默認的彈出框popup.html
。
注意:新版的chrome插件開發(fā)需要在清單文件中制定mainfest_version
為2。
這里的彈出框其實就是我們這個插件與用戶交互的主要界面,它其實就是一個html頁面。不過這個popup.html
文件并不需要<html></html>
、<body></body>
、<head></head>
這樣的標簽。popup.html
文件內(nèi)容如下,
<style>
body {
width: 150px;
}
#add-new-item {
cursor: pointer;
color: #CCC;
}
.hide {
display: none;
}
.show {
display: block;
}
.item {
cursor: pointer;
margin: 5px 0;
}
.item input {
display: inline-block;
width: 12px;
height: 12px;
}
input {
width: 120px;
}
</style>
<div id="add-new-item">添加新項</div>
<div id="add-new-item-input" class="hide">
<input type="text" id="new-item-title" placeholder="添加新任務(wù)"/>
</div>
<div id="item-list"></div>
<script type="text/javascript" src="main.js"></script>
這個html文件其實很簡單(chrome插件的html頁面往往都非常簡單,都是一些列表的展示,輕量的輸入控件等等),而且為了簡便,我把彈出窗的樣式直接寫在html中了。
最后一行我們使用外鏈的方式加載了popup頁面的交互邏輯。main.js
內(nèi)容也很簡單,如下,
(function () {
var $ = function (id) {
return document.getElementById(id);
};
var Tasks = {
show: function (obj) {
obj.className = '';
return this;
},
hide: function (obj) {
obj.className = 'hide';
return this;
},
$addNewItem: $('add-new-item'),
$addNewItemInput: $('add-new-item-input'),
$itemList: $('item-list'),
$newItemTitle: $('new-item-title'),
init: function () {
//打開添加文本框
Tasks.$addNewItem.addEventListener('click', function () {
Tasks.show(Tasks.$addNewItemInput).hide(Tasks.$addNewItem);
Tasks.$newItemTitle.focus();
}, true);
//回車添加任務(wù)
Tasks.$newItemTitle.addEventListener('keyup', function (ev) {
var ev = ev || window.event;
if (ev.keyCode == 13) {
//TODO:寫入本地數(shù)據(jù)
var task = Tasks.$newItemTitle.value;
Tasks.AppendHtml(task);
Tasks.$newItemTitle.value = '';
Tasks.hide(Tasks.$addNewItemInput).show(Tasks.$addNewItem);
}
ev.preventDefault();
}, true);
//取消添加
Tasks.$newItemTitle.addEventListener('blur', function () {
Tasks.$newItemTitle.value = '';
Tasks.hide(Tasks.$addNewItemInput).show(Tasks.$addNewItem);
}, true);
//TODO 初始化數(shù)據(jù),加載本地數(shù)據(jù),生成html
},
//增加
Add: function () {
//TODO
},
//修改
Edit: function () {
//TODO
},
//刪除
Del: function () {
//TODO
},
AppendHtml: function (title) {
var oDiv = document.createElement('div');
oDiv.className = 'item item-todo';
var oInput = document.createElement('input');
oInput.type = 'checkbox';
var oTitle = document.createElement('span');
oTitle.innerHTML = title;
oDiv.appendChild(oInput);
oDiv.appendChild(oTitle);
Tasks.$itemList.appendChild(oDiv);
oDiv.addEventListener('click', function () {
//TODO
}, true);
},
RemoveHtml: function () {
//TODO
}
}
Tasks.init();
})();
在這段js中,我們聲明了一個Tasks
對象,這個對象包括了一系列的功能方法,當然有部分未實現(xiàn),不過核心功能都實現(xiàn)了。在Tasks.init
方法中,我們給一個操作實體(一個div元素)注冊了點擊事件,當觸發(fā)點擊事件時,我們將會展示一個輸入框讓用戶輸入任務(wù)描述,通過回車鍵來添加用戶剛輸入的任務(wù)。好了,這就是todo-plugin
插件的基本功能。下面是本插件的效果預(yù)覽,
好了,至此我們總算完成一個簡陋的chrome插件的開發(fā)了。功能雖然簡陋,但是基本上所有的chrome插件開發(fā)都是遵循這條路。本文示例的代碼中有許多的TODO
,其實我們可以將這個todo插件做的更加復(fù)雜,比如可以采用localstorage來存儲數(shù)據(jù),甚至可以使用網(wǎng)絡(luò)來存儲數(shù)據(jù)。至于更多的內(nèi)容,本文就不再作過多的闡述了,因為本文畢竟是簡要指南嘛
更多建議: