search
HomeWeb Front-endJS TutorialLearn more about Node's module mechanism and talk about the module implementation process

This article will take you to understand the CommonJs specification and the module mechanism of Node, and introduce the basic process of Node implementing the CommonJs specification. I hope it will be helpful to everyone!

Learn more about Node's module mechanism and talk about the module implementation process

Before the CommonJs specification was proposed, Javascript did not have a module system, which meant that it was difficult for us to develop large-scale applications because the organization of the code would be more difficult.

What is CommonJs specification


First of all, CommonJS is not unique to Node. CommonJs is a module specification that defines how to reference and export modules,Nodejs Just implements this specification. The CommonJS module specification is mainly divided into three parts: module reference, module definition and module identification.

Module reference

Module reference means that we can introduce other modules through require.

const { add } = require('./add');
const result = add(1 ,2);

Module definition

A file is a module, and the module will provide two variables, namely module and exports. module is the current module itself, exports is the content to be exported, and exports is an attribute of the module, that is, exports is module.exports. The content imported by other modules through require is the content of module.exports.

// add.js
exports.add = (a, b) => {
    return a + b;
}

Module identification

The module identification is the content in require, such as require('./add'), the module identification is ./add.

The module import and export mechanism built through CommonJS allows users to easily build large-scale applications without having to consider variable pollution.

Node’s module implementation


Node implements the CommonJs specification and adds some features it needs. Node mainly does the following three things to implement the CommonJs specification:

  • Path analysis

  • File positioning

  • Compile and execute

Path analysis

When require() is executed, require receives The parameter is the module identifier, and node performs path analysis through the module identifier. The purpose of path analysis is to find the path where this module is located through the module identifier. First of all, node modules are divided into two categories, namely core modules and file modules. The core module is the module that comes with node, and the file module is the module written by the user. At the same time, file modules are divided into file modules in the form of relative paths, file modules in the form of absolute paths, and file modules in the form of non-paths (such as express).

Learn more about Nodes module mechanism and talk about the module implementation process

When node finds a file module, it will compile, execute and cache the module. The general principle is to use the full path of the module as the key, and the compiled content as value, when this module is introduced for the second time, there is no need to perform these steps of path analysis, file location, compilation and execution. The compiled content can be read directly from the cache.

// 缓存的模块示意:
const cachedModule = {
    '/Usr/file/src/add.js': 'add.js编译后的内容',
    'http': 'Node自带的http模块编译后的内容',
    'express': '非路径形式自定义文件模块express编译后的内容'
    // ...
}

When you want to find the module imported by require, the order of searching for the module is to first check whether the module is already in the cache. If it is not in the cache, then check the core module, and then look for the file module. Among them, file modules in the form of paths are easier to find. The complete file path can be obtained based on the relative or absolute path. It is relatively troublesome to find custom file modules in non-path form. Node will search for the file from the node_modules folder.

Where is the node_modules directory? For example, the file we are currently executing is /Usr/file/index.js;

/** 
* /Usr/file/index.js;
*/

const { add } = require('add');
const result = add(1, 2);

In this module we have introduced an add module, this add It is not a core module nor a file module in the form of a path, so how to find the add module at this time.

Module has a paths attribute. The path to find the add module is in the paths attribute. We can type this attribute to take a look:

/** 
* /Usr/file/index.js;
*/

console.log(module.paths);

We execute node index in the file directory. js can print out the value of paths. The value in paths is an array, as follows:

[
'/Usr/file/node_modules',
'/Usr/node_modules',
'/node_modules',
]

That is, Node will sequentially search from the above directory to see if it contains the add module. The principle is similar to the prototype chain. First, start searching in the node_modules folder in the directory of the same level as the currently executed file. If the node_modules directory is not found or does not exist, continue searching to the upper level.

File positioning

Path analysis and file positioning are used together. The file identifier can be without a suffix, or it can be passed Path analysis finds a directory or a package. At this time, locating specific files requires some additional processing.

File extension analysis

const { add } = require('./add');

比如上面这段代码,文件标识符是不带扩展名的,这个时候node会依次查找是否存在.js、.json、.node文件。

目录和包分析

同样是上面这段代码,通过./add查找到的可能不是一个文件,可能是一个目录或者包(通过判断add文件夹下是否有package.json文件来判断是目录还是包)。这个时候文件定位的步骤是这样的:

  • 查看是否有package.json文件
      • 读取package.json里的main字段的值作为文件
    • 没有
      • 寻找目录下的index作为文件(依次查找index.js、index.json、index.node)

如果package.json里没有main字段,那么也会将index作为文件,然后进行扩展名分析找到对应后缀的文件。

模块编译

我们开发中主要遇到的模块为json模块和js模块。

json模块编译

当我们require一个json模块的时候,实际上Node会帮我们使用fs.readFilcSync去读取对应的json文件,得到json字符串,然后调用JSON.parse解析得到json对象,再赋值给module.exports,然后给到require。

js模块编译

当我们require一个js模块的时候,比如

// index.js
const { add } = require('./add');
// add.js
exports.add = (a, b) => {
    return a + b;
}

这个时候发生了什么呢,为什么我们可以直接在模块里使用module、exports、require这些变量。这是因为Node在编译js模块的时候对模块的内容进行了首尾的包装。

比如add.js这个模块,实际编译的时候是会被包装成类似这样的结构:

(function(require, exports, module) {
  exports.add = (a, b) => {
    return a + b;
  }
  return module.exports;
})(require, module.exports, module)

即我们编写的js文件是会被包装成一个函数,我们编写的只是这个函数里的内容,Node后续的包装的过程对我们隐藏了。这个函数支持传入一些参数,其中就包括require、exports和module。

当编译完js文件后,就会执行这个文件,node会将对应的参数传给这个函数然后执行,并且返回module.exports值给到require函数。

以上就是Node实现CommonJs规范的基本流程。

更多node相关知识,请访问:nodejs 教程

The above is the detailed content of Learn more about Node's module mechanism and talk about the module implementation process. For more information, please follow other related articles on the PHP Chinese website!

Statement
This article is reproduced at:掘金社区. If there is any infringement, please contact admin@php.cn delete
JavaScript in Action: Real-World Examples and ProjectsJavaScript in Action: Real-World Examples and ProjectsApr 19, 2025 am 12:13 AM

JavaScript's application in the real world includes front-end and back-end development. 1) Display front-end applications by building a TODO list application, involving DOM operations and event processing. 2) Build RESTfulAPI through Node.js and Express to demonstrate back-end applications.

JavaScript and the Web: Core Functionality and Use CasesJavaScript and the Web: Core Functionality and Use CasesApr 18, 2025 am 12:19 AM

The main uses of JavaScript in web development include client interaction, form verification and asynchronous communication. 1) Dynamic content update and user interaction through DOM operations; 2) Client verification is carried out before the user submits data to improve the user experience; 3) Refreshless communication with the server is achieved through AJAX technology.

Understanding the JavaScript Engine: Implementation DetailsUnderstanding the JavaScript Engine: Implementation DetailsApr 17, 2025 am 12:05 AM

Understanding how JavaScript engine works internally is important to developers because it helps write more efficient code and understand performance bottlenecks and optimization strategies. 1) The engine's workflow includes three stages: parsing, compiling and execution; 2) During the execution process, the engine will perform dynamic optimization, such as inline cache and hidden classes; 3) Best practices include avoiding global variables, optimizing loops, using const and lets, and avoiding excessive use of closures.

Python vs. JavaScript: The Learning Curve and Ease of UsePython vs. JavaScript: The Learning Curve and Ease of UseApr 16, 2025 am 12:12 AM

Python is more suitable for beginners, with a smooth learning curve and concise syntax; JavaScript is suitable for front-end development, with a steep learning curve and flexible syntax. 1. Python syntax is intuitive and suitable for data science and back-end development. 2. JavaScript is flexible and widely used in front-end and server-side programming.

Python vs. JavaScript: Community, Libraries, and ResourcesPython vs. JavaScript: Community, Libraries, and ResourcesApr 15, 2025 am 12:16 AM

Python and JavaScript have their own advantages and disadvantages in terms of community, libraries and resources. 1) The Python community is friendly and suitable for beginners, but the front-end development resources are not as rich as JavaScript. 2) Python is powerful in data science and machine learning libraries, while JavaScript is better in front-end development libraries and frameworks. 3) Both have rich learning resources, but Python is suitable for starting with official documents, while JavaScript is better with MDNWebDocs. The choice should be based on project needs and personal interests.

From C/C   to JavaScript: How It All WorksFrom C/C to JavaScript: How It All WorksApr 14, 2025 am 12:05 AM

The shift from C/C to JavaScript requires adapting to dynamic typing, garbage collection and asynchronous programming. 1) C/C is a statically typed language that requires manual memory management, while JavaScript is dynamically typed and garbage collection is automatically processed. 2) C/C needs to be compiled into machine code, while JavaScript is an interpreted language. 3) JavaScript introduces concepts such as closures, prototype chains and Promise, which enhances flexibility and asynchronous programming capabilities.

JavaScript Engines: Comparing ImplementationsJavaScript Engines: Comparing ImplementationsApr 13, 2025 am 12:05 AM

Different JavaScript engines have different effects when parsing and executing JavaScript code, because the implementation principles and optimization strategies of each engine differ. 1. Lexical analysis: convert source code into lexical unit. 2. Grammar analysis: Generate an abstract syntax tree. 3. Optimization and compilation: Generate machine code through the JIT compiler. 4. Execute: Run the machine code. V8 engine optimizes through instant compilation and hidden class, SpiderMonkey uses a type inference system, resulting in different performance performance on the same code.

Beyond the Browser: JavaScript in the Real WorldBeyond the Browser: JavaScript in the Real WorldApr 12, 2025 am 12:06 AM

JavaScript's applications in the real world include server-side programming, mobile application development and Internet of Things control: 1. Server-side programming is realized through Node.js, suitable for high concurrent request processing. 2. Mobile application development is carried out through ReactNative and supports cross-platform deployment. 3. Used for IoT device control through Johnny-Five library, suitable for hardware interaction.

See all articles

Hot AI Tools

Undresser.AI Undress

Undresser.AI Undress

AI-powered app for creating realistic nude photos

AI Clothes Remover

AI Clothes Remover

Online AI tool for removing clothes from photos.

Undress AI Tool

Undress AI Tool

Undress images for free

Clothoff.io

Clothoff.io

AI clothes remover

Video Face Swap

Video Face Swap

Swap faces in any video effortlessly with our completely free AI face swap tool!

Hot Tools

SublimeText3 Linux new version

SublimeText3 Linux new version

SublimeText3 Linux latest version

Dreamweaver Mac version

Dreamweaver Mac version

Visual web development tools

ZendStudio 13.5.1 Mac

ZendStudio 13.5.1 Mac

Powerful PHP integrated development environment

SecLists

SecLists

SecLists is the ultimate security tester's companion. It is a collection of various types of lists that are frequently used during security assessments, all in one place. SecLists helps make security testing more efficient and productive by conveniently providing all the lists a security tester might need. List types include usernames, passwords, URLs, fuzzing payloads, sensitive data patterns, web shells, and more. The tester can simply pull this repository onto a new test machine and he will have access to every type of list he needs.

SublimeText3 Mac version

SublimeText3 Mac version

God-level code editing software (SublimeText3)