Erlo

Node.js+Koa实现JWT用户认证步骤详解

时间:2018-05-12   阅读:363次   来源:php中文网
页面报错
点赞
原文:http://www.php.cn/js-tutorial-396143.html

这次给大家带来Node.js+Koa实现JWT用户认证步骤详解,Node.js+Koa实现JWT用户认证的注意事项有哪些,下面就是实战案例,一起来看一下。

一、前置知识

  1. 基于Token的身份验证

  2. Koajs 中文文档

  3. Koa 框架教程

二、环境

  1. Microsoft Visual Studio 2017集成开发环境

  2. Node.js v8.9.4Javascript运行环境

三、开始动手,一步步来完善

1、创建基础的静态资源服务器、基础架构

以下是基本的代码,实现静态服务器,以及一个当token验证异常时候的处理。

下面我们将在这个基本代码下逐步增加注册、登录、信息的功能。

const path = require('path');  // 用于处理目录路径
const Koa = require('koa');  // web开发框架
const serve = require('koa-static'); // 静态资源处理
const route = require('koa-route'); // 路由中间件
const jwt = require('jsonwebtoken'); // 用于签发、解析`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}`
 }
}
#zs# jwt密钥 #fzs#
const secret = 'secret';
#zs# 当token验证异常时候的处理,如token过期、token错误 #fzs#
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;
 }
 });
});
#zs# 查询字符串解析到`ctx.request.query` #fzs#
app.use(koaBody());
#zs# 路由权限控制 #fzs#
// 待办事项……
#zs# POST /api/register 注册 #fzs#
// 待办事项……
#zs# GET /api/login 登录 #fzs#
// 待办事项……
#zs# GET /api/info 信息 #fzs#
// 待办事项……
#zs# 静态资源处理 #fzs#
app.use(serve(path.join(dirname, 'static')));
#zs# 监听服务器端口 #fzs#
app.listen(website.port, () => {
 console.log(`${website.join()} 服务器已经启动!`);
});

下面,我们将在注册、登录、信息的注释底下添加实现的代码。

2、路由权限控制

注册、登录接口、其它资源不需要认证,信息接口需要认证。

#zs# 路由权限控制 #fzs#
app.use(jwtKoa({ secret: secret }).unless({
 // 设置login、register接口,可以不需要认证访问
 path: [
 /^/api/login/,
 /^/api/register/,
 /^((?!/api).)*$/ // 设置除了私有接口外的其它资源,可以不需要认证访问
 ]
}));

3、注册

#zs# POST /api/register 注册 #fzs#
app.use(route.post('/api/register', async (ctx, next) => {
 const body = ctx.request.body;
 #zs#
 * body = {
 * user : '御焱',
 * password : '123456'
 * }
 #fzs#
 // 判断 body.user 和 body.password 格式是否正确
 // 待办事项……
 // 判断用户是否已经注册
 // 待办事项……
 // 保存到新用户到数据库中
 // 待办事项……
 // 是否注册成功
 let 是否注册成功 = true;
 if (是否注册成功) {
 // 返回一个注册成功的JOSN数据给前端
 return ctx.body = {
  ok: true,
  msg: '注册成功',
  token: getToken({ user: body.user, password: body.password })
 }
 } else {
 // 返回一个注册失败的JOSN数据给前端
 return ctx.body = {
  ok: false,
  msg: '注册失败'
 }
 }
}));
#zs# 获取一个期限为4小时的token #fzs#
function getToken(payload = {}) {
 return jwt.sign(payload, secret, { expiresIn: '4h' });
}

3、登录

#zs# GET /api/login 登录 #fzs#
app.use(route.get('/api/login', async (ctx, next) => {
 const query = ctx.request.query;
 #zs#
 * query = {
 * user : '御焱',
 * password : '123456'
 * }
 #fzs#
 // 判断 query.user 和 query.password 格式是否正确
 // 待办事项……
 // 判断是否已经注册
 // 待办事项……
 
 // 判断姓名、学号是否正确
 // 待办事项……
 
 return ctx.body = {
 ok: true,
 msg: '登录成功',
 token: getToken({ user: query.user, password: query.password })
 }
}));

前端获取到token之后,可以保存在任意本地存储里。

4、信息

#zs# GET /api/info 信息 #fzs#
app.use(route.get('/api/info', async (ctx, next) => {
 // 前端访问时会附带token在请求头
 payload = getJWTPayload(ctx.headers.authorization)
 #zs#
 * payload = {
 * user : "御焱",
 * iat : 1524042454,
 * exp : 1524056854
 * }
 #fzs#
 // 根据 payload.user 查询该用户在数据库中的信息
 // 待办事项……
 const info = {
 name: '御焱',
 age: 10,
 sex: '男'
 }
 let 获取信息成功 = true;
 if (获取信息成功) {
 return ctx.body = {
  ok: true,
  msg: '获取信息成功',
  data: info
 }
 } else {
 return ctx.body = {
  ok: false,
  msg: '获取信息失败'
 }
 }
}));
#zs# 通过token获取JWT的payload部分 #fzs#
function getJWTPayload(token) {
 // 验证并解析JWT
 return jwt.verify(token.split(' ')[1], secret);
}

访问需要认证的接口时,需要在request头附带Authorization:Bearer [token]字段。

相信看了本文案例你已经掌握了方法,更多精彩请关注php中文网其它相关文章!

推荐阅读:

Vue三层嵌套路由使用心得

Vue.js计算与侦听器属性使用详解

提交留言

评论留言

还没有评论留言,赶紧来抢楼吧~~

吐槽小黑屋()

* 这里是“吐槽小黑屋”,所有人可看,只保留当天信息。

  • Erlo吐槽

    Erlo.vip2021-09-24 22:18:54Hello、欢迎使用吐槽小黑屋,这就是个吐槽的地方。
  • 返回顶部

    给这篇文章打个标签吧~

    棒极了 糟糕透顶 好文章 PHP JAVA JS 小程序 Python SEO MySql 确认