Node.js笔记

一、内置 fs 模块

1.1 导入fs模块

const fs = require('fs')

1.2 fs.readFlie()

• 作用：读取文件

• 写法：fs.readFlie(path[,options],callback)

• [必选]参数1：读取文件的存放路径

• [可选]参数2：读取文件时候采用的编码格式，一般默认指定 utf8

• [必选]参数3：回调函数，拿到读取失败和成功的结果 err dataStr

fs.readFile('./files/11.txt', 'utf8', function(err, dataStr) {
  // 2.1 如果读取成功，则 err 的值为 null
  // 2.2 如果读取失败，则 err 的值为 错误对象，dataStr 的值为 undefined
  if (err) {
    return console.log('读取文件失败！' + err.message)
  }
  console.log('读取文件成功！' + dataStr)
})

1.3 fs.writeFile()

• 作用：写入文件内容

• 写法：fs.writeFile(path,data[,options],callback)

• [必选]参数1：表示文件的存放路径

• [必选]参数2：表示要写入的内容

• [可选]参数3：写入内容时候采用的编码格式，一般默认指定 utf8

• [必选]参数4：回调函数

fs.writeFile('./files/3.txt', 'abcd', function(err) {
// 3.1 如果文件写入成功，则 err 的值等于 null
// 3.2 如果文件写入失败，则 err 的值等于一个 错误对象
// console.log(err)
if (err) {
return console.log('文件写入失败！' + err.message)
}
console.log('文件写入成功！')
})

二、内置 path 模块

2.1 导入path模块

const path = require('path')

2.2 path.jion()

• 作用：将多个路径片段拼接成一个完整的字符串

• 注意： …/ 会抵消前面的路径

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

2.3 路径拼接错误问题

• 出现路径拼接错误的问题，是因为提供了 ./ 或 …/ 开头的相对路径，代码在运行的时候，会以执行node命令时所处的目录，动态拼接出被操作文件的完整路径

• 解决方法：1.直接提供一个完整的文件存放路径就行（如'C:\\Users\\escook\\Desktop\\Node.js基础\\day1\\code\\files\\1.txt'）【移植性非常差、不利于维护】

• 2. 使用path.jion()与__dirname【表示当前文件所处的目录】【推荐使用】

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

2.4 path.basename()

• 作用：用来从路径字符串中将文件名解析出来

• 写法：path.basename(path[,ext])

• [必选]参数1：表示一个路径的字符串

• [可选]参数2：表示文件扩展名

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

2.5 path.extname()

• 作用：从路径字符串中将文件的扩展名解析出来
• 写法：path.extname(path)

const fpath = '/a/b/c/index.html'
const fext = path.extname(fpath)
console.log(fext) // .html

2.6 实战：clock时钟案例

• 需求：把素材文件夹下的index.html中的样式结构JS部分拆分成三个文件保存在clock文件夹下

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

// 1.3 定义正则表达式，分别匹配 <style></style> 和 <script></script> 标签
// 其中 \s 表示空白字符； \S 表示非空白字符； * 表示匹配任意次； </script>内需要加 \ 转义
const regStyle = /<style>[\s\S]*<\/style>/
const regScript = /<script>[\s\S]*<\/script>/

// 2.1 调用 fs.readFile() 方法读取文件
fs.readFile(path.join(__dirname, '../素材/index.html'), 'utf8', function (err, dataStr) {
	// 2.2 读取 HTML 文件失败
	if (err) return console.log('读取HTML文件失败！' + err.message)
	// 2.3 读取文件成功后，调用对应的三个方法，分别拆解出 css, js, html 文件
	resolveCSS(dataStr)
	resolveJS(dataStr)
	resolveHTML(dataStr)
})

// 3.1 定义处理 css 样式的方法
function resolveCSS(htmlStr) {
	// 3.2 使用正则提取需要的内容 返回的是一个数组 索引为0的元素就是匹配整个模式的字符串
	const r1 = regStyle.exec(htmlStr)
	// 3.3 将提取出来的样式字符串，进行字符串的 replace 替换操作
	const newCSS = r1[0].replace('<style>', '').replace('</style>', '')
	// 3.4 调用 fs.writeFile() 方法，将提取的样式，写入到 clock 目录中 index.css 的文件里面
	fs.writeFile(path.join(__dirname, './clock/index.css'), newCSS, function (err) {
		if (err) return console.log('写入 CSS 样式失败！' + err.message)
		console.log('写入样式文件成功！')
	})
}

// 4.1 定义处理 js 脚本的方法
function resolveJS(htmlStr) {
	// 4.2 通过正则，提取对应的 <script></script> 标签内容
	const r2 = regScript.exec(htmlStr)
	// 4.3 将提取出来的内容，做进一步的处理
	const newJS = r2[0].replace('<script>', '').replace('</script>', '')
	// 4.4 将处理的结果，写入到 clock 目录中的 index.js 文件里面
	fs.writeFile(path.join(__dirname, './clock/index.js'), newJS, function (err) {
		if (err) return console.log('写入 JavaScript 脚本失败！' + err.message)
		console.log('写入 JS 脚本成功！')
	})
}

// 5.1 定义处理 HTML 结构的方法
function resolveHTML(htmlStr) {
	// 5.2 将字符串调用 replace 方法，把内嵌的 style 和 script 标签，替换为外联的 link 和 script 标签
	const newHTML = htmlStr
		.replace(regStyle, '<link rel="stylesheet" href="./index.css" />')
		.replace(regScript, '<script src="./index.js"></script>')
	// 5.3 写入 index.html 这个文件
	fs.writeFile(path.join(__dirname, './clock/index.html'), newHTML, function (err) {
		if (err) return console.log('写入 HTML 文件失败！' + err.message)
		console.log('写入 HTML 页面成功！')
	})
}

代码中的函数定义部分可以耦合

三、内置 http 模块

3.1 导入http模块

const http = require('http')

3.2 server.on()与server.listen()方法创建基本的web服务器

// 1. 导入 http 模块
const http = require('http')
// 2. 创建 web 服务器实例
const server = http.createServer()
// 3. server.on()方法为服务器实例绑定 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')
})

3.3 req请求对象

• req.url是客户端请求的 URL 地址 (如/index.html)

• req.method是客户端请求的 method 类型(如GET/POST/PUT等)

3.4 res.send()方法，向客户端响应内容

• 调用res.send()方法，向客户端发送内容时，会出现乱码问题，此时需要手动设置内容的编码格式
  res.setHeader()方法，设置 Content-Type 响应头，解决中文乱码的问题

res.setHeader('Content-Type', 'text/html; charset=utf-8')

3.5 实战：根据不同的URL响应不同的HTML内容

const http = require('http')
const server = http.createServer()

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 首页
  // 4. 判断用户请求的是否为 /about.html 关于页面
  if (url === '/' || url === '/index.html') {
    content = '<h1>首页</h1>'
  } else if (url === '/about.html') {
    content = '<h1>关于页面</h1>'
  }
  // 5. 设置 Content-Type 响应头，防止中文乱码
  res.setHeader('Content-Type', 'text/html; charset=utf-8')
  // 6. 使用 res.end() 把内容响应给客户端
  res.end(content)
})

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

3.6 实战：clock时钟web服务器

// 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 地址
	//     /clock/index.html
	//     /clock/index.css
	//     /clock/index.js
	const url = req.url
	// 3.2 把请求的 URL 地址映射为具体文件的存放路径
	// const fpath = path.join(__dirname, url)
	// 5.1 预定义一个空白的文件存放路径
	let fpath = ''
	if (url === '/') {
		fpath = path.join(__dirname, './clock/index.html')
	} else {
		//     /index.html
		//     /index.css
		//     /index.js
		fpath = path.join(__dirname, '/clock', url)
	}

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

四、模块化

4.1 概念

遵守固定的规则，把一个大文件拆成独立并相互依赖的多个小模块

4.2 优点

• 提高了代码的复用性

• 提高了代码的可维护性

• 可以实现按需加载

4.3 模块化分类&require()方法加载模块

• 使用require()方法加载其他模块时，会执行被加载模块中的代码

// 1. 加载内置的fs模块
const fs = require('fs')
// 2. 加载用户的自定义模块
const custom = require('fs')
// 3. 加载第三方模块
const moment = require('moment')

4.4 模块作用域&module对象

• 在自定义模块中定义的变量、方法等成员，只能在当前模块内被访问，这种模块级别的访问限制叫做模块作用域

• 防止了全局变量污染问题

• 在每个.js自定义模块中都有一个module对象，存储了和当前模块有关的信息，打印如下

4.5 module.exports对象

• 在自定义模块中，使用module.exports对象将模块内成员共享出去，供外界使用

• 外界使用require()方法导入自定义模块时，得到的就是module.exports所指向的对象

// 在一个自定义模块中，默认情况下， module.exports = {}

const age = 20

// 1. 向 module.exports 对象上挂载 username 属性
module.exports.username = 'zs'
// 2. 向 module.exports 对象上挂载 sayHello 方法
module.exports.sayHello = function() {
  console.log('Hello!')
}
module.exports.age = age

// 3. 让 module.exports 指向一个全新的对象
module.exports = {
  nickname: '小黑',
  sayHi() {
    console.log('Hi!')
  }
}

• 使用require()方法导入模块时，导入结果永远以module.exports指向的对象为准，上面的代码输出结果为

{ nickname: '小黑', sayHi: [Function: sayHi] }

• 若没有（3）则输出结果为

{ username: 'zs', sayHello: [Function (anonymous)], age: 20 }

4.6 exports对象

• 为了简化代码，默认情况下，exports和module.exports指向同一个对象。
• 最终的结果还是以module.exports指向的对象为准

const username = 'zs'
module.exports.username = username
exports.age = 20
exports.sayHello = function() {
  console.log('大家好！')
}

• 上面的代码输出结果

{ username: 'zs', age: 20, sayHello: [Function (anonymous)] }

4.7 模块的加载机制

• 模块在第一次加载后会被缓存。 这也意味着多次调用 require() 不会导致模块的代码被执行多次。
• 不论是内置模块、用户自定义模块、还是第三方模块，它们都会优先从缓存中加载，从而提高模块的加载效率。
• 内置模块的加载优先级最高。
• 使用 require() 加载自定义模块时，必须指定以 ./ 或 …/ 开头的路径标识符。在加载自定义模块时，如果没有指定 ./ 或 …/ 这样的路径标识符，则 node 会把它当作内置模块或第三方模块进行加载。

五、npm与包

• 包就是第三方模块

• 包管理工具：Node Package Manager（npm）

5.1 安装包

// 完整形式
$ npm install 包的名称
// 简写形式
$ npm i 包的名称
// 默认情况下会安装最新版本，若要安装指定版本，可以通过 @ 指定具体的版本
$ npm i moment@2.22.2
$ npm i less-loader@7

5.2 实战：使用 moment 包格式化时间

// 1. 安装需要的包
$ npm i install moment
// 2. 导入需要的包
// 注意：导入的名称，就是装包时候的名称
const moment = require('moment')

// 3. 参考 moment 官方API文档，调用对应的方法对时间进行格式化
// 3.1 调用 moment() 方法，得到当前的时间
// 3.2 调用 format() 方法，得到指定格式的时间的格式化
const dt = moment().format('YYYY-MM-DD HH:mm:ss')

console.log(dt) // 2022-01-23 23:48:18

5.3 node_modules 文件夹& package-lock.json 配置文件& package.json配置文件

• node_modules 文件夹用来存放所有已安装到项目中的包
• package-lock.json 用来记录 node_modules 目录下每一个包的下载信息，例如包的名字、版本号、下载的地址等。从 npm 5 版本之后只要使用 npm install命令下载，就会自动生成 package-lock.json 文件。
• package.json 记录当前项目所依赖模块的版本信息（dependencies 节点），执行 npm init -y命令生成。当版本升级，使用 npm install命令时，会安装 package.json 中指定的大版本的最新版本。
• 在项目开发中，要把 node_modules 文件夹添加到 .gitignore 忽略文件中

5.4 包的语义化版本规范

• 第1位数字：大版本
• 第2位数字：功能版本
• 第3位数字：Bug修复版本

5.5 卸载包

$ npm uninstall 包的名称

• 卸载的包会自动从 package.json 的 dependencies 中移除

5.6 devDependencies 节点

• 如果某些包只在项目开发阶段会用到，在项目上线之后不会用到，则建议把这些包记录到 devDependencies 节点中。

// 安装指定的包并记录到 devDependencies 节点中。
$ npm i 包的名称 -D

5.7 实战：开发属于自己的包，功能：格式化时间，HTMLEscape

1. 初始化包的基本结构

   1. 新建 MyTools 文件夹，作为包的根目录
   2. 在 MyTools 文件夹中，新建如下三个文件
      • package.json （包管理配置文件）
      • index.js（包的入口文件）
      • README.md（包的说明文档）

2. 初始化 package.json 文件

{
    "name": "my-tools-000930", // 包的名字必须是独一无二的，不能和别人的重复
    "version": "1.0.0",
    "main": "index.js", // 如果外界使用require()方法导入的时候没有指定导入的文件，则默认导入main属性指定的入口文件
    "description": "提供了格式化时间，HTMLEscape的功能",
    "keywords": ["my-tools-000930","dateFormat","escape"],
    "license": "ISC" // 开源协议
}

3. 将不同的功能进行模块化拆分
   1. 将格式化时间的功能，拆分到 src -> dateFormat.js 中
   2. 将处理 HTML 字符串的功能，拆分到 src -> htmlEscape.js 中
   3. 在 index.js 中导入两个模块，得到需要向外共享的方法并使用 module.exports 把对应的方法共享出去

// dateFormat.js 
// 定义格式化时间的函数
function dateFormat(dtStr) {
  const dt = new Date(dtStr)

  const y = dt.getFullYear()
  const m = padZero(dt.getMonth() + 1)
  const d = padZero(dt.getDate())

  const hh = padZero(dt.getHours())
  const mm = padZero(dt.getMinutes())
  const ss = padZero(dt.getSeconds())

  return `${y}-${m}-${d} ${hh}:${mm}:${ss}`
}

// 定义补零的函数
function padZero(n) {
  return n > 9 ? n : '0' + n
}

// 向外暴露成员
module.exports = {
  dateFormat
}

// htmlEscape.js
// 定义转义 HTML 字符的函数
function htmlEscape(htmlstr) {
  return htmlstr.replace(/<|>|"|&/g, match => {
    switch (match) {
      case '<':
        return '&lt;'
      case '>':
        return '&gt;'
      case '"':
        return '&quot;'
      case '&':
        return '&amp;'
    }
  })
}

// 定义还原 HTML 字符串的函数
function htmlUnEscape(str) {
  return str.replace(/&lt;|&gt;|&quot;|&amp;/g, match => {
    switch (match) {
      case '&lt;':
        return '<'
      case '&gt;':
        return '>'
      case '&quot;':
        return '"'
      case '&amp;':
        return '&'
    }
  })
}

module.exports = {
  htmlEscape,
  htmlUnEscape
}

// 3. index.js中
const date = require('./src/dateFormat')
const escape = require('./src/htmlEscape')

// 向外暴露需要的成员
module.exports = {
  ...date,
  ...escape
}

4. 在README.md文件中编写包的说明文档
5. 发布包

// 1. 登录 npm 账号
$ npm login
// 2. 发布包
$ npm publish
// 3. 删除包
$ npm unpublish

六、Express 框架

6.1 简介

• Express中文官网
• Express 是基于 Node.js 平台，快速、开放、极简的 Web 开发框架。
• 使用 Express，我们可以方便、快速的创建 Web 网站的服务器或 API 接口的服务器。

6.2 基本使用

6.2.1 下载

$ npm install express --save

6.2.2 创建基本的 Web 服务器【app.get()、app.post()、app.listen()、res.send()、req.query()、req,params()】

// 1. 导入 express
const express = require('express')
// 2. 创建 web 服务器
const app = express()

// 4. 监听客户端的 GET 和 POST 请求，并向客户端响应具体的内容
app.get('/user', (req, res) => {
	// 调用 express 提供的 res.send() 方法，向客户端响应一个 JSON 对象
	res.send({ name: '张三', age: 20, gender: '男' })
})
app.post('/user', (req, res) => {
	// 调用 express 提供的 res.send() 方法，向客户端响应一个 文本字符串
	res.send('请求成功')
})
app.get('/', (req, res) => {
	// 通过 req.query 可以获取到客户端发送过来的 查询参数
	// 注意：默认情况下，req.query 是一个空对象
	console.log(req.query)
	res.send(req.query)
})
// 注意：这里的 :id 是一个动态的参数 接收params参数需要使用占位符
app.get('/user/:ids/:username', (req, res) => {
	// req.params 是动态匹配到的 URL 参数，默认也是一个空对象
	console.log(req.params)
	res.send(req.params)
})

// 3. 启动 web 服务器
app.listen(8080, () => {
	console.log('express server running at http://127.0.0.1:8080')
})

6.3 express.static()托管静态资源

• express 提供了一个非常好用的函数，叫做 express.static()，通过它，我们可以非常方便地创建一个静态资源服务器，
  例如，通过如下代码就可以将 public 目录下的图片、CSS 文件、JavaScript 文件对外开放访问了：

app.use(express.static('public'))
// 挂载路径前缀
app.use('/public',express.static('public'))

6.4 nodemon

• nodemon 在代码被修改后，会自动帮我们重启node
• 全局安装 nodemon

$ npm i nodemon -g

• 开启 nodemon

$ nodemon 文件名

6.5 路由

6.5.1 路由的组成

• 请求的类型、请求的 URL 地址、处理函数

app.METHOD(PATH,HANDLER)

6.5.2 路由的匹配过程

• 每当一个请求到达服务器之后，需要先经过路由的匹配，只有匹配成功之后，才会调用对应的处理函数。
• 在匹配时，会按照路由的顺序进行匹配，如果请求类型和请求的 URL 同时匹配成功，则 Express 会将这次请求，转交给对应的 function 函数进行处理。

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-5HNC6Ar0-1643265026680)(Node.js笔记.assets/路由的匹配过程.png)]

6.5.3 路由最简单的用法

• 在 Express 中使用路由最简单的方式，就是把路由挂载到 app 上，示例代码如下：

const express = require('express')
const app = express()

// 挂载路由
app.get('/', (req,res) => {
    res.send('Hello,World.')
})
app.post('/', (req,res) => {
    res.send('Post Request')
})

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

6.5.4 路由模块化

• 为了方便对路由进行模块化的管理，Express 不建议将路由直接挂载到 app 上，而是推荐将路由抽离为单独的模块。

// router.js中
// 1. 导入 express
const express = require('express')
// 2. 创建路由对象
const router = express.Router()

// 3. 挂载具体的路由
router.get('/user/list', (req, res) => {
  res.send('Get user list.')
})
router.post('/user/add', (req, res) => {
  res.send('Add new user.')
})

// 4. 向外导出路由对象
module.exports = router

// app.js中
const express = require('express')
const app = express()

// app.use('/files', express.static('./files'))

// 1. 导入路由模块
const router = require('./03.router')
// 2. 注册路由模块
app.use('/api', router)

// 注意： app.use() 函数的作用，就是来注册全局中间件

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

6.6 中间件

6.6.1 中间件的调用流程

• 当一个请求到达 Express 的服务器之后，可以连续调用多个中间件，从而对这次请求进行预处理。

6.6.2 中间件的格式

• Express 的中间件，本质上就是一个 function 处理函数，Express 中间件的格式如下：

• 中间件函数的形参列表中，必须包含 next 参数。而路由处理函数中只包含 req 和 res。

6.6.3 next()函数

• next()函数是实现多个中间件连续调用的关键，它表示把流转关系转交给下一个中间件或路由。

6.6.4 定义中间件函数

• 可以通过如下的方式，定义一个最简单的中间件函数：

// 定义一个最简单的中间件函数
const mw = function (req, res, next) {
  console.log('这是最简单的中间件函数')
  // 把流转关系，转交给下一个中间件或路由
  next()
}

6.6.5 全局中间件

• 客户端发起的任何请求，到达服务器之后，都会触发的中间件，叫做全局生效的中间件。

• 通过调用 app.use(中间件函数)，即可定义一个全局生效的中间件，示例代码如下：

// 1. 定义一个最简单的中间件函数
const mw = function (req, res, next) {
  console.log('这是最简单的中间件函数')
  // 把流转关系，转交给下一个中间件或路由
  next()
}
// 将 mw 注册为全局生效的中间件
app.use(mw)

// 2. 简化写法
app.use((req, res, next) => {
	console.log('这是最简单的中间件函数')
	next()
})

// 3. 还可以定义多个全局中间件
// 定义第一个全局中间件
app.use((req, res, next) => {
	console.log('调用了第1个全局中间件')
	next()
})
// 定义第二个全局中间件
app.use((req, res, next) => {
	console.log('调用了第2个全局中间件')
	next()
})

6.6.6 中间件的作用

• 多个中间件之间，共享同一份 req 和 res。基于这样的特性，我们可以在上游的中间件中，统一为 req 或 res 对象添加自定义的属性或方法，供下游的中间件或路由进行使用。

6.6.7 局部生效的中间件

• 不使用 app.use()定义的中间件，叫做局部生效的中间件，示例代码如下：

// 导入 express 模块
const express = require('express')
// 创建 express 的服务器实例
const app = express()

// 1. 定义中间件函数
const mw1 = (req, res, next) => {
  console.log('调用了局部生效的中间件')
  next()
}

// 2. 创建路由，mw1 这个中间件只在“当前路由中生效”
app.get('/', mw1, (req, res) => {
  res.send('Home page.')
})
app.get('/user', (req, res) => {
  res.send('User page.')
})

// 调用 app.listen 方法，指定端口号并启动web服务器
app.listen(8080, function () {
  console.log('server running at http://127.0.0.1:8080')
})

• 定义多个局部中间件

// 以下两种写法完全等价
app.get('/', [mw1, mw2], (req, res) => {
  res.send('Home page.')
})

app.get('/', mw1, mw2, (req, res) => {
  res.send('Home page.')
})

6.6.8 5个注意事项

• 一定要在路由之前注册中间件
• 客户端发送过来的请求，可以连续调用多个中间件进行处理
• 执行完中间件的业务代码之后，不要忘记调用 next()函数
• 为了防止代码逻辑混乱，调用 next() 函数后不要再写额外的代码
• 连续调用多个中间件时，多个中间件之间，共享 req 和 res 对象

6.6.9 中间件的分类

1. 应用级别的中间件

• 通过 app.use()或 app.get()或 app.post()，绑定到 app 实例上的中间件，叫做应用级别的中间件

2. 路由级别的中间件

• 绑定到 express.Router()实例上的中间件，叫做路由级别的中间件。它的用法和应用级别中间件没有任何区别。只不过，应用级别中间件是绑定到 app 实例上，路由级别中间件绑定到 router 实例上，

3. 错误级别的中间件

• 专门用来捕获整个项目中发生的异常错误，从而防止项目异常崩溃的问题。

• 错误级别中间件的 function 处理函数中，必须有 4 个形参，形参顺序从前到后，分别是 (err, req, res, next)

错误级别的中间件，必须注册在所有路由之后！

// 导入 express 模块
const express = require('express')
// 创建 express 的服务器实例
const app = express()

// 1. 定义路由
app.get('/', (req, res) => {
  // 1.1 人为的制造错误
  throw new Error('服务器内部发生了错误！')
  res.send('Home page.')
})

// 2. 定义错误级别的中间件，捕获整个项目的异常错误，从而防止程序的崩溃
app.use((err, req, res, next) => {
  console.log('发生了错误！' + err.message)
  res.send('Error：' + err.message)
})

// 调用 app.listen 方法，指定端口号并启动web服务器
app.listen(8080, function () {
  console.log('Express server running at http://127.0.0.1:8080')
})

4. Express 内置的中间件

• 自 Express 4.16.0 版本开始，Express 内置了 3 个常用的中间件，极大的提高了 Express 项目的开发效率和体验：
  • express.static快速托管静态资源的内置中间件，例如： HTML 文件、图片、CSS 样式等（无兼容性）
  • express.json解析 JSON 格式的请求体数据（有兼容性，仅在 4.16.0+ 版本中可用）
  • express.urlencoded解析 URL-encoded 格式的请求体数据（有兼容性，仅在 4.16.0+ 版本中可用）

// 配置解析 application/json 格式数据的内置中间件
app.use(express.json())
// 配置解析 application//x-www-form-urlencoded 格式数据的内置中间件
app.use(express.urlencoded({ entended: false }))

// 导入 express 模块
const express = require('express')
// 创建 express 的服务器实例
const app = express()

// 注意：除了错误级别的中间件，其他的中间件，必须在路由之前进行配置
// 通过 express.json() 这个中间件，解析表单中的 JSON 格式的数据
app.use(express.json())
// 通过 express.urlencoded() 这个中间件，来解析 表单中的 url-encoded 格式的数据
app.use(express.urlencoded({ extended: false }))

app.post('/user', (req, res) => {
  // 在服务器，可以使用 req.body 这个属性，来接收客户端发送过来的请求体数据
  // 默认情况下，如果不配置解析表单数据的中间件，则 req.body 默认等于 undefined
  console.log(req.body)
  res.send('ok')
})

app.post('/book', (req, res) => {
  // 在服务器端，可以通过 req,body 来获取 JSON 格式的表单数据和 url-encoded 格式的数据
  console.log(req.body)
  res.send('ok')
})

// 调用 app.listen 方法，指定端口号并启动web服务器
app.listen(8080, function () {
  console.log('Express server running at http://127.0.0.1:8080')
})

5. 第三方的中间件

• 非 Express 官方内置的，而是由第三方开发出来的中间件，叫做第三方中间件。

• 例如：在 express@4.16.0 之前的版本中，经常使用 body-parser 这个第三方中间件，来解析请求体数据。使用步骤如下

  1. 运行 $ npm install body-parser安装中间件

  2. 使用 require()导入中间件

  3. 调用 app.use()注册并使用中间件

// 导入 express 模块
const express = require('express')
// 创建 express 的服务器实例
const app = express()

// 1. 导入解析表单数据的中间件 body-parser
const parser = require('body-parser')
// 2. 使用 app.use() 注册中间件
app.use(parser.urlencoded({ extended: false }))
// app.use(express.urlencoded({ extended: false }))

app.post('/user', (req, res) => {
  // 如果没有配置任何解析表单数据的中间件，则 req.body 默认等于 undefined
  console.log(req.body)
  res.send('ok')
})

// 调用 app.listen 方法，指定端口号并启动web服务器
app.listen(80, function () {
  console.log('Express server running at http://127.0.0.1')
})

Express 内置的 express.urlencoded中间件，就是基于 body-parser 这个第三方中间件进一步封装出来的。

6.6.10 实战：自定义中间件

• 需求：自己手动模拟一个类似于 express.urlencoded这样的中间件，来解析 POST 提交到服务器的表单数据。

// 导入 Node.js 内置的 querystring 模块
const qs = require('querystring')

const bodyParser = (req, res, next) => {
  // 定义中间件具体的业务逻辑
  // 1. 定义一个 str 字符串，专门用来存储客户端发送过来的请求体数据
  let str = ''
  // 2. 监听 req 的 data 事件:当服务器接收到客户端发来的数据时触发
  req.on('data', (chunk) => {
    str += chunk
  })
  // 3. 监听 req 的 end 事件:当请求体数据接收完毕之后触发
  req.on('end', () => {
    // 在 str 中存放的是完整的请求体数据
    // console.log(str)
    // TODO: 把字符串格式的请求体数据，解析成对象格式
    const body = qs.parse(str)
    req.body = body
    next()
  })
}

module.exports = bodyParser

如果数据量比较大，无法一次性发送完毕，则客户端会把数据切割后，分批发送到服务器。所以data 事件可能会触发多次，每一次触发 data 事件时，获取到数据只是完整数据的一部分，需要手动对接收到的数据进行拼接。

Node.js 内置了一个 querystring 模块，专门用来处理查询字符串。通过这个模块提供的 parse()函数，可以轻松把查询字符串，解析成对象的格式。

6.7 跨域

6.7.1 同源策略

• 协议 域名 端口号一致

6.7.2 跨域问题

• 跨域问题是浏览器与服务器之间产生的(前端与后端),服务器与服务器之间没有跨域问题

6.7.3 解决接口跨域的主要方案

• CORS
• JSONP （只支持 GET 请求）

6.8 CORS 跨域资源共享

6.8.1 概念

• CORS （Cross-Origin Resource Sharing，跨域资源共享）由一系列 HTTP 响应头组成，这些 HTTP 响应头决定浏览器是否阻止前端 JS 代码跨域获取资源。
• 浏览器的同源安全策略默认会阻止网页“跨域”获取资源。但如果接口服务器配置了 CORS 相关的 HTTP 响应头，就可以解除浏览器端的跨域访问限制。

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-RbG7Upwo-1643265026682)(Node.js笔记.assets/什么是CORS.png)]

6.8.2 CORS 响应头部

1. Access-Control-Allow-Origin

// 允许来自任何域的请求
res.setHeader('Access-Control-Allow-Origin', '*')
// 只允许来自 http://itcast.cn 的请求
res.setHeader('Access-Control-Allow-Origin', 'http://itcast.cn')

• 其中，origin 参数的值指定了允许访问该资源的外域 URL

2. Access-Control-Allow-Headers

• 默认情况下，CORS 仅支持客户端向服务器发送如下的 9 个请求头：Accept、Accept-Language、Content-Language、DPR、Downlink、Save-Data、Viewport-Width、Width 、
  Content-Type （值仅限于 text/plain、multipart/form-data、application/x-www-form-urlencoded 三者之一）

• 如果客户端向服务器发送了额外的请求头信息，则需要在服务器端，通过 Access-Control-Allow-Headers 对额外的请求头进行声明，否则这次请求会失败！

res.setHeader('Access-Control-Allow-Headers', 'Content-Type, X-Custom-Header')

3. Access-Control-Allow-Methods

• 默认情况下，CORS 仅支持客户端发起 GET、POST、HEAD 请求。
• 如果客户端希望通过 PUT、DELETE 等方式请求服务器的资源，则需要在服务器端，通过 Access-Control-Alow-Methods来指明实际请求所允许使用的 HTTP 方法。

// 只允许 POST、GET、DELETE、HEAD 请求方法
res.setHeader('Access-Control-Allow-Methods', 'POST, GET, DELETE, HEAD')
// 允许所有的 HTTP 请求方法
res.setHeader('Access-Control-Allow-Methods', '*')

6.8.3 CORS 请求的分类

1. 简单请求

• 同时满足以下两大条件的请求，就属于简单请求：

  1. 请求方式：GET、POST、HEAD 三者之一
  2. HTTP 头部信息不超过以下几种字段：无自定义头部字段、Accept、Accept-Language、Content-Language、DPR、Downlink、Save-Data、Viewport-Width、Width 、Content-Type（只有三个值application/x-www-form-urlencoded、multipart/form-data、text/plain）

2. 预检请求

• 只要符合以下任何一个条件的请求，都需要进行预检请求：

  1. 请求方式为 GET、POST、HEAD 之外的请求 Method 类型
  2. 请求头中包含自定义头部字段
  3. 向服务器发送了 application/json 格式的数据

• 在浏览器与服务器正式通信之前，浏览器会先发送 OPTION 请求进行预检，以获知服务器是否允许该实际请求，所以这一次的 OPTION 请求称为“预检请求”。服务器成功响应预检请求后，才会发送真正的请求，并且携带真实数据。

3. 简单请求和预检请求的区别

• 简单请求的特点：客户端与服务器之间只会发生一次请求
• 预检请求的特点：客户端与服务器之间会发生两次请求，OPTION 预检请求成功之后，才会发起真正的请求。

6.8.4 使用 CORS 中间件解决跨域问题

1. 运行 $ npm install cors安装中间件
2. 使用 const cors = require('cors')导入中间件
3. 在路由之前调用 app.use(cors())配置中间件

6.8.5 CORS 注意事项

• CORS 主要在服务器端进行配置。客户端浏览器无须做任何额外的配置，即可请求开启了 CORS 的接口。
• CORS 在浏览器中有兼容性。只有支持 XMLHttpRequest Level2 的浏览器，才能正常访问开启了 CORS 的服务端接口（例如：IE10+、Chrome4+、FireFox3.5+）。

6.9 JSONP

6.9.1 概念

• 浏览器端通过

<script src = "http://jsonp.js?callback=xxx"></script>

6.9.2 特点

• JSONP 不属于真正的 Ajax 请求，因为它没有使用 XMLHttpRequest 这个对象。
• JSONP 仅支持 GET 请求，不支持 POST、PUT、DELETE 等请求。

6.9.3 创建 JSONP 接口的注意事项

• 如果项目中已经配置了 CORS 跨域资源共享，为了防止冲突，必须在配置 CORS 中间件之前声明 JSONP 的接口。否则JSONP 接口会被处理成开启了 CORS 的接口。示例代码如下：

// 优先创建 JSONP 接口【这个接口不会被处理成 CORS 接口】
app.get('/api/jsonp', (req, res) => {})

// 再配置 CORS 中间件 【后续所有的接口都会被处理成 CORS 接口】
app.use(cors())

// 这是一个开启了 CORS 的接口
app.get('/api/get', (req, res) => {})

6.10 实战：使用 Express 写接口

// apiRouter.js 【路由模块】
const express = require('express')
const router = express.Router()

// 定义 GET 接口
router.get('/get', (req, res) => {
  // 通过 req.query 获取客户端通过查询字符串，发送到服务器的数据
  const query = req.query
  // 调用 res.send() 方法，向客户端响应处理的结果
  res.send({
    status: 0, // 0 表示处理成功，1 表示处理失败
    msg: 'GET 请求成功！', // 状态的描述
    data: query, // 需要响应给客户端的数据
  })
})

// 定义 POST 接口
router.post('/post', (req, res) => {
  // 通过 req.body 获取请求体中包含的 url-encoded 格式的数据
  const body = req.body
  // 调用 res.send() 方法，向客户端响应结果
  res.send({
    status: 0,
    msg: 'POST 请求成功！',
    data: body,
  })
})

// 定义 DELETE 接口
router.delete('/delete', (req, res) => {
  res.send({
    status: 0,
    msg: 'DELETE请求成功',
  })
})

module.exports = router

//------------------------------------------------------------------------

// api.js【导入并注册路由模块】
// 导入 express
const express = require('express')
// 创建服务器实例
const app = express()

// 配置解析表单数据的中间件
app.use(express.urlencoded({ extended: false }))

// 必须在配置 cors 中间件之前，配置 JSONP 的接口
app.get('/api/jsonp', (req, res) => {
  // TODO: 定义 JSONP 接口具体的实现过程
  // 1. 得到函数的名称 
  const funcName = req.query.callback
  // 2. 定义要发送到客户端的数据对象
  const data = { name: 'zs', age: 22 }
  // 3. 拼接出一个函数的调用
  const scriptStr = `${funcName}(${JSON.stringify(data)})`
  // 4. 把拼接的字符串，响应给客户端
  res.send(scriptStr)
})

// 一定要在路由之前，配置 cors 这个中间件，从而解决接口跨域的问题
const cors = require('cors')
app.use(cors())

// 导入路由模块
const router = require('./apiRouter')
// 把路由模块，注册到 app 上
app.use('/api', router)

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

七、数据库与身份认证

7.1 常用的 SQL 语句

7.1.1 SELECT 语句

-- 通过 * 把 users 表中所有的数据查询出来
select * from users

-- 从 users 表中把 username 和 password 对应的数据查询出来
select username, password from users

7.1.2 INSERT INTO 语句

-- 语法解读：向指定的表中，插入如下几列数据，列的值通过 values 一一指定
-- 注意：列和值要一一对应，多个列和多个值之间，使用英文的逗号分隔
INSERT INTO table_name (列1, 列2, ...) VALUES (值1, 值2, ...)

-- 向 users 表中，插入新数据，username 的值为 tony stark  password 的值为 098123
insert into users (username, password) values ('tony stark', '098123')

7.1.3 UPDATE 语句

-- 语法解读
-- 1. 用 UPDATE 指定要更新哪个表中的数据
-- 2. 用 SET 指定列对应的新值
-- 3. 用 WHERE 指定更新的条件
UPDATE 表名称 SET 列名称 = 新值 WHERE 列名称 = 某值

-- 将 id 为 4 的用户密码，更新成 888888
update users set password='888888' where id=4
-- 更新 id 为 2 的用户，把用户密码更新为 admin123  同时，把用户的状态更新为 1
update users set password='admin123', status=1 where id=2

7.1.4 DELETE 语句

-- 语法解读：从指定的表中，根据 WHERE 条件，删除对应的数据行
DELETE FROM 表名称 WHERE 列名称 = 值

-- 删除 users 表中， id 为 4 的用户
delete from users where id=4

7.1.5 WHERE 子句

• WHERE 子句用于限定选择的标准。在 SELECT、UPDATE、DELETE 语句中，皆可使用 WHERE 子句来限定选择的标准。

-- 查询语句中的 WHERE 条件
SELECT 列名称 FROM 表名称 WHERE 列名称 运算符 值
-- 更新语句中的 WHERE 条件
UPDATE 表名称 SET 列名称 = 新值 WHERE 列名称 运算符 值
-- 删除语句中的 WHERE 条件
DELETE FROM 表名称 WHERE 列名称 运算符 值

7.1.6 在 WHERE 子句中使用的运算符

操作符	描述
=	等于
<>或!=	不等于
>	大于
<	小于
>=	大于等于
<=	小于等于
BETWEEN	在某个范围内
LIKE	搜索某种模式

7.1.7 AND 和 OR 运算符

• AND 和 OR 可在 WHERE 子语句中把两个或多个条件结合起来。
• AND 表示必须同时满足多个条件，相当于 JavaScript 中的 && 运算符，例如 if (a !== 10 && a !== 20)
• OR 表示只要满足任意一个条件即可，相当于 JavaScript 中的 || 运算符，例如 if(a !== 10 || a !== 20)

-- 使用 AND 来显示所有状态为0且id小于3的用户
select * from users where status=0 and id<3

-- 使用 or 来显示所有状态为1 或 username 为 zs 的用户
select * from users where status=1 or username='zs'

7.1.8 ORDER BY 子句

• ORDER BY 语句用于根据指定的列对结果集进行排序。
• ORDER BY 语句默认按照升序对记录进行排序。
• 如果您希望按照降序对记录进行排序，可以使用 DESC 关键字。

-- 对users表中的数据，按照 status 字段进行升序排序
select * from users order by status

-- 按照 id 对结果进行降序的排序  desc 表示降序排序   asc 表示升序排序（默认情况下，就是升序排序的）
select * from users order by id desc

-- 对 users 表中的数据，先按照 status 进行降序排序，再按照 username 字母的顺序，进行升序的排序
select * from users order by status desc, username asc

7.1.9 COUNT(*) 函数

-- 语法解读：COUNT(*) 函数用于返回查询结果的总数据条数
SELECT COUNT(*) FROM 表名称

-- 使用 count(*) 来统计 users 表中，状态为 0 用户的总数量
select count(*) from users where status=0

7.1.10 使用 AS 为列设置别名

-- 使用 AS 关键字给列起别名
select count(*) as total from users where status=0
select username as uname, password as upwd from users

7.2 在项目中操作 MySQL

7.2.1 安装 mysql 模块

$ npm install mysql

7.2.2 配置 mysql 模块

• 在使用 mysql 模块操作 MySQL 数据库之前，必须先对 mysql 模块进行必要的配置

// 1. 导入 mysql 模块
const mysql = require('mysql')
// 2. 建立与 MySQL 数据库的连接关系
const db = mysql.createPool({
  host: '127.0.0.1', // 数据库的 IP 地址 默认端口号 3306 如果要设置端口号则添加 port 属性
  user: 'root', // 登录数据库的账号
  password: 'admin123', // 登录数据库的密码
  database: 'my_db_01', // 指定要操作哪个数据库
})

7.2.3 测试 mysql 模块能否正常工作

// 测试 mysql 模块能否正常工作
db.query('select 1', (err, results) => {
	// mysql 模块工作期间报错了
	if (err) return console.log(err.message)
	// 能够成功的执行 SQL 语句
	console.log(results)
})

// 打印结果
[ RowDataPacket { '1': 1 } ]

7.2.4 使用 mysql 模块操作 MySQL 数据库

1. 查询数据

// 查询 users 表中所有的数据
const sqlStr = 'select * from users'
db.query(sqlStr, (err, results) => {
  // 查询数据失败
  if (err) return console.log(err.message)
  // 查询数据成功
  console.log(results)
})

如果执行的是 SELECT 语句，则 result 是一个数组

2. 插入数据

// 向 users 表中，新增一条数据，其中 username 的值为 Spider-Man，password 的值为 pcc123
const user = { username: 'Spider-Man', password: 'pcc123' }
// 定义待执行的 SQL 语句，其中 ？表示占位符，这样不直接写可以防止SQL注入
const sqlStr = 'insert into users (username, password) values (?, ?)'
// 执行 SQL 语句
db.query(sqlStr, [user.username, user.password], (err, results) => {
  // 执行 SQL 语句失败了
  if (err) return console.log(err.message)
  // 成功了
  // 可以通过 affectedRows 属性，来判断是否插入数据成功
  if (results.affectedRows === 1) {
    console.log('插入数据成功!')
    console.log(results.insertId)
  }
})

• 向表中新增数据时，如果数据对象的每个属性和数据表的字段一一对应，则可以通过如下方式快速插入数据

// 演示插入数据的便捷方式
const user = { username: 'Spider-Man2', password: 'pcc4321' }
// 定义待执行的 SQL 语句
const sqlStr = 'insert into users set ?'
// 执行 SQL 语句
db.query(sqlStr, user, (err, results) => {
  if (err) return console.log(err.message)
  if (results.affectedRows === 1) {
    console.log('插入数据成功')
    console.log(results.insertId)
  }
})

如果执行的是 INSERT INTO 语句，则 results 是一个对象，可以通过 affectedRows 判断是否插入成功

如果 SQL 语句中有多个占位符，则必须使用数组为每个占位符指定具体的值

如果 SQL 语句中只有一个占位符，则可以省略数组

3. 更新数据

// 演示如何更新用户的信息
const user = { id: 6, username: 'aaa', password: '000' }
// 定义 SQL 语句
const sqlStr = 'update users set username=?, password=? where id=?'
// 执行 SQL 语句
db.query(sqlStr, [user.username, user.password, user.id], (err, results) => {
	if (err) return console.log(err.message)
	if (results.affectedRows === 1) {
		console.log('更新成功')
	}
})

• 更新表数据时，如果数据对象的每个属性和数据表的字段一一对应，则可以通过如下方式快速更新表数据：

const user = { id: 6, username: 'aaaa', password: '0000' }
// 定义 SQL 语句
const sqlStr = 'update users set ? where id=?'
// 执行 SQL 语句
db.query(sqlStr, [user, user.id], (err, results) => {
  if (err) return console.log(err.message)
  if (results.affectedRows === 1) {
    console.log('更新数据成功')
  }
})

如果执行的是 UPDATE 语句，则 results 是一个对象，可以通过 affectedRows 判断是否更新成功

4. 删除数据

// 删除 id 为 5 的用户
const sqlStr = 'delete from users where id=?'
db.query(sqlStr, 5, (err, results) => {
  if (err) return console.log(err.message)
  if (results.affectedRows === 1) {
    console.log('删除数据成功')
  }
})

5. 标记删除

• 使用 DELETE 语句，会把真正的把数据从表中删除掉。为了保险起见，推荐使用标记删除的形式，来模拟删除的动作。
• 所谓的标记删除，就是在表中设置类似于 status 这样的状态字段，来标记当前这条数据是否被删除。
• 当用户执行了删除的动作时，我们并没有执行 DELETE 语句把数据删除掉，而是执行了 UPDATE 语句，将这条数据对应的 status 字段标记为删除即可。

const sqlStr = 'update users set status=? where id=?'
db.query(sqlStr, [1, 6], (err, results) => {
  if (err) return console.log(err.message)
  if (results.affectedRows === 1) {
    console.log('标记删除成功')
  }
})

7.3 WEB 开发模式

7.3.1 服务端渲染的 Web 开发模式

1. 概念

• 服务器发送给客户端的 HTML 页面，是在服务器通过字符串的拼接，动态生成的。因此，客户端不需要使用 Ajax 这样的技术额外请求页面的数据。

2. 优缺点

• 优点：

  1. 前端耗时少。因为服务器端负责动态生成 HTML 内容，浏览器只需要直接渲染页面即可。尤其是移动端，更省电。
  2. 有利于SEO。因为服务器端响应的是完整的 HTML 页面内容，所以爬虫更容易爬取获得信息，更有利于 SEO。

• 缺点

  1. 占用服务器端资源。即服务器端完成 HTML 页面内容的拼接，如果请求较多，会对服务器造成一定的访问压力。
  2. 不利于前后端分离，开发效率低。使用服务器端渲染，则无法进行分工合作，尤其对于前端复杂度高的项目，不利于项目高效开发。

7.3.2 前后端分离的 Web 开发模式

1. 概念

• 前后端分离的开发模式，依赖于 Ajax 技术的广泛应用。简而言之，前后端分离的 Web 开发模式，就是后端只负责提供 API 接口，前端使用 Ajax 调用接口的开发模式。

2. 优缺点

• 优点

  1. 开发体验好。前端专注于 UI 页面的开发，后端专注于api 的开发，且前端有更多的选择性。
  2. 用户体验好。Ajax 技术的广泛应用，极大的提高了用户的体验，可以轻松实现页面的局部刷新。
  3. 减轻了服务器端的渲染压力。因为页面最终是在每个用户的浏览器中生成的。

• 缺点

  1. 不利于 SEO。因为完整的 HTML 页面需要在客户端动态拼接完成，所以爬虫对无法爬取页面的有效信息。（解决方案：利用 Vue、React 等前端框架的 SSR （server side render）技术能够很好的解决 SEO 问题！）

7.4 身份认证

7.4.1 什么是身份认证

• 身份认证（Authentication）又称“身份验证”、“鉴权”，是指通过一定的手段，完成对用户身份的确认。

7.4.2 不同开发模式下的身份认证

• 服务端渲染推荐使用 Session 认证机制
• 前后端分离推荐使用 JWT 认证机制

7.4.3 Session 认证机制

1. HTTP 协议的无状态性

• HTTP 协议的无状态性，指的是客户端的每次 HTTP 请求都是独立的，连续多个请求之间没有直接的关系，服务器不会主动保留每次 HTTP 请求的状态。

2. 如何突破 HTTP 无状态的限制

• 对于超市来说，为了方便收银员在进行结算时给 VIP 用户打折，超市可以为每个 VIP 用户发放会员卡。

• 现实生活中的会员卡身份认证方式，在 Web 开发中的专业术语叫做 Cookie。

3. 什么是 Cookie

• Cookie 是存储在用户浏览器中的一段不超过 4 KB 的字符串。它由一个名称（Name）、一个值（Value）和其它几个用于控制 Cookie 有效期、安全性、使用范围的可选属性组成。

• 不同域名下的 Cookie 各自独立，每当客户端发起请求时，会自动把当前域名下所有未过期的 Cookie 一同发送到服务器。

• Cookie 的几大特性

  1. 自动发送
  2. 域名独立
  3. 过期时限
  4. 4KB限制

4. Cookie 在身份认证中的作用

• 客户端第一次请求服务器的时候，服务器通过响应头的形式，向客户端发送一个身份认证的 Cookie，客户端会自动将 Cookie 保存在浏览器中。

• 随后，当客户端浏览器每次请求服务器的时候，浏览器会自动将身份认证相关的 Cookie，通过请求头的形式发送给服务器，服务器即可验明客户端的身份。

5. Cookie 不具有安全性

• 由于 Cookie 是存储在浏览器中的，而且浏览器也提供了读写 Cookie 的 API，因此 Cookie 很容易被伪造，不具有安全性。因此不建议服务器将重要的隐私数据，通过 Cookie 的形式发送给浏览器。

6. 提高身份认证的安全性

• 为了防止客户伪造会员卡，收银员在拿到客户出示的会员卡之后，可以在收银机上进行刷卡认证。只有收银机确认存在的会员卡，才能被正常使用。

• 这种“会员卡 + 刷卡认证”的设计理念，就是 Session 认证机制的精髓。

7. Session 的工作原理

7.4.4 在 Express 中使用 Session 认证

1. 安装 express-session 中间件

$ npm install express-session

2. 配置 express-session 中间件

// 1. 导入 session 中间件
const session = require('express-session')
// 2. 配置 session 中间件
app.use(session({
    secret: 'cat No1 ^_^', // secret 属性值可以为任意字符串
    resave: false, // 固定写法
    saveUninitialized: true // 固定写法
}))

3. 向 session 中存数据

• 当 express-session 中间件配置成功后，即可通过 req.session 来访问和使用 session 对象，从而存储用户的关键信息：

// 登录的 API 接口
app.post('/api/login', (req, res) => {
  // 判断用户提交的登录信息是否正确
  if (req.body.username !== 'admin' || req.body.password !== '000000') {
    return res.send({ status: 1, msg: '登录失败' })
  }
    
  // 注意：只有成功配置了 express-session 这个中间件之后，才能够通过 req 点出来 session 这个属性
  req.session.user = req.body // 用户的信息
  req.session.islogin = true // 用户的登录状态

  res.send({ status: 0, msg: '登录成功' })
})

5. 从 session 中取数据

• 可以直接从 req.session 对象上获取之前存储的数据，示例代码如下：

// 获取用户姓名的接口
app.get('/api/username', (req, res) => {
   // 判断用户是否登录
  if (!req.session.islogin) {
    return res.send({ status: 1, msg: 'fail' })
  }
    
  res.send({
    status: 0,
    msg: 'success',
    username: req.session.user.username,
  })
})

6. 清空 session

• 调用 req.session.destroy() 函数，即可清空服务器保存的 session 信息。

// 退出登录的接口
app.post('/api/logout', (req, res) => {
  req.session.destroy()
  res.send({
    status: 0,
    msg: '退出登录成功',
  })
})

7. 完整演示

// 导入 express 模块
const express = require('express')
// 创建 express 的服务器实例
const app = express()

// TODO_01：请配置 Session 中间件
const session = require('express-session')
app.use(
  session({
    secret: 'cat No1 ^_^',
    resave: false,
    saveUninitialized: true,
  })
)

// 托管静态页面
app.use(express.static('./pages'))
// 解析 POST 提交过来的表单数据
app.use(express.urlencoded({ extended: false }))

// 登录的 API 接口
app.post('/api/login', (req, res) => {
  // 判断用户提交的登录信息是否正确
  if (req.body.username !== 'admin' || req.body.password !== '000000') {
    return res.send({ status: 1, msg: '登录失败' })
  }

  // TODO_02：请将登录成功后的用户信息，保存到 Session 中
  // 注意：只有成功配置了 express-session 这个中间件之后，才能够通过 req 点出来 session 这个属性
  req.session.user = req.body // 用户的信息
  req.session.islogin = true // 用户的登录状态

  res.send({ status: 0, msg: '登录成功' })
})

// 获取用户姓名的接口
app.get('/api/username', (req, res) => {
  // TODO_03：请从 Session 中获取用户的名称，响应给客户端
  if (!req.session.islogin) {
    return res.send({ status: 1, msg: 'fail' })
  }
  res.send({
    status: 0,
    msg: 'success',
    username: req.session.user.username,
  })
})

// 退出登录的接口
app.post('/api/logout', (req, res) => {
  // TODO_04：清空 Session 信息
  req.session.destroy()
  res.send({
    status: 0,
    msg: '退出登录成功',
  })
})

// 调用 app.listen 方法，指定端口号并启动web服务器
app.listen(8080, function () {
  console.log('Express server running at http://127.0.0.1:8080')
})

7.4.5 JWT 认证机制

1. 了解 Session 认证的局限性

• Session 认证机制需要配合 Cookie 才能实现。由于 Cookie 默认不支持跨域访问，所以，当涉及到前端跨域请求后端接口的时候，需要做很多额外的配置，才能实现跨域 Session 认证。

• 当前端请求后端接口不存在跨域问题的时候，推荐使用 Session 身份认证机制。

• 当前端需要跨域请求后端接口的时候，不推荐使用 Session 身份认证机制，推荐使用 JWT 认证机制。

2. 什么是 JWT

• JWT（英文全称：JSON Web Token）是目前最流行的跨域认证解决方案。

3. JWT 的工作原理

• 用户的信息通过 Token 字符串的形式，保存在客户端浏览器中。服务器通过还原 Token 字符串的形式来认证用户的身份。

4. JWT 的组成部分

• JWT 通常由三部分组成，分别是 Header（头部）、Payload（有效荷载）、Signature（签名）。
  三者之间使用英文的“.”分隔，格式如下：

Header.Payload.Signature

• Payload 部分才是真正的用户信息，它是用户信息经过加密之后生成的字符串。
• Header 和 Signature 是安全性相关的部分，只是为了保证 Token 的安全性。

5. JWT 的使用方式

• 客户端收到服务器返回的 JWT 之后，通常会将它储存在 localStorage 或 sessionStorage 中。
• 此后，客户端每次与服务器通信，都要带上这个 JWT 的字符串，从而进行身份认证。推荐的做法是把 JWT 放在 HTTP 请求头的 Authorization 字段中，格式如下：

Authorization: Bearer <token>

7.4.6 在 Express 中使用 JWT

1. 安装 JWT 相关的包

$ npm install jsonwebtoken express-jwt

• jsonwebtoken 用于生成 JWT 字符串
• express-jwt 用于将 JWT 字符串解析还原成 JSON 对象

2. 导入 JWT 相关的包

const jwt = require('jsonwebtoken')
const expressJWT = require('express-jwt')

3. 定义 secret 密钥

• 为了保证 JWT 字符串的安全性，防止 JWT 字符串在网络传输过程中被别人破解，我们需要专门定义一个用于加密和解密的 secret 密钥：
  1. 当生成 JWT 字符串的时候，需要使用 secret 密钥对用户的信息进行加密，最终得到加密好的 JWT 字符串
  2. 当把 JWT 字符串解析还原成 JSON 对象的时候，需要使用 secret 密钥进行解密

// secret 密钥的本质：就是一个字符串
const secretKey = 'cat No1 ^_^'

4. 在登录成功后生成 JWT 字符串

• 调用 jsonwebtoken 包提供的 sign() 方法，将用户的信息加密成 JWT 字符串，响应给客户端：

// 登录接口
app.post('/api/login', function (req, res) {
  // 将 req.body 请求体中的数据，转存为 userinfo 常量
  const userinfo = req.body
  // 登录失败
  if (userinfo.username !== 'admin' || userinfo.password !== '000000') {
    return res.send({
      status: 400,
      message: '登录失败！',
    })
  }
  // 登录成功
  // 在登录成功之后，调用 jwt.sign() 方法生成 JWT 字符串。并通过 token 属性发送给客户端
  // 参数1：用户的信息对象
  // 参数2：加密的秘钥
  // 参数3：配置对象，可以配置当前 token 的有效期
  // 记住：千万不要把密码加密到 token 字符中
  const tokenStr = jwt.sign({ username: userinfo.username }, secretKey, { expiresIn: '30s' })
  res.send({
    status: 200,
    message: '登录成功！',
    token: tokenStr, // 要发送给客户端的 token 字符串
  })
})

5. 将 JWT 字符串还原为 JSON 对象

• 客户端每次在访问那些有权限接口的时候，都需要主动通过请求头中的 Authorization 字段，将 Token 字符串发送到服务器进行身份认证。

• 此时，服务器可以通过 express-jwt 这个中间件，自动将客户端发送过来的 Token 解析还原成 JSON 对象：

// 使用 app.use() 来注册中间件
// 注意：只要配置成功了 express-jwt 中间件，就可以把解析出来的用户信息，挂载到 req.user 属性上
// expressJWT({ secret: secretKey }) 就是用来解析 Token 的中间件
// .unless({ path: [/^\/api\//] }) 用来指定哪些接口不需要访问权限
app.use(expressJWT({ secret: secretKey }).unless({ path: [/^\/api\//] }))

6. 使用 req.user 获取用户信息

• 当 express-jwt 这个中间件配置成功之后，即可在那些有权限的接口中，使用 req.user 对象，来访问从 JWT 字符串中解析出来的用户信息了，示例代码如下：

// 这是一个有权限的 API 接口
app.get('/admin/getinfo', function (req, res) {
  // 使用 req.user 获取用户信息，并使用 data 属性将用户信息发送给客户端
  console.log(req.user)
  res.send({
    status: 200,
    message: '获取用户信息成功！',
    data: req.user, // 要发送给客户端的用户信息
  })
})

7. 捕获解析 JWT 失败后产生的错误

• 当使用 express-jwt 解析 Token 字符串时，如果客户端发送过来的 Token 字符串过期或不合法，会产生一个解析失败的错误，影响项目的正常运行。我们可以通过 Express 的错误中间件，捕获这个错误并进行相关的处理，示例代码如下：

// 使用全局错误处理中间件，捕获解析 JWT 失败后产生的错误
app.use((err, req, res, next) => {
  // 这次错误是由 token 解析失败导致的
  if (err.name === 'UnauthorizedError') {
    return res.send({
      status: 401,
      message: '无效的token',
    })
  }
  res.send({
    status: 500,
    message: '未知的错误',
  })
})

8. 完整演示

// 导入 express 模块
const express = require('express')
// 创建 express 的服务器实例
const app = express()

// TODO_01：安装并导入 JWT 相关的两个包，分别是 jsonwebtoken 和 express-jwt
const jwt = require('jsonwebtoken')
const expressJWT = require('express-jwt')

// 允许跨域资源共享
const cors = require('cors')
app.use(cors())

// 解析 post 表单数据的中间件
const bodyParser = require('body-parser')
app.use(bodyParser.urlencoded({ extended: false }))

// TODO_02：定义 secret 密钥，建议将密钥命名为 secretKey
const secretKey = 'cat No1 ^_^'

// TODO_04：注册将 JWT 字符串解析还原成 JSON 对象的中间件
// 注意：只要配置成功了 express-jwt 这个中间件，就可以把解析出来的用户信息，挂载到 req.user 属性上
// 在 express-jwt 6.x版本以后 需要在配置中加入 algorithms:['HS256']属性
app.use(expressJWT({ secret: secretKey }).unless({ path: [/^\/api\//] }))
// app.use(expressJWT({ secret: secretKey, algorithms:['HS256'] }).unless({ path: [/^\/api\//] }))

// 登录接口
app.post('/api/login', function (req, res) {
  // 将 req.body 请求体中的数据，转存为 userinfo 常量
  const userinfo = req.body
  // 登录失败
  if (userinfo.username !== 'admin' || userinfo.password !== '000000') {
    return res.send({
      status: 400,
      message: '登录失败！',
    })
  }
  // 登录成功
  // TODO_03：在登录成功之后，调用 jwt.sign() 方法生成 JWT 字符串。并通过 token 属性发送给客户端
  // 参数1：用户的信息对象
  // 参数2：加密的秘钥
  // 参数3：配置对象，可以配置当前 token 的有效期
  // 记住：千万不要把密码加密到 token 字符中
  const tokenStr = jwt.sign({ username: userinfo.username }, secretKey, { expiresIn: '30s' })
  res.send({
    status: 200,
    message: '登录成功！',
    token: tokenStr, // 要发送给客户端的 token 字符串
  })
})

// 这是一个有权限的 API 接口
app.get('/admin/getinfo', function (req, res) {
  // TODO_05：使用 req.user 获取用户信息，并使用 data 属性将用户信息发送给客户端
  console.log(req.user)
  res.send({
    status: 200,
    message: '获取用户信息成功！',
    data: req.user, // 要发送给客户端的用户信息
  })
})

// TODO_06：使用全局错误处理中间件，捕获解析 JWT 失败后产生的错误
app.use((err, req, res, next) => {
  // 这次错误是由 token 解析失败导致的
  if (err.name === 'UnauthorizedError') {
    return res.send({
      status: 401,
      message: '无效的token',
    })
  }
  res.send({
    status: 500,
    message: '未知的错误',
  })
})

// 调用 app.listen 方法，指定端口号并启动web服务器
app.listen(8888, function () {
  console.log('Express server running at http://127.0.0.1:8888')
})

• Postman 测试结果