在浏览器控制台安装 NPM 包是什么体验？

来自同事独钓寒江雪的投稿，首发：https://juejin.cn/post/7023916328637431816

大家好，我是零一，我们都知道，npm 是 JavaScript 世界的包管理工具,并且是 Node.js 平台的默认包管理工具。通过 npm 可以安装、共享、分发代码,管理项目依赖关系。虽然作为命令行工具的 npm 近年来逐渐式微，但是作为广泛使用的存储库的 npm，却依然如日中天，还是世界上最大的软件注册表。

通常，我们通过npm install xxx在 React、Vue、Angular 等现代前端项目中安装依赖，但是前端项目在本质上还是运行在浏览器端的 HTML、JavaScript 和 CSS，那么，我们有办法在浏览器控制台直接安装 npm 包并使用吗？

如果你对这个问题感兴趣，不妨跟着我通过本文一探究竟，也许最终你会发现：越是“复杂”的东西，其原理越趋向“简单”。

通过 <script /> 引入 cdn 资源

在浏览器控制台安装 npm 包，看起来是个天马行空的想法，让人觉得不太切实际。如果我换一个方式进行提问：如何在浏览器/HTML 中引入 JavaScript 呢？也许你马上就有了答案：<script />标签。没错，我们的第一步就是通过 <script />标签在 HTML 页面上引入 cdn 资源。

那么，又该如果在控制台在页面上插入<script />标签来引入 CDN 资源呢？这个问题可难不倒你：

// 在页面中插入<script />标签
const injectScript = (url) => {
  const script = document.createElement('script');
  script.src = url;
  document.body.appendChild(script);
};

我们还得在资源引入后以及出现错误时，给用户一些提示：

script.onload = () => {
  console.log(pkg_name_origin, ' 安装成功。');
};
script.onerror = () => {
  console.log(pkg_name_origin, ' 安装失败。');
};

这么以来，我们就可以直接在控制台引入 cdn 资源了，你可以再额外补充一些善后工作的处理逻辑，比如把<script />标签移除。当然，你也完全可以通过创建<link />标签来引入 css 样式库，这里不过多赘述。

根据包名安装 npm 包

上面实现了通过<script /> 引入 cdn 资源，但是我们安装 npm 包一般都是通过npm install后面直接跟包名来完成的，显然单靠<script />的方式难以达到我们的饿预期，那么，有没有一种方式，可以将我们的包名直接转换成 cdn 资源地址呢？

答案当然是：有。否则我写个屁啊 🤔，cdnjs就提供了这样的能力。

cdnjs^[1] 提供了一个简单的 API，允许任何人快速查询 CDN 上的资源。具体使用读者可参考官方链接，这里给出一个根据包名查询 CDN 资源链接的示例，可以直接在浏览器地址栏打开这个链接查看：https://api.cdnjs.com/libraries?search=jquery，这是一个 get 请求，你将看到类似下面的页面，数组的第一项为名称/功能最相近的资源的最新 CDN 资源地址：

jquery

是以，根据包名搜索 cdn 资源 URL 便有如下的实现：

const cdnjs = async (name) => {
  const searchPromise = await fetch(
    `https://api.cdnjs.com/libraries?search=${name}`,
    // 不显示referrer的任何信息在请求头中
    { referrerPolicy: 'no-referrer' }
  );
  const { results, total } = await searchPromise.json();
  if (total === 0) {
    console.error('Sorry, ', name, ' not found, please try another keyword.');
    return;
  }

  // 取结果中最相关的一条
  const { name: exactName, latest: url } = results[0];
  if (name !== exactName) {
    // 如果名称和你传进来的不一样
    console.log(name, ' not found, import ', exactName, ' instead.');
  }
  // 通过<script />标签插入
  injectScript(url);
};

安装特定版本的 npm 包

我们在 npm 中还可以通过类似npm install jquery@3.5.1的语法安装特定版本的 npm 包，而 cdnjs 只能返回特定版本的详细信息（不含 cdn 资源链接）。

UNPKG^[2]在此时可以帮我们一个大忙。unpkg 是一个快速的全球内容分发网络，适用于 npm 上的所有内容。使用它可以使用以下 URL 快速轻松地从任何包加载任何文件：unpkg.com/:package@:version/:file。

例如，访问https://unpkg.com/jquery@3.5.1会自动重定向到https://unpkg.com/jquery@3.5.1/dist/jquery.js，并返回v3.5.1版本的jQuery文件内容（如果不带版本号，会返回最新的资源）：

jquery_unpkg

也就是说，我们可以将https://unpkg.com/➕包名直接丢给<script />标签来加载资源：

const unpkg = (name) => {
  injectScript(`https://unpkg.com/${name}`);
};

完整代码

将上面的代码简单整理，并通过一个统一的入口方法npmInstall进行调用：

// 存储原始传入的名称
let pkg_name_origin = null;
const npmInstall = (originName) => {
  // Trim string
  const name = originName.trim();
  pkg_name_origin = name;
  // 三种引入方式
  // 如果是一个有效的URL，直接通过<script />标签插入
  if (/^https?:\/\//.test(name)) return injectScript(name);
  // 如果指定了版本，尝试使用unpkg加载
  if (name.indexOf('@') !== -1) return unpkg(name);
  // 否则，尝试使用cdnjs搜索
  return cdnjs(name);
};

// 在页面中插入<script />标签
const injectScript = (url) => {
  const script = document.createElement('script');
  script.src = url;
  script.onload = () => {
    console.log(pkg_name_origin, ' 安装成功。');
  };
  script.onerror = () => {
    console.log(pkg_name_origin, ' 安装失败。');
  };
  document.body.appendChild(script);
  // document.body.removeChild(script);
};

const unpkg = (name) => {
  injectScript(`https://unpkg.com/${name}`);
};

const cdnjs = async (name) => {
  const searchPromise = await fetch(
    `https://api.cdnjs.com/libraries?search=${name}`,
    // 不显示referrer的任何信息在请求头中
    { referrerPolicy: 'no-referrer' }
  );
  const { results, total } = await searchPromise.json();
  if (total === 0) {
    console.error('Sorry, ', name, ' not found, please try another keyword.');
    return;
  }

  // 取结果中最相关的一条
  const { name: exactName, latest: url } = results[0];
  if (name !== exactName) {
    console.log(name, ' not found, import ', exactName, ' instead.');
  }
  // 通过<script />标签插入
  injectScript(url);
};

我们可以使用类似npmInstall('moment')的方式在控制台进行调用：

console

下面这些调用方式自然也是支持的：

npmInstall('jquery'); // 直接引入
npmInstall('jquery@2'); // 指定版本
npmInstall('https://cdnjs.cloudflare.com/ajax/libs/jquery/3.1.1/jquery.min.js'); // cdn地址

不每次都写这些函数行不行

看了上面的操作，确实很简单，但是也许你会说：每次要使用时，我都得在控制台定义和调用函数，有些麻烦，不每次都写这些函数行不行？那自然是行的啦，你完全可以自己写一个浏览器插件，将这些 JS 代码注入页面，详情可参考7 分钟学会写一个浏览器插件——突破某 SDN 未登录禁止复制的限制^[3]。

如果你实在不想写，其实有人已经为你写好了，那便是Console Importer，它可以让你的浏览器控制台成为更强大的实验场。

• 使用示例：

import

• 效果图：

Console Importer

链接：Console Importer^[4] | Chrome 插件地址^[5]

可以干什么

那么，本文介绍的方法和工具到底有什么用呢？

平时开发中，我们经常会想要在项目里尝试一些操作或者验证一些库的方法、打印结果，通过本文的学习，以后你完全可以直接在控制台引入loadsh、moment、jQuery、React 等来进行使用和验证，减少在项目中进行console.log验证后再删除的频次。

• 你可以通过引入jQuery方便的进行一些项目、页面中的 DOM 操作；
• 你可以通过引入axios进行一些简单的接口请求；
• 你可以通过引入moment.js来验证一些时间格式化方法的使用；
• 你可以通过引入loadsh并调用它的方法完成一些便捷的计算；
• ...

可以学到什么

unpkg

unpkg^[6] 是一个内容源自 npm 的前端常用全球快速 CDN，它能以快速、简洁、优雅的方式提供任意包、任意文件的访问，在流行的类库、框架文档中常常能看到它的身影。使用方式一般是unpkg.com/:package@:version/:file。或者更简洁一点：https://unpkg.com/➕包名，包名包含版本号时，你将获得对应版本的 js 文件，不包含版本号时，你将获得这个库的最新版 js 文件。

cdnjs

cdnjs^[7] 是一种免费的开源 CDN 服务，受到超过 12.5% 的网站的信任，每月处理超过 2000 亿次请求，由 Cloudflare 提供支持。它类似 Google CDN 和微软 CDN 服务，但是速度比这二者更加快。CDNJS 上提供了众多 JavaScript 库，你可以直接在网页上引用这些 JS 文件，实现用户浏览网站的最佳速度体验。

你还可以通过它的查询 APIhttps://api.cdnjs.com/libraries?search=xxx进行特定库的 cdn 地址的查找，这个 API 还会给你返回一些你所查询的库的替代品。

大道至简，繁在人心

越是“复杂”的东西，其原理也许越是趋向“简单”，大道至简，繁在人心，祝每一个努力攀登者，终能豁然开朗，释然于心。

参考资料

[1]

cdnjs: https://cdnjs.com/api

[2]

UNPKG: https://unpkg.com/

[3]

7 分钟学会写一个浏览器插件——突破某 SDN 未登录禁止复制的限制: https://king-hcj.github.io/2021/10/17/browser-extension/

[4]

Console Importer: https://github.com/pd4d10/console-importer

[5]

Chrome 插件地址: https://chrome.google.com/webstore/detail/console-importer/hgajpakhafplebkdljleajgbpdmplhie

[6]

unpkg: https://unpkg.com/

[7]

cdnjs: https://cdnjs.com/

[8]

Console Importer: https://github.com/pd4d10/console-importer

The End
往期推荐
如何把 Vue 网页打包体积增大 1500%
JavaScript 已成最受欢迎的编程语言，社区规模近 1650 万
2021互联网校招研发薪资汇总，最高40k ？
Chrome 96又更新了5个巨巨巨好用的功能
肝完「浏览器原理与实践」，我总结了36条
【望周知】淘宝 NPM 镜像换域名了！

我是零一，分享技术，不止前端，下期见~

最后，欢迎加我的微信，拉你进上百人的前端交流群

创作不易，加个点赞、在看 支持一下哦！