3.4.2 配置 express-session 中间件
express-session 中间件安装成功后，需要通过 app.use() 来注册 session 中间件。
// 导入 express 模块 const express = require('express') // 创建 express 的服务器实例 const app = express() // 配置 Session 中间件 const session = require('express-session') app.use( session({ // secret 属性可以为任意字符串 secret: 'itheima', // 固定写法 resave: false, // 固定写法 saveUninitialized: true, }) )
3.4.3 向 session 中存数据
当 express-session 中间件配置成功后，即可通过 req.session 来访问和使用 session 对象，从而存储用户的关键信息。
// 导入 express 模块 const express = require('express') // 创建 express 的服务器实例 const app = express() // TODO_01：配置 Session 中间件 const session = require('express-session') app.use( session({ // secret 属性可以为任意字符串 secret: 'itheima', // 固定写法 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: '登录成功' }) })
3.4.4 从 session 中取数据
可以直接从 req.session 对象上获取之前存储的数据。
// 导入 express 模块 const express = require('express') // 创建 express 的服务器实例 const app = express() // TODO_01：配置 Session 中间件 const session = require('express-session') app.use( session({ // secret 属性可以为任意字符串 secret: 'itheima', // 固定写法 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, }) })
3.4.5 清空 session
调用 req.session.destroy() 函数，即可清空服务器保存的 session 信息。
// 导入 express 模块 const express = require('express') // 创建 express 的服务器实例 const app = express() // TODO_01：配置 Session 中间件 const session = require('express-session') app.use( session({ // secret 属性可以为任意字符串 secret: 'itheima', // 固定写法 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(80, function () { console.log('Express server running at http://127.0.0.1:80') })
注意：
session的清除，只会清除对应的发起请求的客户端的session。其他的客户端如果为发起请求不会清除。
3.4.6 Session 认证的局限性
Session 认证机制需要配合 Cookie 才能实现。由于 Cookie 默认不支持跨域访问，所以，当涉及到前端跨域请求后端接口的时候，需要做很多额外的配置，才能实现跨域 Session 认证。
注意：
当前端请求后端接口不存在跨域问题的时候，推荐使用 Session 身份认证机制。
当前端需要跨域请求后端接口的时候，不推荐使用 Session 身份认证机制，推荐使用 JWT 认证机制。
4 JWT 认证机制
4.1 JWT
JWT（英文全称：JSON Web Token）是目前最流行的跨域认证解决方案。
4.2 JWT 的工作原理
用户的信息通过 Token 字符串的形式，保存在客户端浏览器中。服务器通过还原 Token 字符串的形式来认证用户的身份。
4.3 JWT 的组成部分
JWT 通常由三部分组成，分别是 Header（头部）、Payload（有效荷载）、Signature（签名）。
三者之间使用英文的“.”分隔，格式如下：
Header.Payload.Signature
如：
Payload 部分才是真正的用户信息，它是用户信息经过加密之后生成的字符串。
Header 和 Signature 是安全性相关的部分，只是为了保证 Token 的安全性。
4.4 JWT 的使用方式
客户端收到服务器返回的 JWT 之后，通常会将它储存在 localStorage 或 sessionStorage 中。
此后，客户端每次与服务器通信，都要带上这个 JWT 的字符串，从而进行身份认证。推荐的做法是把 JWT 放在 HTTP 请求头的 Authorization 字段中。
Authorization: Bearer token
4.5 在 Express 中使用 JWT
4.5.1 安装 JWT 相关的包
运行如下命令，安装如下两个 JWT 相关的包：
npm i jsonwebtoken express-jwt
jsonwebtoken 用于生成 JWT 字符串
express-jwt 用于将 JWT 字符串解析还原成 JSON 对象
4.5.2 导入 JWT 相关的包
使用 require() 函数，分别导入 JWT 相关的两个包：
// 导入 express 模块 const express = require('express') // 创建 express 的服务器实例 const app = express() // TODO_01：安装并导入 JWT 相关的两个包，分别是 jsonwebtoken 和 express-jwt const jwt = require('jsonwebtoken') const expressJWT = require('express-jwt')
3.5.3 定义 secret 密钥
为了保证 JWT 字符串的安全性，防止 JWT 字符串在网络传输过程中被别人破解，我们需要专门定义一个用于加密和解密的 secret 密钥：
① 当生成 JWT 字符串的时候，需要使用 secret 密钥对用户的信息进行加密，最终得到加密好的 JWT 字符串
② 当把 JWT 字符串解析还原成 JSON 对象的时候，需要使用 secret 密钥进行解密
// 导入 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 // secret 密钥本质是一个字符串 const secretKey = 'itheima No1 ^_^'
3.5.4 登录成功后生成 JWT 字符串
调用 jsonwebtoken 包提供的 sign() 方法，将用户的信息加密成 JWT 字符串，响应给客户端。
// 导入 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 = 'itheima No1 ^_^' // 登录接口 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 字符串 }) })
3.5.5 将 JWT 字符串还原为 JSON 对象
客户端每次在访问那些有权限接口的时候，都需要主动通过请求头中的 Authorization 字段，将 Token 字符串发送到服务器进行身份认证。
此时，服务器可以通过 express-jwt 这个中间件，自动将客户端发送过来的 Token 解析还原成 JSON 对象。
// 导入 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 = 'itheima No1 ^_^' // TODO_04：注册将 JWT 字符串解析还原成 JSON 对象的中间件 // 注意：只要配置成功了 express-jwt 这个中间件，就可以把解析出来的用户信息， // 挂载到 req.user 属性上 // unless({ path: [/^\/api\//] })用于去除不用jwt认真的请求路径 app.use(expressJWT({ secret: secretKey }).unless({ path: [/^\/api\//] }))
3.5.6 使用 req.user 获取用户信息
当 express-jwt 这个中间件配置成功之后，即可在那些有权限的接口中，使用 req.user 对象，来访问从 JWT 字符串中解析出来的用户信息了。
// 导入 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 = 'itheima No1 ^_^' // TODO_04：注册将 JWT 字符串解析还原成 JSON 对象的中间件 // 注意：只要配置成功了 express-jwt 这个中间件，就可以把解析出来的用户信息，挂载到 req.user 属性上 app.use(expressJWT({ secret: secretKey }).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, // 要发送给客户端的用户信息 }) })
3.5.7 捕获解析 JWT 失败后产生的错误
当使用 express-jwt 解析 Token 字符串时，如果客户端发送过来的 Token 字符串过期或不合法，会产生一个解析失败的错误，影响项目的正常运行。我们可以通过 Express 的错误中间件，捕获这个错误并进行相关的处理。
// 导入 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 = 'itheima No1 ^_^' // TODO_04：注册将 JWT 字符串解析还原成 JSON 对象的中间件 // 注意：只要配置成功了 express-jwt 这个中间件，就可以把解析出来的用户信息，挂载到 req.user 属性上 app.use(expressJWT({ secret: secretKey }).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') })
