初步学习Node.js

雨点打透心脏的1/2处 2022-10-14 00:50 172阅读 0赞

### 初步学习Node.js ###

*  什么是Node.js
 *   *  判断node.js是否安装成功
 *  在node.js环境中执行JavaScript代码
 *  fs文件系统模块
 *   *  什么是fs文件系统模块
     *  读取指定文件中的内容
     *   *  判断文件是否读取成功
     *  向指定的文件中写入内容
     *   *  判断文件是否写入成功
     *  fs文件模块路径动态拼接的问题
     *   *  解决方案
         *   *  使用绝对地址
             *  使用\`\_\_dirname\`进行拼接
 *  path路径模块
 *   *  什么是path路径模块
     *  路径拼接
     *  获取路径中的文件名
     *  获取路径中的文件扩展名
 *  http模块
 *   *  什么是http模块
     *  使用http模块创建最基本的web服务器
     *   *  根据不同的url地址响应不同的html内容
 *  模块化
 *   *  什么是模块化
     *  模块化规范
     *  Node.js中的模块分类
     *  如何加载模块
     *  Node.js中的模块作用域
     *   *  向外共享模块作用域的成员
         *   *  exports对象
     *  Node.js中的模块化规范
 *  npm与包
 *   *  包
     *  一些好用的包
     *   *  i5ting\_toc包
     *  npm里面的包管理配置文件
     *   *   *  记录项目中都安装了哪些包
             *  devDependencies节点
     *  包的规范
     *  开发属于自己的包
     *  模块的加载机制

# 什么是Node.js #

Node.js是一个基于Chrome V8引擎的JavaScript运行时。点击进入[Node.js官网][Node.js]  
注意：

*  浏览器是JavaScript的前端运行环境，而Node.js是JavaScript的后端运行环境
 *  Node.js中无法调用DOM和BOM等浏览器内置API

## 判断node.js是否安装成功 ##

`win`\+`R`输入`cmd`打开终端，输入`node -v`查看版本号，如果有版本号则表示node.js安装成功  
![查看版本号][20210604210841683.png]

# 在node.js环境中执行JavaScript代码 #

首先打开终端，用`cd`命令切换到需要执行的js文件的目录，默认在C盘，如果在其他盘符就需要先切换到该盘符，使用命令`D:`，如下图所示  
![切换到相应目录][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NzU4NDUzNg_size_16_color_FFFFFF_t_70]  
切换到指定目录后，使用`node 要执行的文件名`命令来执行指定文件中的JavaScript代码  
![需要执行的代码][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NzU4NDUzNg_size_16_color_FFFFFF_t_70 1]  
执行结果  
![执行结果][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NzU4NDUzNg_size_16_color_FFFFFF_t_70 2]

# fs文件系统模块 #

## 什么是fs文件系统模块 ##

**fs模块**是Node.js官方提供的、用来操作文件的模块。它提供了一系列的方法和属性，用来满足用户对文件的操作希求。

## 读取指定文件中的内容 ##

使用`fs.readFile()`方法，可以读取指定文件的内容，具体语法如下

fs.readFile(path[, options], callback);

<table> 
 <thead> 
  <tr> 
   <th>参数</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>path</td> 
   <td>必选，字符串，表示文件的路径</td> 
  </tr> 
  <tr> 
   <td>options</td> 
   <td>可选，表示以什么编码格式来读取文件</td> 
  </tr> 
  <tr> 
   <td>callback</td> 
   <td>必选，文件读取完后，通过回调函数来拿到读取的结果</td> 
  </tr> 
 </tbody> 
</table>

注意，在调用fs模块的`readFile()`方法需要使用`require`方法导入模块

const fs = require("fs");

示例：

// 使用require方法导入fs模块
    const fs = require("fs");
    // 调用readFile()方法读取文件
    fs.readFile("./files/test.txt", "utf-8", function(err, dataStr){ 
    	console.log("err:"+err);
    	console.log("--------");
    	// dataStr就是test.txt文件中的内容
    	console.log("dataStr:"+dataStr);
    });

结果如下  
![输出结果][20210604215801209.png]  
如果读取失败（把path参数中的文件名改一下）

// 使用require方法导入fs模块
    const fs = require("fs");
    // 调用readFile()方法读取文件
    fs.readFile("./files/test11.txt", "utf-8", function(err, dataStr){ 
    	console.log("err:"+err);
    	console.log("--------");
    	// dataStr就是test.txt文件中的内容
    	console.log("dataStr:"+dataStr);
    });

那么输出的dataStr将会是`undefind`，err中存有错误信息，值为错误对象  
![发生错误时][20210604220135328.png]

### 判断文件是否读取成功 ###

可以判断回调函数的参数err的值，如果err的值为`null`，则表示文件读取成功，否则读取文件失败

// 导入fs模块
    const fs = require("fs");
    fs.readFile("./files/text.txt","utf-8",function(err, dataStr){ 
    	// 如果存在错误对象，则证明读取文件失败
    	if(err){ 
    		return console.log("读取文件失败："+err.message);
    	}
    	console.log("读取文件成功："+ dataStr);
    });

来看一下实际效果（分别为读取成功和读取失败）  
![判断读取文件是否成功][20210604221244582.png]

## 向指定的文件中写入内容 ##

使用`fs.writeFile()`方法，可以向指定的文件中写入内容，语法格式如下：

fs.writeFile(file, data[, options], callback);

<table> 
 <thead> 
  <tr> 
   <th>参数</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>file</td> 
   <td>必选参数，文件路径字符串，表示文件的存放路径</td> 
  </tr> 
  <tr> 
   <td>data</td> 
   <td>必选参数，表示要写入的内容</td> 
  </tr> 
  <tr> 
   <td>options</td> 
   <td>可选参数，表示以什么格式写入文件内容，默认是utf8</td> 
  </tr> 
  <tr> 
   <td>callback</td> 
   <td>必选参数，文件写入完成后的回调函数</td> 
  </tr> 
 </tbody> 
</table>

示例：

const fs = require("fs");
    // 默认以utf8格式写入文件
    fs.writeFile("./files/写入的文件.txt", "Hello Node.js!", function(err){ 
    	console.log(err);
    });

可以看到输出的`err`值为`null`，如果将存放文件的路径修改成不存在的路径，则会输出错误对象  
![新增加了一个文件][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NzU4NDUzNg_size_16_color_FFFFFF_t_70 3]  
![不同情况输出的err值不同][err]

### 判断文件是否写入成功 ###

如果文件写入成功了，那么回调函数中的`err`值为`null`，否则`err`的值为错误对象

fs.writeFile("./files.写入的文件.txt", "Hello Node.js", function(err){ 
    	// 如果写入成功，则err的值为null，否则为错误对象
    	if(err){ 
    		return console.log("文件写入失败："+ err.message);
    	}
    	console.log("文件写入成功！");
    });

## fs文件模块路径动态拼接的问题 ##

在使用fs文件模块时，都需要提供相应的操作路径，如果提供的相应路径是以`./`或者`../`开头的相对路径时，非常容易出现路径动态拼接错误的问题  
出现错误的原因：代码在运行时，**会执行以node命令所在的目录**，动态拼接出被操作文件的完整路径  
为了更好理解，举个例子：

// 先写一个读取文件的方法
    const fs = require("fs");
    fs.readFile("./files/test.txt", "utf-8", function(err, dataStr){ 
    	if(err){ 
    		return console.log("读取文件失败："+err.message);
    	}
    	console.log("读取文件成功："+ dataStr);
    });

在文件当前目录内访问是成功的  
![在文件当前目录下访问][20210604232458560.png]  
切换文件目录后访问就报错  
![返回上一级目录后再次执行][20210604232757109.png]  
而执行`fs.readFile()`方法时，参数`path`值为`./files/test.txt`，可以看出，报错信息的路径就是上图①中框出的路径加上path路径拼接而成  
![错误原因][20210604233146580.png]

### 解决方案 ###

#### 使用绝对地址 ####

出现路径拼接错误是因为在调用`fs.readFile()`方法时，设置的`path`值为相对路径，要解决只需要将path值设置为**完整的绝对存放路径**即可，缺点也很明显，移植性非常差，且不利于后期的维护

// 将path改为 D:/Desktop/前端/nodeJS/day1/code/files/text.txt
    // 或者 D:\\Desktop\\前端\\nodeJS\\day1\\code\\files

改好之后将解决这个问题  
![正常访问][20210604234142595.png]

#### 使用`__dirname`进行拼接 ####

`__dirname`表示当前文件所处的位置

const fs = require("fs");
    fs.readFile(__dirname+"/files/test.txt", "utf-8", function(err, dataStr){ 
    	if(err){ 
    		return console.log("读取文件失败："+err.message);
    	}
    	console.log("读取文件成功："+dataStr);
    });

可以看到，我们完美的解决了这个问题  
![完美解决][20210604235145936.png]

# path路径模块 #

## 什么是path路径模块 ##

path模块是Node.js官方提供的、用来处理路径的模块，它提供了一系列的方法和属性，用来满足用户对路径的处理需求

## 路径拼接 ##

使用path.join()方法，可以把多个路径片段拼接为完整的路径字符串，语法格式如下：

// 首先需要导入path模块
    const path = require("path");
    path.join([...paths]);

<table> 
 <thead> 
  <tr> 
   <th>参数</th> 
   <th>类型</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>…paths</td> 
   <td>string</td> 
   <td>路径片段的序列</td> 
  </tr> 
  <tr> 
   <td>返回值</td> 
   <td>string</td> 
   <td>拼接好的一个路径字符串</td> 
  </tr> 
 </tbody> 
</table>

示例：

需要注意下面的一个参数`"../"`表示上一级，因此会抵消掉`/c`这一级目录

const path = require("path");
    var pathStr = path.join("/a", "/b/c", "../", "./d", "e");
    console.log(pathStr);// 输出的是：a\b\d\e

来看结果：  
![拼接后的结果][20210605163909925.png]  
示例2：

const path = require("path");
    var pathStr2 = path.join(__dirname, "./code/files/text.txt");
    console.log(pathStr2);

结果：  
![示例2结果][2]  
在之后的有涉及到路径字符串拼接的操作都尽量使用`join()`方法，用`+`拼接可能会出现异常

## 获取路径中的文件名 ##

使用`path.basename()`方法，可以获取路径中的最后一部分，经常通过这个方法获取路径中的文件名，语法格式如下：

path.basename(path[, ext]);

<table> 
 <thead> 
  <tr> 
   <th>参数</th> 
   <th>类型</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>path</td> 
   <td>string</td> 
   <td>必选，表示一个路径的字符串</td> 
  </tr> 
  <tr> 
   <td>ext</td> 
   <td>string</td> 
   <td>可选，表示文件的扩展名</td> 
  </tr> 
  <tr> 
   <td>返回值</td> 
   <td>string</td> 
   <td>表示路径中的最后一部分</td> 
  </tr> 
 </tbody> 
</table>

示例：

const path = require("path");
    var str = path.basename(path.join(__dirname, "./files/text.txt"));
    console.log(str); // 输出的是 text.txt
    
    var str2 = path.basename(path.join(__dirname, "./files/text.txt"), ".txt");
    console.log(str2); // 输出的是 text

## 获取路径中的文件扩展名 ##

使用path.extname()方法，专门用来获取路径中的扩展名部分，语法格式如下：

path.extname(path);

<table> 
 <thead> 
  <tr> 
   <th>参数</th> 
   <th>类型</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>path</td> 
   <td>string</td> 
   <td>必选，表示一个路径的字符串</td> 
  </tr> 
  <tr> 
   <td>返回值</td> 
   <td>string</td> 
   <td>得到扩展名字符串</td> 
  </tr> 
 </tbody> 
</table>

示例：

const path = require("path");
    var extName = path.extname("a/b/c/d/index.html");
    console.log(extName); // 输出的是 .html

# http模块 #

## 什么是http模块 ##

http模块是Node.js官方提供的、用来**创建web服务器**的模块。通过通过http模块提供的`http.createServer()`方法，就能方便的把一台普通电脑变为一台web服务器，从而对外提供web资源。在使用的时候仍然是需要调用`require()`方法导入该模块

const http = require("http");

## 使用http模块创建最基本的web服务器 ##

创建web服务器一共有四步：

1.  导入http模块
2.  创建web服务器实例
3.  为服务器绑定**request**事件，监听客户端的请求
4.  启动服务器

步骤一：导入http模块

const http = require("http");

步骤二：创建web服务器实例

const server = http.createServer();

步骤三：为服务器绑定**request**事件

//使用服务器实例的.on()方法，为服务器绑定一个request事件
    server.on("request", (req, res) => { 
    	// 只要有客户端来请求web服务器，就会触发request事件，从而调用request事件的处理函数
    	const url = req.url;
    	const method = req.method;
    	const str = `请求的url地址是：${ url}，请求的方法是：${ method}`;
    	res.setHeader("Content-Type","text/html;charset:utf-8");
    	res.end(str);
    });

回调函数中有两个参数，分别是`req`请求对象和`res`响应对象  
**req请求对象**，它包含了**客户端相关的数据和属性**，例如：

<table> 
 <thead> 
  <tr> 
   <th>属性</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>req.url</td> 
   <td>客户端请求的url地址</td> 
  </tr> 
  <tr> 
   <td>req.method</td> 
   <td>客户端请求的方法</td> 
  </tr> 
 </tbody> 
</table>

**res响应对象**，它包含了**服务器端相关的数据和属性**，例如：

<table> 
 <thead> 
  <tr> 
   <th>方法</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>res.end(data)</td> 
   <td>向客户端发送指定的数据，并结束这次处理请求</td> 
  </tr> 
 </tbody> 
</table>

注意：当响应内容含有中文字符时，可能会出现乱码，这时候需要手动设置内容的编码格式

// 防止中文显示乱码的问题
    // 可以设置响应头的Content-Type值为text/html，charset=utf-8
    res.setHeader("Content-Type","text/html;charsetutf-8");

步骤四：启动web服务器

//调用服务器实例的.listen(端口号, 回调)方法，即可启动服务器
    server.listen(80, () => { 
    	console.log("web server is running!");
    });

来看一下效果：  
![请求的效果][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NzU4NDUzNg_size_16_color_FFFFFF_t_70 4]

### 根据不同的url地址响应不同的html内容 ###

# 模块化 #

## 什么是模块化 ##

模块化是指解决一个复杂问题时，自顶向下逐层把系统划分为若干模块的过程。对于整个系统来说，模块是可组合、可分解和更换的单元。  
编程中的模块化：就是遵守固定的规则，把一个大文件拆成独立并相互依赖的多个小模块。  
优点：

*  提高了代码的复用性
 *  提高代码的可维护性
 *  可以实现按需加载

## 模块化规范 ##

模块化规范就是对代码进行模块化的拆分与组合时，需要遵守的那些规则。  
比如：需要使用什么样的语法格式来应用模块、在模块中以什么样的语法格式向外暴露成员。  
模块化规范的好处：当多人遵守同一套模块化规范开发时，能够极大降低沟通成本，极大方便的各模块之间的相互调用。

## Node.js中的模块分类 ##

Node.js模块根据来源不同，可分为三类：

<table> 
 <thead> 
  <tr> 
   <th>模块</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>内置模块</td> 
   <td>由Node.js官方提供，例如fs、path、http等</td> 
  </tr> 
  <tr> 
   <td>自定义模块</td> 
   <td>用户创建的每个js文件，都是自定义模块</td> 
  </tr> 
  <tr> 
   <td>第三方模块</td> 
   <td>由第三方开发出来的模块，需要下载使用</td> 
  </tr> 
 </tbody> 
</table>

## 如何加载模块 ##

使用强大的`require()`方法，可以加载需要的内置模块、用户自定义模块和第三方模块

// 加载内置模块
    const fs = require("fs");
    // 加载自定义模块
    const def = require("./def.js");
    // 加载第三方模块
    const moment = require("moment");

> 需要注意的是，当使用`require()`方法加载模块时，会执行被加载模块中的代码

## Node.js中的模块作用域 ##

和函数作用域类似，在自定义模块中定义的变量、方法等成员，只能在当前模块内访问，这种模块级别的访问限制，叫做**模块作用域**。模块作用域的好处是防止全局变量污染。

### 向外共享模块作用域的成员 ###

在每个.js自定义模块中都有一个`module`对象，它里面存储了和当前模块有关的信息，打印如下：  
![module对象][module]  
可以看到，这个`module`对象里面有一个`exports`属性，它是一个对象，初始是为空的。在自定义模块中，可以使用`module.exports`对象，将模块内的成员共享出去，供外界使用。外界用`require()`方法导入自定义模块时，得到的就是`module.exports`所指的对象。  
首先在自定义模块(module.js文件)上为`module.exports`对象挂载属性和方法

// module.js
    module.exports.username = "张三";
    module.exports.sayHello = () => { 
    	console.log("Hello!");
    }

然后在需要导入模块的文件上调用该方法

// test.js
    const md = require("./module.js");
    console.log(md.username);
    md.sayHello();

来看一下打印的结果  
![给module.exports对象挂载成员后调用的结果][module.exports]

#### exports对象 ####

由于`module.exports`对象书写比较复杂，Node.js提供了`exports`对象，这个对象等同于`module.exports`对象

console.log(module.exports === exports); //true

> 共享成员时需要注意的点：使用`require()`方法导入模块时，导入的结果，永远以`module.exports`指向的对象为准

那到底要怎么理解这个注意点呢？我们来看，当我们给`exports`对象挂载属性并且同时给`module.exports`对象挂载属性，看看是否会相等

// 在自定义模块module.js中，我们对外共享了如下属性
    // 给exports挂载
    exports.username = "小陈";
    // 给module.exports挂载
    module.exports = { gender: "男", age: 20};
    console.log(exports);
    console.log(module.exports);
    console.log(exports === module.exports);

然后我们在外部的test.js文件中导入我们自定义的模块module.js

const md = require("./module.js");
    // 顺便验证自定义模块中的成员是否被共享出去了
    console.log("是否有username属性：" + md.username);
    console.log("是否有gender属性：" + md.gender);

在执行test.js中的导入module.js模块时，会自动执行自定义模块里面的代码

node ./test.js

来看一看输出的结果  
![输出的结果][20210607161040421.png]  
可以看到，导入模块时的共享成员是以`module.exports`对象为准，所以我们尽量在模块中只使用`exports`对象或者只使用`module.exports`对象来向外共享成员

## Node.js中的模块化规范 ##

Node.js遵循了CommonJS模块化规范，CommonJS规定了模块的特性和各模块之间如何相互依赖。  
CommonJS规定：

*  每个模块内部，module变量就代表了当前变量
 *  module变量是一个对象，它的`exports`（或者`module.exports`）属性是对外的接口
 *  加载某个模块其实是加载该模块的`module.exports`属性。用`require()`方法来加载模块

# npm与包 #

## 包 ##

什么是包：Node.js中**第三方模块**又叫做包。

包的来源：不同于Node.js中的内置模块和自定义模块，包是由第三方个人或团队开发出来的，开源且免费供所有人使用。

为什么需要包：由于Node.js仅提供了一些底层的API，如果是基于内置模块开发项目时，效率会非常低。**包是基于内置模块开发出来的**，提供了更高级、更方便的API，极大提高了工作效率。

如何查找包：[点击这里进入全球最大的包共享平台][Link 1]

如何安装包：

npm i(install) 包名[@指定版本]

![安装成功][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NzU4NDUzNg_size_16_color_FFFFFF_t_70 5]  
然后就可以进入上面的网址去查找相应的官方文档去使用了

需要注意的是，第一次安装一个包时，在相应目录下生产一个`node_modules`文件夹和一个名为`package-lock`的json文件  
`node_modules文件夹`用来存放所有已安装到项目中的包，require()导入包时就是去这个目录里寻找并加载包  
`package-lock`文件用来记录每次下载包的信息

> 不要手动修改上述两个文件的信息，npm包管理工具会自动维护它们

如何卸载包：

npm uninstall [包名]

将包卸载后npm管理工具会自动将`package.json`中的`dependencies`节点中的相关信息也会清除

下载包速度很慢：使用国内淘宝NPM镜像服务器，切换npm的下包镜像源

方法一：

# 查看当前的下包镜像源
    npm config get registry
    # 将当前的下包镜像源切换到淘宝的镜像源
    npm config set registry=https://registry.npm.taobao.org/
    # 再次运行查看是否切换成功
    npm config get registry

方法二：利用nrm快速切换下包的镜像源

# 通过npm将nrm设置为全局可用的工具
    npm i nrm -g
    # 查看所有可用镜像源
    nrm ls
    # 将下包镜像源设置为淘宝镜像源
    nrm use taobao

## 一些好用的包 ##

### i5ting\_toc包 ###

i5ting\_toc包是一个可以将md文档转换为html页面的小工具  
使用教程：[i5ting\_toc包][i5ting_toc]

# 安装i5ting_toc包
    npm i i5ting_toc -g
    # 调用i5ting_toc包，将md文件转换为html，-o表示转换完成后自动打开转换后的html页面
    i5ting_toc -f [要转换的md文件路径] -o

## npm里面的包管理配置文件 ##

#### 记录项目中都安装了哪些包 ####

为了方便团队成员之间共享源代码，一般都是将`node_modules`文件夹添加到`.gitignore`文件中，再上传到github等平台上，这时候需要创建一个文件`package.json`来记录都安装过哪些包

在执行命令的目录下快速创建package.json文件

npm init -y

注意：

*  上述命令只能在英文目录中执行成功，不能包含空格
 *  运行npm install 命令安装包时，npm管理工具会自动将包的名称和版本号记录在package.json文件中

![刚开始创建后的样子][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NzU4NDUzNg_size_16_color_FFFFFF_t_70 6]  
之后再去安装第三方包时，就会产生一个新节点对象（**dependencies**）用于记录第三方包的名字以及版本号  
![添加第三方包后产生的新节点][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NzU4NDUzNg_size_16_color_FFFFFF_t_70 7]  
以后如果需要的话，只需将`package.json`这个文件复制到新别的文件夹中，再执行`npm install`命令即可一次性将全部的包下载至新文件夹中

#### devDependencies节点 ####

如果项目中某些包只是开发时会用到，上线后用不到，那么可以把这些包记录`devDependencies`节点中。如果开发到上线都用到了，则可以记录到`dependencies`节点中

如何判断要记录到哪一个节点：上官网查询相应的包

安装包并记录到`devDependencies`节点中：

npm i [包名] -D

## 包的规范 ##

在一个规范的包结构中，必须要符合以下3点要求：

*  每个包必须以单独的目录形式存在
 *  包的顶级目录下必须包含package.json这个包管理配置文件
 *  package.json中必须包含name(包名字)、version(版本号)、main(包入口)这三个属性

更多的约束可以参考以下网址：[https://yarnpkg.com/zh-Hans/docs/package-json][https_yarnpkg.com_zh-Hans_docs_package-json]

## 开发属于自己的包 ##

1.  创建一个文件夹作为包的根目录
2.  在根目录中，创建以下三个文件  
    package.json（包管理配置文件）  
    index.js（包的入口文件）  
    README.md（包的说明文档）

package.json要包含以下内容

{ 
    	"name":"package_name",
    	"version":"1.0.0",
    	"main":"index.js",
    	"description":"这里填写包的介绍信息",
    	"keywords":["myPackage","goodPackage"],
    	"license":"ISC"
    }

## 模块的加载机制 ##

外置模块会优先从缓存中加载，即加载执行了一次后，第二次再用require方法加载相同的模块，模块内部不会再次执行。

内置模块的加载优先级高于外置模块，即外置模块中如果有相同的名为fs的模块，require方法加载的仍然是内置的fs模块。

自定义模块的加载机制，需要以./或…/这样的路径标识符开头，否则会按照内置或第三方模块加载。

第三方模块的加载机制，如果在本目录中没有找到对应的第三方模块，则会向上一层到父目录中查找，直到文件系统的根目录（C盘符等）为止

[Node.js]: https://nodejs.org/zh-cn/
[20210604210841683.png]: /images/20221014/f84284b34e6e4d93acfaaaca0223d10f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NzU4NDUzNg_size_16_color_FFFFFF_t_70]: /images/20221014/a212a82669594d64b901948c4e14672f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NzU4NDUzNg_size_16_color_FFFFFF_t_70 1]: /images/20221014/f71529d8092d4f8a86abd10396a01085.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NzU4NDUzNg_size_16_color_FFFFFF_t_70 2]: /images/20221014/2805a23e6b97432e8afa1a3fd171ecf1.png
[20210604215801209.png]: /images/20221014/45e138d3077c4773b1ca56d78249836a.png
[20210604220135328.png]: /images/20221014/76ae624c08c34ff68245c45708070f8f.png
[20210604221244582.png]: /images/20221014/2070433416634483b4dfd663e2d72607.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NzU4NDUzNg_size_16_color_FFFFFF_t_70 3]: /images/20221014/a1931b72d51045349c1b0cdea4e80884.png
[err]: /images/20221014/89fe1587301e4a6ba04d52b732a214fe.png
[20210604232458560.png]: /images/20221014/31f2dff245304f9bb542e6252021f5d9.png
[20210604232757109.png]: /images/20221014/9f4a7774b4c44128b9a0fd4d2652a7cc.png
[20210604233146580.png]: /images/20221014/eb6566b727d84870a37777e0b1bdc9f3.png
[20210604234142595.png]: /images/20221014/9033fbf3468e4cf497d0ec906f1fbe0a.png
[20210604235145936.png]: /images/20221014/d68cd6b28b92413198246d7adf1a981c.png
[20210605163909925.png]: /images/20221014/db2a6419dc3e4688bc58fe05fb7281d6.png
[2]: /images/20221014/836786e30d764fd88b878377d54c6b83.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NzU4NDUzNg_size_16_color_FFFFFF_t_70 4]: /images/20221014/920fb926d9c546d0807ed49bcae26432.png
[module]: /images/20221014/86d8dd127de441d4ba6da0b42e2fefe3.png
[module.exports]: /images/20221014/7deff29cbf16401ba7f4670b64bb7de0.png
[20210607161040421.png]: /images/20221014/eb21e97c9d704516b99d818a062f0375.png
[Link 1]: https://www.npmjs.com/
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NzU4NDUzNg_size_16_color_FFFFFF_t_70 5]: /images/20221014/1862ffdb311b4bf79af97af49d2a047d.png
[i5ting_toc]: https://www.npmjs.com/package/i5ting_toc
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NzU4NDUzNg_size_16_color_FFFFFF_t_70 6]: /images/20221014/6fcc2e4ea13c490ab6382aca53dded21.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NzU4NDUzNg_size_16_color_FFFFFF_t_70 7]: /images/20221014/15e1aab9514e432fa55206d15936c67b.png
[https_yarnpkg.com_zh-Hans_docs_package-json]: https://yarnpkg.com/zh-Hans/docs/package-json