在 Express 中使用 JWT

1. 安装 JWT 相关的包

        运行下面两个命令，安装如下两个 JWT 相关的包

npm i 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 密钥：

        ①   当生成JWT字符串时，需要使用 secret 密钥对用户的信息进行加密，最终得到加密好的JWT字符串

        ②   当把JWT字符串解析还原成JSON对象时，需要使用 secret 密钥进行解密

// 定义 secret 密钥，建议将密钥命名为 secretKey
// secret 密钥的本质:就是一个字符串
const secretKey = 'love sy ^_^'

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

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

// 登录接口
app.post('/api/login', function(req, res) {
    const userinfo = req.body
    // 登录失败
    // ......省略

    // 登录成功
    // 登录成功后,调用 jwt.sign() 方法生成 jwt字符串,并通过token发送给客户端
    // 参数1: 用户的信息对象
    // 参数2: 加密的密钥
    // 参数3: 配置对象,可以配置当前 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 对象

// 注册将 JWT 字符串还原成 JSON 对象的中间件
// expressJWT({ secret: secretKey }) 解析 Token 的中间件
// .unless({ path: [/^\/api\//] }) 用来指定哪些接口不需要访问权限
app.use(expressJWT({ secret: secretKey }).unless({ path: [/^\/api\//] }))

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

        当 express.jwt 这个中间件配置成功后，即可在有权限的接口中使用 req.user 对象，来访问从 JWT 字符串中解析出来的用户信息

        最新版 是挂载到 req.auth

// 这是一个有权限的 API 接口
app.get('/admin/getinfo', (req, res) => {
    // 使用 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: '未知错误'
    })
})