掌握装饰器路由，告别繁琐重复！

2023-11-26 09:19:09

很多时候，我们在使用 Koa 或 Egg 等框架开发接口时，都会遇到这样的困扰：每当我们定义一个路由后，还要去 router 文件中再次定义一遍，十分繁琐。虽然这种写法很吸引人，但为了一个写法去切换框架却并不划算。那么，有没有办法在不切换框架的前提下，简化路由的定义过程呢？答案就是装饰器路由。

什么是装饰器路由？

装饰器路由是一种语法糖，它允许我们在定义路由时使用装饰器。这样，我们就可以在 Controller 方法上直接定义路由，无需再到 router 文件中重复定义。这不仅简化了路由定义的过程，还使代码更加清晰易读。

如何使用装饰器路由？

在 Koa 中使用装饰器路由非常简单。我们只需要安装 koa-router-decorator 包即可。安装完成后，我们可以在 Controller 方法上使用 @Router 装饰器来定义路由。例如：

import {Router} from 'koa-router-decorator'

class UserController {
  @Router.get('/user/:id')
  async getUser(ctx) {
    // ...
  }
}

在 Egg 中使用装饰器路由也同样简单。我们只需要安装 egg-decorator-router 包即可。安装完成后，我们可以在 Controller 方法上使用 @router.get、@router.post 等装饰器来定义路由。例如：

import {router} from 'egg-decorator-router'

export default class UserController {
  @router.get('/user/:id')
  async getUser(ctx) {
    // ...
  }
}

使用装饰器路由的好处

使用装饰器路由有很多好处，包括：

简化路由定义过程，提高开发效率
使代码更加清晰易读，便于维护
减少代码冗余，避免重复定义路由

示例

下面是一个使用装饰器路由的示例：

// Koa
import {Router} from 'koa-router-decorator'

class UserController {
  @Router.get('/user/:id')
  async getUser(ctx) {
    // ...
  }

  @Router.post('/user')
  async createUser(ctx) {
    // ...
  }
}

// Egg
import {router} from 'egg-decorator-router'

export default class UserController {
  @router.get('/user/:id')
  async getUser(ctx) {
    // ...
  }

  @router.post('/user')
  async createUser(ctx) {
    // ...
  }
}