Node-note-1

Node-note-1

Charles Lv7
  2023-07-24 08:12:31 2023-07-24 08:12:31 Created   2023-07-26 16:22:39 2023-07-26 16:22:39 Updated      2.3k Words  9 Mins  

初识Node.js与内置模块

初识 Node.js

Node.js 是一个基于 Chrome V8 引擎的 JavaScript 运行环境。
Node.js 作为一个 JavaScript 的运行环境，仅仅提供了基础的功能和 API。然而，基于 Node.js 提供的这些基础能，很多强大的工具和框架如雨后春笋，层出不穷：

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

fs 文件系统模块

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

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

fs.readFile()

使用 fs.readFile() 方法，可以读取指定文件中的内容。

1
2
3
4
5
6
7
8
9
10
11
12
13
// 1. 导入 fs 模块，来操作文件
const fs = require('fs')

// 2. 调用 fs.readFile() 方法读取文件
fs.readFile('./files/11.txt', 'utf8', function(err, dataStr) {
  // 2.1 打印失败的结果
  // 如果读取成功，则 err 的值为 null
  // 如果读取失败，则 err 的值为 错误对象，dataStr 的值为 undefined
  console.log(err)
  console.log('-------')
  // 2.2 打印成功的结果
  console.log(dataStr)
})

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

fs.writeFile()

使用 fs.writeFile() 方法，可以向指定的文件中写入内容。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
// 1. 导入 fs 文件系统模块
const fs = require('fs')

// 2. 调用 fs.writeFile() 方法，写入文件的内容
fs.writeFile('./files/3.txt', 'ok123', function(err) {
  // 2.1 如果文件写入成功，则 err 的值等于 null
  // 2.2 如果文件写入失败，则 err 的值等于一个 错误对象
  // console.log(err)

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

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

注意：

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

路径动态拼接的问题

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

1
2
3
4
5
6
7
8
9
10
11
const fs = require('fs')
// __dirname 表示当前文件所处的目录
// console.log(__dirname)

fs.readFile(__dirname + '/files/1.txt', 'utf8', function(err, dataStr) {
  if (err) {
    return console.log('读取文件失败！' + err.message)
  }
  console.log('读取文件成功！' + dataStr)
})

path 路径模块

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

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

path.join()

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
const path = require('path')
const fs = require('fs')

// 注意：  ../ 会抵消前面的路径
// const pathStr = path.join('/a', '/b/c', '../../', './d', 'e')
// console.log(pathStr)  // \a\b\d\e

// fs.readFile(__dirname + '/files/1.txt')

fs.readFile(path.join(__dirname, './files/1.txt'), 'utf8', function(err, dataStr) {
  if (err) {
    return console.log(err.message)
  }
  console.log(dataStr)
})

参数解读：
…paths <string> 路径片段的序列
返回值: <string>

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

path.basename()

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

1
2
3
4
5
6
7
8
9
10
11
const path = require('path')

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

// const fullName = path.basename(fpath)
// console.log(fullName)

const nameWithoutExt = path.basename(fpath, '.html')
console.log(nameWithoutExt)

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

path.extname()

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

1
2
3
4
5
6
7
8
const path = require('path')

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

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

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

http 模块

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

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

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

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

创建 web 服务器

调用 http.createServer() 方法，即可快速创建一个 web 服务器实例。

1
2
3
4
5
6
7
8
9
10
11
12
// 1. 导入 http 模块
const http = require('http')
// 2. 创建 web 服务器实例
const server = http.createServer()
// 3. 为服务器实例绑定 request 事件，监听客户端的请求
server.on('request', function (req, res) {
  console.log('Someone visit our web server.')
})
// 4. 启动服务器
server.listen(8080, function () {  
  console.log('server running at http://127.0.0.1:8080')
})

为服务器实例绑定 request 事件，即可监听客户端发送过来的网络请求。

调用服务器实例的 .listen() 方法，即可启动当前的 web 服务器实例。

req 请求对象

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
const http = require('http')
const server = http.createServer()
// req 是请求对象，包含了与客户端相关的数据和属性
server.on('request', req => {
  // req.url 是客户端请求的 URL 地址
  const url = req.url
  // req.method 是客户端请求的 method 类型
  const method = req.method
  const str = `Your request url is ${url}, and request method is ${method}`
  console.log(str)
})
server.listen(80, () => {
  console.log('server running at http://127.0.0.1')
})

res 响应对象

在服务器的 request 事件处理函数中，如果想访问与服务器相关的数据或属性，调用 res.end() 方法，向客户端响应一些内容。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
const http = require('http')
const server = http.createServer()
// req 是请求对象，包含了与客户端相关的数据和属性
server.on('request', (req, res) => {
  // req.url 是客户端请求的 URL 地址
  const url = req.url
  // req.method 是客户端请求的 method 类型
  const method = req.method
  const str = `Your request url is ${url}, and request method is ${method}`
  console.log(str)
  // 调用 res.end() 方法，向客户端响应一些内容
  res.end(str)
})
server.listen(80, () => {
  console.log('server running at http://127.0.0.1')
})
  • Title: Node-note-1
  • Author: Charles
  • Created at : 2023-07-24 08:12:31
  • Updated at : 2023-07-26 16:22:39
  • Link: https://charles2530.github.io/2023/07/24/node-note-1/
  • License: This work is licensed under CC BY-NC-SA 4.0.
recommend_articles
CO_Pre CO_Pre JavaScript_note_7 JavaScript_note_7 Ajax-note-3 Ajax-note-3
recommend_articles
CO_Pre CO_Pre JavaScript_note_7 JavaScript_note_7
Comments
On this page
Node-note-1
  1. 初识Node.js与内置模块
    1. 初识 Node.js
    2. fs 文件系统模块
      1. fs.readFile()
      2. fs.writeFile()
      3. 路径动态拼接的问题
    3. path 路径模块
      1. path.join()
      2. path.basename()
      3. path.extname()
    4. http 模块
      1. 创建 web 服务器
      2. req 请求对象
      3. res 响应对象