// router 路由 // Router 主要用来描述请求 URL 和具体承担执行动作的 Controller 的对应关系, 框架约定了 app/router.js 文件用于统一所有路由规则。 // 通过统一的配置,我们可以避免路由规则逻辑散落在多个地方,从而出现未知的冲突,集中在一起我们可以更方便的来查看全局的路由规则。 // 定义 Router // app/router.js 里面定义 URL 路由规则 // app/router.js module.exports = app => { const { router, controller } = app; router.get('/user/:id', controller.user.info); }; // app/controller 目录下面实现 Controller // app/controller/user.js class UserController extends Controller { async info() { const { ctx } = this; ctx.body = { name: `hello ${ctx.params.id}`, }; } } // 这样就完成了一个最简单的 Router 定义,当用户执行 GET /user/123,user.js 这个里面的 info 方法就会执行。 // Router 详细定义说明 // 下面是路由的完整定义,参数可以根据场景的不同,自由选择: router.verb('path-match', app.controller.action); router.verb('router-name', 'path-match', app.controller.action); router.verb('path-match', middleware1, ..., middlewareN, app.controller.action); router.verb('router-name', 'path-match', middleware1, ..., middlewareN, app.controller.action); // verb: 用户触发动作,支持 get,post 等所有 HTTP 方法 router.head: HEAD router.options: OPTIONS router.get: GET router.put: PUT router.post: POST router.patch: PATCH router.delete: DELETE router.del: 由于 delete 是一个保留字,所以提供了一个 delete 方法的别名。 router.redirect: 可以对 URL 进行重定向处理,比如我们最经常使用的可以把用户访问的根目录路由到某个主页。 router-name: 给路由设定一个别名,可以通过 Helper 提供的辅助函数 pathFor 和 urlFor 来生成 URL。(可选) path-match: 路由 URL 路径。 middleware1: 在 Router 里面可以配置多个 Middleware。(可选) controller: 指定路由映射到的具体的 controller 上,controller 可以有两种写法: app.controller.user.fetch: 直接指定一个具体的 controller 'user.fetch': 可以简写为字符串形式 // 注意事项 在 Router 定义中, 可以支持多个 Middleware 串联执行 Controller 必须定义在 app/controller 目录中。 一个文件里面也可以包含多个 Controller 定义,在定义路由的时候,可以通过 ${fileName}.${functionName} 的方式指定对应的 Controller。 Controller 支持子目录,在定义路由的时候,可以通过 ${directoryName(目录名)}.${fileName(文件名)}.${functionName(方法名)} 的方式制定对应的 Controller。 // app/router.js 下面是一些路由定义的方式: module.exports = app => { const { router, controller } = app; router.get('/home', controller.home); router.get('/user/:id', controller.user.page); router.post('/admin', isAdmin, controller.admin); router.post('/user', isLoginUser, hasAdminPermission, controller.user.create); router.post('/api/v1/comments', controller.v1.comments.create); // app/controller/v1/comments.js }; // 参数命名方式 // app/router.js module.exports = app => { // get 参数拼接 http://127.0.0.1:7001/user/123/xiaoming app.router.get('/user/:id/:name', app.controller.user.info); // 表单参数获取 post请求 app.router.post('/form', app.controller.form.post); }; // app/controller/user.js exports.info = async ctx => { // get ctx.body = `user: ${ctx.params.id}, ${ctx.params.name}`; // 表单post ctx.body = `body: ${JSON.stringify(ctx.request.body)}`; }; // 注意: 直接发起 POST 请求会报错:'secret is missing' // 原因:框架内部针对表单 POST 请求均会验证 CSRF 的值,因此我们在表单提交时,请带上 CSRF key 进行提交,可参考安全威胁csrf的防范 // 因为框架中内置了安全插件 egg-security,提供了一些默认的安全实践,并且框架的安全插件是默认开启的,如果需要关闭其中一些安全防范,直接设置该项的 enable 属性为 false 即可。 // 在 config/config.default.js 中设置 exports.security = { csrf: false }; 或者 config.security = { csrf: false } // 表单校验 // app/router.js module.exports = app => { app.router.post('/user', app.controller.user); }; // app/controller/user.js const createRule = { username: { type: 'email', }, password: { type: 'password', compare: 're-password', }, }; exports.create = async ctx => { // 如果校验报错,会抛出异常 ctx.validate(createRule); ctx.body = ctx.request.body; }; // 多路由映射 // app/router.js module.exports = app => { require('./router/news')(app); require('./router/admin')(app); }; // app/router/news.js module.exports = app => { app.router.get('/news/list', app.controller.news.list); app.router.get('/news/detail', app.controller.news.detail); }; // app/router/admin.js module.exports = app => { app.router.get('/admin/user', app.controller.admin.user); app.router.get('/admin/log', app.controller.admin.log); };
node_egg_router路由
猜你喜欢
转载自www.cnblogs.com/JunLan/p/12536108.html
今日推荐
周排行