【Node.js】CommonJs 和 Nodejs 模块、自定义模 块

【Node.js】CommonJs 和 Nodejs 模块、自定义模 块

```
CommonJs 和 Nodejs 模块、自定义模块
```

## 目录

一、什么是CommonJs？
二、Nodejs中的模块化
三、npminit生成package.json

一、什么是 **CommonJs** ？

JavaScript是一个强大面向对象语言，它有很多快速高效的解释器。然而， JavaScript
标准定义的API是为了构建基于浏览器的应用程序。并没有制定一个用于更广泛的应用程序
的标准库。CommonJS规范的提出,主要是为了弥补当前JavaScript没有标准库的缺陷。它的
终极目标就是：提供一个类似Python，Ruby和Java语言的标准库,而不只是让JavaScript停
留在小脚本程序的阶段。用CommonJSAPI编写出的应用，不仅可以利用 JavaScript开发客
户端应用，而且还可以编写以下应用。

- 服务器端JavaScript应用程序。（nodejs）
- 命令行工具。
- 桌面图形界面应用程序。

```
CommonJS 就是模块化的标准， nodejs 就是 CommonJS （模块化）的实现。
```
二、 **Nodejs** 中的模块化

Node应用由模块组成，采用CommonJS模块规范。


**2. 1** 在 **Node** 中，模块分为两类 **:**

```
一类是Node提供的模块,称为核心模块；另一类是用户编写的模块，称为文件模块。
```
- 核心模块部分在Node源代码的编译过程中，编译进了二进制执行文件。在Node进
程启动时，部分核心模块就被直接加载进内存中，所以这部分核心模块引入时，文件定位和
编译执行这两个步骤可以省略掉，并且在路径分析中优先判断，所以它的加载速度是最快的。
如： **HTTP** 模块、 **URL** 模块、 **Fs** 模块都是 **nodejs** 内置的核心模块，可以直接引入使用。
- 文件模块则是在运行时动态加载，需要完整的路径分析、文件定位、编译执行过程、
速度相比核心模块稍微慢一些，但是用的非常多。这些模块需要我们自己定义。接下来我
们看一下 **nodejs** 中的自定义模块。

**2.2 CommonJS** （ **Nodejs** ）中自定义模块的规定：

1 .我们可以把公共的功能抽离成为一个单独的 **js** 文件作为一个模块，默认情况下面这
个模块里面的方法或者属性，外面是没法访问的。如果要让外部可以访问模块里面的方法或
者属性，就必须在模块里面通过 exports或者module.exports暴露属性或者方法。

**exports暴露**
```JavaScript
exports.get = function () {
  console.log('从服务器获取数据')
}
exports.post = function () {
  console.log('提交数据')
}
```

**module.exports暴露**
```JavaScript
var obj = {

  get: function () {

    console.log('从服务器获取数据')
  },
  post: function () {
    console.log('提交数据')
  }
}
module.exports = obj;

```

2 .​ 在需要使用这些模块的文件中，通过require的方式引入这个模块。这个时候就可
以使用模块里面暴露的属性和方法。

**2.3  定义使用模块**

定义一个tools.js的模块
```JavaScript
//模块定义
vartools={
sayHello:function(){
return'helloNodeJS';
},
add:function(x,y){
returnx+y;
}
};
//模块接口的暴露
//module.exports=tools;
exports.sayHello=tools.sayHello;
exports.add=tools.add;
```

定义一个useTools.js的模块
```JavaScript

var http= require('http');
//引入自定义的tools.js模块
var tools= require('./tools');
tools.sayHello(); //使用模块
```

三、 **npminit** 生成 **package.json**

```bash
npminit--yes
```

【Node.js】CommonJs 和 Nodejs 模块、自定义模块

```
CommonJs 和 Nodejs 模块、自定义模块
```

## 目录

一、什么是CommonJs？
二、Nodejs中的模块化
三、npminit生成package.json

一、什么是 **CommonJs** ？

JavaScript是一个强大面向对象语言，它有很多快速高效的解释器。然而， JavaScript
标准定义的API是为了构建基于浏览器的应用程序。并没有制定一个用于更广泛的应用程序
的标准库。CommonJS规范的提出,主要是为了弥补当前JavaScript没有标准库的缺陷。它的
终极目标就是：提供一个类似Python，Ruby和Java语言的标准库,而不只是让JavaScript停
留在小脚本程序的阶段。用CommonJSAPI编写出的应用，不仅可以利用 JavaScript开发客
户端应用，而且还可以编写以下应用。

- 服务器端JavaScript应用程序。（nodejs）
- 命令行工具。
- 桌面图形界面应用程序。

```
CommonJS 就是模块化的标准， nodejs 就是 CommonJS （模块化）的实现。
```
二、 **Nodejs** 中的模块化

Node应用由模块组成，采用CommonJS模块规范。


**2. 1** 在 **Node** 中，模块分为两类 **:**

```
一类是Node提供的模块,称为核心模块；另一类是用户编写的模块，称为文件模块。
```
- 核心模块部分在Node源代码的编译过程中，编译进了二进制执行文件。在Node进
程启动时，部分核心模块就被直接加载进内存中，所以这部分核心模块引入时，文件定位和
编译执行这两个步骤可以省略掉，并且在路径分析中优先判断，所以它的加载速度是最快的。
如： **HTTP** 模块、 **URL** 模块、 **Fs** 模块都是 **nodejs** 内置的核心模块，可以直接引入使用。
- 文件模块则是在运行时动态加载，需要完整的路径分析、文件定位、编译执行过程、
速度相比核心模块稍微慢一些，但是用的非常多。这些模块需要我们自己定义。接下来我
们看一下 **nodejs** 中的自定义模块。

**2.2 CommonJS** （ **Nodejs** ）中自定义模块的规定：

1 .我们可以把公共的功能抽离成为一个单独的 **js** 文件作为一个模块，默认情况下面这
个模块里面的方法或者属性，外面是没法访问的。如果要让外部可以访问模块里面的方法或
者属性，就必须在模块里面通过 exports或者module.exports暴露属性或者方法。

2 .​ 在需要使用这些模块的文件中，通过require的方式引入这个模块。这个时候就可
以使用模块里面暴露的属性和方法。

**2.3  定义使用模块**

定义一个tools.js的模块
```JavaScript
//模块定义
vartools={
sayHello:function(){
return'helloNodeJS';
},
add:function(x,y){
returnx+y;
}
};
//模块接口的暴露
//module.exports=tools;
exports.sayHello=tools.sayHello;
exports.add=tools.add;
```

定义一个useTools.js的模块
```JavaScript

var http= require('http');
//引入自定义的tools.js模块
var tools= require('./tools');
tools.sayHello(); //使用模块
```

三、 **npminit** 生成 **package.json**

```bash
npminit--yes
```