@eggjs/路由器

路由器核心组件用于 鸡蛋.js。 。 。 .

此寄存器为 旋转道。 。 。 . 带有一些额外特征. 感谢@alexmingoia和原始团队的出色工作.

API 参考

• @eggjs/路由器
  • API 参考
    • 路由器QQ
      • 新建路由器( [opts] )
      • 路由器.get|put|post|patch|delelete|del⇒路由器
      • 命名路线
      • 多个中间软件
    • 嵌入路由器
      • 路由器前缀
      • URL 参数
      • 路由器. routes qq 函数
      • 路由器.use([路径],中间软件) QQ路由器
      • 路由器.prefix(前缀) QQ路由器
      • 路由器.allowd Methods ([选项]) QQ函数
      • 路由器.rediction(来源,目的地,[代码]) QQ路由器
      • 路由器.route(名称) QQ 层 QQ 假
      • 路由器.url(名称,参数,[选项]) QQ String QQ出错
      • 路由器.param( param, 中间软件) QQ 路由器
      • 路由器.url(路径,参数[,选项]) QQ String
  • 测试
  • V3 正在中断更改
  • 许可证
  • 贡献者

路由器QQ

仁爱: 导出类别

新建路由器( [opts] )

创建新路由器 .

示例 基本用途:

import Koa from '@eggjs/koa';
import Router from '@eggjs/router';

const app = new Koa();
const router = new Router();

router.get('/', async (ctx, next) => {
  // ctx.router available
});

app.use(router.routes()).use(router.allowedMethods());

路由器 Router

创建 router.verb() 方法,其中 动词 是HTTP 动词之一 作为 router.get() 或者说 router.post()。 。 。 .

匹配 URL 模式以调用调用函数或控制器动作 router.verb(), (中文(简体) ), 地点 动词 hTTP 等动词之一 router.get() 或者说 router.post()。 。 。 .

还有, router.all() 可以用来匹配所有方法.

router
  .get('/', (ctx, next) => {
    ctx.body = 'Hello World!';
  })
  .post('/users', (ctx, next) => {
    // ...
  })
  .put('/users/:id', (ctx, next) => {
    // ...
  })
  .del('/users/:id', (ctx, next) => {
    // ...
  })
  .all('/users/:id', (ctx, next) => {
    // ...
  });

当一个路径匹配时, 它的路径可用于 ctx.routePath 并且如果命名, 名称在 ctx.routeName

路由路径将使用 路径到备忘。 。 。 .

匹配请求时不考虑查询字符串 .

命名路线

路由可以选择有名称. 这样可以生成 URL 和 简单 开发期间重新命名 URL.

router.get('user', '/users/:id', (ctx, next) => {
  // ...
});

router.url('user', 3);
// => "/users/3"

多个中间软件

多个中间软件可能给出:

router.get(
  '/users/:id',
  (ctx, next) => {
    return User.findOne(ctx.params.id).then(function (user) {
      ctx.user = user;
      next();
    });
  },
  (ctx) => {
    console.log(ctx.user);
    // => { id: 17, name: "Alex" }
  },
);

嵌入路由器

支持嵌入路由器 :

const forums = new Router();
const posts = new Router();

posts.get('/', (ctx, next) => {...});
posts.get('/:pid', (ctx, next) => {...});
forums.use('/forums/:fid/posts', posts.routes(), posts.allowedMethods());

// responds to "/forums/123/posts" and "/forums/123/posts/123"
app.use(forums.routes());

路由器前缀

路径可以在路由器级别前缀:

const router = new Router({
  prefix: '/users'
});

router.get('/', ...); // responds to "/users"
router.get('/:id', ...); // responds to "/users/:id"

URL 参数

获取并添加命名的路由参数 ctx.params。 。 。 .

router.get('/:category/:title', (ctx, next) => {
  console.log(ctx.params);
  // => { category: 'programming', title: 'how-to-node' }
});

这个 路径到备忘 模块是 用于将路径转换为正则表达式.

仁爱: 实例财产 Router

路由器. 路由器 qq function

返回发送匹配请求的路由器中间软件 .

仁爱: 实例财产 Router

路由器.use([path],中间软件) qq Router

使用给定的中间软件 .

中间软件按定义顺序运行 .use()它们被援引 依次从第一个中间器件开始请求并按自己的方式工作 "下"中相器叠.

仁爱: 实例方法 Router

示例

// session middleware will run before authorize
router.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());

路由器. prefix( 前缀) qq Router

为已经初始化的路由器实例设置路径前缀 .

仁爱: 实例方法 Router

示例

router.prefix('/things/:thing_id');

路由器. allowd Methods ([可选 ) QQ function

返回响应的单独中间软件 OPTIONS 请求 a 一个 Allow 包含允许的方法以及响应的页眉 与 405 Method Not Allowed 财务报告和审定财务报表 501 Not Implemented 视情况而定.

仁爱: 实例方法 Router

示例

import Koa from '@eggjs/koa';
import Router from '@eggjs/router';

const app = new Koa();
const router = new Router();

app.use(router.routes());
app.use(router.allowedMethods());

示例 轰

import Koa from '@eggjs/koa';
import Router from '@eggjs/router';
import Boom from 'boom';

const app = new Koa();
const router = new Router();

app.use(router.routes());
app.use(
  router.allowedMethods({
    throw: true,
    notImplemented: () => new Boom.notImplemented(),
    methodNotAllowed: () => new Boom.methodNotAllowed(),
  }),
);

路由器. redirect(来源,目的地,[代码]) qq Router

重定向 source 改为 destination 可选 30x 状态的 URL code。 。 。 .

两者 source 财务报告和审定财务报表 destination 可以是路由名称.

router.redirect('/login', 'sign-in');

这相当于:

router.all('/login', (ctx) => {
  ctx.redirect('/sign-in');
  ctx.status = 301;
});

仁爱: 实例方法 Router

路由器.route(名称) qq Layer | false

以给定的查找路径 name。 。 。 .

仁爱: 实例方法 Router

路由器.url(名称,参数,[可选 ) qq String | Error

生成路由的 URL 。 使用命名的路由名称和地图 params。 。 。 .

仁爱: 实例方法 Router

示例

router.get('user', '/users/:id', (ctx, next) => {
  // ...
});

router.url('user', 3);
// => "/users/3"

router.url('user', { id: 3 });
// => "/users/3"

router.use((ctx, next) => {
  // redirect to named route
  ctx.redirect(ctx.router.url('sign-in'));
});

router.url('user', { id: 3 }, { query: { limit: 1 } });
// => "/users/3?limit=1"

router.url('user', { id: 3 }, { query: 'limit=1' });
// => "/users/3?limit=1"

路由器.param( parm, 中间软件) qq Router

运行命名路由参数的中间软件 。 用于自动装入或 审定.

仁爱: 实例方法 Router

示例

router
  .param('user', (id, ctx, next) => {
    ctx.user = users[id];
    if (!ctx.user) return (ctx.status = 404);
    return next();
  })
  .get('/users/:user', (ctx) => {
    ctx.body = ctx.user;
  })
  .get('/users/:user/friends', (ctx) => {
    return ctx.user.getFriends().then(function (friends) {
      ctx.body = friends;
    });
  });
// /users/3 => {"id": 3, "name": "Alex"}
// /users/3/friends => [{"id": 4, "name": "TJ"}]

Router.url(路径,参数[,选项]) QQ String

从 url 模式生成 URL并给出 params。 。 。 .

仁爱:静态方法 Router

示例

const url = Router.url('/users/:id', { id: 1 });
// => "/users/1"

const url = Router.url('/users/:id', { id: 1 }, { query: { active: true } });
// => "/users/1?active=true"

测试

使用 npm test。 。 。 .

V3 正在中断更改

• 丢弃生成器函数支持
• 丢出节点.js < 18.19.0 支持

许可证

麻省理工学院

贡献者

制造的 贡献者-img。 。 。 .