开发H5都会喜欢这个Vite插件

小鑫同学 2022/11/20 VitePlugin

在开发小程序的时候经常会通过手机扫描小程序开发工具生成的二维码来快速在手机上打开正在开发的小程序进行功能调试，但是在H5开发时却还是通过聊天软件来粘贴地址，费时费力，所以我将编写一个Vite插件来支持终端显示二维码的功能。

🎄Hi~ 大家好，我是小鑫同学 (opens new window)，一位长期从事前端开发的编程爱好者，我将使用更为实用的案例输出更多的编程知识，同时我信奉分享是成长的唯一捷径，在这里也希望我的每一篇文章都能成为你技术落地的参考~

1. Vite插件开发辅助

开发Vite插件建议使用开源项目generator-vite-plugin (opens new window)，可以通过简单了两步操作实现一个Vite插件开发的基本环境,还贴心的配置了调试脚本方便第一次开发插件时手忙脚乱；

1.1 安装generator-vite-plugin：

$ npm i -g yo
$ npm i -g generator-vite-plugin

1
2

1.2 生成Vite插件基本环境：

$ yo vite-plugin

2. DevQRCode插件开发

通过第一步已经生成了vite-plugin-dev-qrcode 插件的基本状态，这里要介绍几个基本的前提要素：

手机端需要和电脑端处于同一局域网环境；
手机端必须使用局域网分配的IP访问H5页面，Local地址无效；
Vite默认启动不提供Network地址，需要增加--host 参数，插件中默认已配置；

2.1 获取Vite启动后分配的URLs：

vite命令执行后会在终端启动一个开发服务器，并分配给我们访问该服务的地址，所以这里要关注的就是configureServer 这个钩子函数，通过该函数提供的server 对象可以获取到该服务的相关信息；

在server对象的ViteDevServer 类型定义中看到如下参数，在server.listen 之后urls将会打印到终端，这正是我要找的属性；

/**
 * The resolved urls Vite prints on the CLI. null in middleware mode or
 * before `server.listen` is called.
 */
resolvedUrls: ResolvedServerUrls | null;

1
2
3
4
5

2.2 溯源Vite如何终端输出信息：

上一步知道了urls如何获取，这一步要解决的就是vite到底是如何输出urls到终端的？在Vite源码的packages/vite/src/node/server/index.ts 文件中有如下这段函数，可以看出这个函数将resolvedUrls 内容进行了打印，在加上ViteDevServer 类型定义中对该函数的注释，就完全锁定了这个就是我的目标函数；

printUrls() {
  if (server.resolvedUrls) {
    printServerUrls(
      server.resolvedUrls,
      serverConfig.host,
      config.logger.info
    )
  } else if (middlewareMode) {
    throw new Error('cannot print server URLs in middleware mode.')
  } else {
    throw new Error(
      'cannot print server URLs before server.listen is called.'
    )
  }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

/**
 * Print server urls
 */
printUrls(): void;

1
2
3
4

2.3 生成二维码并在适时打印到终端：

生成的二维码要同urls一同输出，保持一致，这里要使用到扩展的手段来让server.printUrls 得到支持，类似的手段在Vue2的数组响应式实现中也有体现，不知道你是否还有印象；

具体的二维码生成使用到了qrcode-terminal 模块，丰富的样式输出使用kolorist模块，具体代码如下：

configureServer(server: ViteDevServer) {
  const _print = server.printUrls;
  server.printUrls = () => {
    _print();
    const host = server.resolvedUrls?.network[0];
    if (host) {
      console.log(`${bold("Scan QR code to open quickly. ⤦")}`);
      qrcode.generate(`${host}`, { small: true });
    } else {
      console.log(
        `  ${green("➜")}  ${yellow("Failed to get the network address.")}`
      );
    }
  };
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

总结：

实现这个插件仅仅使用了十几行代码，期间翻阅了Vite插件的开发文档和源码，分别找到了开发服务器的相关钩子函数拿到了Vite打印的urls信息，并通过扩展printUrls 函数在保证原始逻辑正常执行的情况下增加二维码输出的功能。怎么样，这个插件你会写了吗？尝试一下吧~

这一篇就结束了，欢迎点赞、评论、分享支持一下。你的支持和肯定，是我坚持写作的动力~ 最后可以关注我@小鑫同学。欢迎点此扫码联系 (opens new window)交流，共同进步（还可以帮你fix🐛）~