Node.js入门指南：从环境搭建到模块应用-优快云博客

本文链接：https://blog.youkuaiyun.com/qq_40046544/article/details/126701585

1、初识 Node.js

1.1 什么是 Node.js

Node.js 是一个基于 Chrome V8 引擎的 JavaScript 运行环境
浏览器是 JavaScript 的前端运行环境
Node.js 是 JavaScript 的后端运行环境
Node.js 中无法调用 DOM 和 BOM 等浏览器内置 API

1.2 Node.js 可以做什么

基于 Express 框架（http://www.expressjs.com.cn/），可以快速构建 Web 应用
基于 Electron 框架（https://electronjs.org/），可以构建跨平台的桌面应用
基于 restfy 框架（http://restify.com），可以快速构建 API 接口项目
读写和操作数据库，创建实用的命令行工具辅助前端开发

1.3 Node.js 环境的安装

如果想通过 Node.js 来运行 JavaScript 代码，则必须在计算机上安装 Node.js 环境才行
安装包可以从 Node.js 的官网首页直接下载，进入到 Node.js 的官网首页（https://nodejs.org/en/）进行下载安装

1.3.1 区分 LTS 版本和 Current 版本的不同

LTS 为长期稳定版，对于追求稳定性的企业项目来说，推荐安装 LTS 版本的 Node.js
Current 为新特性尝鲜版，对热衷于尝试新特性的用户来说，推荐安装 Current 版本的 Node.js。
但是，Current 版本中可能存在隐藏的 Bug 或安全性漏洞，因此不推荐在企业项目中使用 Current 版本的 Node.js

1.3.2 查看已安装的 Node.js 版本

打开终端，在终端输入命令 node -v 后，按下回车键，即可查看已安装的 Node.js 版本号

1.4 什么是终端

终端（英文： Terminal）是专门为开发人员设计的，用于实现人机交互的一种方式

终端快捷键：

使用 ↑ 键，可以快速定位到上一次执行的命令
使用 tab 键，能够快速补全路径
使用 esc 键，能够快速清空当前已输入的命令
输入 cls 命令，可以清空终端

2、fs 文件系统模块

2.1、什么是 fs 文件系统模块

fs 模块是 Node.js 官方提供的、用来操作文件的模块。他提供了一系列的方法和属性，用来满足用户对文件的操作需求。
fs.readFile()方法，用来读取指定文件的内容
fs.writeFile()方法，用来向指定的文件写入内容

# 如果要在 JavaScript 代码中，使用 fs 模块来操作文件，则需要先导入
const fs = require('fs')

2.2、读取指定文件中的内容

# 使用 fs.readFile() 方法，可以读取指定文件中的内容
fs.readFile(path[, options], callback)

参数解读：

参数 1：必选参数，表示文件的路径
参数 2：可选参数，表示以什么编码格式来读取文件
参数 3：必选参数，文件读取完成后，通过回调函数拿到读取的结果

示例代码：

const fs = require('fs');
fs.readFile('./test.txt', 'utf8', (err, result) => {
  if (err) {
    return console.log('文件读取失败！' + err.message);
  }
  console.log('文件读取成功，内容是：' + result)
})

2.3、向指定的文件中写入内容

# 使用 fs.writeFile() 方法，可以向指定的文件中写入内容
fs.writeFile(file, data[, options], callback)

参数解读：

参数 1：必选参数，需要指定一个文件路径的字符串，表示文件的存放路径
参数 2：必选参数，表示要写入的内容
参数 3：可选参数，表示以什么格式写入文件内容，默认值是 utf8
参数 4：必选参数，文件写入完成后的回调函数

示例代码：

const fs = require('fs');
fs.writeFile('./test.txt', 'Hello World', 'utf8', (err) => {
  if (err) {
    return console.log('文件写入失败！' + err.message);
  }
  console.log('文件写入成功！')
})

3、path 路径模块

3.1、什么是 path 路径模块

path 模块是 Node.js 官方提供的、用来处理路径的模块。它提供了一系列的方法和属性，用来满足用户对路径的处理需求。
path.join() 方法，用来将多个路径片段拼接成一个完整的路径字符串
path.basename() 方法，用来从路径字符串中，将文件名解析出来

3.2、路径拼接

# 使用 path.join() 方法，可以把多个路径片段拼接为完整的路径字符串
path.join([...paths])

参数解读：

参数 1：...paths<string>路径片段的序列
返回值：<string>

示例代码：

const pathStr = path.join('/a', '/b');
console.log(pathStr); // 输出 \a\b

const str = path.join(__dirname, './test.txt');
console.log(str); // 输出 当前文件所处目录\test.txt

3.3、path.basename() 的语法格式

# 使用 path.basename() 方法，可以获取路劲中的最后一部分，经常通过这个方法获取路径中的文件名

参数解读：

参数 1：path<string>必选参数，表示一个路径的字符串
ext<string> 可选参数，表示文件扩展名
返回值：<string>表示路径中的最后一部分

示例代码：

const fpath = '/a/b/c/index.html'; // 文件的存放路径

const fullName = path.basename(fpath)
console.log(fullName); // 输出 index.html

const name = path.basename(fpath, '.html');
console.log(name); // 输出 index

3.4、获取路径中的文件扩展名

# 使用 path.extname() 方法，可以获取路径中的扩展名部分
path.extname(path);

参数解读：

参数 1：path<string>必选参数，表示一个路径的字符串
返回值：<string>返回得到的扩展名字符串

示例代码：

const fpath = '/a/b/c/index.html'; // 文件的存放路径

const fext = path.extname(fpath)

console.log(fext); // 输出 .html

4、http 模块

4.1、什么是 http 模块

http 模块是 Node.js 官方提供的，用来创建 web 服务器的模块。
通过 http 模块提供的 http.createServer()方法，就能方便的把一台普通的电脑，变成一台 WEB 服务器，从而对外提供 Web 资源服务

4.2、http 模块的作用

服务器和普通电脑的区别在于，服务器上安装了 web 服务器软件，例如：IIS、Apache 等。
通过安装这些服务器软件，就能把一台普通的电脑变成一台 web 服务器。
在 Node.js 中，不需要使用 IIS、Apache 等这些第三方 web 服务器软件。
可以基于 Node.js 提供的 http 模块，通过几行简单的代码，就能轻松的手写一个服务器软件，从而对外提供 web 服务

4.3、服务器相关的概念

4.3.1 IP 地址

IP 地址就是互联网上每台计算机的唯一地址，因此 IP 地址具有唯一性。如果把个人电脑比作一台电话，那么 IP 地址就相当于电话号码，只有在知道对方 IP 地址的前提下，才能与对应的电脑之间进行数据通信
IP 地址的格式：通常用点分十进制表示（a.b.c.d）的形式，其中，a,b,c,d 都是 0 ~ 255 之间的十进制整数。
互联网中每台 Web 服务器，都有自己的 IP 地址
在开发期间，自己的电脑既是一台服务器，也是一个客户端。

4.3.2 域名和域名服务器

尽管 IP 地址能够唯一的标记网络上的计算机，但 IP 地址是一长串数字，不直观，而且不便于记忆，于是人们发明了另一套字符型的地址方案，即所谓的域名（Domain Name）地址
IP 地址和域名是一一对应的关系，这份对应关系存放在一种叫做域名服务器（DNS, Domain name server）的电脑中。使用者只需通过好记的域名访问对应的服务器即可，对应的转换工作由域名服务器实现。因此，域名服务器就是提供 IP 地址和域名之间的转换服务的服务器

4.3.3 端口号

一台电脑中，可以运行成百上千个 web 服务器。每个 web 服务都对应一个唯一的端口号。客户端发送过来的网络请求，通过端口号，可以被准确地交给对应地 web 服务进行处理

4.4、创建 web 服务器地基本步骤

# 步骤1 - 导入 http 模块
const http = require('http');

# 步骤2 - 创建 web 服务器实例
const server = http.createServer();

# 步骤3 - 为服务器实例绑定 request 事件
server.on('request', (req, res) => {
  # 只要有客户端请求服务器，就会触发 request 事件
})

# 步骤4 - 启动服务器
server.listen(80, () => {
  console.log('http server running at http://127.0.0.1')
})

4.4.1 req 请求对象和 res 响应对象

# 只要服务器接收到了客户端地请求，就会调用通过 server.on() 为服务器绑定 request 事件处理函数

server.on('request', (req) => {
  // req.url 是客户端请求地 URL 地址
  // req.method 是客户端地 method 请求类型
  const str = `Your request url is ${ req.url }, and request method is ${ req.method }`;
  console.log(str)
  // res.end() 方法地作用：向客户端发送指定地内容，并结束这次请求的处理过程
  res.end(str)
})

4.4.2 解决中文乱码问题

# 当调用 res.end() 方法，向客户端发送中文内容地时候，会出现乱码问题，需要手动设置内容地编码格式
server.on('request', (req, res) => {
  // 发送地内容包含中文
  const str = `您请求的 url 地址是 ${ req.url }, 请求的 method 类型是 ${ req.method }`;
  // 为了防止中文显示乱码的问题，需要设置响应头 Content-Type 的值为 text/html; charset=utf8
  res.setHeader('Content-Type', 'text/html; charset=utf-8');
  // 把包含中文的内容，响应给客户端
  res.end(str);
})

4.5、根据不同的 url 响应不同的 html 内容

server.on('request', (req, res) => {
  // 获取请求的 url 地址
  const url = req.url;
  // 设置默认的内容为 404 Not found
  let content = '<h1>404 Not found!</h1>';
  if (url === '/' || url === '/index.html') {
    // 用户请求的是首页
    content = '<h1>首页</h1>';
  } else if (url === 'about.html') {
    // 用户请求的是关于页面
    content = '<h1>关于页面</h1>';
  }
  res.setHeader('Content-Type', 'text/html; charset=utf-8');
  res.end(content);
})

5、模块化的基本概念

5.1、什么是模块化

模块化是指解决一个复杂问题时，自顶向下逐层把系统划分成若干模块的过程。对于整个系统来说，模块是可组合、分解和更换的单元。
编程领域中的模块化，就是遵守固定的规则，把一个大文件拆分成独立并互相依赖的多个小模块
模块化开发提高了代码的复用性、可维护性、按需加载和降低沟通的成本

5.2、Node.js 中模块的分类

内置模块（内置模块是由 Node.js 官方提供的，例如 fs、path、http）
自定义模块（用户创建的每个 .js 文件，都是自定义模块）
第三方模块（由第三方开发出来的模块，并非官方提供的内置模块，也不是用户创建的自定义模块，使用前需要先下载）

5.3、加载模块

# 使用强大的 require() 方法，可以加载需要的内置模块、用户自定义模块、第三方模块
# 加载内置的 fs 模块
const path = require('fs');

# 加载用户的自定义模块
const index = require('./index.js');

# 加载第三方模块
const moment = require('moment')

5.4、Node.js 中的模块作用域

5.4.1 什么是模块作用域

和函数作用域类似，在自定义模块中定义的变量、方法等成员，只能在当前模块内被访问，这种模块级别的访问限制，叫做模块作用域

模块作用域可以有效防止全局变量污染的问题

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

在每个 .js 自定义模块中都有一个 module 对象，它里面存储了和当前模块有关的信息
在自定义模块中，可以使用 module.exports 对象，将模块内的成员共享出去，供外界使用
外界用 require() 方法导入自定义模块时，得到的就是 module.exports 所指向的对象
使用 require() 方法导入模块时，导入结果，永远以 module.exports 指向的对象为准
由于 module.exports 单词写起来比较复杂，为了简化向外共享的代码，Node 提供了 exports 对象
默认情况下，exports 和 module.exports 指向同一个对象。最终共享的结果，还是以 module.exports 指向的对象为准

5.5、Node.js 中的模块化规范

每个模块内部，module 变量代表当前模块
module 变量是一个对象，他的 exports 属性是对外的接口
加载某个模块，其实是加载该模块的 module.exports 属性。require() 方法用于加载模块

6、npm 与包

6.1、什么是包

Node.js 中的第三方模块又叫做包
就像电脑和计算机指的是相同的东西，第三方模块和包值得是同一个概念，只不过叫法不同

6.2、包的来源

不同于 Node.js 中的内置模块与自定义模块，包是由第三方个人或团队开发出来的，免费供所有人使用
Node.js 中的包都是免费且开源的，不需要付费即可免费下载使用

6.3、为什么需要包

由于 Node.js 的内置模块仅提供了一些底层的 API，导致在基于内置模块进行项目开发时，效率很低

包是基于内置模块封装出来的，提高了更高级、更方便的 API，极大的提高了开发效率
包和内置模块之间的关系，类似于 jQuery 和浏览器内置 API 之间的关系

6.4、包从哪里下载

https://www.npmjs.com/，他是全球最大的包共享平台，你可以从这个网站上搜索到任何你需要的包
https://registry.npmjs.org/，对外共享所有的包，我们可以从这个服务器上下载所需要的包

6.5、在项目中安装包

# 在项目中安装指定名称的包
npm install 包的完整名称

# 简写形式
npm i 完整包的名称

# 安装指定版本的包
npm i moment@2.22.2

6.6、包管理配置文件

npm 规定，在项目根目录中，必须提供一个叫做 package.json 的包管理配置文件。用来记录与项目有关的一些配置信息
项目的名称、版本号、描述等
项目中都用了哪些包
哪些包只在开发期间会用到
哪些包在开发和部署时都需要用到

# npm 包管理工具提供了一个快捷命令，可以在执行命令时所处的目录中，快速创建 package.json
npm init -y

# 上述命令只能在英文的目录下成功运行！所以，项目文件夹的名称一定要使用英文命名，不要使用中文，不能出现空格
# 运行 npm install 命令安装包的时候，npm 包管理工具会自动把包的名称和版本号，记录到 package.json 中

6.6.1 dependencies 节点

package.json 文件中，有一个 dependencies 节点，专门用来记录 npm install 命令安装了哪些包

6.6.2 一次性安装所有的包

# 运行 npm install 或 npm i 一次性安装所有的依赖包
npm install
npm i

6.6.3 卸载包

# 运行 npm uninstall 命令卸载指定的包

6.6.4 devDependencies 节点

如果某些包只在项目开发阶段会用到，在项目上线之后不会用到，则建议把这些包记录到 devDependencies 节点中
如果某些包在开发和项目上线之后都需要用到，则建议把这些包记录到 dependencies 节点中

# 安装指定的包，并记录到 devDependencies 节点中
npm i 包名 -d
# 上述命令是简写形式，等价于下面的完整写法
npm install 包名 --save-dev

6.7、解决下包速度慢的问题

# 查看当前的下包镜像源
npm config get registry

# 将下包的镜像切换为淘宝镜像源
npm config set registry=https://registry.npm.taobao.org/

# 检查镜像源是否下载成功
npm config get registry

6.8、包的分类

6.8.1 项目包

被安装到项目的 node_modules 目录中的包，都是项目包
项目包又分为两类：

开发依赖包（被记录到 devDependencies 节点中的包，只会在开发期间会用到）
核心依赖包（被记录到 dependencies 节点中的包，在开发期间和项目上线之后都会用到）

6.8.2 全局包

# 在执行 npm install 命令时，如果提供了 -g 参数，则会把包安装为全局包
npm i 包名 -g # 全局安装指定的包
npm uninstall 包名 -g # 卸载全局安装的包

只有工具性质的包，才有全局安装的必要性。因为它们提供了好用的终端命令
判断某个包是否需要全局安装后才能使用，可以参考官方安装说明

6.9、包的结构

包必须以单独的目录而存在
包的顶级目录下要必须包含 package.json 这个包管理配置文件
package.json 中必须包含 name, version, main 这三个属性，分别代表包的名字、版本号、包的入口

6.10、发布自己开发的包

可以在终端中执行 npm login 命令，依次输入用户名、密码、邮箱后，即可登录成功

在运行 npm login 命令之前，必须先把下包的服务器地址切换为 npm 的官方服务器，否则会导致发布包失败
运行 npm publish 命令，即可将包发布到 npm 上
运行 npm unpublish 包名 --force 命令，即可从 npm 删除已发布的包
npm unpublish 命令只能删除 72 小时以内发布的包
npm unpublish 删除的包，在 24 小时内不允许重复发布

7、加载机制

7.1、优先从缓存中加载

模块在第一次加载后会被缓存。这也意味着多次调用 require() 不会导致模块的代码被执行多次
不论是内置模块、用户自定义模块、还是第三方模块，它们都会优先从缓存中加载，从而提高模块的加载效率

7.2、内置模块的加载机制

内置模块是由 Node.js 官方提供的模块，内置模块的加载优先级最高
require(‘fs’) 始终返回内置的 fs 模块，即使在 node_modules 目录下有相同名字的包也叫 fs

7.3、自定义模块的加载机制

使用 require() 加载自定义模块时，必须指定以 ./ 或 ../ 开头的路径标识符。在加载自定义模块时，如果没有指定 ./ 或 ../ 这样的路径标识符，则 node 会把它当作内置模块或第三方模块进行加载。

同时，在使用 require() 导入自定义模块时，如果省略了文件的扩展名，则 Node.js 会按顺序分别尝试加载以下的文件：

按照确切的文件名进行加载
补全 .js 扩展名进行加载
补全 .json 扩展名进行加载
补全 .node 扩展名进行加载
加载失败，终端报错

7.4、第三方模块的加载机制

如果传递给 require() 的模块标识符不是一个内置模块，也没有以 ./ 或 ../ 开头，则 Node.js 会从当前模块的父目录开始，尝试从 /node_modules 文件夹中加载第三方模块
如果没有找到对应的第三方模块，则移动到再上一层父目录中，进行加载，直到文件系统的根目录

7.5、目录作为模块

在被加载的目录下查找一个叫做 package.json 的文件，并寻找 main 属性，作为 require() 加载的入口
如果目录里没有 package.json 文件，或者 main 入口不存在或无法解析，则 Node.js 将会试图加载目录下的 index.js 文件
如果以上两步都失败了，则 Node.js 会在终端打印错误消息，报告模块的确实：Error: Cannot find module ‘xxx’