前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
圈层
工具
发布
首页
学习
活动
专区
圈层
工具
MCP广场
社区首页 >专栏 >Koa、koa-router、koa-jwt 鉴权详解:分模块鉴权实践总结

Koa、koa-router、koa-jwt 鉴权详解:分模块鉴权实践总结

原创
作者头像
周陆军博客
发布于 2023-04-09 14:26:13
发布于 2023-04-09 14:26:13
1.4K00
代码可运行
举报
文章被收录于专栏:前端博客前端博客
运行总次数:0
代码可运行

首先看koa-router

koa-router use

熟悉Koa的同学都知道use是用来注册中间件的方法,相比较Koa中的全局中间件,koa-router的中间件则是路由级别的。

koa-router中间件注册方法主要完成两项功能

  • 将路由嵌套结构扁平化,其中涉及到路由路径的更新和param前置处理函数的插入;
  • 路由级别中间件通过注册一个没有method的Layer实例进行管理。

具体参看:玩转Koa -- koa-router原理解析 https://zhuanlan.zhihu.com/p/54960421

https://github.com/koajs/router/blob/master/API.md#module_koa-router--Router+use

koa-router添加中间件:

router.use([path], middleware) ⇒ Router

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
// session middleware will run before authorizerouter
  .use(session())
  .use(authorize());
  // use middleware only with given path
  router.use('/users', userAuth());
  // or with an array of paths
  router.use(['/users', '/admin'], userAuth());
  app.use(router.routes());

更多可以参看:koa2学习笔记:koa-router使用方法及多路由代码组织 www.shanhuxueyuan.com/news/detail/128.html

koa koa-router路由层级 路由模块化

主应用中加载子路由模块:

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
let api = require('./api');
let admin = require('./admin');
let login = require('./login');
const koaJwt = require('koa-jwt');
const Const = require('../const');
const cors = require('koa2-cors');
module.exports = (app) => {
    app.use(login.routes());
    //这是处理前端跨域的配置
    //这是处理前端跨域的配置
    app.use(cors(
        {
            /* origin: function (ctx) {
               // if (ctx.url === '/login') {
               //   return "*"; // 允许来自所有域名请求
               // }
               return '*';
             },*/
            exposeHeaders: ['WWW-Authenticate', 'Server-Authorization'],
            maxAge: 5,
            credentials: true,
            allowMethods: ['GET', 'POST', 'DELETE'],
            allowHeaders: ['Content-Type', 'Authorization', 'Accept'],
        }
    )).use(api.routes());
    app.use(koaJwt({
        secret: Const.TokenGlobal
    }).unless({ // 配置白名单
        method: 'get',
        path: [
            /\/api\/img/
        ]
    })).use(admin.routes());
}

子模块示例:

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
const Router = require('koa-router')
const newsRouter = new Router({
  prefix: '/user' //前缀
})
const apiController = require('../controller/api')
newsRouter.post('/login', apiController.login)
module.exports  = newsRouter

不同模块,分配不同的前缀

具体参看:koa2 router koa-router路由配置 bbs.itying.com/topic/5bcc1afb0e32ae0ac45a76e8

koa-jwt  实现模块化鉴权

百度谷歌能搜到的基本都是如此:koa-jwt 实现自定义排除动态路由的鉴权 # https://jwchan.cn/_posts/backend/node/koa_jwt_unless.html#场景描述

主要是使用koa-jwt的 unless , koa-jwt 的 unless 方法调用了 koa-unless 这个包,于是去阅读了 koa-unless 之后,发现可配置以下参数:

  • - method 它可以是一个字符串或字符串数组。如果请求方法匹配,则中间件将不会运行。
  • - path 它可以是字符串,正则表达式或其中任何一个的数组。如果请求路径匹配,则中间件将不会运行。
  • - ext 它可以是一个字符串或字符串数组。如果请求路径以这些扩展名之一结尾,则中间件将不会运行。
  • - custom 它必须是一个返回 true/ 的函数 false。如果函数针对给定的请求返回 true,则中间件将不会运行。该功能将通过 this 访问 Koa 的上下文
  • - useOriginalUrl 应该为 true 或 false,默认为 true。如果为false,path 则匹配 this.url 而不是 this.originalUrl。

比如在custom 配置自定义函数进行判断。这个实现肯定很补科学,对于超多模块鉴权,这个custom岂不是超级复杂。比如:https://github.com/ppap6/PPAP.server/blob/master/app.js

 koa-jwt 中间件简化验证

分模块鉴权:

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
module.exports = (app) => {
    app.use(login.routes());
    app.use(koaJwt({
        secret: Const.TokenGlobal
    }).unless({ // 配置白名单
        method: 'get',
        path: [
            /\/api\/img/
        ]
    })).use(admin.routes());
}

模块里面在分路径鉴权:

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
router
    .get('/', ctx => {
        ctx.type = 'html';
        ctx.body = fs.createReadStream('./public/index.html');
    })
    .get('/sign', ctx => {
        let payload = {name: 'morilence'};
        const token = jwt.sign(payload, 'fgnb', {
            notBefore: 30,
            expiresIn: 90
        });
        ctx.type = 'json';
        ctx.body = {
            token
        };
    })
    /* 只需把koaJwt中间件写在涉及具体业务逻辑处理的中间件之前就ok啦! */
    .get('/api', koaJwt({secret: 'fgnb'}), ctx => { // 参数对象指定密钥
        ctx.type = 'json';
        ctx.body = {
            msg: '你追我,如果你追到我,我就让你...'
        };
    })

更详细可以参看:【Koa】利用 JWT 实现 token验证 https://blog.csdn.net/Morilence/article/details/104301904

整个工程配置可以参看:https://github.com/zhoulujun008/koa-pass-server

转载本站文章《Koa、koa-router、koa-jwt 鉴权详解:分模块鉴权实践总结》, 请注明出处:https://www.zhoulujun.cn/html/webfront/server/koa/8818.html

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

评论
登录后参与评论
暂无评论
推荐阅读
编辑精选文章
换一批
Koa项目搭建及路由模块化实践
Koa是一个自由而灵活的后端框架,非常适合个人的项目开发,在开发时,一般会用Koa-generator应用生成器生成一个初始化项目,这个应用生成器主要定义了一些文件夹,并且将路由实现了模块化,其实我们也可以自定义一个应用生成器,便于自行扩展。
越陌度阡
2020/11/26
9960
Koa - 初体验(写个接口)
  这几年node.js确实是越来越火了,好多公司对node.js都开始有要求。虽说前端不一定要会后端,但想要成为一个优秀的前端,node.js是必经之路。
WahFung
2020/08/24
1.5K0
node-koa 框架 项目搭建 🏗
---- 这是我参与11月更文挑战的第21天,活动详情查看:2021最后一次更文挑战」 代码[链接🔗]:(https://gitee.com/yang-yiming1234/koa/tree/master) 持续更新~ 简介 Koa 是一个新的 web 框架,由 Express 幕后的原班人马打造, 致力于成为 web 应用和 API 开发领域中的一个更小、更富有表现力、更健壮的基石。 通过利用 async 函数,Koa 帮你丢弃回调函数,并有力地增强错误处理。 Koa 并没有捆绑任何中间件, 而是提供了
用户4793865
2023/01/12
3.6K0
koa-router源码解读
上一篇文章阅读了koa的源码,了解了koa整个运行流程、洋葱模型的实现方式,以及ctx的构建流程,让我整体有了对koa大概的了解。
LamHo
2022/09/26
5480
koa-router源码解读
koa源码阅读[2]-koa-router
首先,因为koa是一个管理中间件的平台,而注册一个中间件使用use来执行。 无论是什么请求,都会将所有的中间件执行一遍(如果没有中途结束的话) 所以,这就会让开发者很困扰,如果我们要做路由该怎么写逻辑?
贾顺名
2019/12/09
1K0
koa2使用jwt鉴权
至此已经实现了基础鉴权,但是由于这里使用了restful api,获取资源的操作与修改、删除操作使用的是相同的路径,而koa-unless只支持单一的url匹配或者method匹配,两者无法混用,于是需要改写koa-unless:
4O4
2022/04/25
4950
koa2使用jwt鉴权
这份Koa的简易Router手敲指南请收下
以下方例子为例,主要通过提取req中的path信息,来匹配当前路径,并给ctx.body赋值,返回相应的界面。这个过程不复杂,就是一个匹配路径的过程。但是这种会不会太臃肿了呢,而且很有可能路径一多,就要被if...else...给弄晕了。
小美娜娜
2019/04/04
4650
Koa入门(三)Koa 路由
在 Koa 应用中,通常会使用 koa-router 模块,提供对路由的支持。那为什么需要路由呢?做前后端分离开发的朋友都遇到过,对接接口的时候后台都会提供一个地址,请求这个地址,传相应参数就能实现相应地数据处理。你可以把这个接口理解为路由的地址。
测不准
2021/04/14
1.4K0
Koa搭建基本服务器
目录结构 │ server.js │ ├─libs │ database.js │ ├─log ├─routers │ │ static.js │ │ │ ├─admin │ │ index.js │ │ │ ├─api │ └─www │ index.js │ ├─static │ └─upload ├─template └─upload 基础模块 cnpm i koa koa-router ko
切图仔
2022/09/14
3850
【Node】使用 koa 实现一个简单JWT鉴权
全称 JSON Web Token, 是目前最流行的跨域认证解决方案。基本的实现是服务端认证后,生成一个 JSON 对象,发回给用户。用户与服务端通信的时候,都要发回这个 JSON 对象。
GopalFeng
2022/08/01
1.8K0
【Node】使用 koa 实现一个简单JWT鉴权
Nodejs+koa.js实现服务端内容(超级详细
最近在使用vue3和typesript写一个后台系统的demo。对于一些登录及内容数据不想单纯的使用假数据模拟,所以从零搭建一个nodejs的后端内容
KID.
2023/10/08
8411
JWT 鉴权
使用 koa-jwt + jsonwebtoken 完成用户鉴权功能。 项目地址:https://github.com/Ewall1106/mall 安装 首先我们安装 koa-jwt 和 jsonwebtoken这两个 npm 包。 $ npm install koa-jwt jsonwebtoken --save 先明确一下两者的关系:koa-jwt 是负责对 token 进行验证的,而 jsonwebtoken 是负责生成 token 的。 JWT 鉴权 在 app.js 中引入并使用。 co
Ewall
2020/11/12
1.6K0
koa实践及其手撸
Koa 是一个新的 web 框架,由 Express 幕后的原班人马打造, 致力于成为 web 应用和 API 开发领域中的一个更小、更富有表现力、更健壮的基石。 通过利用 async 函数,Koa 帮你丢弃回调函数,并有力地增强错误处理。
一粒小麦
2019/07/18
1.2K0
koa实践及其手撸
Koa-router源码解读
链式调用 在 koa 中,对中间件的使用是支持链接调用的。同样, 对于多个路径的请求,koa-router 也支持链式调用: router .get(‘/‘, function (next) { this.body = ‘Hello World!’; }) .post(‘/users’, function (next) { // … }) .put(‘/users/:id’, function (next) { // … }) .del(‘/users/:
xiangzhihong
2018/01/26
1.1K0
深入浅出 Koa2:现代 Node.js 框架
Koa2 是一个现代的、简洁的 Node.js 框架,由 Express 团队设计和开发。与 Express 相比,Koa2 提供了更加精简和强大的功能,特别是其中间件处理机制和异步编程能力,深受开发者喜爱。本文将详细介绍 Koa2 的安装、基本用法、核心概念及其高级功能,并通过示例代码展示如何构建一个功能完整的 Web 应用程序。
Michel_Rolle
2024/07/31
2.9K0
知新 | koa框架入门到熟练第一章
是由Express原班人马打造,致力于成为一个更小的,更加富有表现力的,web框架。
mySoul
2020/07/15
1K0
【Nodejs进阶】koa2+mySql用户注册和登录以及实现列表分页
Koa 是一个新的 web 框架,由 Express 幕后的原班人马打造, 致力于成为 web 应用和 API 开发领域中的一个更小、更富有表现力、更健壮的基石。通过利用 async 函数,Koa 帮你丢弃回调函数,并有力地增强错误处理。Koa 并没有捆绑任何中间件, 而是提供了一套优雅的方法,帮助您快速而愉快地编写服务端应用程序。
微芒不朽
2022/09/13
1.7K0
Koa2+MongoDB+JWT实战--Restful API最佳实践
Web API 已经在最近几年变成重要的话题,一个干净的 API 设计对于后端系统是非常重要的。
前端森林
2020/04/23
9.6K0
Koa2+MongoDB+JWT实战--Restful API最佳实践
手写@koa\u002Frouter源码
上一篇文章我们讲了Koa的基本架构,可以看到Koa的基本架构只有中间件内核,并没有其他功能,路由功能也没有。要实现路由功能我们必须引入第三方中间件,本文要讲的路由中间件是@koa/router,这个中间件是挂在Koa官方名下的,他跟另一个中间件koa-router名字很像。其实@koa/router是fork的koa-router,因为koa-router的作者很多年没维护了,所以Koa官方将它fork到了自己名下进行维护。这篇文章我们还是老套路,先写一个@koa/router的简单例子,然后自己手写@koa/router源码来替换他。
蒋鹏飞
2022/11/28
8470
koa实战_2023-02-28
sequelize这个包专门用于项目中处理关系型数据库的操作,它是基于 promise 的
用户10377376
2023/02/28
1.3K0
相关推荐
Koa项目搭建及路由模块化实践
更多 >
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档
本文部分代码块支持一键运行,欢迎体验
本文部分代码块支持一键运行,欢迎体验