記一次chrome插件編寫（修改User-Agent和Accept-Language）

什麼是Chrome插件

嚴格來講，我們正在說的東西應該叫Chrome擴展(Chrome Extension)，真正意義上的Chrome插件是更底層的瀏覽器功能擴展，可能需要對瀏覽器源碼有一定掌握纔有能力去開發。鑑於Chrome插件的叫法已經習慣，本文也全部採用這種叫法，但讀者需深知本文所描述的Chrome插件實際上指的是Chrome擴展。

Chrome插件是一個用Web技術開發、用來增強瀏覽器功能的軟件，它其實就是一個由HTML、CSS、JS、圖片等資源組成的一個.crx後綴的壓縮包.

學習Chrome插件開發有什麼意義

增強瀏覽器功能，輕鬆實現屬於自己的“定製版”瀏覽器，等等。
Chrome插件提供了很多實用API供我們使用，包括但不限於：
書籤控制；
下載控制；
窗口控制；
標籤控制；
網絡請求控制，各類事件監聽；
自定義原生菜單；
完善的通信機制；
等等；

準備調試

從右上角菜單->更多工具->擴展程序可以進入 插件管理頁面，也可以直接在地址欄輸入 chrome://extensions 訪問。
勾選開發者模式即可以文件夾的形式直接加載插件，否則只能安裝.crx格式的文件。Chrome要求插件必須從它的Chrome應用商店安裝，其它任何網站下載的都無法直接安裝，所以，其實我們可以把crx文件解壓，然後通過開發者模式直接加載。

開發中，代碼有任何改動都必須重新加載插件，只需要在插件管理頁按下Ctrl+R即可，以防萬一最好還把頁面刷新一下。

插件核心

manifest.json
這是一個Chrome插件最重要也是必不可少的文件，用來配置所有和插件相關的配置，必須放在根目錄。其中，manifest_version、name、version3個是必不可少的，description和icons是推薦的。

{
	// 清單文件的版本，這個必須寫，而且必須是2
	"manifest_version": 2,
	// 插件的名稱
	"name": "demo",
	// 插件的版本
	"version": "1.0.0",
	// 插件描述
	"description": "簡單的Chrome擴展demo",
	// 圖標，一般偷懶全部用一個尺寸的也沒問題
	"icons":
	{
		"16": "img/icon.png",
		"48": "img/icon.png",
		"128": "img/icon.png"
	},
	// 會一直常駐的後臺JS或後臺頁面
	"background":
	{
		// 2種指定方式，如果指定JS，那麼會自動生成一個背景頁
		"page": "background.html"
		//"scripts": ["js/background.js"]
	},
	// 瀏覽器右上角圖標設置，browser_action、page_action、app必須三選一
	"browser_action": 
	{
		"default_icon": "img/icon.png",
		// 圖標懸停時的標題，可選
		"default_title": "這是一個示例Chrome插件",
		"default_popup": "popup.html"
	},
	// 當某些特定頁面打開才顯示的圖標
	/*"page_action":
	{
		"default_icon": "img/icon.png",
		"default_title": "我是pageAction",
		"default_popup": "popup.html"
	},*/
	// 需要直接注入頁面的JS
	"content_scripts": 
	[
		{
			//"matches": ["http://*/*", "https://*/*"],
			// "<all_urls>" 表示匹配所有地址
			"matches": ["<all_urls>"],
			// 多個JS按順序注入
			"js": ["js/jquery-1.8.3.js", "js/content-script.js"],
			// JS的注入可以隨便一點，但是CSS的注意就要千萬小心了，因爲一不小心就可能影響全局樣式
			"css": ["css/custom.css"],
			// 代碼注入的時間，可選值： "document_start", "document_end", or "document_idle"，最後一個表示頁面空閒時，默認document_idle
			"run_at": "document_start"
		},
		// 這裏僅僅是爲了演示content-script可以配置多個規則
		{
			"matches": ["*://*/*.png", "*://*/*.jpg", "*://*/*.gif", "*://*/*.bmp"],
			"js": ["js/show-image-content-size.js"]
		}
	],
	// 權限申請
	"permissions":
	[
		"contextMenus", // 右鍵菜單
		"tabs", // 標籤
		"notifications", // 通知
		"webRequest", // web請求
		"webRequestBlocking",
		"storage", // 插件本地存儲
		"http://*/*", // 可以通過executeScript或者insertCSS訪問的網站
		"https://*/*" // 可以通過executeScript或者insertCSS訪問的網站
	],
	// 普通頁面能夠直接訪問的插件資源列表，如果不設置是無法直接訪問的
	"web_accessible_resources": ["js/inject.js"],
	// 插件主頁，這個很重要，不要浪費了這個免費廣告位
	"homepage_url": "https://www.baidu.com",
	// 覆蓋瀏覽器默認頁面
	"chrome_url_overrides":
	{
		// 覆蓋瀏覽器默認的新標籤頁
		"newtab": "newtab.html"
	},
	// Chrome40以前的插件配置頁寫法
	"options_page": "options.html",
	// Chrome40以後的插件配置頁寫法，如果2個都寫，新版Chrome只認後面這一個
	"options_ui":
	{
		"page": "options.html",
		// 添加一些默認的樣式，推薦使用
		"chrome_style": true
	},
	// 向地址欄註冊一個關鍵字以提供搜索建議，只能設置一個關鍵字
	"omnibox": { "keyword" : "go" },
	// 默認語言
	"default_locale": "zh_CN",
	// devtools頁面入口，注意只能指向一個HTML文件，不能是JS文件
	"devtools_page": "devtools.html"
}

開始

因爲我只需要修改User-Agent和Accept-Language，所以不需要其他的頁面選項之類的，只需要一個background和申請對應權限即可，我的大概是這個樣子

{
  "name": "__MSG_chrome_extension_name__",
  "description": "__MSG_chrome_extension_description__",
  "version": "0.2",
  "default_locale": "en_US",
  "browser_action": {
      "default_title": "__MSG_browser_action_title__",
      "default_icon": "24.png"
  },
  "background": {
    "scripts": [ "background.js" ]
  },
  "icons": {
    "128": "128.png",
    "16": "16.png",
    "48": "48.png"
  },
  "manifest_version": 2,
  "permissions": [  "webRequest", "webRequestBlocking", "\u003Call_urls>" ]
}

對於相應的開發方法和api呢，我們可以去chrome官方查看，或者找國內瀏覽器的漢化版說明
360極速瀏覽器開放平臺.
經過查詢，我們需要的是chrome.webRequest api，所以我們要在manifest.json中申請對應的權限，
修改的是http頭參數，並且是在發送header之前我們需要的是chrome.webRequest.onBeforeSendHeaders api
接口簡介.
按照該api進行開發，根據文檔的說明，傳入需要的requestHeaders參數，即可修改User-Agent參數
而對於Accept-Language參數，使用默認參數對header進行打印的時候是看不到這個參數的，所以對於api需要傳入另一個參數extraHeaders纔可以修改。

function replaceHeader(user_agent, requestHeaders) {
    console.log("1111");
    var newHeaders = [];
    for (var i = 0; i < requestHeaders.length; i++)
    {   console.log(requestHeaders[i].name);
        if (requestHeaders[i].name == "User-Agent")
            newHeaders.push({name: "User-Agent", value: "Mozilla/5.0 (MSIE 10.0; Windows NT 6.1; Trident/5.0)"});
        else
        {
            newHeaders.push(requestHeaders[i]);
        }
    }
    newHeaders.push({name: "User-Agent11", value: "45465"});
    newHeaders.push({name: "Accept-Language", value: "en-US,en;q=0.5"});
    console.log(newHeaders);
    return newHeaders;
}

function updateListeners() {
    if (!listener) listener = function (details) {
        //console.log(details);
        var header_map = {requestHeaders: details.requestHeaders};
        if (details && details.url && details.requestHeaders && details.requestHeaders.length > 0)
        {
            header_map = {requestHeaders: replaceHeader("Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/78.0.3904.108 Safari/537.37", details.requestHeaders)};
        }
        return header_map;
    };
    chrome.webRequest.onBeforeSendHeaders.addListener(listener, {"urls": ["<all_urls>"]}, ["requestHeaders", "blocking", "extraHeaders"]);
}

var listener = null;
updateListeners();

這裏默認填寫的是ie10的ua和英文的Accept-Language

打包

打包的話直接在插件管理頁有一個打包按鈕：

然後會生成一個.crx文件，發送給別人直接打開就可以用了。

驗證

使用插件之前

使用插件之後

參考文章

https://www.cnblogs.com/liuxianan/p/chrome-plugin-develop.html.
https://crxdoc-zh.appspot.com/extensions/webRequest#event-onBeforeSendHeaders.
http://open.chrome.360.cn/extension_dev/messaging.html.