Node.js的Koa實現(xiàn)JWT用戶認證方法

更新時間：2018年05月05日 11:00:15 作者：御焱

本篇文章主要介紹了Node.js的Koa實現(xiàn)JWT用戶認證方法，小編覺得挺不錯的，現(xiàn)在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧

本文介紹了Node.js的Koa實現(xiàn)JWT用戶認證方法，分享給大家，具體如下：

一、前置知識

二、環(huán)境

Microsoft Visual Studio 2017集成開發(fā)環(huán)境
Node.js v8.9.4Javascript運行環(huán)境

三、開始動手，一步步來完善

1、創(chuàng)建基礎的靜態(tài)資源服務器、基礎架構

以下是基本的代碼，實現(xiàn)靜態(tài)服務器，以及一個當token驗證異常時候的處理。

下面我們將在這個基本代碼下逐步增加注冊、登錄、信息的功能。

const path = require('path');  // 用于處理目錄路徑
const Koa = require('koa');  // web開發(fā)框架
const serve = require('koa-static'); // 靜態(tài)資源處理
const route = require('koa-route'); // 路由中間件
const jwt = require('jsonwebtoken'); // 用于簽發(fā)、解析`token`
const jwtKoa = require('koa-jwt'); // 用于路由權限控制
const koaBody = require('koa-body'); // 用于查詢字符串解析到`ctx.request.query`
const app = new Koa();
const website = {
 scheme: 'http',
 host: 'localhost',
 port: 1337,
 join: function () {
 return `${this.scheme}://${this.host}:${this.port}`
 }
}

/* jwt密鑰 */
const secret = 'secret';

/* 當token驗證異常時候的處理，如token過期、token錯誤 */
app.use((ctx, next) => {
 return next().catch((err) => {
 if (err.status === 401) {
  ctx.status = 401;
  ctx.body = {
  ok: false,
  msg: err.originalError ? err.originalError.message : err.message
  }
 } else {
  throw err;
 }
 });
});

/* 查詢字符串解析到`ctx.request.query` */
app.use(koaBody());

/* 路由權限控制 */
// 待辦事項……

/* POST /api/register 注冊 */
// 待辦事項……

/* GET /api/login 登錄 */
// 待辦事項……

/* GET /api/info 信息 */
// 待辦事項……

/* 靜態(tài)資源處理 */
app.use(serve(path.join(__dirname, 'static')));
/* 監(jiān)聽服務器端口 */
app.listen(website.port, () => {
 console.log(`${website.join()} 服務器已經(jīng)啟動！`);
});

下面，我們將在注冊、登錄、信息的注釋底下添加實現(xiàn)的代碼。

2、路由權限控制

注冊、登錄接口、其它資源不需要認證，信息接口需要認證。

/* 路由權限控制 */
app.use(jwtKoa({ secret: secret }).unless({
 // 設置login、register接口，可以不需要認證訪問
 path: [
 /^\/api\/login/,
 /^\/api\/register/,
 /^((?!\/api).)*$/ // 設置除了私有接口外的其它資源，可以不需要認證訪問
 ]
}));

3、注冊

/* POST /api/register 注冊 */
app.use(route.post('/api/register', async (ctx, next) => {
 const body = ctx.request.body;
 /*
 * body = {
 * user : '御焱',
 * password : '123456'
 * }
 */

 // 判斷 body.user 和 body.password 格式是否正確
 // 待辦事項……

 // 判斷用戶是否已經(jīng)注冊
 // 待辦事項……

 // 保存到新用戶到數(shù)據(jù)庫中
 // 待辦事項……

 // 是否注冊成功
 let 是否注冊成功 = true;
 if (是否注冊成功) {
 // 返回一個注冊成功的JOSN數(shù)據(jù)給前端
 return ctx.body = {
  ok: true,
  msg: '注冊成功',
  token: getToken({ user: body.user, password: body.password })
 }
 } else {
 // 返回一個注冊失敗的JOSN數(shù)據(jù)給前端
 return ctx.body = {
  ok: false,
  msg: '注冊失敗'
 }
 }
}));
/* 獲取一個期限為4小時的token */
function getToken(payload = {}) {
 return jwt.sign(payload, secret, { expiresIn: '4h' });
}

3、登錄

/* GET /api/login 登錄 */
app.use(route.get('/api/login', async (ctx, next) => {
 const query = ctx.request.query;
 /*
 * query = {
 * user : '御焱',
 * password : '123456'
 * }
 */

 // 判斷 query.user 和 query.password 格式是否正確
 // 待辦事項……

 // 判斷是否已經(jīng)注冊
 // 待辦事項……
 
 // 判斷姓名、學號是否正確
 // 待辦事項……
 
 return ctx.body = {
 ok: true,
 msg: '登錄成功',
 token: getToken({ user: query.user, password: query.password })
 }
}));

前端獲取到token之后，可以保存在任意本地存儲里。

4、信息

/* GET /api/info 信息 */
app.use(route.get('/api/info', async (ctx, next) => {
 // 前端訪問時會附帶token在請求頭
 payload = getJWTPayload(ctx.headers.authorization)
 /*
 * payload = {
 * user : "御焱",
 * iat : 1524042454,
 * exp : 1524056854
 * }
 */

 // 根據(jù) payload.user 查詢該用戶在數(shù)據(jù)庫中的信息
 // 待辦事項……
 const info = {
 name: '御焱',
 age: 10,
 sex: '男'
 }
 let 獲取信息成功 = true;
 if (獲取信息成功) {
 return ctx.body = {
  ok: true,
  msg: '獲取信息成功',
  data: info
 }
 } else {
 return ctx.body = {
  ok: false,
  msg: '獲取信息失敗'
 }
 }
}));
/* 通過token獲取JWT的payload部分 */
function getJWTPayload(token) {
 // 驗證并解析JWT
 return jwt.verify(token.split(' ')[1], secret);
}