vue-cli3开发Chrome插件实践

时间 2019-11-05 标签 vue cli3 cli 3 开发 chrome 插件实践

以前找了很多如何开发谷歌插件的文章，结果发现都是些很基础的内容，并无写到如何快速编译打包插件。我就在想为何不能经过webpack来打包插件呢？若是经过webpack编译的话，就能使开发过程变得更舒服，使文件结构趋向模块化，而且打包的时候直接编译压缩代码。后来发现了vue-cli-plugin-chrome-ext插件，经过这个插件能很方便地用vue-cli3来开发谷歌插件，并能直接引用各类UI框架跟npm插件。javascript

tip：若是你没接触过谷歌插件开发的话建议先看看基础文档：css

Chrome 插件开发中文文档

Chrome插件开发全攻略

搭建环境

建立一个vue-cli3项目： vue create vue-extension，对话流程选择默认就行。
进入项目cd vue-extension
安装vue-cli-plugin-chrome-ext插件：vue add chrome-ext,根据安装对话选项设置好。
删除vue-cli3无用文件跟文件夹：src/main.js、src/components

运行项目

npm run build-watch 运行开发环境，对修改文件进行实时编译并自动在根目录下生成dist文件夹，而后在浏览器上加载dist文件夹完成插件安装。(注意：~~修改background文件跟manifest.json文件并不能实时刷新代码，须要从新加载插件才行。~~ 后面已经有实时刷新的解决方法) html
npm run build 运行生产环境编译打包，将全部文件进行整合打包。前端

引入element UI

目前的插件加载到浏览器后弹出页面是这种界面： vue

平时咱们确定要引入好看的UI框架的，在这里咱们能够引入 element-ui，首先安装：

npm install element-ui
复制代码

考虑到插件打包后的文件大小，最后经过按需加载的方式来引入组件，按照element-ui官方的按需加载方法，要先安装babel-plugin-component插件:java

npm install babel-plugin-component -D
复制代码

而后，将babel.config.js修改成：webpack

module.exports = {
  presets: [
    '@vue/app'
  ],
  "plugins": [
    [
      "component",
      {
        "libraryName": "element-ui",
        "styleLibraryName": "theme-chalk"
      }
    ]
  ]
}
复制代码

接下来修改popup相关文件引入所需组件， src/popup/index.js内容:git

import Vue from "vue";
import AppComponent from "./App/App.vue";

Vue.component("app-component", AppComponent);

import {
  Card
} from 'element-ui';

Vue.use(Card);

new Vue({
  el: "#app",
  render: createElement => {
    return createElement(AppComponent);
  }
});
复制代码

src/popup/App/App.vue 内容：github

<template>
  <el-card class="box-card">
    <div slot="header" class="clearfix" >
      <span>卡片名称</span>
      <el-button style="float: right; padding: 3px 0" type="text" >操做按钮</el-button>
    </div>
    <div v-for="o in 4" :key="o" class="text item" >
      {{'列表内容 ' + o }}
    </div>
  </el-card>
</template>

<script> export default { name: 'app', } </script>

<style> .box-card { width: 300px; } </style>
复制代码

渲染效果： web

固然，不单单是插件内部的页面，还能够将element-ui组件插入到content页面。

`content.js`使用`element-ui`组件

content.js主要做用于浏览网页，对打开的网页进行插入、修改DOM，对其进行操做交互。别以为element-ui只能配合vue使用，其实就是一个前端框架，只要咱们引入了就能使用，webpack会自动帮咱们抽离出来编译打包。

根据评论的朋友提示，能够经过Chrome插件的chrome.extension.getURLAPI来引入字体文件，解决element-ui没法引入相对路径的字体文件问题。

首先咱们建立src/content/index文件，在里面咱们经过chrome.extension.getURLAPI来引入插件的字体文件，内容：

import {
    Message,
    MessageBox
} from 'element-ui';

// 经过Chrome插件的API加载字体文件
(function insertElementIcons() {
    let elementIcons = document.createElement('style')
    elementIcons.type = 'text/css';
    elementIcons.textContent = ` @font-face { font-family: "element-icons"; src: url('${ window.chrome.extension.getURL("fonts/element-icons.woff")}') format('woff'), url('${ window.chrome.extension.getURL("fonts/element-icons.ttf ")}') format('truetype'); /* chrome, firefox, opera, Safari, Android, iOS 4.2+*/ } `
    document.head.appendChild(elementIcons);
})();

MessageBox.alert('这是一段内容', '标题名称', {
    confirmButtonText: '肯定',
    callback: action => {
        Message({
            type: 'info',
            message: `action: ${ action }`
        });
    }
})
复制代码

vue.config.js增长content.js文件的打包配置，由于content.js（background.js一样能够只生成js文件）只有js文件，不用像app模式那样打包生成相应的html文件。这里咱们还要对字体打包配置处理下，由于默认打包后的文件名是带有hash值的，在这里咱们要去除掉，完整内容以下：

const CopyWebpackPlugin = require("copy-webpack-plugin");
const path = require("path");

// Generate pages object
const pagesObj = {};

const chromeName = ["popup", "options"];

chromeName.forEach(name => {
  pagesObj[name] = {
    entry: `src/${name}/index.js`,
    template: "public/index.html",
    filename: `${name}.html`
  };
});

// 生成manifest文件
const manifest =
  process.env.NODE_ENV === "production" ? {
    from: path.resolve("src/manifest.production.json"),
    to: `${path.resolve("dist")}/manifest.json`
  } : {
    from: path.resolve("src/manifest.development.json"),
    to: `${path.resolve("dist")}/manifest.json`
  };

const plugins = [
  CopyWebpackPlugin([
    manifest
  ])
]

module.exports = {
  pages: pagesObj,
  // // 生产环境是否生成 sourceMap 文件
  productionSourceMap: false,

  configureWebpack: {
    entry: {
      'content': './src/content/index.js'
    },
    output: {
      filename: 'js/[name].js'
    },
    plugins: plugins
  },
  css: {
    extract: {
      filename: 'css/[name].css'
      // chunkFilename: 'css/[name].css'
    }
  },
  chainWebpack: config => {
    // 处理字体文件名，去除hash值
    const fontsRule = config.module.rule('fonts')

    // 清除已有的全部 loader。
    // 若是你不这样作，接下来的 loader 会附加在该规则现有的 loader 以后。
    fontsRule.uses.clear()
    fontsRule.test(/\.(woff2?|eot|ttf|otf)(\?.*)?$/i)
      .use('url')
      .loader('url-loader')
      .options({
        limit: 1000,
        name: 'fonts/[name].[ext]'
      })
  }
};
复制代码

最后在manifest.development.json加载content.js文件，以及将字体文件添加到网页可加载资源字段web_accessible_resources里去：

{
    "manifest_version": 2,
    "name": "vue-extension",
    "description": "a chrome extension with vue-cli3",
    "version": "0.0.1",
    "options_page": "options.html",
    "browser_action": {
        "default_popup": "popup.html"
    },
    "content_security_policy": "script-src 'self' 'unsafe-eval'; object-src 'self'",
    "content_scripts": [{
        "matches": [
            "*://*.baidu.com/*"
        ],
        "css": [
            "css/content.css"
        ]
        "js": [
            "js/content.js"
        ],
        "run_at": "document_end"
    }],
    "web_accessible_resources": ["fonts/*"]
}
复制代码

而后浏览器从新加载插件后打开https://www.baidu.com/网址后可看到：

实时刷新插件

以前写的时候发现单纯地经过vue-cli3更新代码并不能使插件的background.js、content.js也跟着更新，由于代码已经加载到浏览器了，浏览器并不会监听这些文件的变化。也是经过评论的朋友推荐，经过crx-hotreload能够完美实现实时刷新功能，而不用从新手动加载。代码还简单易用，在这里咱们直接将代码复制到src/utils/hot-reload.js文件：

// 代码来源：https://github.com/xpl/crx-hotreload/edit/master/hot-reload.js
const filesInDirectory = dir => new Promise(resolve =>
    dir.createReader().readEntries(entries =>
        Promise.all(entries.filter(e => e.name[0] !== '.').map(e =>
            e.isDirectory ?
            filesInDirectory(e) :
            new Promise(resolve => e.file(resolve))
        ))
        .then(files => [].concat(...files))
        .then(resolve)
    )
)

const timestampForFilesInDirectory = dir =>
    filesInDirectory(dir).then(files =>
        files.map(f => f.name + f.lastModifiedDate).join())

const reload = () => {
    window.chrome.tabs.query({
        active: true,
        currentWindow: true
    }, tabs => { // NB: see https://github.com/xpl/crx-hotreload/issues/5
        if (tabs[0]) {
            window.chrome.tabs.reload(tabs[0].id)
        }
        window.chrome.runtime.reload()
    })
}

const watchChanges = (dir, lastTimestamp) => {
    timestampForFilesInDirectory(dir).then(timestamp => {
        if (!lastTimestamp || (lastTimestamp === timestamp)) {
            setTimeout(() => watchChanges(dir, timestamp), 1000) // retry after 1s
        } else {
            reload()
        }
    })
}

window.chrome.management.getSelf(self => {
    if (self.installType === 'development') {
        window.chrome.runtime.getPackageDirectoryEntry(dir => watchChanges(dir))
    }
})
复制代码

而后在vue.config.js对热刷新代码进行处理，若是是开发环境的话就将其复制到assets文件夹里面：

// vue.config.js
...

// 在这段下面添加
const plugins = [
  CopyWebpackPlugin([
    manifest
  ])
]

// 开发环境将热加载文件复制到dist文件夹
if (process.env.NODE_ENV !== 'production') {
  plugins.push(
    CopyWebpackPlugin([{
      from: path.resolve("src/utils/hot-reload.js"),
      to: path.resolve("dist")
    }])
  )
}

...
复制代码

最后只要在开发环境manifest.development.json里配置一下，将hot-reload.js加载到background运行环境中便可：

"background": { "scripts": ["hot-reload.js"] }
复制代码

添加打包文件大小预览配置

既然用了vue-cli3了，怎能不继续折腾呢，咱们平时用webpack开发确定离不开打包组件预览功能，才能分析哪些组件占用文件大，该有的功能一个都不能少😎。这么实用的功能，实现起来也无非就是添加几行代码的事：

// vue.config.js

module.export = {
  /* ... */

  chainWebpack: config => {
    // 查看打包组件大小状况
    if (process.env.npm_config_report) {
      // 在运行命令中添加 --report参数运行， 如：npm run build --report
      config
        .plugin('webpack-bundle-analyzer')
        .use(require('webpack-bundle-analyzer').BundleAnalyzerPlugin)
    }
  }
}
复制代码

就辣么简单，而后运行npm run build --report看看效果：

自动打包zip

作过Chrome插件的都知道，提交到谷歌插件市场的话须要打包为zip文件才行。若是每次咱们都须要将编译文件打包成zip的话就太麻烦了，这种每次都要经历的重复流程固然是交给程序来处理啦。想打包zip的话首先要安装zip-webpack-plugin插件到开发环境：

npm install --save-dev zip-webpack-plugin
复制代码

而后添加打包代码到vue.config.js:

// vue.config.js
...

// 开发环境将热加载文件复制到静态文件夹(在这段下面添加)
if (process.env.NODE_ENV !== 'production') {
    /*...*/
}

// 生产环境下打包dist为zip
if (process.env.NODE_ENV === 'production') {
  plugins.push(
    new ZipPlugin({
      path: path.resolve("dist"),
      filename: 'dist.zip',
    })
  )
}

...
复制代码

搞定收工！

结语

事实证实，vue-cli3很强大，vue相关的插件并非不能应用于开发浏览器插件，element-ui也不只限于vue的运用。只有你想不到，没有作不到的事😁。

tip：若是你懒得从头开始搭建模板的话也能够从GitHub拉取vue-extension-template。