在 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 以訪問受保護的路由。