Detailed explanation of using Node's module system

This time I will bring you a detailed explanation of the use of Node's module system. What are theprecautionswhen using the Node module system? The following is a practical case, let's take a look.

Modules are the basis for building applications. They also make functions and variables private and not directly exposed to the outside world. Next we will introduce Node’s modular system and its most commonly used modes

In order to allow Node.js files to call each other, Node.js provides a simple module system.

Modules are the basic components of Node.js applications, and files and modules have a one-to-one correspondence. In other words, a Node.js file is a module, which may be JavaScript code, JSON, or a compiled C/C extension.

The essence of module

We all know that a big flaw in JavaScript is the lack of the concept of namespacing. The program runs in the global scope and is easily contaminated by the code of internal applications or the data of third-party dependent programs. A very typical solution Just solve it through IIFE, which is essentially using closures

const module = (() => { const privateOne = () => { // ... } const privateTwo = () => { // ... } const exported = { publicOne: () => { // ... }, publicTwo: [] } return exported; })() console.log(module);

From the above code, we can see that the module variable contains only the API exposed to the outside world, but the remaining module content is invisible to the outside world, and this is also the core idea of the Node module system.

Node modules Description

CommonJS is an organization dedicated to standardizing the JavaScript ecosystem. One of its most famous proposals is what we all know as CommonJS. modules, Node built his own module system based on this specification, and added some custom extensions. In order to describe how it works, we can use the essential idea of the module mentioned above to make one ourselves. Similar implementation.

Made a module loader

The following code mainly imitates the function of Node's original require() function

First, we create a function to load the contents of a module and wrap it in a private scope

function loadModule(filename, module, require) { const warppedSrc = `(function(module, mexports, require) { ${fs.readFileSync(filename, 'utf-8')} })(module, module.exports, require)` eval(warppedSrc); }

The source code of the module is wrapped into a function, just like IIFE. The difference here is that we pass some variables to the module, specifically module, module.exports and require. Note that our exports variable is actually module. exports is initialized, we will continue to discuss this

*In this example, it should be noted that we use vm modules like eval() or node, which may cause some security issues of code injection attacks, so we need to pay special attention to and avoid

Next, let us see how these variables are introduced by implementing our require() function

const require = (moduleName) => { console.log(`Required invoked for module: ${moduleName}`); const id = require.resolve(moduleName); if(require.cache[id]) { return require.cache[id].exports; } // module structure data const module = { exports: {}, id: id } // uodate cache require.cache[id] = module; // load the module loadModule(id, module, require); // return exported variables return module.exports; } require.cache = {}; require.resolve = (moduleName) => { // resolve a full module id from the moduleName }

The above function simulates the behavior of Nodejs's native require function for loading modules. Of course, it is only a prototype and does not completely accurately reflect the behavior of the real require function, but it can give us a good understanding of the Node module system. The internal mechanism, how a module is defined and sandwiched, our self-made module system has the following functions

1. The module name is passed in as a parameter. The first thing to do is to call the require.resolve method to generate a module id based on the passed in module name (generated through the specified resolve algorithm)

2. If The module has been loaded, then it will be obtained directly from the cache

3. If the module has not been loaded, we will initialize a module object, where Contains two attributes, one is module id, and the other is exports. Its initial value is an empty object. This attribute will be used to save the public API code of the module's export

4. Cache the module

5. Call the loadModule function we defined above to obtain the source code of the module and initialize the module object Passed in as a parameter, because module is an object, reference type, so the module can use module.exports or replace module.exports to expose its public API

6. Finally, the content of module.exports is returned to the caller, which is the public API

of the module. Seeing this, we will find that the Node module system is not as difficult as imagined. The real skill lies in packaging the module code and creating a runtime virtual environment.

Define a module

通过观察我们自制的require()函数的工作机制，我们应该很清楚的知道如何定义一个模块

const dependency = require('./anotherModule'); function log() { console.log(`get another ${dependency.username}`); } module.exports.run = () => { log(); } // anotherModule.js module.exports = { username: 'wingerwang' }

最重要的是要记住在模块里面，除了被分配给module.exports的变量，其他的都是该模块私有的，在使用require()加载后，这些变量的内容将会被缓存并返回。

定义全局变量

即使所有的变量和函数都在模块本身的作用域内声明的，但是仍然可以定义全局变量，事实上，模块系统暴露一个用来定义全局变量的特殊变量global，任何分配到这个变量的变量都会自动的变成全局变量

需要注意的是，污染全局作用域是一个很不好的事情，甚至使得让模块系统的优点消失，所以只有当你自己知道你要做什么时候，才去使用它

module.exports VS exports

很多不熟悉Node的开发同学，会对于module.exports和exports非常的困惑，通过上面的代码我们很直观的明白，exports只是module.exports的一个引用，而且在模块加载之前它本质上只是一个简单的对象

这意味着我们可以将新属性挂载到exports引用上

exports.hello = () => { console.log('hello'); }

如果是对exports重新赋值，也不会有影响，因为这个时候exports是一个新的对象，而不再是module.exports的引用，所以不会改变module.exports的内容。所以下面的代码是错误的

exports = () => { console.log('hello'); }

如果你想暴露的不是一个对象，或者是函数、实例或者是一个字符串，那可以通过module.exports来做

module.exports = () => { console.log('hello'); }

require函数是同步的

另外一个重要的我们需要注意的细节是，我们自建的require函数是同步的，事实上，它返回模块内容的方法很简单，并且不需要回调函数。Node内置的require()函数也是如此。因此，对于module.exports内容必须是同步的

// incorret code setTimeout(() => { module.exports = function(){} }, 100)

这个性质对于我们定义模块的方法十分重要，使得限制我们在定义模块的时候使用同步的代码。这也是为什么Node提供了很多同步API给我们的最重要的原因之一

如果我们需要定义一个异步操作来进行初始化的模块，我们也可以这么做，但是这种方法的问题是，我们不能保证require进来的模块能够准备好，后续我们会讨论这个问题的解决方案

其实，在早期的Node版本里，是有异步的require方法的，但是因为它的初始化时间和异步I／O所带来的性能消耗而废除了

resolving 算法

相依性地狱(dependency hell)描述的是由于软件之间的依赖性不能被满足从而导致的问题，软件的依赖反过来取决于其他的依赖，但是需要不同的兼容版本。Node很好的解决了这个问题通过加载不同版本的模块，具体取决于该模块从哪里被加载。这个特性的所有优点都能在npm上体现，并且也在require函数的resolving 算法中使用

然我们来快速连接下这个算法，我们都知道，resolve()函数获取模块名作为输入，然后返回一个模块的全路径，该路金用于加载它的代码也作为该模块唯一的标识。resolcing算法可以分为以下三个主要分支

1. 文件模块(File modules)，如果模块名是以"/"开始，则被认为是绝对路径开始，如果是以"./"开始，则表示为相对路径，它从使用该模块的位置开始计算加载模块的位置

2. 核心模块(core modules)，如果模块名不是"/"、"./"开始的话，该算法会首先去搜索Node的核心模块

3. 包模块(package modules)，如果通过模块名没有在核心模块中找到，那么就会继续在当前目录下的node_modules文件夹下寻找匹配的模块，如果没有，则一级一级往上照，直到到达文件系统的根目录

对于文件和包模块，单个文件和文件夹可以匹配到模块名，特别的，算法将尝试匹配一下内容

1. .js

2. /index.js

3. 在 /package main中指定的目录／文件

算法文档

每个包通过npm安装的依赖会放在node_modules文件夹下，这就意味着，按照我们刚刚算法的描述，每个包都会有它自己私有的依赖。

myApp ├── foo.js └── node_modules ├── depA │ └── index.js └── depB │ ├── bar.js ├── node_modules ├── depA │ └── index.js └── depC ├── foobar.js └── node_modules └── depA └── index.js

通过看上面的文件夹结构，myApp、depb和depC都依赖depA，但是他们都有自己私有的依赖版本，根据上面所说的算法的规则，当使用require('depA')会根据加载的模块的位置加载不同的文件

1. myApp/foo.js 加载的是 /myApp/node_modules/depA/index.js

2. myApp/node_modules/depB/bar.js 加载的是 /myApp/node_modules/depB/node_modules/depA/index.js

3. myApp/node_modules/depB/depC/foobar.js 加载的是 /myApp/node_modules/depB/depC/node_modules/depA/index.js

resolving算法是保证Node依赖管理的核心部分，它的存在使得即便应用程序拥有成百上千个包的情况下也不会出现冲突和版本不兼容的问题

当我们使用require()时，resolving算法对于我们是透明的，然后，如果需要的话，也可以在模块中直接通过调用require.resolve()来使用

模块缓存(module cache)

每个模块都会在它第一次被require的时候加载和计算，然后随后的require会返回缓存的版本，这一点通过看我们自制的require函数会非常清楚，缓存是提高性能的重要手段，而且他也带来了一些其他的好处

1. 使得在模块依赖关系中，循环依赖变得可行

2. 它保证了在给定的包中，require相同的模块总是会返回相同的实例

模块的缓存通过变量require.cache暴露出来，所以如果需要的话，可以直接获取，一个很常见的使用场景是通过删除require.cache的key值使得某个模块的缓存失效，但是不建议在非测试环境下去使用这个功能

循环依赖

很多人会认为循环依赖是自身设计的问题，但是这确实是在真实的项目中会发生的问题，所以我们很有必要去弄清楚在Node内部是怎么工作的。然我们通过我们自制的require函数来看看有没有什么问题

定义两个模块

// a.js exports.loaded = false; const b = require('./b.js'); module.exports = { bWasLoaded: b.loaded, loaded: true } // b.js exports.loaded = false; const a = require('./a.js'); module.exports = { aWasLoaded: a.loaded, loaded: true }

在main.js中调用

const a = require('./a'); const b = require('./b'); console.log(a); console.log(b);

最后的结果是

{ bWasLoaded: true, loaded: true }
{ aWasLoaded: false, loaded: true }

这个结果揭示了循环依赖的注意事项，虽然在main主模块require两个模块的时候，它们已经完成了初始化，但是a.js模块是没有完成的，这种状态将会持续到它把模块b.js加载完，这种情况需要我们值得注意

其实造成这个的原因主要是因为缓存的原因，当我们先引入a.js的时候，到达去引入b.js的时候，这个时候require.cache已经有了关于a.js的缓存，所以在b.js模块中，去引入a.js的时候，直接返回的是require.cache中关于a.js的缓存，也就是不完全的a.js模块，对于b.js也是一样的操作，才会得出上面的结果

模块定义技巧

模块系统除了成为一个加载依赖的机制意外，也是一个很好的工具去定义API，对于API设计的主要问题，是去考虑私有和公有功能的平衡，最大的隐藏内部实现细节，对外暴露出API的可用性，而且还需要对软件的扩展性和可用性等的平衡

接下来来介绍几种在Node中常见的定义模块的方法

命名导出

这也是最常见的一种方法，通过将值挂载到exports或者是module.exports上，通过这种方法，对外暴露的对象成为了一个容器或者是命名空间

// logger.js exports.info = function(message) { console.log('info:' + message); } exports.verbose = function(message) { console.log('verbose:' + message) }

// main.js const logger = require('./logger.js'); logger.info('hello'); logger.verbose('world');

很多Node的核心模块都使用的这种模式

其实在CommonJS规范中，只允许使用exports对外暴露公共成员，因此该方法是唯一的真的符合CommmonJS规范的，对于通过module.exports去暴露的，都是Node的一个扩展功能

函数导出

另一个很常见的就是将整个module.exports作为一个函数对外暴露，它主要的优点在于只暴露了一个函数，使得提供了一个很清晰的模块的入口，易于理解和使用，这种模式也被社区称为substack pattern

// logger.js module.exports = function(message) { // ... }

该模式的的一个扩展就是将上面提到的命名导出组合起来，虽然它仍然只是提供了一个入口点，但是可以使用次要的功能

module.exports.verbose = function(message) { // ... }

虽然看起来暴露一个函数是一个限制，但是它是一个很完美的方式，把重点放在一个函数中，代表该函数是这个模块最重要的功能，而且使得内部私有变量属性变的更透明

Node的模块化也鼓励我们使用单一职责原则，每个模块应该对单个功能负责，从而保证模块的复用性

构造函数导出

将构造函数导出，是一个函数导出的特例，但是区别在于它可以使得用户通过它区创建一个实例，但是我们仍然继承了它的prototype属性，类似于类的概念

class Logger { constructor(name) { this.name = name; } log(message) { // ... } info(message) { // ... } verbose(message) { // ... } }

const Logger = require('./logger'); const dbLogger = new Logger('DB'); // ...

实例导出

我们可以利用require的缓存机制轻松的定义从构造函数或者是工厂实例化的实例，可以在不同的模块中共享

// count.js function Count() { this.count = 0; } Count.prototype.add = function() { this.count++; } module.exports = new Count(); // a.js const count = require('./count'); count.add(); console.log(count.count) // b.js const count = require('./count'); count.add(); console.log(count.count) // main.js const a = require('./a'); const b = require('./b');

输出的结果是

1
2

该模式很像单例模式，它并不保证整个应用程序的实例的唯一性，因为一个模块很可能存在一个依赖树，所以可能会有多个依赖，但是不是在同一个package中

修改其他的模块或者全局作用域

一个模块甚至可以导出任何东西这可以看起来有点不合适;但是，我们不应该忘记一个模块可以修改全局范围和其中的任何对象，包括缓存中的其他模块。请注意，这些通常被认为是不好的做法，但是由于这种模式在某些情况下（例如测试）可能是有用和安全的，有时确实可以利用这一特性，这是值得了解和理解的。我们说一个模块可以修改全局范围内的其他模块或对象。它通常是指在运行时修改现有对象以更改或扩展其行为或应用的临时更改。

以下示例显示了我们如何向另一个模块添加新函数

// file patcher.js // ./logger is another module require('./logger').customMessage = () => console.log('This is a new functionality');

// file main.js require('./patcher'); const logger = require('./logger'); logger.customMessage();

在上述代码中，必须首先引入patcher程序才能使用logger模块。

上面的写法是很危险的。主要考虑的是拥有修改全局命名空间或其他模块的模块是具有副作用的操作。换句话说，它会影响其范围之外的实体的状态，这可能导致不可预测的后果，特别是当多个模块与相同的实体进行交互时。想象一下，有两个不同的模块尝试设置相同的全局变量，或者修改同一个模块的相同属性，效果可能是不可预测的（哪个模块胜出？），但最重要的是它会对在整个应用程序产生影响。

相信看了本文案例你已经掌握了方法，更多精彩请关注php中文网其它相关文章！

推荐阅读：

bootstrap有哪些轮播模板可以使用

JS数组去重最快的算法

The above is the detailed content of Detailed explanation of using Node's module system. For more information, please follow other related articles on the PHP Chinese website!