在 Koa 中实现身份验证,通常需要使用一些中间件和策略。这里我们将介绍如何使用 JWT(JSON Web Token)进行身份验证。以下是实现步骤:
首先,你需要安装一些依赖包,如 jsonwebtoken
和 koa-jwt
。在项目根目录运行以下命令:
npm install jsonwebtoken koa-jwt
在一个新文件(例如 auth.js
)中,编写 JWT 生成和验证的函数:
const jwt = require('jsonwebtoken');
const secret = 'your-secret-key'; // 用于签名的密钥,应保密且复杂
// 生成 JWT
function generateToken(payload) {
return jwt.sign(payload, secret, { expiresIn: '1h' });
}
// 验证 JWT
function verifyToken(token) {
try {
const payload = jwt.verify(token, secret);
return payload;
} catch (error) {
return null;
}
}
module.exports = { generateToken, verifyToken };
在你的 Koa 应用中,创建一个登录接口,用户可以通过该接口获取 JWT。
const Router = require('@koa/router');
const auth = require('./auth');
const router = new Router();
router.post('/login', async (ctx) => {
const { username, password } = ctx.request.body;
// 在此处验证用户名和密码,然后生成 JWT
if (username === 'user' && password === 'password') {
const token = auth.generateToken({ username });
ctx.body = { token };
} else {
ctx.status = 401;
ctx.body = { message: 'Invalid credentials' };
}
});
module.exports = router;
在你的 Koa 应用中,使用 koa-jwt
中间件保护需要身份验证的路由。
const Koa = require('koa');
const jwtMiddleware = require('koa-jwt');
const loginRouter = require('./loginRouter');
const protectedRouter = require('./protectedRouter');
const auth = require('./auth');
const app = new Koa();
// 使用 koa-jwt 中间件保护路由
app.use(jwtMiddleware({ secret: auth.secret }).unless({ path: [/^\/login/] }));
app.use(loginRouter.routes());
app.use(protectedRouter.routes());
app.listen(3000);
在受保护的路由中,你可以通过 ctx.state.user
访问 JWT 中的 payload。
const Router = require('@koa/router');
const router = new Router();
router.get('/protected', async (ctx) => {
const { username } = ctx.state.user;
ctx.body = { message: `Hello, ${username}! This is a protected route.` };
});
module.exports = router;
现在,你已经在 Koa 应用中实现了基于 JWT 的身份验证。用户需要先登录以获取 JWT,然后在后续请求的 Authorization
头中附带 JWT 以访问受保护的路由。