Content Scripts是運行在Web頁面的上下文的JavaScript文件。通過標准的DOM,Content Scripts
可以操作(讀取並修改)瀏覽器當前訪問的Web頁面的內容。
Content Scripts通常用於如下場景:
- 找到Web頁面中的無效鏈接並修復
- 增大字體以突出顯示
- 查找並處理DOM中的microformat
Content Scripts的使用限制條件:
- 不能訪問如下chrome.* API
chrome.extension
API- chrome.i18n API
chrome.runtime
APIchrome.storage
API
- 不能訪問Chrome擴展頁面中定義的JavaScript變量和函數
- 不能訪問Web頁面或其他Content Scripts中定義的JavaScript變量和函數
乍一看,Content Scripts似乎無法與Chrome擴展的其他部分進行任何交互,但是通過Chrome的消息傳遞機制,Content Scripts可以間接地調用chrome.* API,訪問Chrome擴展的數據,調用Chrome擴展的方法等,詳見Chrome的消息傳遞部分。
此外,Content Scripts還可以通過“跨域XMLHttpRequest對象”訪問Chrome擴展的其他部分。Content Scripts還可以與Web頁面通過共享DOM進行通信。
在Chrome瀏覽器擴展中使用Content Scripts有兩種方式。一種是在Chrome瀏覽器擴展中一直存在的Content Scripts,這需要在manifest.json文件中聲明content_scripts如下:
1 { 2 "content_scripts": [ 3 { 4 "matches": ["http://www.google.com/*"], 5 "css": ["mystyles.css"], 6 "js": ["jquery.js", "myscript.js"] 7 } 8 ], 9 }
這種方式非常靈活,可以為Web頁面注入多個JavaScript文件和CSS文件。
content_scripts中的屬性說明如下:
名稱 |
類型 |
必選/可選 |
說明 |
matches |
string數組 |
必選 |
Content Script注入的Web頁面 |
exclude_matches |
string數組 |
可選 |
Content Script不注入的Web頁面 |
include_globs |
string數組 |
可選 |
對於matches匹配的Web頁面,進一步限定URL |
exclude_globs |
string數組 |
可選 |
對於matches匹配的Web頁面,進一步排除URL |
match_about_blank |
boolean |
可選 |
是否注入Content Script到about:blank和about:srcdoc頁面,默認false |
css |
string數組 |
可選 |
注入到匹配的Web頁面中的CSS文件,順序相關 |
js |
string數組 |
可選 |
注入到匹配的Web頁面中的JS文件,順序相關 |
run_at |
string |
可選 |
控制JS文件注入的時機,如"document_start", "document_end", "document_idle"。默認"document_idle"
|
all_frames |
boolean |
可選 |
控制JS文件是否在匹配的Web頁面中的所有框架中運行。默認false表示只在頂層框架中運行 |
另一種是只在需要的時候(某事件發生)通過編程注入的Content Scripts,這需要在manifest.json文件中聲明permissions如下:
1 { 2 "permissions": [ 3 "tabs", 4 "http://www.google.com/*" //要注入Content Scripts的Web頁面所在的域 5 ], 6 }
這種方式能夠針對個別Web頁面有條件地注入Content Scripts。
聲明必要的權限后,就可以在發生某些事件的時候動態注入必要的Content Scripts,示例如下:
1 chrome.browserAction.onClicked.addListener( 2 function(tab) { //tab對象表示當前(用戶點擊browser action的時候)處於活動狀態的tab 3 chrome.tabs.executeScript({ 4 //設置活動狀態的tab顯示的頁面的document對象的屬性 5 code: 'document.body.style.backgroundColor="red"'//通過JS代碼 6 }); 7 chrome.tabs.executeScript({file: "content_script.js"});//通過JS文件 8 });
Content Scripts的執行位於一個特殊的環境,我們稱為isolated world。在這個環境中,Content Scripts能夠訪問當前Web頁面的DOM,但是Content Scripts與當前Web頁面自帶的JavaScript變量和函數是不能直接互相訪問的。而且被注入的每個Content Script之間也彼此獨立,互不干擾。此外,對於一些共享的JavaScript對象,如window.onload事件對象,也都是彼此獨立互不干擾的。
雖然Content Scripts與Web頁面的JavaScript彼此獨立,但是他們都能夠訪問Web頁面的DOM,因此通過共享的DOM和消息機制,Content Scripts可以與Web頁面的JavaScript進行通信。
另外,Content Scripts中要考慮安全問題,特別是Content Scripts通過跨域XMLHttpRequest對象獲取的第三方結果,在作用於當前Web頁面的時候要注意腳本注入攻擊。
Content Scripts可以通過如下方式訪問擴展中的其他文件:
1 //顯示圖片<extensionDir>/images/myimage.png 2 var imgURL = chrome.extension.getURL("images/myimage.png"); 3 document.getElementById("someImage").src = imgURL;