当前位置：首页 > 行业动态 > 正文

commonjs教程

admin
行业动态
2025-03-25
3

# 简答CommonJS 是一种 JavaScript 模块规范，用于在服务器端模块化代码。

CommonJS教程

一、什么是CommonJS？

CommonJS是一种JavaScript模块规范，旨在创建一个适用于服务器端和客户端的模块系统，在CommonJS中，每个文件都是一个独立的模块，模块之间通过module.exports和require进行交互，这种模块化方式可以让代码更结构化，易于理解和维护，同时提高了代码的复用性，避免了全局作用域被墙。

二、为什么使用CommonJS？

1、模块化管理：让代码更结构化，易于理解和维护。

2、代码复用：提高了开发效率。

3、避免全局作用域被墙：减少了命名冲突的风险。

4、提高代码可维护性：通过模块化的方式，可以更容易地管理和更新代码。

三、CommonJS的核心概念

1、模块：在CommonJS中，每个文件都是一个独立的模块，模块可以是任何类型的文件，如JavaScript文件、JSON文件等。

2、导出（Exports）：使用module.exports来导出模块中要暴露的功能或对象，这是CommonJS模块系统中定义模块接口的方式。

3、导入（Imports）：使用require来导入其他模块，这是CommonJS模块系统中加载模块的方式。

四、CommonJS的基本用法

1、导出模块：

commonjs教程

使用module.exports来导出模块中要暴露的内容，在一个名为math.js的文件中，我们可以定义一些数学函数并导出它们：

 // math.js
     function add(a, b) {
         return a + b;
     }
     function subtract(a, b) {
         return a b;
     }
     module.exports = {
         add,
         subtract
     };

在这个例子中，我们定义了两个函数add和subtract，然后使用module.exports将它们作为一个对象导出，这样，其他文件就可以通过require来导入这些函数了。

2、导入模块：

使用require来导入其他模块，在一个名为app.js的文件中，我们可以导入math.js模块并使用其中的函数：

 // app.js
     const math = require('./math');
     console.log(math.add(5, 3)); // 输出: 8
     console.log(math.subtract(5, 3)); // 输出: 2

在这个例子中，我们使用require('./math')来导入math.js模块，并将其赋值给变量math，我们就可以通过math.add和math.subtract来调用导出的函数了。

五、CommonJS的特点

1、同步加载：CommonJS模块是同步加载的，意味着在服务器端执行时，模块会在代码执行时立即加载，这对于服务器端（Node.js）很适用，但在浏览器环境中就显得不太高效。

commonjs教程

2、单例模式：每个模块在第一次加载后会被缓存，后续的加载将直接返回缓存中的实例，这可以提高模块的加载性能，但也可能带来一些副作用，比如模块状态的共享问题。

3、运行在模块作用域：所有代码都运行在模块作用域，不会被墙全局作用域，这有助于避免命名冲突和全局变量的滥用。

六、CommonJS与ES Modules的区别

	CommonJS	ES Modules
导入/导出语法	`require`,`module.exports`	`import`,`export`
模块加载时机	同步加载	异步加载（在顶层时）
模块缓存	是	否
循环依赖处理	通常导致错误	通常可以正常工作（通过静态分析）
默认导出	不支持（需使用`module.exports`）	支持（使用`export default`）
环境支持	Node.js和多数前端构建工具	现代浏览器和多数前端构建工具（需适当转译）