前言
在进行前端开发时，经常会涉及到模块引用的问题。使用 require/import 等语句引用模块已经是我们司空见惯了的事情，但是如何确保引用的模块正确性呢？
这时候 require-spy 这个 npm 包就能帮我们解决这个问题。它能够记录我们当前项目中所有的模块引用，并打印出一份 JavaScript 文件，让我们可以直观地了解我们的代码是如何运作的。
安装
在命令行中输入下面的代码即可安装 require-spy：
npm install require-spy --save-dev
一般来说，这个包只在开发环境下需要，因为它所需要的功能不适合在生产环境下启用。
使用
在你的代码中，通过以下方式引用 require-spy：
const requieSpy = require('require-spy');不过，在使用 requieSpy 前，要对其进行初始化：
requieSpy.init();
初始化之后，我们就可以像平常一样引用我们的模块了。这时候，require-spy 会记录下我们的模块使用情况。当我们的应用退出时（比如在 Node.js 中，直接运行了小程序，并进行完整的循环迭代后），最好在退出前加上一个 requieSpy.done()，以确保所有的数据都已经被汇总在了一起。
// You can also call requireSpy.done() to print require
// stats just before the process exists.
process.on('beforeExit', () => {
requireSpy.done();
});在这个过程中，我们唯一需要关心的就是如何查看 logger(requireStats) 打印出来的信息。
案例
以下是 require-spy 的一个例子，在此例子中，它记录了当前项目中每个文件的引用。
-- -------------------- ---- -------
----- ---------- - -----------------------
----- ------ - ------------------
----- ---- - ----------------
----- ---- - ----------------
----- ------------ - -------------------------
----- --- - ---------------
------------------
-- --- - ------ ----- ------- -- - ---- ------- -- -- --- ------ -
-- ------- -- ------- ---- ------- ------------ -- ----- ----
----- ----- - ----------------------------------- -
-------------------- --------------------
-- -
------ ---------
---
----------------- ------ -- -
------------------ ------- ------ ---- ------- ------
------------------
---------------- ---------- -----------------------
---
------------------------ -- -- -
---------------------- -----------------------
---
-- -- - ---- ------------ -- -------- -------- --- ----- ---------
-- --- -- ---- ---- -- --- ------ ------ ---- ------- ---- ------ --
-- ----- ------- ---------- -- ----- ---- ---- ---- -- -- --- ---
-- --------
----- --- - --------------------
----- --- - --- -------------
----- ----- - ----------------------------在这个例子中，我们分别引用了 crypto，http，path，child_process 以及 net 五个 Node.js 的核心模块，然后初始化了 requireSpy，最后使用 child_process 的 spawn 方法开启一个子进程，并在子进程中引用了一个 example-script.js 文件，用于测试 requireSpy 记录我们的模块使用情况。最后，当子进程结束时，我们使用 requireSpy.done() 输出日志，并在 Node.js 应用退出时使用 console.log(requireSpy.getStats()) 输出 require-spy 的统计信息。
结论
通过使用 require-spy，我们可以清晰、直观地了解我们在编写 JavaScript 的时候，所引用的各个模块，而这也是优化代码架构的一个有效方法。需要特别注意的是，require-spy 在我们进行开发调试时对我们是非常有帮助的，但呢，强烈建议在正式的生产环境下关闭 require-spy 所记录的相关信息。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005554581e8991b448d27a1