chrome扩展应用开发快速科普

时间 2019-11-06

标签 chrome 扩展应用开发快速科普栏目 Chrome 繁體版

原文原文链接

概述

本文经过对chrome插件的各个部分进行快速的介绍，从而让你们了解插件各个部分的关系，而且知道如何将其进行组装成一个完整的chrome插件。javascript

因为chrome官方文档中对于如何从零开发一个chrome扩展应用没有一套完整的流程，同时官方的API文档对于初学者也不是那么友好，所以本文将经过一个初学者的视角来说解如何从零开始快速了解和开发一个chrome插件。css

本文的目标群体：已经了解或使用过chrome扩展应用，可是本身不知道如何开发一个chrome扩展应用的工程师。若是有具体的chrome扩展应用开发经验的同窗，本篇文章可能太过简单，并不适合你。html

本文的主要内容以下：java

chrome扩展应用模块功能介绍
chrome扩展应用模块开发介绍

本文的内容不包括chrome扩展应用开发时提供的各个API功能详解，有需求的同窗能够自行查看官方API文档。web

chrome扩展应用模块功能介绍

chrome扩展应用由不少部分组成，其中主要模块为：chrome

Manifest File
Background Pages
Content Script
Options

为了不因为翻译缘由致使的问题，所以在下文中对相关模块的称呼一概采用上面的英文。下面，咱们先简单来了解下这些模块具体是什么做用。json

Background Pages

A common need for extensions is to have a single long-running script to manage some task or state. Background pages to the rescue.

从官方的介绍咱们能够知道，Background Pages的做用就是在浏览器运行时，会长时间执行的脚本。只要浏览器处于打开状态，在Background Pages中的脚本就会在后台执行。api

Content Script

Content scripts are JavaScript files that run in the context of web pages. By using the standard Document Object Model (DOM), they can read details of the web pages the browser visits, or make changes to them.

从上面官方的介绍咱们能够知道，Content Script其实就是咱们须要写的将会在咱们但愿的目标页面中执行的脚本文件。每次目标页面刷新时，这部分脚本也会从新加载执行。浏览器

Options

To allow users to customize the behavior of your extension, you may wish to provide an options page.

从官方的介绍咱们能够了解，Options部分就是咱们对于扩展的管理功能。咱们可以经过一个模块来对chrome扩展应用的设置和数据进行处理。app

chrome扩展应用模块开发介绍

首先，让咱们先肯定咱们插件须要完成的一个功能，这样咱们就可以有一个目标示例来进行介绍。

以我本身开发的表情插件为例，它必须具有如下几项功能：

可以收集任何网页的图片做为表情
可以在插件中管理已有表情
可以在特定页面中将表情发送出去

咱们将上面的功能抽象一下，就可以获得以下的结果：

可以收集保存任何网页的图片做为表情（长时间执行脚本监听用户操做）
可以在特定页面中将保存的表情发送出去（在目标页面中使用脚本与页面进行交互）
可以在插件中管理已有表情（插件管理相关功能）

所以，须要完成上述功能，咱们就须要用到上面咱们提到的功能模块。下面，让咱们按照模块来看下，咱们应该如何实现这些功能。

配置文件（Manifest File）

首先，在进行具体的功能开发时，咱们须要来看下咱们的项目配置文件。这个配置文件在整个chrome扩展应用中很是重要，包含了项目的属性、配置、权限和资源信息。

{
  "manifest_version": 2,
  "name": "大象表情收藏",
  "description": "大象表情收藏（非官方）",
  "version": "4.15.1",
  "default_locale": "zh_CN",
  "icons": {
    "16": "img/icon16.png",
    "48": "img/icon48.png",
    "128": "img/icon128.png"
  },
  "background": {
    "scripts": [
      "js/background.js"
    ],
    "persistent": false
  },
  "permissions": [
    "<all_urls>",
    "storage",
    "contextMenus"
  ],
  "content_scripts": [
    {
      "css": [
        "js/main.css"
      ],
      "js": [
        "js/favor.js"
      ],
      "matches": [
        "*://x.sankuai.com/*"
      ],
      "run_at": "document_end"
    }
  ],
  "options_page": "options.html",
  "web_accessible_resources": [
    "img/favorite.png",
    "img/left.svg",
    "img/right.svg",
    "img/icon128.png",
    "img/plane.svg",
    "options.html"
  ]
}

这是我开发的大象表情插件的manifest配置文件，咱们经过这个配置文件来看下相关的属性字段。

属性名称	属性含义	备注
manifest_version	manifest文件版本
name	项目名称	发布到商店时的名称。
description	项目简介	发布到商店时的简介。
version	项目版本	发布到商店时须要每次递增。
default_locale	默认的locale目录	具体见此处。
icons	扩展应用图标	须要提供16x16，48x48，128x128三种尺寸。
background	Background Pages文件
permissions	扩展应用所需权限	权限列表见此处。申请权限后，可使用chrome对象来进行访问该权限提供的API接口。我所开发的扩展应用主要是使用到了右键菜单和存储权限
content_scripts	Content Script文件	matches字段表示Content Script文件生效的域名
options_page	Options文件
web_accessible_resources	扩展须要访问的本地资源	只用列举的资源才可以在扩展中经过相对路径方式访问。

根据上面的实例文件和具体的属性介绍，相信你们对manifest文件有了一个具体的了解。下面，咱们来具体介绍下咱们须要使用的各个功能模块。

收集网页的图片（Background Pages）

须要收集各个网页的图片，咱们须要一个后台常驻的脚原本知足咱们的需求。所以，咱们须要使用Background Pages。

根据前一节的manifest文件，咱们指定了background.js文件做为咱们的后台常驻脚本，下面让咱们来看下这个文件的部分示例内容。

// 注册一个右键菜单选项
chrome.runtime.onInstalled.addListener(function () {
    chrome.contextMenus.create({
        'id': 'F577D6742FF1A1AB5946A8E5281D5C5D',
        'title': '添加到表情收藏',
        'contexts': ['image']
    });
});

chrome.contextMenus.onClicked.addListener(function (info, tab) {
    var src = info['srcUrl'];
    // 获取以前存储的表情
    chrome.storage.local.get(['newFavorList'], function (items) {
        var newFavorList = items['newFavorList'] || [];
        newFavorList.push(src);
        
        // 存储全部表情
        chrome.storage.local.set({
            'newFavorList': newFavorList
        });
    });
});

经过上面的例子，咱们能够实现咱们的目标：当用户在任意网页上面右键一张图片时，右键菜单中都会增长一个选项——添加到表情收藏。点击这个选项，咱们就可以将这张图片存储到咱们的扩展应用提供的存储模块中。

其中，runtime和contextMenus是chrome提供的原生API，相关API接口能够见此处。

具体效果以下：

发送保存的表情（Content Script）

当咱们须要发送咱们已经保存的表情时，咱们就须要跟页面进行部分功能交互了。这个时候，咱们须要使用到Content Script。

当咱们使用Content Script时，咱们的执行上下文将会是整个页面。所以，咱们可使用JavaScript来操纵DOM节点，和页面原有的JavaScript进行交互。

下面，咱们经过jQuery来页面注入表情面板，同时使用PostMessage来与原有页面进行数据通讯。让咱们来看下favor.js文件的部分示例代码：

chrome.storage.local.get(['newFavorList'], (items) => {
    let favorBox = $('#favorbox');
    favorBox.empty();
    newFavorList = items.newFavorList;


    let emotionPanel = $('<div>', {
        class: 'smiley-emotion-panel'
    });

    newFavorList.forEach((element) => {
        if (element && element.url) {
            emotionPanel.append($('<span>', {
                class: 'icon icon-smiley-emotions',
                'click': postFavor
            }).append($('<img>', {
                'width': '100%',
                'height': '100%',
                src: element.url
            })));
        }
    });

    favorBox.append(emotionPanel);
});

function postFavor(e) {
    let src = event.target.getAttribute('src');
    
    window.postMessage({
        type: 'sendCustomEmotion',
        text: src
    }, '*');
}

经过上面的示例代码，咱们能够知道：从Storage中将表情数据取出后，当即渲染到页面中。当渲染的表情被点击时，咱们就经过PostMessage将数据按照约定的格式发送便可。

在具体项目中的使用以下图所示：

这样，咱们就解决了在特定的网页与页面的代码进行交互的功能。接下来让咱们来看下咱们的“设置”页面应该怎么开发。

管理已有表情（Options）

经过Options，咱们可以给chrome扩展应用开发一个“设置”页面。当咱们指定options_page字段后，它的值就是咱们的“设置”页面。

开发一个管理已有表情的options页面，其实就是一个带有特殊API接口的网页。咱们仍然可以经过chrome对象来访问chrome提供的已经申请过权限的API接口。

首先，咱们将咱们存储在Storage中的图片表情数据渲染出来，而后提供相关的操做函数。options.js部分示例代码以下：

$scope.remove = function (obj) {
    var result = [];

    $scope.favors.forEach(function (element) {
        if (element.url !== obj.url) {
            result.push(element);
        }
    });
    $scope.favors = result;
    chrome.storage.local.set({
        'newFavorList': $scope.favors
    });
};

若是咱们须要在“设置”页面删除后，Content Script页面当即响应应该怎么作呢？咱们只须要在Content Script中增长Storage监听事件便可。具体代码示例以下：

chrome.storage.onChanged.addListener((changes) => {
    let newFavorList = changes['newFavorList'];
    
    renderNewValue(newFavorList.newValue);
});

经过在Options和Content Script增长相关代码，咱们就可以完成管理已有表情的功能。具体展现效果以下：

总结

咱们经过一个简单的表情插件的例子来快速的介绍了chrome扩展应用的各个模块的功能和开发方法。经过这篇文章你们应该知道了chrome扩展应用各个模块的做用和开发的方法。

若是你们想对chrome扩展应用有一个更加深刻的了解，那么建议本身动手开发相关的功能。这样才可以对chrome扩展应用的相关逻辑有一个更加清楚的认识。

附录中提供了部分学习相关的文档，有兴趣的同窗能够自行阅读。

附录

chrome官方开发文档(英)——建议有英文阅读能力的人阅读此文档。
chrome开发文档(中)——阅读中文文档时，自动忽略“百度”二字便可，同时建议参考官方文档一块儿阅读。