node.js内置模块(fs、path、http)的学习总结

温少昌
377 阅读14分钟

Node.js 内置模块指的是除默认提供的语法之外，提供的美容，无需下载，直接引入，引入只写名称即可。

目标

  • 知道什么是 Node.js
  • Node.js 可以做什么
  • Node.js 中的 JavaScript 的组成部分
  • 使用 fs 模块读写操作文件
  • 使用 path 模块处理路径
  • 使用 http 模块编写一个基本的 web 服务器

目录

  1. 初始 Node.js
  2. fs 文件系统模块
  3. path 路径模块
  4. http 模块

1. 初识 Node.js

1.1 浏览器中的 JavaScript

浏览器中的 JavaScript， 解析引擎可以解析待执行的 JS 代码。不同浏览器使用不同的解析引擎：

  • Chrome 浏览器 => V8
  • Firefox 浏览器 => OdinMonkey(奥丁猴)
  • Safri 浏览器 => JSCore
  • IE 浏览器 => Chakra(查克拉)
  • etc...

其中，Chrome 浏览器的 V8 解析引擎性能最好！

每个浏览器都内置了 DOM 和 BOM 这样的 API 函数，因此，浏览器中的 JavaScript 才可以调用它们。

浏览器中的 JavaScript 运行环境。运行环境是指代码正常运行所需的必要环境。

Chrome 浏览器运行环境，包括：V8 引擎和内置 API(DOM、BOM、Canvas、XMLHttpRequest、JS内置对象、tec...)。

  • V8 引擎负责解析和执行 JavaScript 代码。
  • 内置 API 是由运行环境提供的特殊接口，只能在所属的运行环境中被调用。

1.2 Node.js 中的 JavaScript

Node.js 是一个基于 Chrome V8 引擎的 JavaScript 运行环境。

Node.js 运行环境，包括：V8 引擎和内置API(fs、path、http、JS内置对象、querystring、etc...)

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

1.2.1 Node.js 可以做什么？

  1. 基于 Express 框架，可以快速构建 Web 应用。
  2. 基于 Electron框架，可以构建跨平台的桌面应用。
  3. 基于 restify 框架，可以快速构建 API 接口项目。
  4. 读写和操作数据库、创建实用的命令行工具辅助前端开发、etc...

1.2.2 Node.js 的学习路径

JavaScript 基础语法 + Node.js 内置 API 模块(fs、path、http等) + 第三方 API 模块(express、mysql等)

2. fs 文件系统模块

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

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

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

const fs = require('fs');

2.1 读取文件内容

fs.readFile(path[, options], callback)
  • 参数1：必选参数，字符串，表示文件的路径。
  • 参数2：可选参数，表示以什么编码格式来读取文件。
  • 参数3：必选参数，文件读取完成后，通过回调函数拿到读取的结果。

fs.readFile() 示例代码。以 utf8 的编码格式，读取文件的内容，并打印 err 和 dataStr 的值：

const fs = require('fs');
fs.readFile('./files/11.txt', 'utf8', function (err, dataStr) {
  // 打印失败的结果。
  // 1. 读取成功，则 err 的值为 null，dataStr为文件内容。
  // 2. 读取失败，则 err 的值为错误对象，dataStr为 undefined。
  console.log(err)
  console.log('-------')
  console.log(dataStr)

  if (err) {
    return console.log('文件读取失败！' + err.message)
  }
  console.log('文件读取成功，内容是：' + dataStr)
})

可以判断 err 对象是否为 null，从而可以知道文件读取的结果。

2.2 写入文件内容

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

fs.writeFile() 示例代码。向指定的文件路径中，写入内容：

const fs = require('fs');
fs.writeFile('./22.txt', 'Hello Node.js!', function(err) {
  // 写入成功，err 的值为 null
  // 写入失败，err 的值为错误对象
  console.log(err)

  if (err) {
    return console.log('文件写入失败！' + err.message)
  }
  console.log('文件写入成功！')
})

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

2.3 案例 - 整理成绩

使用 fs 文件系统模块，将 "成绩.txt" 文件中的考试成绩数据，整理到 "成绩-ok.txt" 文件中。"成绩.txt" 文件中的数据格式如下：

小红=99 小白=100 小黄=70 小黑=66 小绿=88

整理完成之后，希望得到 "成绩-ok.txt" 文件中的数据格式如下：

小红：99
小白：100
小黄：70
小黑：66
小绿：88

const fs = require('fs');

fs.readFile('./成绩.txt', 'utf8', function(err, dataStr) {
  if(err) {
    return console.log('文件读取失败！')
  }
  handleWrite(dataStr)
})

function handleWrite(dataStr) {
  const newArr = []
  const result = dataStr.split(' ')
  result.forEach(item => {
    newArr.push(item.replace('-', '：'))
  });
  const newStr = newArr.join('\r\n')

  fs.writeFile('./成绩-ok.txt', newStr, function(err) {
    if(err) {
      return console.log('文件写入失败！')
    }
    console.log('文件写入成功！')
  })
}

注意：fs.readFile 的第二个参数一定要加 "utf8"。否则读取的文件是 Buffer 格式的内容。

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

在使用 fs 模块操作文件时，如果提供的操作路径是以 ./ 或者 ../ 开头的相对路径时，很容易出现路径动态拼接错误的问题。

原因：代码在运行的时候，会以执行 node 命令时所处的目录，动态拼接出被操作文件的完整路径。

解决方案：在使用 fs 模块操作文件时，直接提供完整的路径，不要提供 ./ 或 ../ 开头的相对路径，从而防止路径动态拼接的问题。

完整的路径:

  • D:\\learn\\Node\\成绩.txt 缺点：移植性非常差，不利于维护。
  • __dirname + '/Node/成绩.txt'：__dirname 表示当前文件所处的目录。

3. path 路径模块

3.1 什么是 path 路径模块

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

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

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

const path = require('path')

3.2 路径拼接

3.2.1 path.join() 的语法格式

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

path.join([...paths])
  • ...paths <string> 路径片段的序列
  • 返回值：<string>

3.2.2 path.join() 的代码示例

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

const patStr2 = path.join(__dirname, './Node/成绩.txt')
const .log(patStr2) // 输出 当前文件所处目录\Node\成绩.txt

注意：../ 会抵消前面的路径。

注意：今后凡是涉及到路径拼接的操作，都要使用 path.join() 方法进行处理。不要直接使用 + 进行字符串的拼接。

3.3 获取路径中的文件名

3.3.1 path.basename() 的语法格式

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

path.basename(path[, ext])
  • path <string> 必选参数，表示一个路径的字符串
  • ext <string> 可选参数，表示文件扩展名
  • 返回 <string> 表示路径中的最后一部分

3.3.2 path.basename() 的代码示例

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

var fullName = path.basename(fpath)
consoel.log(fullName) // index.html

var nameWithoutExt = path.basename(fpath, '.html')
console.log(nameWithoutExt) // index

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

3.4.1 path.extname() 的语法格式

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

path.extname(path)
  • path <string> 必选参数，表示一个路径的字符串
  • 返回 <string> 扩展名字符串

3.4.2 path.extname() 的代码示例

const fpath = '/a/b/c/index.html' // 路径字符串

const fext = path.extname(fpath)
console.log(fext) // .html

3.5 案例 - 拆分html到单独文件

  1. 引入 fs 和 path 模块。
  2. 创建两个正则，用来匹配 style 和 script 中的内容。
  3. 读取 html 文件，读取成功后依次调用处理 css、js、html的函数。
  4. 将匹配到的 style、script 中的内容，写入到对应的文件中。
  5. 将 html 文件中匹配到 style、script 内容替换为外联的形式。
const fs = require('fs')
const path = require('path')

const pattenCss = /<style>[\s\S]*<\/style>/
const pattenScript = /<script>[\s\S]*<\/script>/

fs.readFile(path.join(__dirname, './素材/index.html'), 'utf8', function (err, dataStr) {
  if(err) return console.log('读取HTML文件失败！' + err.message)
  console.log(dataStr)
  resolveCss(dataStr)
  resolveScript(dataStr)
  resolveHtml(dataStr)
})

function resolveCss(dataStr) {
  const css = pattenCss.exec(dataStr)
  const newCss = css[0].replace('<style>', '').replace('</style>', '')
  fs.writeFile(path.join(__dirname, './split/index.css'), newCss, function(err) {
    if(err) return console.log('写入CSS失败！' + err.message)
    console.log('写入CSS成功！')
  })
}

function resolveScript(dataStr) {
  const script = pattenScript.exec(dataStr)
  const newScript = script[0].replace('<script>', '').replace('</script>', '')
  fs.writeFile(path.join(__dirname, './split/index.js'), newScript, function(err) {
    if(err) return console.log('写入Script失败！' + err.message)
    console.log('写入Script成功！')
  })
}

function resolveHtml(dataStr) {
  const newHTml = dataStr.replace(pattenCss, '<link rel="stylesheet" href="./index.css" />').replace(pattenScript, '<script src="./index.js"></script>')
  fs.writeFile(path.join(__dirname, './split/index.html'), newHTml, function(err) {
    if(err) return console.log('写入HTML文件失败！' + err.message)
    console.log('写入HTML文件成功！')
  })
}

两个注意点：

  • fs.writeFile() 方法只能用来创建文件，不能用来创建路径。
  • 重复调用 fs.write() 写入同一个文件，新写入的内容会覆盖之前的旧内容。

4. http 模块

4.1 什么是 http 模块

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

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

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

使用 http 模块创建 Web 服务器，则需要先导入它。

const http = require('http')

4.2 进一步理解 http 模块的作用

服务器和普通电脑的区别在于，服务器上安装了 web 服务器软件，例如：IIS、Apache 等。通过安装这些服务器软件，就能把一台普通的电脑变成一台 web 服务器。

在 Node.js 中，我们不需要使用 IIS、Apache 等这些第三方 web 服务器软件。因为我们可以基于 Node.js 提供的 http 模块，通过几行简单的代码，就能轻松的手写一个服务器软件，从而对外提供服务。

4.3 服务器相关的概念

4.3.1 IP 地址

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

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

ping.png

注意：

  • 互联网中每台 Web 服务器，都有自己的 IP 地址，例如：大家可以在 Windows 的终端运行 ping www.baidu.com 命令，即可查看到百度服务器的 IP 地址(36.152.44.95)。
  • 在开发期间，自己的电脑既是一台服务器，也是一个客户端，为了方便测试，可以在自己的浏览器中输入 127.0.0.1 这个 IP 地址，就能把自己电脑当作一台服务器访问了。

4.3.2 域名和域名服务器

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

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

注意：

  • 单纯使用 IP 地址，互联网中的电脑也能够正常工作。但是有了域名的加持，能够让互联网的世界变得更加方便。
  • 在开发测试期间，127.0.0.1 对应的域名是 localhost，它们都代表我们自己的这台电脑，在使用效果上没有任何区别。

4.3.3 端口号

计算机中的端口号，就好像是生活中的门牌号一样。通过门牌号，外卖小哥可以在整栋大楼众多的房间，准确送到你的手中。

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

注意：

    1. 每个端口号不能同时被多个 web 服务占用。
    1. 在实际应用中，URL 中的 80 端口可以被省略。

port.png

4.4 创建最基本的 Web 服务器

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

4.4.1 完整步骤

// 1. 导入 http 模块
// 如果希望在自己的电脑上创建一个 web 服务器，从而对外提供 web 服务，则需要导入 http 模块：
const http = require('http')

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

// 3. 为服务器实例绑定 request 事件，监听客户端的请求
// 使用服务器实例的 `.on()` 方法，为服务器实例绑定 `request` 事件，即可监听客户端发送过来的网络请求：
server.on('request', (req, res) => {
  // 只要由客户端来请求我们自己的服务器，就会触发 request 事件，从而调用这个事件处理函数
  console.log('Someone visit outr web serve.')
})

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

4.4.2 req 请求对象

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

如果想在事件处理函数中，访问与客户端相关的数据或属性，可以使用如下的方式：

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

4.4.3 res 响应对象

在服务器的 requset 事件处理函数中，如果想访问与服务器相关的数据或属性，可以使用如下的方式：

server.on('request', (req, res) => {
  // res 是响应对象，它包含了与服务器相关的数据和属性，例如：
  // 要发送到客户端的字符串
  const str = const str = `你请求的url是${req.url}，请求的方法是${req.method}`
  
  // res.send() 方法的作用：
  // 向客户端发送指定的内容，并结束这次请求的处理过程
  res.end(str)
})

4.4.4 解决中文乱码

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

server.on('request', (req, res) => {
  const str = const str = `你请求的url是${req.url}，请求的方法是${req.method}`
  // 为了防止中文显示乱码的问题，需要设置响应头 Content-Type 的值为 text/html; charset=utf-8
  res.setHeader('Content-Type', 'text/html: charset=utf-8')
  res.end(str)
})

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

    1. 获取请求的 url 地址
    1. 设置默认的响应内容为 404 Not found
    1. 判断用户请求的是否为 / 或 /index.html 页面
    1. 判断用户请求的是否为 /about 页面
    1. 设置 Content-type 响应头，防止中文乱码
    1. 使用 res.end() 把内容响应给客户端
server.on('request', (req, res) => {
  // 1. 获取请求的 url 地址
  const url = req.url
  // 2. 设置默认的响应内容为404 Not found
  let content = '<h1>404 Not found!</h1>'
  // 3. 判断用户请求的是否为 / 或 /index.html 页面
  if (url === '/' || url === '/index.html') {
    content = '<h1>首页</h1>'
  } else if(url === '/about.html') { // 4. 判断用户请求的是否为 /about 页面
    content = '<h1>关于页面</h1>'
  }
  // 5. 设置 Content-type 响应头，防止中文乱码
  res.setHeader('Content-Type', 'text/html; charset=utf-8')
  // 6. 使用 `res.end()` 把内容响应给客户端
  res.end(content)
})

4.6 案例 - 实现页面的 web 服务器

4.6.1 核心思路

把文件的实际存放路径，作为每个资源的请求 url 地址。

4.6.2 实现步骤

  • 导入需要的模块
  • 创建基本的 web 服务器
  • 将资源的请求 url 地址映射为文件的存放路径
  • 读取文件内容并响应给客户端
  • 优化资源的请求路径

4.6.3 Code

// 1.1 导入 http 模块
const http = require('http')
// 1.2 导入 fs 文件系统模块
const fs = require('fs')
// 1.3 导入 path 路径处理模块
const path = require('path')

// 2.1 创建 web 服务器
const server = http.createServer()
// 2.2 监听 web 服务器的 request 事件
server.on('request', (req, res) => { 
  // 3.1 获取到客户端请求的 url 地址
  const url = req.url
  // 3.2 把请求的 url 地址，映射为文件的存放路径
  // const fpath = path.join(__dirname, url)

  // *** 将 3.2 的实现方式，改为如下代码... ***
  // 5.1 预定义空白的文件存放路径
  let fpath = ''
  if (url === '/') {
    // 5.2 如果请求的路径是 / ，则手动指定文件的存放路径
    fpath = path.join(__dirname, './split/index.html')
  } else {
    // 5.3 如果请求的路径不为 /，则动态拼接文件的存放路径
    fpath = path.join(__dirname, './split', url)
  }

  // 4.1 根据“映射”过来的文件路径读取文件
  fs.readFile(fpath, 'utf8', (err, dataStr) => {
    // 4.2 读取文件失败后，向客户端响应固定的“错误信息”
    if (err) return res.end('404 Not fount.')
    // 4.3 读取文件成功后，将“读取成功的内容”响应给客户端
    res.end(dataStr)
  })
})
// 2.3 启动 web 服务器
server.listen(80, () => {
  console.log('Server listen at http://127.0.0.1')
})
avatar
文章
阅读
粉丝