Node.js三个主要模块（fs,path,http）

lxf2023-05-18 00:56:48

首页 > JavaScript
> 正文

Node.js三个主要模块

一. fs文件系统模块

1. 什么是fs文件系统模块

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

fs.readFile()方法，用来读取指定文件中的内容
fs.writeFile()方法，用来向指定的文件中写入内容

如果要在 JavaScript 代码中，使用 fs 模块来操作文件，则需要使用如下的方式先导入它：

const fs = require('fs');

2. 读取指定文件中的内容

使用fs.readFile()方法，可以读取指定文件中的内容，语法格式如下：
```
fs.readFile(path[,options],callback)
```
参数解读：
- 参数1：必选参数，字符串，表示文件的路径
- 参数2：可选参数，表示以什么编码格式来读取文件
- 参数3：必选参数，文件读取完成后，通过回调函数拿到读取的如果

fs.readfile()的示例代码

//content.txt
长风破浪会有时
直挂云帆济沧海

//index.js
const fs = require('fs');

fs.readFile('./content.txt', 'utf-8', (err, dataStr) => {
    console.log(`err:${err}`);
    console.log(`dataStr:${dataStr}`);
})

终端输出结果如图： Node.js三个主要模块（fs,path,http）

判断文件是否读取成功可以判断err对象是否为null,从而知晓文件读取的结果：

const fs = require('fs');

fs.readFile('./content.txt', 'utf-8', (err, result) => {
    if (err) return console.log('文件读取失败！' + err.message);

    console.log('文件读取成功，内容是:\n' + result)
});

终端输出结果截图：

Node.js三个主要模块（fs,path,http）

3. 向指定的文件中写入内容

fs.writeFile()的语法格式使用fs.writeFile()方法，可以向指定的文件中写入内容，语法格式如下：
```
fs.writeFile(file,data[,options],callback)
```
参数解读：
- 参数1：必选参数，需要指定一个文件路径的字符串，表示文件的存放路径
- 参数2：必选参数，表示要写入的内容
- 参数3：可选参数，表示以什么格式写入文件内容，默认值是utf8
- 参数4：必选参数，文件写入完成后的回调函数

fs.writeFile()的示例代码

//index.js
const fs = require('fs');

fs.writeFile('./content.txt', 'Hello Node.js!', (err) => {
    console.log(`err:${err}`);
})

判断文件是否写入成功可以判断err对象是否为null，从而知晓文件的写入结果

const fs = require('fs');

let str = '长风破浪会有时,直挂云帆济沧海';
//文件写入内容
fs.writeFile('./content.txt', str, (err, result) => {
    if (err) return console.log('文件写入失败！' + err.message);

    console.log('文件写入成功!')
})

//读取文件内容
fs.readFile('./content.txt', 'utf-8', (err, result) => {
    if (err) return console.log('文件读取失败！' + err.message);

    console.log('文件读取成功，内容是:\n' + result)
});

终端运行截图：

Node.js三个主要模块（fs,path,http）

4. fs模块-路径动态拼接的问题

在使用 fs 模块操作文件时，如果提供的操作路径是以 ./ 或 ../ 开头的相对路径时，很容易出现路径动态拼接错误的问题。
原因：代码在运行的时候，会以执行 node 命令时所处的目录，动态拼接出被操作文件的完整路径。
解决方案：在使用 fs 模块操作文件时，直接提供完整的路径，不要提供 ./ 或 ../ 开头的相对路径，从而防止路径动态拼接的问题。

// __dirname表示当前文件所在的目录
fs.readFile(__dirname + '/content.txt', 'utf-8', (err, result) => {
    if (err) return console.log('文件读取失败！' + err.message);

    console.log('文件读取成功，内容是:\n' + result)
});

二. path路径模块

1. 什么是path路径模块

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

path.join()方法，用来将多个路径片段拼接成一个完整的路径字符串
path.basename()方法，用来从路径字符串中，将文件名解析出来

如果要在JavaScript代码中，使用path模块来处理路径，则需要使用如下的方式先导入它：

const path = require('path');

2. 路径拼接

path.join()的语法格式

使用 path.join() 方法，可以把多个路径片段拼接为完整的路径字符串，语法格式如下：
```
path.join([...paths])
```
参数解读：
- ...paths<string>路径片段的序列
- 返回值:<string>

path.join()的代码示例

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

//引入path模块
const path = require('path');
//拼接完整的路径字符串
const pathStr = path.join('/a', '/b/c', '../', './d', 'e');
console.log(pathStr); //输出 \a\b\d\e

//拼接完整的路径字符串
const pathStr1 = path.join(__dirname, './file/content.txt');
console.log(pathStr1); //输出 当前文件所处目录\file\content.txt

3. 获取路径中的中文名

path.basename()的语法格式

使用 path.basename() 方法，可以获取路径中的最后一部分，经常通过这个方法获取路径中的文件名，语法格式如下：
```
path.basename(path[,ext])
```
参数解读：
- path<string>必选参数，表示一个路径的字符串
- ext<string>可选参数，表示文件扩展名
- 返回:<string>表示路径中的最后一部分

path.basename()的代码示例

使用 path.basename() 方法，可以从一个文件路径中，获取到文件的名称部分：

const path = require('path');

//文件存放路径
const fpath = 'a/b/c/index.html';
//获取文件名（包括后缀）
const fullName = path.basename(fpath);
console.log(fullName); //输出：index.html

//获取文件名（不包括后缀）
const nameWithoutExt = path.basename(fpath, '.html');
console.log(nameWithoutExt); //输出：index

4. 获取路径中的文件扩展名

path.extname()的语法格式

使用path.extname()方法，可以获取路径中的扩展名部分，语法格式如下：
```
path.extname(path)
```
参数解读：
- path <string>必选参数，表示一个路径的字符串
- 返回: <string> 返回得到的扩展名字符串

path.extname()的代码示例

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

const path = require('path');

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

//文件扩展名
const fext = path.extname(fpath);
console.log(fext); //输出：.html

三. http模块

1. 什么是http模块

回顾：什么是客户端、什么是服务器？

在网络节点中，负责消费资源的电脑，叫做客户端；负责对外提供网络资源的电脑，叫做服务器。

http 模块是 Node.js 官方提供的、用来创建 web 服务器的模块。通过 http 模块提供的 http.createServer() 方法，就

能方便的把一台普通的电脑，变成一台 Web 服务器，从而对外提供 Web 资源服务。

如果要希望使用 http 模块创建 Web 服务器，则需要先导入它：

const http = require('http');

2.进一步理解http模块的作用

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

3. 服务器相关的概念

IP地址

IP 地址就是互联网上每台计算机的唯一地址，因此 IP 地址具有唯一性。如果把“个人电脑”比作“一台电话”，那么“IP地址”就相当于“电话号码”，只有在知道对方 IP 地址的前提下，才能与对应的电脑之间进行数据通信。

IP 地址的格式:通常用“点分十进制”表示成（a.b.c.d）的形式，其中，a,b,c,d 都是 0~255 之间的十进制整数。例如：用点分十进表示的 IP地址（192.168.1.1）

注意：

① 互联网中每台 Web 服务器，都有自己的 IP 地址，例如：大家可以在 Windows 的终端中运行 ping www.baidu.com 命令，即可查看到百度服务器的 IP 地址。

② 在开发期间，自己的电脑既是一台服务器，也是一个客户端，为了方便测试，可以在自己的浏览器中输入 127.0.0.1 这个IP 地址，就能把自己的电脑当做一台服务器进行访问了。
域名和域名服务器

尽管 IP 地址能够唯一地标记网络上的计算机，但IP地址是一长串数字，不直观，而且不便于记忆，于是人们又发明了另一套字符型的地址方案，即所谓的域名（Domain Name）地址。

IP地址和域名是一一对应的关系，这份对应关系存放在一种叫做域名服务器(DNS，Domain name server)的电脑中。使用者只需通过好记的域名访问对应的服务器即可，对应的转换工作由域名服务器实现。因此，域名服务器就是提供 IP 地址和域名之间的转换服务的服务器。

注意：

① 单纯使用 IP 地址，互联网中的电脑也能够正常工作。但是有了域名的加持，能让互联网的世界变得更加方便。

② 在开发测试期间， 127.0.0.1 对应的域名是 localhost，它们都代表我们自己的这台电脑，在使用效果上没有任何区别。
端口号

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

注意：

① 每个端口号不能同时被多个 web 服务占用。

② 在实际应用中，URL 中的 80 端口可以被省略。

4. 创建最基本的web服务器

创建 web 服务器的基本步骤：

① 导入 http 模块

const http = require('http');

② 创建 web 服务器实例

//调用http.createServer() 方法，即可快速创建一个 web 服务器实例：
const server = http.createServer();

③ 为服务器实例绑定 request 事件，监听客户端的请求

//使用服务器的.on()方法，为服务器绑定一个request事件
server.on('request',(req,res)=>{
    console.log('触发事件');
})

④ 启动服务器

//调用server.listen(端口号，callback回调)方法，即可启动web服务器
server.listen(80,()=>{
    console.log('http server running at http://127.0.0.1');
})

req请求对象和res响应对象

只要服务器接收到了客户端的请求，就会调用通过 server.on() 为服务器绑定的 request 事件处理函数。
如果想在事件处理函数中，访问与客户端相关的数据或属性，可以使用如下的方式;
在服务器的 request 事件处理函数中，如果想访问与服务器相关的数据或属性，可以使用如下的方式：

const http = require('http');

const server = http.createServer.createServer();

server.on('request', (req, res) => {
    //req是请求对象，它包含了与客户端相关的数据和属性,例如：
    //req.url是客户端请求的url地址
    //req.method是客户端的method请求类型

    const str = `请求路径：${req.url},请求方法：${req.method}`;
    console.log(str);

    //res是响应对象，它包含了与服务器相关的数据和属性，例如：
    //向客户端发送指定的内容，并结束这次请求的处理过程
    res.end(str);
})

server.listen(80, () => {
    console.log('http server running at http://127.0.0.1');
})

解决中文乱码问题

当调用 res.end() 方法，向客户端发送中文内容的时候，会出现乱码问题，此时，需要手动设置内容的编码格式：
```
 //为了防止中文乱码，需要设置响应头Content-Type值为text/html;charset=utf-8
res.setHeader('Content-Type', 'text/html;charset=utf-8');
```

5. 根据不同的url响应不同的html内容

核心实现步骤：

① 获取请求的 url 地址

② 设置默认的响应内容为 404 Not found

③ 判断用户请求的是否为 / 或 /index.html 首页

④ 判断用户请求的是否为 /about.html 关于页面

⑤ 设置 Content-Type 响应头，防止中文乱码

⑥ 使用 res.end() 把内容响应给客户端

动态响应内容

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

//创建 web 服务器实例
const server = http.createServer();

//绑定request事件，监听客户端请求
server.on('request', (req, res) => {
    //1.请求的url
    const url = req.url;

    // 2.设置默认的内容
    let content = '<h1>404 Not found!</h1>';

    //3.用户请求首页
    if (url === '/' || url === '/index.html') {
        content = '<h1>首页</h1>';
    } //用户请求关于页面
    else if (url === '/about.html') {
        content = '<h1>关于页面</h1>';
    }
    //为了防止中文乱码，需要设置响应头Content-Type值为text/html;charset=utf-8
    res.setHeader('Content-Type', 'text/html;charset=utf-8');

    res.end(content);
})

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

客户端打开：

Node.js三个主要模块（fs,path,http）

本网站是一个以CSS、JavaScript、Vue、HTML为核心的前端开发技术网站。我们致力于为广大前端开发者提供专业、全面、实用的前端开发知识和技术支持。在本网站中，您可以学习到最新的前端开发技术，了解前端开发的最新趋势和最佳实践。我们提供丰富的教程和案例，让您可以快速掌握前端开发的核心技术和流程。本网站还提供一系列实用的工具和插件，帮助您更加高效地进行前端开发工作。我们提供的工具和插件都经过精心设计和优化，可以帮助您节省时间和精力，提升开发效率。除此之外，本网站还拥有一个活跃的社区，您可以在社区中与其他前端开发者交流技术、分享经验、解决问题。我们相信，社区的力量可以帮助您更好地成长和进步。在本网站中，您可以找到您需要的一切前端开发资源，让您成为一名更加优秀的前端开发者。欢迎您加入我们的大家庭，一起探索前端开发的无限可能!

本文是由"秘密武器开发者中心"本站原创整理，所有内容的版权归原作者所有。

上一篇 Koa 与 Express:关键差别消息中间件连接方法

下一篇自定义webpack loader和babel plugin，替换国际化Key，减小打包体积

Node.js三个主要模块（fs,path,http）