扩展程序能够利用 Chrome 开发者工具为网页提供的相同调试优势,但它们具有独特的行为属性。成为扩展程序主调试程序需要了解这些行为、扩展程序组件如何彼此协同工作以及在哪里可以找到 bug。本教程旨在让开发者对调试扩展程序有基本的了解。
找到日志
扩展程序由许多不同的组件组成,这些组件各承担不同的责任。点击此处下载已损坏的扩展程序,以开始查找不同扩展程序组件的错误日志。
后台脚本
前往 Chrome 扩展程序管理页面 (chrome://extensions
),并确保开发者模式已开启。点击 Load Unpacked(加载解压缩)按钮,然后选择已损坏的扩展程序目录。该扩展程序加载后应该有三个按钮:Details、Remove 和 Errors(以红色字母表示)。
点击错误按钮查看错误日志。扩展程序系统发现后台脚本中存在问题。
Uncaught TypeError: Cannot read property 'addListener' of undefined
此外,通过选择 Inspect view 旁边的蓝色链接,可以为后台脚本打开 Chrome DevTools 面板。
返回到代码。
chrome.runtime.oninstalled.addListener(function() {
chrome.storage.sync.set({color: '#3aa757'}, function() {
console.log('The color is green.');
});
chrome.declarativeContent.onPageChanged.removeRules(undefined, function() {
chrome.declarativeContent.onPageChanged.addRules([{
conditions: [new chrome.declarativeContent.PageStateMatcher({
pageUrl: {hostEquals: 'developer.chrome.com'},
})],
actions: [new chrome.declarativeContent.ShowPageAction()]
}]);
});
});
后台脚本正在尝试监听 onInstalled
事件,但属性名称要求使用大写的“I”。更新代码以反映正确的调用,点击右上角的全部清除按钮,然后重新加载该扩展程序。
弹出式窗口
现在,扩展程序已正确初始化,可以测试其他组件了。请刷新此页面,或者打开新的标签页并前往 developer.chrome.com 上的任一页面,打开弹出式窗口并点击绿色方块。而且...什么也没有发生。
返回到“扩展程序管理”页面,错误按钮重新出现。点击以查看新日志。
Uncaught ReferenceError: tabs is not defined
您还可通过检查弹出式窗口来查看弹出式窗口错误。
错误 tabs is undefined
表示扩展程序不知道将内容脚本注入到何处。调用 tabs.query()
方法,然后选择活动标签页即可解决此问题。
let changeColor = document.getElementById('changeColor');
chrome.storage.sync.get('color', function(data) {
changeColor.style.backgroundColor = data.color;
changeColor.setAttribute('value', data.color);
});
changeColor.onclick = function(element) {
let color = element.target.value;
chrome.tabs.query({active: true, currentWindow: true}, function(tabs) {
chrome.tabs.executeScript(
tabs[0].id,
{code: 'document.body.style.backgroundColor = color;'});
});
};
更新代码,点击右上角的全部清除按钮,然后重新加载扩展程序。
内容脚本
刷新页面,打开弹出式窗口,然后点击绿色框。而且... 背景色还是没有改变颜色!返回“扩展程序管理”页面,但是没有错误按钮。原因可能在于网页内运行的内容脚本。
打开该扩展程序尝试更改的网页的“开发者工具”面板。
“扩展程序管理”页面上只会记录运行时错误 console.warning
和 console.error
。
如需在内容脚本中使用开发者工具,请点击 top 旁边的下拉箭头,然后选择扩展程序。
错误消息显示未定义 color
。扩展程序必须未正确传递变量。更正注入的脚本,以将颜色变量传递到代码中。
{code: 'document.body.style.backgroundColor = "' + color + '";'});
“扩展程序”标签页
在网页控制台和扩展程序管理页面上,可以找到显示为标签页的扩展程序页面(例如替换网页和整页选项)的日志。
监控网络请求
即使是最快速的开发者,在打开开发者工具之前,该弹出式窗口通常也会发出所有必需的网络请求。如需查看这些请求,请从“网络”面板内进行刷新。它会重新加载弹出式窗口,而不会关闭开发者工具面板。
声明权限
虽然扩展程序具有与网页类似的功能,但它们通常需要权限才能使用某些功能,例如 Cookie、存储和跨域 XMLHttpRequst。请参阅权限文章和可用的 Chrome API,确保扩展程序在其清单中请求正确的权限。
{
"name": "Broken Background Color",
"version": "1.0",
"description": "Fix an Extension!",
"permissions": [
"activeTab",
"declarativeContent",
"storage"
],
"options_page": "options.html",
"background": {
"scripts": ["background.js"],
"persistent": false
},
"page_action": {
"default_popup": "popup.html",
"default_icon": {
"16": "images/get_started16.png",
"32": "images/get_started32.png",
"48": "images/get_started48.png",
"128": "images/get_started128.png"
}
},
"icons": {
"16": "images/get_started16.png",
"32": "images/get_started32.png",
"48": "images/get_started48.png",
"128": "images/get_started128.png"
},
"manifest_version": 2
}
后续步骤
如需详细了解如何调试扩展程序,请观看开发和调试。请阅读相关文档,详细了解 Chrome 开发者工具。