利用Decorator如何控制Koa路由详解
程序员文章站
2023-08-21 09:34:24
前言
在spring中controller长这样
@controller
public class hellocontroller{
@requestma...
前言
在spring中controller长这样
@controller public class hellocontroller{ @requestmapping("/hello") string hello() { return "hello world"; } }
还有python上的flask框架
@app.route("/hello") def hello(): return "hello world"
两者都用decorator来控制路由,这样写的好处是更简洁、更优雅、更清晰。
反观express或koa上的路由
router.get('/hello', async ctx => { ctx.body = 'hello world' })
完全差了一个档次
js从es6开始就有decorator了,只是浏览器和node都还没有支持。需要用babel-plugin-transform-decorators-legacy转义。
decorator基本原理
首先需要明确两个概念:
- decorator只能作用于类或类的方法上
- 如果一个类和类的方法都是用了decorator,类方法的decorator优先于类的decorator执行
decorator基本原理:
@controller class hello{ } // 等同于 controller(hello)
controller是个普通函数,target为修饰的类或方法
// decorator不传参 function controller(target) { } // decorator传参 function controller(params) { return function (target) { } }
如果decorator是传参的,即使params有默认值,在调用时必须带上括号,即:
@controller() class hello{ }
如何在koa中使用decorator
我们可以对koa-router中间件进行包装
先回顾一下koa-router基本使用方法:
var koa = require('koa'); var router = require('koa-router'); var app = new koa(); var router = new router(); router.get('/', async (ctx, next) => { // ctx.router available }); app .use(router.routes()) .use(router.allowedmethods());
再想象一下最终目标
@controller({prefix: '/hello'}) class hellocontroller{ @request({url: '/', method: requestmethod.get}) async hello(ctx) { ctx.body = 'hello world' } }
类内部方法的装饰器是优先执行的,我们需要对方法重新定义
function request({url, method}) { return function (target, name, descriptor) { let fn = descriptor.value descriptor.value = (router) => { router[method](url, async(ctx, next) => { await fn(ctx, next) }) } } }
对requestmethod进行格式统一
const requestmethod = { get: 'get', post: 'post', put: 'put', delete: 'delete' }
controller装饰器需将request方法添加到router实例并返回router实例
import koarouter from 'koa-router' function controller({prefix}) { let router = new koarouter() if (prefix) { router.prefix(prefix) } return function (target) { let reqlist = object.getownpropertydescriptors(target.prototype) for (let v in reqlist) { // 排除类的构造方法 if (v !== 'constructor') { let fn = reqlist[v].value fn(router) } } return router } }
至此,装饰器基本功能就完成了,基本使用方法为:
import {controller, request, requestmethod} from './decorator' @controller({prefix: '/hello'}) export default class hellocontroller{ @request({url: '/', method: requestmethod.get}) async hello(ctx) { ctx.body = 'hello world' } }
在app实例中同路由一样use即可。
总结
以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作具有一定的参考学习价值,如果有疑问大家可以留言交流,谢谢大家对的支持。