谷歌插件开发学习指南

什么是谷歌插件

谷歌插件(Chrome Extension)是为谷歌浏览器(Chrome)开发的小程序,旨在增强浏览器的功能或用户体验。它们可以通过添加工具栏按钮、修改网页内容、集成其他服务等方式,实现各种功能,例如广告拦截、密码管理、社交媒体工具等。用户可以从 Chrome 网上应用店安装和管理这些插件,通常以简单易用的方式进行配置和使用。

谷歌插件官网API

https://developer.chrome.com/docs/extensions/reference/api?hl=zh-cn

基础构造

  • manifest.json:这是插件的配置文件,定义插件的基本信息、权限、入口等。 必须项
  • content-script:用于操作网页内容的脚本,可以直接与网页交互。在自己的作用域中运行,无法直接访问网页的变量和函数。
  • background:后台脚本,在浏览器后台运行,可监听和处理各种事件。2版本可以常驻后台,3版本为了节约内存的使用不再常驻后台,也会自动停止释放资源。
  • event-pages:类似于 background,但在空闲时会自动释放资源,节省内存。
  • popup:插件的弹出页面,通常在插件图标点击时显示,作为插件的用户界面。
  • injected js:直接注入到网页中的 JavaScript 脚本,在网页的上下文中运行,可以直接访问和操作网页的变量和函数。

五种js权限对比

JS种类可访问的APIDOM访问情况JS访问情况直接跨域
injected script和普通JS无任何差别,不能访问任何扩展API可以访问可以访问不可以
content script只能访问 extension、runtime等部分API可以访问不可以不可以
popup js可访问绝大部分API,除了devtools系列不可直接访问不可以可以
background js可访问绝大部分API,除了devtools系列不可直接访问不可以可以
devtools js只能访问 devtools、extension、runtime等部分API可以可以不可以

调试方式

JS类型调试方式图片说明
injected script直接普通的F12即可懒得截图
content-script打开Console,如图切换

popup-jspopup页面右键审查元素
background插件管理页点击背景页即可
devtools-js暂未找到有效方法-

互相通信概览

注:-表示不存在或者无意义,或者待验证。

injected-scriptcontent-scriptpopup-jsbackground-js
injected-script-

发:window.postMessage

收:window.addEventListener

--
content-script

发:window.postMessage

收:window.addEventListener

-

发:chrome.runtime.sendMessage 长连接chrome.runtime.connect

收:chrome.runtime.onMessage.addListener

chrome.runtime.sendMessage chrome.runtime.connect
popup-js-

发:chrome.tabs.sendMessage chrome.tabs.connect

收:chrome.runtime.onMessage

chrome.runtime.onConnect

-chrome.extension. getBackgroundPage()
background-js-chrome.tabs.sendMessage chrome.tabs.connectchrome.extension.getViews-
devtools-jschrome.devtools. inspectedWindow.eval-chrome.runtime.sendMessagechrome.runtime.sendMessage

manifest.json 核心配置与解释

{
	// 清单文件的版本,这个必须写,2或者3  3是最新版本
	"manifest_version": 3,
	// 插件的名称
	"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访问的网站
        "cookies" //获取cookies的权限
	],
	// 普通页面能够直接访问的插件资源列表,如果不设置是无法直接访问的
	"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"
}

简化的常用配置

1、name 扩展名称。

2、version 插件的版本。

3、manifest_version manifest配置文件版本。

4、description 对于插件功能的描述。

5、icons 插件的图标 可以为插件找一个好看的图标。

6、browser_action 可以定义插件的图标,点击插件时弹出的页面,以及插件的标题,建议始终保留一个,直接不设置这个属性图标会是灰色的,设置了后才会亮起来。

7、background 背景页,扩展进程的背景运行环境,可以拦截修改请求等等。

8、content_scripts 内容脚本,可以指定在什么时机向什么页面插入什么脚本或者css资源

9、permissions 权限申请项,比如存储权限storage,请求拦截权限webRequest, webRequestBlocking等等。
{
    "name" : "插件助手",
    "version" : "1.0",
    "description" : "允许跨域访问",
    "manifest_version" : 2,
    "icons": {
        "16": "images/ico-48.png",
        "48": "images/ico-48.png",
        "128": "images/ico-48.png"
    },
    "browser_action": {
        "default_title": "助手"
    },
    "permissions" : ["webRequestBlocking", "webRequest", "*://*/*"],
    "background" : {
        "scripts" : ["js/background.js"]
    }
}

content-script的说明

content-scripts和原始页面共享DOM,但是不共享JS,如要访问页面JS(例如某个JS变量),只能通过injected js来实现。content-scripts不能访问绝大部分chrome.xxx.api,除了下面这4种:

  • chrome.extension(getURL , inIncognitoContext , lastError , onRequest , sendRequest)
  • chrome.i18n
  • chrome.runtime(connect , getManifest , getURL , id , onConnect , onMessage , sendMessage)
  • chrome.storage

展现形式 -在manifest.json中配置对应的属性值

  • browserAction:在浏览器工具栏中添加一个图标,点击后可以弹出一个窗口。
  • pageAction:在特定页面显示图标,可以根据页面内容动态显示或隐藏。
  • contextMenu:在右键菜单中添加自定义选项。
  • override:替换浏览器内置的页面(例如新标签页)。
  • devtools:在开发者工具中添加自定义的工具或面板。
  • options:为插件提供设置页面,用户可以自定义插件行为。
  • omnibox:在浏览器地址栏输入特定关键字来触发插件功能。
  • notification:显示系统通知,提醒用户关注某些事件。

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值