JWT（JSON Web Token）是一种轻量级的身份验证标准，常用于在分布式系统中安全地传输信息。在这个场景中，我们关注的是如何在Node.js环境中利用JWT进行API开发，特别是结合TypeScript来提升代码的可读性和类型安全性。下面将详细介绍JWT的基础知识、Node.js中的JWT实现以及TypeScript的应用。
JWT由三部分组成：头部（Header）、负载（Payload）和签名（Signature）。头部通常包含令牌的类型（JWT）和加密算法；负载则包含了声明，如用户ID、角色等信息；签名则是通过头部和负载与密钥进行哈希运算生成，用于验证令牌的完整性和来源。
在Node.js中，我们可以使用`jsonwebtoken`库来处理JWT。安装这个库可以使用npm命令：
```bash
npm install jsonwebtoken
```
接着，你可以创建一个签发JWT的函数，如下所示：
```typescript
import jwt from 'jsonwebtoken';
const secret = 'your-secret-key'; // 用于签名的密钥
function generateToken(payload: any) {
return jwt.sign(payload, secret, { expiresIn: '1h' }); // 过期时间可自定义
}
```
对于验证JWT，同样使用`jsonwebtoken`库提供的`verify`方法：
```typescript
function verifyToken(token: string) {
return new Promise((resolve, reject) => {
jwt.verify(token, secret, (err, decoded) => {
if (err) {
reject(err);
} else {
resolve(decoded);
}
});
});
}
```
在TypeScript中，我们可以通过定义接口来增强类型检查，确保payload的数据结构一致性：
```typescript
interface UserPayload {
id: string;
role: string;
}
// ... 在generateToken和verifyToken函数中使用UserPayload
```
在API开发中，通常在登录成功后返回JWT，客户端将其存储在Cookie或LocalStorage中。之后的每次请求，客户端都将JWT放在Authorization头中发送给服务器进行验证。
例如，创建一个简单的登录路由：
```typescript
import express from 'express';
import { Router } from 'express';
import jwt from 'jsonwebtoken';
const router = express.Router();
router.post('/login', async (req, res) => {
const user = { id: '123', role: 'admin' }; // 假设已验证用户身份
const token = generateToken(user as UserPayload);
res.json({ token });
});
// ... 其他路由，如需要验证的资源访问路由
```
在需要验证的路由中，我们可以使用中间件来检查JWT的有效性：
```typescript
router.get('/protected', async (req, res, next) => {
const authHeader = req.headers['authorization'];
if (!authHeader) {
return res.status(401).json({ message: 'Unauthorized' });
}
try {
const token = authHeader.split(' ')[1];
const decoded = await verifyToken(token);
req.user = decoded; // 将解码后的payload附加到请求对象上
next();
} catch (err) {
res.status(401).json({ message: 'Invalid token' });
}
});
```
通过这样的方式，我们可以构建一个基于JWT的安全API。TypeScript的引入不仅提高了代码的可读性，还增强了类型检查，降低了因数据类型错误导致的问题。在`jwt-Api-master`这个项目中，你可能会找到更多关于如何组织和实现JWT API的示例代码，包括路由、中间件和错误处理等方面。通过研究这些代码，你可以更深入地了解JWT与Node.js、TypeScript的集成应用。
jwt-Api-master.zip （29个子文件） 
jwt-Api-master 
package.json 718B
