Node.js常用模块详解

后端 Node.js

后端开发

发布日期: 2023-06-27

更新日期: 2023-08-26

文章字数: 4.9k

阅读时长: 21 分

阅读次数:

Buffer（缓冲器）

概念

Buffer 是一个类似于数组的 对象 ，用于表示固定长度的字节序列

Buffer 本质是一段内存空间，专门用来处理 二进制数据 。

特点

Buffer 大小固定且无法调整
Buffer 性能较好，可以直接对计算机内存进行操作
每个元素的大小为 1 字节（byte）

使用

创建Buffer

Node.js 中创建 Buffer 的方式主要如下几种：

Buffer.alloc

// 创建了一个长度为 10 字节的 Buffer，相当于申请了 10 字节的内存空间，每个字节的值为 0
let buf_1 = Buffer.alloc(10) //=>结果为<Buffer 00 00 00 00 00 00 00 00 00 00>

Buffer.allocUnsafe

// 创建了一个长度为 10 字节的 Buffer，buffer 中可能存在旧数据，可能会影响执行结果，所以叫 unsafe ，但是效率比 alloc 高
let buf_2 = Buffer.allocUnsafe(10)

Buffer.from

// 通过字符串创建 Buffer
let buf_3 = Buffer.from('hello')
// 通过数组创建 Buffer
let buf_4 = Buffer.from([105, 108, 111, 118, 101, 121, 111, 117])

Buffer与字符串的转化

我们可以借助 toString 方法将 Buffer 转为字符串

let buf_4 = Buffer.from([105, 108, 111, 118, 101, 121, 111, 117])
console.log(buf_4.toString()) //=>iloveyou

**注意: **toString 默认是按照 utf-8 编码方式进行转换的

Buffer 的读写

Buffer 可以直接通过 [] 的方式对数据进行处理。

let buf_3 = Buffer.from('hello')
// 读取
console.log(buf_3[1]) //=>101
// 修改
buf_3[1] = 97
//查看字符串结果
console.log(buf_3.toString()) //=>hallo

注意:

如果修改的数值超过 255 ，则超过 8 位数据会被舍弃

一个 utf-8 的字符一般占3个字节

fs模块

fs 全称为 file system ，称之为 文件系统 ，是 Node.js 中的 内置模块 ，可以对计算机中的磁盘进行操作。

本章节会介绍如下几个操作：

文件写入
文件读取
文件移动与重命名
文件删除
文件夹操作
查看资源状态

文件写入

文件写入就是将数据保存到文件中，我们可以使用如下几个方法来实现该效果

方法	说明
writeFile	异步写入
writeFileSync	同步写入
appendFile / appendFileSync	追加写入
createWriteStream	流式写入

writeFile 异步写入

语法： fs.writeFile(file, data[, options], callback)

参数说明：

file 文件名
data 待写入的数据
options 选项设置 （可选）
callback 写入回调

返回值： undefined

代码示例：

// require 是 Node.js 环境中的 '全局' 变量，用来导入模块
const fs = require('fs')

// 将 [三人行，必有我师焉。] 写入到当前文件夹下的 [座右铭.txt] 文件中
fs.writeFile('./座右铭.txt', '三人行，必有我师焉。', err =>{
    // 如果写入失败，则回调函数调用时，会传入错误对象，如写入成功，会传入 null
    if(err){
        console.log(err)
        return
    }
    console.log('写入成功')  
})

writeFileSync 同步写入

语法: fs.writeFileSync(file, data[, options])

参数与 fs.writeFile 大体一致，只是没有 callback 参数

返回值：undefined

代码示例：

try{
    fs.writeFileSync('./座右铭.txt', '三人行，必有我师焉。')
}catch(e){
    console.log(e)
}

Node.js 中的磁盘操作是由其他 线程 完成的，结果的处理有两种模式:

同步处理 JavaScript 主线程 会等待 其线程的执行结果，然后再继续执行主线程的代码，效率较低

异步处理 JavaScript 主线程 不会等待 其线程的执行结果，直接执行后续的主线程代码，效率较好

appendFile / appendFileSync 追加写入

appendFile 作用是在文件尾部追加内容，appendFile 语法与 writeFile 语法完全相同

语法:

fs.appendFile(file, data[, options], callback)
fs.appendFileSync(file, data[, options])

返回值：二者都为 undefined

实例代码：

fs.append('./座右铭.txt', '则其善者而从之，其不善者而改之。', err =>{
    if(err) throw err
    console.log('追加成功')
})

fs.appendFileSync('./座右铭.txt','\r\n温故而知新，可以为师矣')

createWriteStream 流式写入

语法：fs.createWriteStream(path[, options])

参数说明：

path 文件路径
options 选项配置（ 可选 ）

**返回值: **Object

代码示例：

let ws = fs.createWriteStream('./观书有感.txt')

//写入数据到流
ws.write('半亩方塘一鉴开\r\n')
ws.write('天光云影共徘徊\r\n')
ws.write('问渠那得清如许\r\n')
ws.write('为有源头活水来\r\n')

//关闭写入流，表明已没有数据要被写入可写流
ws.end()

程序打开一个文件是需要消耗资源的，流式写入可以减少打开关闭文件的次数。

流式写入方式适用于大文件写入或者频繁写入的场景，writeFile适合于写入频率较低的场景

写入文件的场景

文件写入 在计算机中是一个非常常见的操作，下面的场景都用到了文件写入

下载文件
安装软件
保存程序日志，如 Git
编辑器保存文件
视频录制

当需要持久化保存数据的时候，应该想到 文件写入

文件读取

文件读取顾名思义，就是通过程序从文件中取出其中的数据，我们可以使用如下几种方式：

方法	说明
readFile	异步读取
readFileSync	同步读取
createReadStream	流式读取

readFile 异步读取

语法: fs.readFile(path[, options], callback)

参数说明：

path 文件路径
options 选项配置
callback 回调函数

返回值： undefined

代码示例：

// 导入 fs 模块

fs.readFile('./座右铭.txt', (error,data) =>{
    if(err) throw err
    console.log(data)
})

fs.readFile('./座右铭.txt', 'uft-8', (error,data) =>{
    if(err) throw err
    console.log(data)
})

readFileSync 同步读取

语法：fs.readFileSync(path[, options])

参数说明：

path 文件路径
options 选项配置

返回值：string | Buffer

代码示例：

let data = fs.readFileSync('./座右铭.txt')
let data = fs.readFileSync('./座右铭.txt', 'utf-8')

createReadStream 流式读取

语法：fs.createReadStream(path[, options])

参数说明：

path 文件路径
options 选项配置（ 可选 ）

返回值：Object

代码示例：

// 创建读取流对象
let rs = fs.createReadStream('./观书有感.txt')

// 每次取出 64k 数据后执行一次 data 回调
// 绑定一个 data 事件  chunk 块儿  大块儿
re.on('data', chunk =>{
    console.log(chunk)
    console.log(chunk.length)
})

// 读取完毕后，执行 end 回调 (可选事件)
re.on('end', () =>{
    console.log('读取完毕')
})

文件移动与重命名

在 Node.js 中，我们可以使用 rename 或 renameSync 来移动或重命名 文件或文件夹

语法：

fs.rename(oldPath, newPath, callback)
fs.renameSync(oldPath, newPath)

参数说明：

oldPath 文件当前的路径
newPath 文件新的路径
callback 操作后的回调

代码示例：

fs.rename('./观书有感.txt', './论语/观书有感.txt', err =>{
	if(err) throw err
    console.log('移动完成')
})

fs.renameSync('./座右铭.txt', './论语/.我的座右铭.txt')

注: 如果还是移动到当前路径，但是修改了名字，就是重命名了

文件删除

在 Node.js 中，我们可以使用 unlink 或 unlinkSync 来删除文件

语法:

fs.unlink(path, callback)
fs.unlinkSync(path)

参数说明：

path 文件路径
callback 操作后的回调

代码示例：

const fs = require('fs')

fs.unlink('./test.txt', err =>{
    if(err) throw err
    console.log('删除成功')
})

fs.unlinkSync('./test2.txt')


// 调用 rm 方法  14.4   同步 rmSync
fs.rm('./论语.txt', err => {
  if (err) {
    console.log('删除失败')
    return

  }
  console.log('删除成功')
})

文件夹操作

借助 Node.js 的能力，我们可以对文件夹进行 创建 、读取 、删除 等操作

方法	说明
mkdir / mkdirSync	创建文件夹
readdir / readdirSync	读取文件夹
rmdir / rmdirSync	删除文件夹

mkdir 创建文件夹

在 Node.js 中，我们可以使用 mkdir 或 mkdirSync 来创建文件夹

语法:

fs.mkdir(path[, options], callback)
fs.mkdirSync(path[, options])

参数说明：

path 文件夹路径
options 选项配置（ 可选 ）
callback 操作后的回调

示例代码：

// 异步创建文件夹  mk  make  制作   dir  directory  文件夹
fs.mkdir('./page', err =>{
    if(err) throw err
    console.log('创建成功')
})

// 递归异步创建
fs.mkdir('./1/2/3', {recursive: true}, err =>{
    if(err) throw err
    console.log('递归创建成功')
})

// 递归同步创建文件夹
fs.mkdirSync('./x/y/z', {recursive: true})

readdir 读取文件夹

在 Node.js 中，我们可以使用 readdir 或 readdirSync 来读取文件夹

语法：

fs.readdir(path[, options], callback)
fs.readdirSync(path[, options])

参数说明：

path 文件夹路径
options 选项配置（ 可选 ）
callback 操作后的回调

示例代码：

// 异步读取
fs.readdir('./论语', (err, data) => {
	if(err) throw err
    console.log(data)
})
// 同步读取 
let data = fs.readdirSync('./论语')
console.log(data)

rmdir 删除文件夹

在 Node.js 中，我们可以使用 rmdir 或 rmdirSync 来删除文件夹

语法：

fs.rmdir(path[, options], callback)
fs.redirSync(path[, options])

参数说明：

path 文件夹路径
options 选项配置（可选）
callback 操作后的回调

示例代码：

// 异步删除文件夹  rm  remove 移除
fs.rmdir('./page', err => {
    if(err) throw err
    console.log('删除成功')
})
//异步递归删除文件夹  不推荐
//=>DeprecationWarning: In future versions of Node.js, fs.rmdir(path, { recursive: true }) will be removed. Use fs.rm(path, { recursive: true }) instead
fs.rmdirSync('./1', {recursive: true}, err => {
    if(err){ 
    	console.log(err)
        return
    }
    console.log('递归删除')
})
//同步递归删除文件夹
fs.rmdirSync('./x', {recursive: true})

// 建议使用
fs.rm('./a', { recursive: true }, err => {
  if (err) {
    console.log(err)
    return
  }
  console.log('删除成功')
})

查看资源状态

在 Node.js 中，我们可以使用 stat 或 statSync 来查看资源的详细信息

语法：

fs.stat(path[, options], callback)
fs.statSync(path[, options])

参数说明：

path 文件夹路径
options 选项配置（可选）
callback 操作后的回调

示例代码：

// 异步获取状态
// stat  方法  status 缩写 状态
fs.stat('/data.txt', (err, data) =>{
    if(err) throw err
    console.log(data)
})
// 同步获取状态
let data = fs.statSync('./data.txt')

结果值对象结构：

size 文件体积
birthtime 创建时间
mtime 最后修改时间
isFile 检测是否为文件
isDirectory 检测是否为文件夹
…

相对路径问题

fs 模块对资源进行操作时，路径的写法有两种：

相对路径
- ./座右铭.txt 当前目录下的座右铭.txt
- 座右铭.txt 等效于上面的写法
- ../座右铭.txt 当前目录的上一级目录中的座右铭.txt
绝对路径
- D:/Program Files windows 系统下的绝对路径
- /user/bin Linux 系统下的绝对路径

相对路径中所谓的 当前目录 ，指的是 命名行的工作目录 ，而并非是文件的所在目录

所以当命名行的工作目录与文件所在目录不一致时，会出现一些 Bug

_dirname

__dirname 与 require 类似，都是 Node.js 环境中的 ‘全局’ 变量

__dirname 保存着当前文件夹所在目录的绝对路径，可以使用 __dirname 与文件名拼接成绝对路径

代码示例:

//=>__dirname + '/data.txt'  === 'D:\\Desktop\\Node\\code\\03-fs模块/data.txt'
let data = fs.readFileSync(__dirname + '/data.txt')
console.log(data)

使用 fs 模块的时候，尽量使用 __dirname 路径转换为绝对路径，这样可以避免相对路径产生的 Bug

path模块

path 模块提供了 操作路径 的功能，我们将介绍如下几个较为常用的几个 API：

API	说明
path.resolve	拼接规范的绝对路径 `常用`
path.sep	获取操作系统的路径分隔符
path.parse	解析路径并返回对象
path.basename	获取路径的基础名称
path.dirname	获取路径的目录名
path.extname	获得路径的扩展名

代码示例：

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

// 写入文件
// fs.writeFileSync(__dirname + '/index.html', 'love')
console.log(__dirname + '/index.html') //=>D:\Desktop\Node\code\04-path/index.html

// resolve 解决问题  拼接绝对路径
console.log(path.resolve(__dirname, './index.html')) //=>D:\Desktop\Node\code\04-path\index.html
console.log(path.resolve(__dirname, 'index.html')) //=>D:\Desktop\Node\code\04-path\index.html
console.log(path.resolve(__dirname, '/index.html', './test')) //=>D:\index.html\test

// sep 获取路径分隔符
console.log(path.sep) //=> window \  linux /

// parse 方法  __filename  '全局变量'
console.log(__filename) //=>文件的绝对路径 //=>D:\Desktop\Node\code\04-path\01-path.js
// 解析路径
let str = 'D:\\Desktop\\Node\\code\\04-path\\01-path.js'
console.log(path.parse(str))

// 获取路径基础名称
console.log(path.basename(pathname))

// 获取路径的目录名
console.log(path.dirname(pathname))

// 获取路径的拓展名
console.log(path.extname(pathname))

http模块

创建 HTTP 服务

使用 nodejs 创建 HTTP 服务

操作步骤

//1. 导入 http 模块
const http = require('http');


//2. 创建服务对象 create 创建 server 服务
// request 意为请求. 是对请求报文的封装对象, 通过 request 对象可以获得请求报文的数据
// response 意为响应. 是对响应报文的封装对象, 通过 response 对象可以设置响应报文
const server = http.createServer((request, response) => { 		
    // 设置响应体
    response.end('Hello HTTP server');
});  //=>返回结果是一个对象

//3. 监听端口, 启动服务
server.listen(9000, () => {
	console.log('服务已经启动, 端口 9000 监听中...');
});

http.createServer 里的回调函数的执行时机：当接收到 HTTP 请求的时候，就会执行

注意事项

命令行 ctrl + c 停止服务
当服务启动后，更新代码必须重启服务才能生效

响应内容中文乱码的解决办法

// 设置响应头
response.setHeader('content-type','text/html;charset=utf-8');

端口号被占用

Error: listen EADDRINUSE: address already in use :::9000

1）关闭当前正在运行监听端口的服务（使用较多）

2）修改其他端口号
HTTP 协议默认端口是 80 。HTTPS 协议的默认端口是 443, HTTP 服务开发常用端口有 3000，8080，8090，9000 等

如果端口被其他程序占用，可以使用资源监视器找到占用端口的程序，然后使用任务管理器关闭对应的程序

获取 HTTP 请求报文

含义	语法	重点掌握
请求方法	`request.method`	*****
请求版本	`request.httpVersion`
请求路径	`request.url`	*****
URL 路径	`require('url').parse(request.url).pathname`	*****
URL 查询字符串	`require('url').parse(request.url, true).query`	*****
请求头	`request.headers`	*****
请求体	request.on(‘data’, function(chunk){}) request.on(‘end’, function(){})

// 1. 导入 http 模块
const http = require('http')

// 2. 创建服务对象
const server = http.createServer((request, response) => {
  // 获取请求的方法
  console.log(request.method)  //=>GET
  // 获取请求的 url
  console.log(request.url)  // 只包含 url 中的 路径 与查询字符串
  // 获取 http 协议的版本号
  console.log(request.httpVersion)  //=> 1.1
  // 获取 http 的请求头
  console.log(request.headers) //=>结果是一个对象
  response.end('http') //=>设置响应体
})

// 3. 监听端口，启动服务
server.listen(9000, () => {
  console.log('服务已经启动...')
})

注意事项：

request.url 只能获取路径以及查询字符串，无法获取 URL 中的域名以及协议的内容
request.headers 将请求信息转化成一个对象，并将属性名都转化成了『小写』
关于路径：如果访问网站的时候，只填写了 IP 地址或者是域名信息，此时请求的路径为『 / 』
关于 favicon.ico：这个请求是属于浏览器自动发送的请求

提取 http 报文中 url的路径与查询字符串

// 导入 http 模块
const http = require('http')

// 创建服务对象
const server = http.createServer((request, response) => {
  // 实例化 url 对象
  // let url = new URL('/search?a=100&b=200','http://127.0.0.1:9000')
  let url = new URL(request.url, 'http://127.0.0.1')
  console.log(url)  //=>如图所示，为一个对象
  // 输出路径
  console.log(url.pathname)  //=>/search
  // 输出 keyword 查询字符串
  console.log(url.searchParams.get('a'))  //=> 100
  response.end('url new')
})

// 监听端口，启动服务
server.listen(9000, () => {
  console.log('服务已经启动...')
})

设置 HTTP 响应报文

作用	语法
设置响应状态码	response.statusCode
设置响应状态描述	response.statusMessage （用的非常少）
设置响应头信息	response.setHeader(‘头名’, ‘头值’) (`可以自定义`)
设置响应体	response.write(‘xx’) response.end(‘xxx’)

// 1. 设置响应状态码
response.statusCode = 203
// 2. 响应状态的描述
response.statusMessage = 'i love you'
// 3. 响应头
response.setHeader('content-type', 'text/html;charset=utf-8')
// 自定义响应头
response.setHeader('myHeader', 'test test')
// 设置多个同名的响应头
response.setHeader('test', ['a', 'b', 'c'])

// write 和 end 的两种使用情况：
// 1. write 和 end 的结合使用 响应体相对分散
response.write('xx');
response.write('xx');
response.write('xx');
response.end(); //每一个请求，在处理的时候必须要执行 end 方法的

//2. 单独使用 end 方法 响应体相对集中
response.end('xxx');

网页中的 URL

网页中的 URL 主要分为两大类：相对路径 与 绝对路径

绝对路径

绝对路径可靠性强，而且相对容易理解，在项目中运用较多

形式	特点
http://atguigu.com/w eb	直接向目标资源发送请求，容易理解。网站的外链会用到此形式
//atguigu.com/web	与页面 URL 的协议拼接形成完整 URL 再发送请求。大型网站用的比较多
/web	与页面 URL 的协议、主机名、端口拼接形成完整 URL 再发送请求。中小型网站

相对路径

相对路径在发送请求时，需要与当前页面 URL 路径进行 计算 ，得到完整 URL 后，再发送请求，学习阶段用的较多

例如当前网页 url 为 http://www.atguigu.com/course/h5.html

形式	最终的 URL
./css/app.css	http://www.atguigu.com/course/css/app.css
js/app.js	http://www.atguigu.com/course/js/app.js
…/img/logo.png	http://www.atguigu.com/img/logo.png
…/…/mp4/show.mp4	http://www.atguigu.com/mp4/show.mp4

网页中使用 URL 的场景小结

包括但不限于如下场景：

a 标签 href
link 标签 href
script 标签 src
img 标签 src
video audio 标签 src
form 中的 action
AJAX 请求中的 URL

QT-7274

https://qt-7274.github.io/2023/06/27/node.js-chang-yong-mo-kuai-xiang-jie/

本博客所有文章除特別声明外，均采用 CC BY 4.0 许可协议。转载请注明来源 QT-7274 !

后端 Node.js

CSS中的浮动与定位

在最初，浮动是用来实现文字环绕图片效果的，现在浮动是主流的页面布局方式之一。

2023-06-28 前端开发

前端 CSS

志愿填报

zrq志愿填报建议

2023-06-26 QT-7274

硕士生涯

Node.js常用模块详解

Buffer（缓冲器）

概念

特点

使用

创建Buffer

Buffer与字符串的转化

Buffer 的读写

fs模块

文件写入

writeFile 异步写入

writeFileSync 同步写入

appendFile / appendFileSync 追加写入

createWriteStream 流式写入

写入文件的场景

文件读取

readFile 异步读取

readFileSync 同步读取

createReadStream 流式读取

文件移动与重命名

文件删除

文件夹操作

mkdir 创建文件夹

readdir 读取文件夹

rmdir 删除文件夹

查看资源状态

相对路径问题

_dirname

path模块

http模块

创建 HTTP 服务

操作步骤

注意事项

获取 HTTP 请求报文

提取 http 报文中 url的路径 与 查询字符串

设置 HTTP 响应报文

网页中的 URL

绝对路径

相对路径

网页中使用 URL 的场景小结

你的赏识是我前进的动力

提取 http 报文中 url的路径与查询字符串