Node.js模块加载及第三方包的使用--学习笔记

一、Node.js模块化开发

1.1 JavaScript开发弊端

javaScript在使用时存在两大问题，文件依赖和命名冲突。

1.2 软件中的模块化开发

一个功能就是一个模块，多个模块可以组成完整应用，抽离一个模块不会影响其他功能的运行。

1.3 Node.js中模块化开发规范

Node.js规定一个JavaScript文件就是一个模块，模块内部定义的变量和函数默认情况下在外部无法得到
模块内部可以使用exports对象进行成员导出， 使用require方法导入其他模块。
例如：将a.js里的成员导出给b.js导入使用

• 模块成员的，a.js里的导出成员

// a.js
  // 在模块内部定义变量
 let version = 1.0;
 // 在模块内部定义方法
 const sayHi = name => `您好, ${name}`;
 // 向模块外部导出数据  exports 关键字
 exports.version = version;
 exports.sayHi = sayHi;

• 模块成员的导入

 // b.js
  // 在b.js模块中导入模块a，  require关键字
 let a = require('./b.js');
  // 输出b模块中的version变量
 console.log(a.version);
  // 调用b模块中的sayHi方法 并输出其返回值
 console.log(a.sayHi('我用到了你啦')); 

1.4 模块成员导出的另一种方式

module.exports.version = version;
module.exports.sayHi = sayHi;

exports是module.exports的别名(地址引用关系)，导出对象最终以module.exports为准

二、系统模块

2.1 什么是系统模块

Node运行环境提供的API. 因为这些API都是以模块化的方式进行开发的, 所以我们又称Node运行环境提供的API为系统模块。

2.2 系统模块fs 文件操作

读取文件内容
fs.reaFile(‘文件路径/文件名称’[,‘文件编码’], callback);

• 写入文件内容
  fs.writeFile(‘文件路径/文件名称’, ‘数据’, callback);

// 1.通过模块的名字fs对模块进行引用
const fs = require('fs');

// 2.通过模块内部的readFile读取文件内容
fs.readFile('./01.helloworld.js', 'utf8', (err, doc) => {
	// 如果文件读取出错err 是一个对象 包含错误信息
	// 如果文件读取正确 err是 null
	// doc 是文件读取的结果
	console.log(err);   //null
	console.log(doc);
});

fs.writeFile('./demo.txt', '即将要写入的内容', err => {
	if (err != null) {
		console.log(err);
		return;
	}
	console.log('文件内容写入成功');
})
 

2.3 系统模块path 路径操作

• 为什么要进行路径拼接

不同操作系统的路径分隔符不统一

• 路径拼接语法
  path.join(‘路径’, ‘路径’, …）

 // 导入path模块
 const path = require('path');
  // 路径拼接
 let finialPath = path.join('itcast', 'a', 'b', 'c.css');
  // 输出结果 itcast\a\b\c.css
 console.log(finialPath);

2.4 相对路径VS绝对路径

大多数情况下使用绝对路径，因为相对路径有时候相对的是命令行工具的当前工作目录
在读取文件或者设置文件路径时都会选择绝对路径
使用 _dirname获取当前文件所在的绝对路径

 // 导入path模块
const path = require('path');

console.log(__dirname); //_dirname获取当前文件所在的绝对路径
console.log(path.join(__dirname, '01.helloworld.js')) // 路径拼接

三、第三方模块

3.1 什么是第三方模块

别人写好的、具有特定功能的、我们能直接使用的模块即第三方模块，由于第三方模块通常都是由多个文件组成并且被放置在一个文件夹中，所以又名包。

3.2 第三方模块有两种存在形式

以js文件的形式存在，提供实现项目具体功能的API接口。
以命令行工具形式存在，辅助项目开发

3.3 获取第三方模块

• npmjs.com：第三方模块的存储和分发仓库

• npm (node package manager) ： node的第三方模块管理工具
  下载：npm install 模块名称
  卸载：npm unintall package 模块名称

• 全局安装与本地安装
  命令行工具：全局安装
  库文件：本地安装

3.4 第三方模块 nodemon

nodemon是一个命令行工具，用以辅助项目开发。
在Node.js中，每次修改文件都要在命令行工具中重新执行该文件，非常繁琐。
修改保存时自动执行，不用再用node命令执行，crt+c退出命令。

• 使用步骤
  使用npm install nodemon –g 下载它
  在命令行工具中用nodemon命令替代node命令执行文件
  

3.5 第三方模块 nrm

nrm ( npm registry manager )：npm下载地址切换工具
npm默认的下载地址在国外，国内下载速度慢，提高
使用步骤
使用npm install -g nrm 下载它
查询可用下载地址列表 nrm ls
切换npm下载地址 nrm use 下载地址名称

四、package.json文件

4.1 node_modules文件夹的问题

文件夹以及文件过多过碎，当我们将项目整体拷贝给别人的时候,，传输速度会很慢很慢.
复杂的模块依赖关系需要被记录，确保模块的版本和当前保持一致，否则会导致当前项目运行报错.

4.2 package.json文件的作用

项目描述文件，记录了当前项目信息，例如项目名称、版本、作者、github地址、当前项目依赖了哪些第三方模块等。
使用npm init -y命令生成。

4.3 项目依赖

在项目的开发阶段和线上运营阶段，都需要依赖的第三方包，称为项目依赖
使用npm install 包名命令下载的文件会默认被添加到 package.json 文件的 dependencies 字段中。

4.4 开发依赖

在项目的开发阶段需要依赖，线上运营阶段不需要依赖的第三方包，称为开发依赖
使用npm install 包名 --save-dev命令将包添加到package.json文件的devDependencies字段中。

4.5 package-lock.json文件的作用

锁定包的版本，确保再次下载时不会因为包版本不同而产生问题
加快下载速度，因为该文件中已经记录了项目所依赖第三方包的树状结构和包的下载地址，重新安装时只需下载即可，不需要做额外的工作.
当你执行npm install的时候，node会先从package.json文件中读取所有dependencies信息，下载node_modules中的模块。

五、 Node.js中模块加载机制

5.1 模块查找规则-当模块拥有路径但没有后缀时

require('./find.js');
require('./find');

规则：

1. require方法根据模块路径查找模块，如果是完整路径，直接引入模块。
2. 如果模块后缀省略，先找同名JS文件再找同名JS文件夹
3. 如果找到了同名文件夹，找文件夹中的index.js
4. 如果文件夹中没有index.js就会去当前文件夹中的package.json文件中查找main选项中的入口文件
5. 如果找指定的入口文件不存在或者没有指定入口文件就会报错，模块没有被找到

5.2 模块查找规则-当模块没有路径且没有后缀时

require('find');

规则：

1. Node.js会假设它是系统模块
2. Node.js会去node_modules文件夹中
3. 首先看是否有该名字的JS文件
4. 再看是否有该名字的文件夹
5. 如果是文件夹看里面是否有index.js
6. 如果没有index.js查看该文件夹中的package.json中的main选项确定模块入口文件
   否则找不到报错