chrome插件开发入门教程

内容#

  1. 创建清单
  2. 添加指令
  3. 介绍用户界面
  4. 层逻辑
  5. 给用户选项
  6. 采取下一步

入门教程

扩展由不同的但相互联系的组件组成。组件可以包括 后台脚本， 内容脚本，选项页， UI元素 和各种逻辑文件。扩展组件是使用Web开发技术创建的：HTML，CSS和JavaScript。扩展的组件将取决于其功能，并且可能不需要所有选项。

本教程将构建一个扩展，允许用户更改developer.chrome.com上任何页面的背景颜色 。它将使用许多核心组件来介绍它们之间的关系。

首先，创建一个新目录来保存扩展名的文件。

完整的扩展程序可以在此处下载 。

创建清单#

扩展从清单开始。创建一个名为manifest.json 并包含以下代码的文件，或在此处下载该文件 。

1
2
3
4
5
6
{
    "name": "Getting Started Example",
    "version": "1.0",
    "description": "Build an Extension!",
    "manifest_version": 2
}

可以在当前状态下以开发人员模式将包含清单文件的目录添加为扩展名。

  1. 通过导航到来打开“扩展管理”页面 chrome://extensions。
    • 也可以通过点击Chrome菜单，将鼠标悬停在“ 更多工具”上， 然后选择扩展程序来打开“扩展程序管理”页面。
  2. 通过单击“ 开发人员模式”旁边的切换开关启用“开发人员模式”。
  3. 单击LOAD UNPACKED按钮，然后选择扩展目录。

负荷扩展

  • 该扩展程序已成功安装。由于清单中未包含任何图标，因此将为扩展名创建通用工具栏图标。

添加指令#

尽管已安装扩展，但没有说明。 通过创建标题为的文件或在此处下载 ，然后将其放置在扩展目录中来引入背景脚本。 background.js

后台脚本和许多其他重要组件必须在清单中注册。在清单中注册后台脚本会告诉扩展名要引用的文件以及该文件的行为。

1
2
3
4
5
6
7
8
9
10
11
12
{
    "name": "Getting Started Example",
    "version": "1.0",
    "description": "Build an Extension!",
    "background": {
        "scripts": [
            "background.js"
        ],
        "persistent": false
    },
    "manifest_version": 2
}

现在，该扩展程序知道它包含一个非持久性后台脚本，并将扫描注册文件中需要侦听的重要事件。

此扩展在安装后将需要来自持久变量的信息。首先runtime.onInstalled 在后台脚本中包含一个监听事件 。在onInstalled侦听器内部，扩展将使用存储 API 设置一个值 。这将允许多个扩展组件访问该值并进行更新。

1
2
3
4
5
chrome.runtime.onInstalled.addListener(function() {
	chrome.storage.sync.set({color: '#3aa757'}, function () {
		console.log('The color is green.');
	});
}

大多数API（包括存储 API）都必须"permissions"在清单中的字段下注册，以便扩展程序使用它们。

1
2
3
4
5
6
7
8
9
10
11
{
  "name": "Getting Started Example",
  "version": "1.0",
  "description": "Build an Extension!",
  "permissions": ["storage"],
  "background": {
    "scripts": ["background.js"],
    "persistent": false
  },
  "manifest_version": 2
}

浏览回到扩展管理页面，然后单击“ 重新加载”链接。带有蓝色链接背景页面的新字段“ **检查视图”**可用。

检查视图

点击链接以查看后台脚本的控制台日志“ The color is green.”

介绍用户界面#

扩展可以具有多种形式的用户界面，但是这种形式 将使用 弹出窗口。创建并添加标题popup.html为目录的文件，或在此处下载 。此扩展程序使用按钮来更改背景颜色。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
<!DOCTYPE html>
<html>
  <head>
    <style>
      button {
        height: 30px;
        width: 30px;
        outline: none;
      }
    </style>
  </head>
  <body>
    <button id="changeColor"></button>
  </body>
</html>

与后台脚本一样，该文件需要在清单下的清单中指定为弹出窗口 page_action。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
  "name": "Getting Started Example",
  "version": "1.0",
  "description": "Build an Extension!",
  "permissions": ["storage"],
  "background": {
    "scripts": ["background.js"],
    "persistent": false
  },
  "page_action": {
    "default_popup": "popup.html"
  },
  "manifest_version": 2
}

工具栏图标的名称也包含page_action 在该default_icons字段下。在 此处下载images文件夹 ，将其解压缩，并将其放置在扩展程序的目录中。更新清单，以便扩展程序知道如何使用图像。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
{
  "name": "Getting Started Example",
  "version": "1.0",
  "description": "Build an Extension!",
  "permissions": ["storage"],
  "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"
    }
  },
  "manifest_version": 2
}

扩展程序还会在扩展程序管理页面上显示图像，权限警告和网站图标。这些图像在清单中的下方指定 icons。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
{
  "name": "Getting Started Example",
  "version": "1.0",
  "description": "Build an Extension!",
  "permissions": ["storage"],
  "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
}

如果在此阶段重新加载扩展，它将包含一个灰度图标，但不会包含任何功能差异。由于page_action是在清单中声明的​​，因此取决于扩展名来告知浏览器用户何时可以与进行交互popup.html。

使用侦听器事件中的declarativeContent API 将声明的规则添加到后台脚本 runtime.onInstalled。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
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()]
    }]);
  });
});

该扩展将需要权限才能访问declarativeContent其清单中的 API。

1
2
3
4
5
6
{
  "name": "Getting Started Example",
...
  "permissions": ["declarativeContent", "storage"],
...
}

弹出

现在，当用户导航到包含的URL时，浏览器将在浏览器工具栏中显示一个全彩的页面操作图标 "developer.chrome.com"。该图标为全色时，用户可以单击它以查看popup.html。

弹出界面的最后一步是为按钮添加颜色。创建一个名为popup.js以下文件的文件并将其添加 到扩展目录，或在此处下载 。

1
2
3
4
5
6
let changeColor = document.getElementById('changeColor');

chrome.storage.sync.get('color', function(data) {
  changeColor.style.backgroundColor = data.color;
  changeColor.setAttribute('value', data.color);
});

此代码从中获取按钮popup.html 并从存储中请求颜色值。然后，它将颜色用作按钮的背景。包括脚本标记popup.js在popup.html。

1
2
3
4
5
6
7
8
<!DOCTYPE html>
<html>
...
  <body>
    <button id="changeColor"></button>
    <script src="popup.js"></script>
  </body>
</html>

重新加载扩展以查看绿色按钮。

层逻辑#

现在，该扩展程序知道该弹出窗口对developer.chrome.com上的用户应该可用， 并显示一个彩色按钮，但是需要逻辑来进行进一步的用户交互。更新popup.js以包括以下代码。

1
2
3
4
5
6
7
8
9
10
let changeColor = document.getElementById('changeColor');
...
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 + '";'});
  });
};

更新的代码在按钮上添加了onclick事件，该事件触发了以 编程方式注入的内容脚本。这会将页面的背景色变成与按钮相同的颜色。使用程序注入可以允许用户调用内容脚本，而不是将不需要的代码自动插入网页中。

清单将需要activeTab 许可权，以允许扩展程序临时访问 tabsAPI。这使分机可以进行呼叫 tabs.executeScript。

1
2
3
4
5
6
{
  "name": "Getting Started Example",
...
  "permissions": ["activeTab", "declarativeContent", "storage"],
...
}

该扩展程序现在可以正常使用了！重新加载扩展程序，刷新此页面，打开弹出窗口，然后单击按钮将其变为绿色！但是，某些用户可能希望将背景更改为其他颜色。

给用户选项#

该扩展程序当前仅允许用户将背景更改为绿色。包括一个选项页面使用户可以更好地控制扩展功能，从而进一步自定义其浏览体验。

首先在名为的目录中创建一个文件，options.html 并包含以下代码，或在此处下载 。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
<!DOCTYPE html>
<html>
  <head>
    <style>
      button {
        height: 30px;
        width: 30px;
        outline: none;
        margin: 10px;
      }
    </style>
  </head>
  <body>
    <div id="buttonDiv">
    </div>
    <div>
      <p>Choose a different background color!</p>
    </div>
  </body>
  <script src="options.js"></script>
</html>

然后在清单中注册选项页面，

1
2
3
4
5
6
7
{
  "name": "Getting Started Example",
  ...
  "options_page": "options.html",
  ...
  "manifest_version": 2
}

重新加载扩展，然后单击DETAILS。

检查视图

向下滚动详细信息页面，然后选择扩展选项 以查看选项页面，尽管该页面当前将显示为空白。

检查视图

最后一步是添加选项逻辑。options.js使用以下代码在扩展目录中创建一个名为的文件，或在此处下载 。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
let page = document.getElementById('buttonDiv');
const kButtonColors = ['#3aa757', '#e8453c', '#f9bb2d', '#4688f1'];
function constructOptions(kButtonColors) {
  for (let item of kButtonColors) {
    let button = document.createElement('button');
    button.style.backgroundColor = item;
    button.addEventListener('click', function() {
      chrome.storage.sync.set({color: item}, function() {
        console.log('color is ' + item);
      })
    });
    page.appendChild(button);
  }
}
constructOptions(kButtonColors);

提供了四个颜色选项，然后使用onclick事件侦听器将它们生成为选项页面上的按钮。用户单击按钮时，它将更新扩展程序全局存储中的颜色值。由于所有扩展名文件均从全局存储中提取颜色信息，因此无需更新其他值。

恭喜你！该目录现在包含一个功能齐全的Chrome扩展程序，尽管过于简单。