1. 安装 JWT 相关的包
- 运行如下命令,安装如下两个 JWT 相关的包:
```js
npm install jsonwebtoken express-jwt
```
其中:
jsonwebtoken 用于生成 JWT 字符串
express-jwt 用于将 JWT 字符串解析还原成 JSON 对象
2. 导入 JWT 相关的包
- 使用 require() 函数,分别导入 JWT 相关的两个包:
```js
// 1. 导入用于生成 JWT 字符串的包
const jwt = require('jsonwebtoken')
// 2. 导入用于将客户端发送过来的 JWT 字符串,解析还原成 JSON 对象的包
const expressJWT = require('express-jwt')
```
3. 定义 secret 密钥
- 为了保证 JWT 字符串的安全性,防止 JWT 字符串在网络传输过程中被别人破解,我们需要专门定义一个用于加密和解密的 secret 密钥:
① 当生成 JWT 字符串的时候,需要使用 secret 密钥对用户的信息进行加密,最终得到加密好的 JWT 字符串
② 当把 JWT 字符串解析还原成 JSON 对象的时候,需要使用 secret 密钥进行解密
```js
// 3. secret 密钥的本质:就是一个字符串
const secretKey = 'itheima 11^_^'
```
4. 在登录成功后生成 JWT 字符串
- 调用 jsonwebtoken 包提供的 sign() 方法,将用户的信息加密成 JWT 字符串,响应给客户端:
```js
app.post('/api/login', function(req, res) {
// ... 省略登录失败代码
// 登录成功后,生成 JWT 字符串, 通过 token 属性响应给客户端
res.send({
status: 200,
message: '登录成功',
// 调用 jwt.sign() 生成 JWT 字符串,三个参数分别是:用户信息对象、加密密钥、配置对象
token: jwt.sign({ username: userinfo.username }, secretKey, { expiresIn: '30s' })
})
})
```
5. 将 JWT 字符串还原为 JSON 对象
- 客户端每次在访问那些有权限接口的时候,都需要主动通过请求头中的 Authorization 字段,将 Token 字符串发送到服务器进行身份认证。
- 服务器可以通过 express-jwt 这个中间件,自动将客户端发送过来的 Token 解析还原成 JSON 对象:
```js
// 使用 app.use() 来注册中间件
// expressJWT({ secret: secretKey }) 就是用来解析 Token 的中间件
// .unless({ path: [/^\/api\//] }) 用来指定哪些接口不需要访问权限
app.use(expressJWT({ secret: secretKey }).unless({ path: [/^\/api\//] }))
```
6. 使用 req.user 获取用户信息
- 当 express-jwt 这个中间件配置成功之后,即可在那些有权限的接口中,使用 req.user 对象,来访问从 JWT 字符串中解析出来的用户信息了,示例代码如下:
```js
// 一个有权限的 API 接口
app.get('/admin/getinfo', function(req, res) {
res.send({
status: 200,
message: '获取用户信息成功',
data: req.user
})
})
```
7. 捕获解析 JWT 失败后产生的错误
- 当使用 express-jwt 解析 Token 字符串时,如果客户端发送过来的 Token 字符串过期或不合法,会产生一个解析失败的错误,影响项目的正常运行。我们可以通过 Express 的错误中间件,捕获这个错误并进行相关的处理,示例代码如下:
```js
app.use((err, req, res, next) => {
// token 解析失败导致的错误
if(err.name === 'UnauthorizedError') {
return res.send({ status:401, message: '无效的token' })
}
// 其他原因导致的错误
res.send({ status: 500, mwssage: '未知错误' })
})
```