二、Node.js内置API（fs、path、http）

最新推荐文章于 2025-04-30 10:29:33 发布

·某某·

最新推荐文章于 2025-04-30 10:29:33 发布

阅读量784

点赞数 1

分类专栏： node 文章标签： node.js http javascript

本文链接：https://blog.youkuaiyun.com/weixin_43123984/article/details/126460068

版权

node 专栏收录该内容

7 篇文章

订阅专栏

一、fs 文件系统模块

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

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

1、fs.readFile()

语法格式：

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

fs.readFile(path[, options], callback)

案例：

// 以 utf8 的编码格式，读取指定文件的内容，判断 err 对象是否为 null，从而知晓文件读取的结果：
const fs = require('fs')
fs.readFile('./files/1.txt', 'utf8', function(err, result){
  if (err) {
    return console.log('文件读取失败！', err + message)
  }
  console.log('文件读取成功， 内容是：' + result)
})

2、fs.writeFile()

语法格式：

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

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

案例：

// 以 utf8 的编码格式，写入指定文件的内容，判断 err 对象是否为 null，从而知晓文件写入的结果：
const fs = require('fs')
fs.writeFile('./files/1.txt', 'hello world!','utf8', function(err){
  if (err) {
    return console.log('文件写入失败！', err + message)
  }
  console.log('文件写入成功！')
})

注意事项：
1、fs.writeFile() 默认会覆盖原文件的内容

2、fs.writeFile() 可以创建一个新的文件，但不能创建一个新的目录：
如./files目录下没有1.txt文件，我们写入./files/1.txt，如果files目录下没有1.txt文件，可以在files目录下创建一个新的1.txt；
但是，如果没有files111这个目录，我们写入./files111/1.txt，则会报错！

3、fs读写文件demo

需求：
将成绩.txt文件中的内容整理到成绩new.txt文件中

原格式：
小红=99 小白=100 小黄=70 小黑=66 小绿=88

转换后格式：
小红:99
小白:100
小黄:70
小黑:66
小绿:88

方案：

const fs = require('fs')

fs.readFile('./files/成绩.txt', 'utf8', function(err, result) {
  if (err) {
    return console.log('文件读取失败！' + err.message)
  }
  // 简写
  // let arr = result.split(' ').map(item => item.replace(/=/g, ':')).join('\r\n')
  
  let arr = result.split(' ') // [ '小红=99', '小白=100', '小黄=70', '小黑=66', '小绿=88' ]
  arr = arr.map(item => item.replace(/=/g, ':'))  // [ '小红:99', '小白:100', '小黄:70', '小黑:66', '小绿:88' ]
  arr = arr.join('\r\n')  // 拼接换行符

  fs.writeFile('./files/成绩new.txt', arr, function (err) {
    if (err) {
      return console.log('文件写入失败！' + err.message)
    }
    console.log('文件写入成功！')
  })
})

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

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

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

// ./或../相对路径，容易造成动态路径拼接错误
fs.readFile('./files/成绩new.txt', function(err, result) {
  if (err) {
    return console.log('文件读取失败！' + err.message)
  }
  console.log('文件读取成功！' + result)
})

// __dirname表示当前文件所处的目录，避免相对路径动态拼接错误
fs.readFile(__dirname + '/files/成绩new.txt', function(err, result) {
  if (err) {
    return console.log('文件读取失败！' + err.message)
  }
  console.log('文件读取成功！' + result)
})

二、path路径模块

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

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

1、path.join() 路径拼接

语法格式：

// 使用 path.join() 方法，可以把多个路径片段拼接为完整的路径字符串
// ...paths <string> 路径片段的序列
// 返回值: <string>

path.join([...paths])

案例：

const path = require('path')

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

const pathStr2 = path.join(__dirname, './d', 'e')
console.log(pathStr2)  // D:\study\Typescript_study\node\01-内置模块\02-path\d\e

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

2、path.basename() 获取文件名

语法格式：

// 使用 path.basename() 方法，可以获取路径中的最后一部分，经常通过这个方法获取路径中的文件名
// path <string> 必选参数，表示一个路径的字符串
// ext <string> 可选参数，表示文件扩展名
// 返回: <string> 表示路径中的最后一部分

path.basename(path[,ext])

案例：

const path = require('path')
const fpath = './a/b/c/d/index.html'

let fullName = path.basename(fpath)
console.log(fullName)  // index.html

let name = path.basename(fpath, '.html')
console.log(name)   // index

3、path.extname() 获取文件扩展名

语法格式：

// 使用 path.extname() 方法，可以获取路径中的扩展名部分
// path <string>必选参数，表示一个路径的字符串
// 返回: <string> 返回得到的扩展名字符串

path.extname(path)

案例：

const path = require('path')
const fpath = './a/b/c/d/index.html'

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

4、时钟案例demo

需求：
将一份html文件中的css与js拆分成index.css、index.js、index.html三份

方案：

const fs = require('fs')
const path = require('path')

// 1、创建两个正则，匹配css与js代码
// \s表示空白字符； \S表示非空白字符； *表示匹配任意字符
// 匹配 style 标签内内容
const regStyle = /<style>[\s\S]*<\/style>/

// 匹配 script 标签内内容
const regScript = /<script>[\s\S]*<\/script>/

// 2、使用fs模块，读取原index.html模块
fs.readFile(path.join(__dirname, './index.html'), 'utf8', (err, result) => {
  if (err) {
    return console.log('文件读取失败！' + err.message)
  }
  
  resolveCss(result)
  resolveJS(result)
  resolveHTML(result)
})

// 3、自定义resolveCss方法，写入index.css样式文件
function resolveCss(htmlStr) {
  let cssArr = regStyle.exec(htmlStr)
  let cssStr = cssArr[0].replace(/<style>|<\/style>/g, '').trim()
  
  fs.writeFile(path.join(__dirname, './clock/index.css'), cssStr, function (err) {
    if (err) {
      return console.log('文件写入失败！' + err.message)
    }
    console.log('css文件写入成功！')
  })
}

// 4、自定义resolveJS方法，写入index.js样式文件
function resolveJS(htmlStr) {
  let jsArr = regScript.exec(htmlStr)
  let jsStr = jsArr[0].replace(/<script>|<\/script>/g, '').trim()
  
  fs.writeFile(path.join(__dirname, './clock/index.js'), jsStr, function (err) {
    if (err) {
      return console.log('文件写入失败！' + err.message)
    }
    console.log('js文件写入成功！')
  })
}

// 5、自定义resolveHTML方法，来写入index.html文件
function resolveHTML(htmlStr) {
  let htmlStrNew = htmlStr
      .replace(regStyle, '<link rel="stylesheet" href="./index.css">')
      .replace(regScript, '<script src="./index.js"></script>')
      
  fs.writeFile(path.join(__dirname, './clock/index.html'), htmlStrNew, function (err) {
    if (err) {
      return console.log('文件写入失败！' + err.message)
    }
    console.log('html文件写入成功！')
  })
}

三、http 模块

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

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

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

服务器相关的概念

IP地址
IP 地址就是互联网上每台计算机的唯一地址，因此 IP 地址具有唯一性。如果把“个人电脑”比作“一台电话”，那么“IP地址”就相当于“电话号码”，只有在知道对方 IP 地址的前提下，才能与对应的电脑之间进行数据通信。
域名和域名服务器
尽管 IP 地址能够唯一地标记网络上的计算机，但IP地址是一长串数字，不直观，而且不便于记忆，于是人们又发明了另一套字符型的地址方案，即所谓的域名（Domain Name）地址。
1、单纯使用 IP 地址，互联网中的电脑也能够正常工作。但是有了域名的加持，能让互联网的世界变得更加方便。
2、在开发测试期间，127.0.0.1 对应的域名是 localhost，都代表我们自己的这台电脑，在使用上没有区别。
端口号
计算机中的端口号，就好像是现实生活中的门牌号一样。通过门牌号，外卖小哥可以在整栋大楼众多的房间中，准确把外卖送到你的手中。
同理，在一台电脑中，可以运行成百上千个 web 服务。每个 web 服务都对应一个唯一的端口号。客户端发送过来的网络请求，通过端口号，可以被准确地交给对应的 web 服务进行处理。

1、使用http创建web服务器

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

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

// 3、使用服务器实例的on方法，为服务器绑定一个request事件，监听客户端的请求
server.on('request', (req, res) => {
  // 只要客户端请求我们的服务器，就会触发request事件，从而调用这个事件处理函数
  console.log('Someone visit our web server.')
  // req 是请求对象，它包含了客户端相关的数据和属性，如：
  // req.url 是客户端请求的url地址
  // req.method 是客户端的method请求类型

  // res 是响应对象，它包含了与服务器相关的数据和属性，如
  // res.end()作用是向客户端发送返回的内容，并结束这次请求
  res.end('返回的内容，结束这次请求！')
})

// 4、启动服务器
// server.listen(端口号, cb回调函数)
server.listen(3333, () => {
  console.log('server running at http://127.0.0.1:3333')
})

2、返回中文数据乱码问题

当调用 res.end() 方法，向客户端发送中文内容的时候，会出现乱码问题，此时，需要手动设置内容的编码格式：

server.on('request', (req, res) => {
  // 发送的中文信息
  let 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)
})

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

server.on('request', (req, res) => {
  // 1、请求的url地址
  let url = req.url
  // 2、设置默认内容为404 not find
  let content = '<h1>404 not find</h1>'

  // 3、用户请求不同url，返回不同内容
  if (url === '/' || url === '/index.html') {
    content = '<h1>首页</h1>'
  } else if (url === '/about.html'){
    content = '<h1>关于</h1>'
  }
  // 4、设置Content-Type响应头，防止中文乱码
  res.setHeader('Content-Type', 'text/html; charset=utf-8')
  // 5、内容返回给客户端
  res.end(content)
})

3、demo2 根据请求url返回时钟案例界面资源

在这里插入图片描述

const fs = require('fs')
const path = require('path')
const http = require('http')

const server = http.createServer()

const getMime = function(extname){
  switch(extname){
    case '.html':
      return 'text/html';
    case '.css':
      return 'text/css';
    case '.js':
      return 'text/javascript';
    default:
      return 'text/html';
  }
}

server.on('request', (req, res) => {
  let extname = path.extname(req.url)
  let fpath = ''
  if (req.url === '/') {
    fpath = path.join(__dirname, './clock/index.html')
  } else {
    fpath = path.join(__dirname, './clock', req.url)
  }

  fs.readFile(fpath, 'utf8', (err, result) => {
    if (err) return res.end('404 not find')
    res.setHeader('Content-Type', getMime(extname)+';charset=utf-8')
    res.end(result)
  })
})

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

注意：
上面案例要么不设置响应头，要么设置res.setHeader('Content-Type', getMime(extname)+';charset=utf-8')
不要写死设置res.setHeader('Content-Type', 'text/html; charset=utf-8')

原因：不同类型的文件响应类型是不一样的，如果统一设置成text/html; charset=utf-8，会导致加载静态资源css、js不显示的问题