Quartz 4

N_Chrome 扩展开发

10 min read

2019-8-11

什么是 Chrome 插件

Chrome插件是一个用Web技术开发, 用来增强浏览器功能的软件, 它其实就是一个由HTML, CSS, JS, 图片等资源组成的一个.crx后缀的压缩包.

Chrome 扩展(插件)开发教程官方文档中文版 Chrome API 文档 Opera API 文档 Edge API 文档 360 browserAction

实例

Chrome插件没有严格的项目结构要求, 只要保证本目录有一个manifest.json即可, 也不需要专门的IDE, 普通的web开发工具即可;

manifest.json

{
    "manifest_version": 2,// Manifest version 2 is deprecated, and support will be removed in 2023.
    "name": "xvpase",
    "version": "1.0.0",
    "description": "呵呵",
    "icons": {
		"16": "pic/ico_128.png",
		"48": "pic/ico_128.png",
		"128": "pic/ico_128.png"
    },
    "content_scripts": [
        {
            "matches": [
                "https://www.baidu.com/*"
            ],
            "js": [
                "js/jquery-1.11.3.min.js",
                "js/main-script.js"
            ],
            "run_at": "document_start"
        }
    ],
    "permissions": [
        "contextMenus",
        "tabs",
        "notifications",
        "webRequest",
        "webRequestBlocking",
        "storage",
        "http://*/*",
        "https://*/*"
    ]
 
}

manifest 说明

这是一个Chrome插件最重要也是必不可少的文件, 用来配置所有和插件相关的配置, 必须放在根目录; 其中, manifest_version, name ersion3 个是必不可少的, description 和 icons 是推荐的;

chrome manifest

 
{
    // 清单文件的版本, 这个必须写, 而且必须是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"
}

main-script.js 内容

alert("脚本已经注入")
 

//给网页注入   --args --disable-web-security --user-data-dir
var jq = document.createElement('script');
jq.src = "https://ajax.aspnetcdn.com/ajax/jQuery/jquery-1.8.0.js";
document.getElementsByTagName('head')[0].appendChild(jq);

所谓main-script.js, 其实就是Chrome插件中向页面注入脚本的一种形式（虽然名为script, 其实还可以包括css的）, 借助content-scripts我们可以实现通过配置的方式轻松向指定页面注入JS和CSS（如果需要动态注入, 可以参考下文）, 最常见的比如: 广告屏蔽, 页面CSS定制, 等等;

特别注意, 如果没有主动指定run_at为document_start（默认为 ）

content-scripts和原始页面共享DOM, 但是不共享JS, 如要访问页面JS（例如某个JS变量）, 只能通过injected js来实现; content-scripts不能访问绝大部分chrome.xxx.api

在扩展页面 勾选开发者模式即可以文件夹的形式直接加载插件, 否则只能安装.crx格式的文件; Chrome要求插件必须从它的Chrome应用商店安装, 其它任何网站下载的都无法直接安装, 所以, 其实我们可以把crx文件解压, 然后通过开发者模式直接加载;

打开 https://www.baidu.com/ , 弹出窗口

// 这里代码已经在页面运行, 可以访问dom了.
console.log("插件已经注入")
$(function(){
    $(".tab-buttons li").click(function(){
        let d_but = $(this).find(".download");
        if(d_but.length > 0 ){
            $("#tabDownload").find("a").each(function(){
                let qu = $(this).find("strong").text()
                var mid_url = ""
                if(qu == "MEDIUM"){//
                    mid_url = $(this).attr("href")
                    console.log("mid="+mid_url)
                }
            })
        }
    })
})

注意main-script.js 和原始页面共享DOM, 但是不共享JS

文件

background

后台服务

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

background的权限非常高, 几乎可以调用所有的Chrome扩展API（除了devtools）, 而且它可以无限制跨域, 也就是可以跨域访问任何网站而无需要求对方设置CORS;

经过测试, 其实不止是background, 所有的直接通过chrome-extension://id/xx.html这种方式打开的网页都可以无限制跨域;

配置中, background可以通过page指定一张网页, 也可以通过scripts直接指定一个JS, Chrome会自动为这个JS生成一个默认的网页:

#@popup

点击图标的弹窗

popup是点击browser_action或者page_action图标时打开的一个小窗口网页, 焦点离开网页就立即关闭, 一般用来做一些临时性的交互;

https://www.cnblogs.com/liuxianan/p/chrome-plugin-develop.html

监听dom 修改

https://developer.mozilla.org/zh-CN/docs/Web/API/MutationObserver

MutationObserver 接口提供了监视对 DOM 树所做更改的能力。它被设计为旧的 Mutation Events 功能的替代品，该功能是 DOM3 Events 规范的一部分。

 
 // 选择需要观察变动的节点
const targetNode = document.getElementById('some-id');
 
// 观察器的配置（需要观察什么变动）
const config = { attributes: true, childList: true, subtree: true };
 
// 当观察到变动时执行的回调函数
const callback = function(mutationsList, observer) {
    // Use traditional 'for loops' for IE 11
    for(let mutation of mutationsList) {
        if (mutation.type === 'childList') {
            console.log('A child node has been added or removed.');
        }
        else if (mutation.type === 'attributes') {
            console.log('The ' + mutation.attributeName + ' attribute was modified.');
        }
    }
};
 
// 创建一个观察器实例并传入回调函数
const observer = new MutationObserver(callback);
 
// 以上述配置开始观察目标节点
observer.observe(targetNode, config);
 
// 之后，可停止观察
observer.disconnect();

webRequest 模块拦截请求

需要监听网络请求的话,需要先在扩展程序的清单文件中声明 webRequest 权限.需要阻塞网络请求的话需要webRequestBlocking权限 ..

    "permissions": [
        "webRequest",
        "webRequestBlocking",
    ]

chrome.webRequest.onBeforeRequest.addListener( function (details) { console.log(details);

	return { cancel: false };
}
, { urls: ["*://www.baidu.com/*"] }
, ["blocking"]

);

官方实例

Graph View

Backlinks