路由

5.x

5.x

import Route from '@ioc:Adonis/Core/Route'

Route.get('/', () => {
  return 'Hello world'
})Copy

import Route from '@ioc:Adonis/Core/Route'

Route.get('posts', 'PostsController.index')Copy

// title: start/routes.ts
import 'App/Modules/User/routes'
import 'App/Modules/Cart/routes'
import 'App/Modules/Product/routes'Copy

// title: .adonisrc.json
{
  "preloads": [
    "./start/kernel",
    "add-path-to-your-routes-file"
  ]
}Copy

node ace list:routesCopy

node ace list:routes --json > routes.jsonCopy

Route.post('posts', async () => {})Copy

Route.put('posts/:id', async () => {})Copy

Route.patch('posts/:id', async () => {})Copy

Route.delete('posts/:id', async () => {})Copy

Route.route('/', ['OPTIONS', 'HEAD'], async () => {})Copy

Route.any('csp-report', async () => {})Copy

Route.get('/posts/:id', async ({ params }) => {
  return `Viewing post with id ${params.id}`
})Copy

Route.get('/posts/:id?', async ({ params }) => {
  if (params.id) {
    return `Viewing post with id ${params.id}`
  }
  return 'Viewing all posts'
})Copy

Route.get('docs/*', ({ params }) => {
  console.log(params['*'])
})Copy

Route.get('docs/:category/*', ({ params }) => {
  console.log(params.category)
  console.log(params['*'])
})Copy

Route
  .get('/posts/:id', async ({ params }) => {
    return `Viewing post using id ${params.id}`
  })
  .where('id', /^[0-9]+$/)

Route
  .get('/posts/:slug', async ({ params }) => {
    return `Viewing post using slug ${params.slug}`
  })
  .where('slug', /^[a-z0-9_-]+$/)Copy

Route.where('id', /^[0-9]+$/)Copy

Route
  .get('posts/:id', 'PostsController.show')
  .where('id', {
    match: /^[0-9]+$/,
    cast: (id) => Number(id),
  })Copy

// 验证 id 为数字 + 强制转换为数字类型
Route.where('id', Route.matchers.number())

// 验证 id 是否为有效的 uuid
Route.where('id', Route.matchers.uuid())

// 验证 slug 以匹配给定的 slug 正则表达式：regexr.com/64su0
Route.where('slug', Route.matchers.slug())Copy

Route.get('/users/:id', 'UsersController.show')

// 位置参数
const url = Route.makeUrl('/users/:id', [1])

// 命名对象键
const url = Route.makeUrl('/users/:id', { id: 1 })Copy

const url = Route.makeUrl('UsersController.show', { id: 1 })Copy

Route
  .get('/users/:id', 'UsersController.show')
  .as('showUser') // 👈 路由名

// 生成 URL
const url = Route.makeUrl('showUser', { id: 1 })Copy

const url = Route.makeUrl('showUser', [1], {
  qs: {
    verified: true,
  },
})Copy

Route
  .get('/users/:id', 'UsersController.show')
  .domain(':tenant.adonisjs.com')

// 制作 URL
const url = Route.makeUrl('UsersController.show', [1], {
  domain: ':tenant.adonisjs.com',
})Copy

const url = Route.makeUrl('UsersController.show', [1], {
  prefixUrl: 'https://foo.com',
})Copy

const url = Route.builder()
  .params({ id: 1 })
  .qs({ verified: true })
  .prefixUrl('https://foo.com')
  .make('UsersController.show')Copy

const url = Route.builderForDomain(':tenant.adonisjs.com')
  .params({ id: 1 })
  .qs({ verified: true })
  .prefixUrl('https://foo.com')
  .makeUrl('UsersController.show')Copy

Route.post('posts', 'PostsController.store').as('posts.create')Copy

<form method="POST" action="{{ route('posts.create') }}">
</form>Copy

Route
  .get('/users/:id', 'UsersController.show')
  .as('users.show')Copy

Route.post('users', async ({ response }) => {
  // 创建用户
  response.redirect().toRoute('users.show', { id: user.id })
})Copy

// 文件名: start/routes.ts
Route.get('*', async ({ view }) => {
  return view.render('app')
})

// 简单版本
Route.on('*').render('app')Copy

Route.get('/api/users', 'UsersController.index')
Route.get('/api/posts', 'PostsController.index')

// SPA 路由
Route.on('*').render('app')Copy

Route.group(() => {
  Route.get('/users', 'UsersController.index')
  Route.get('/posts', 'PostsController.index')
}).prefix('/api')

// SPA 路由
Route.on('*').render('app')Copy

Route.group(() => {
  // 这里所有的路由都是组的一部分
})Copy

Route
  .group(() => {
    Route.get('/users', 'UsersController.index')
    Route.get('/posts', 'PostsController.index')
  })
  .prefix('/api')Copy

Route.group(() => {
  Route.group(() => {
    Route.get('/users', 'UsersController.index') // /api/v1/users
    Route.get('/posts', 'PostsController.index') // /api/v1/posts
  }).prefix('/v1')
}).prefix('/api')Copy

Route.group(() => {
  Route.get('users', async () => {
    return 'handled'
  }).middleware('can:view_users')
}).middleware('auth')Copy

// 命名为 users.index, users.store 等
Route.resource('users', 'UserController')

Route
  .group(() => {
    // 命名为 api.users.index, api.users.store
    Route.resource('users', 'UserController')
  })
  .prefix('v1')
  .as('api')Copy

Route
  .group(() => {
    Route.get('/', 'PostsController.index')
    Route.get('/:id', 'PostsController.show')
  })
  .domain('blog.adonisjs.com')Copy

Route
  .group(() => {
    Route.get('/', ({ subdomains }) => {
      console.log(subdomains.tenant)
    })
  })
  .domain(':tenant.adonisjs.com')Copy

Route.on('/').render('welcome')Copy

Route.on('/').render('welcome', { greeting: 'Hello world' })Copy

Route.on('/posts/:id').redirect('/articles/:id')

// 内联参数
Route.on('/posts/:id').redirect('/articles/:id', { id: 1 })

// 自定义状态
Route.on('/posts/:id').redirect('/articles/:id', undefined, 301)Copy

Route.on('/posts/:id').redirectToUrl('https://medium.com/my-blog')

// 自定义状态
Route.on('/posts/:id').redirectToUrl('https://medium.com/my-blog', 301)Copy

// 文件名: providers/AppProvider.ts
import { ApplicationContract } from '@ioc:Adonis/Core/Application'

export default class AppProvider {
  public static needsApplication = true
  constructor(protected app: ApplicationContract) {}

  public async ready() {
    const Route = this.app.container.use('Adonis/Core/Route')
    console.log(Route.toJSON())
  }
}Copy

import { ApplicationContract } from '@ioc:Adonis/Core/Application'

export default class AppProvider {
  public static needsApplication = true

  constructor(protected app: ApplicationContract) {}

  public async boot() {
    const Route = this.app.container.use('Adonis/Core/Route')

    Route.Route.macro('mustBeSigned', function () {
      this.middleware(async (ctx, next) => {
        if (!ctx.request.hasValidSignature()) {
          ctx.response.badRequest('Invalid signature')
          return
        }

        await next()
      })

      return this
    })
  }
}Copy

// 文件名: start/routes.ts
Route
  .get('email/verify', 'OnboardingController.verifyEmail')
  .mustBeSigned()Copy

// 文件名: contracts/route.ts
declare module '@ioc:Adonis/Core/Route' {
  interface RouteContract {
    mustBeSigned(): this
  }
}Copy

// 主题: 添加宏
Route.RouteResource.macro('yourMacroName', fn)Copy

// 主题：扩展接口
declare module '@ioc:Adonis/Core/Route' {
  interface RouteResourceContract {
    yourMacroName(): this
  }
}Copy

// 主题: 使用宏
Route.resource().yourMacroName()Copy

// 主题：添加宏
Route.RouteGroup.macro('yourMacroName', fn)Copy

// 主题：扩展接口
declare module '@ioc:Adonis/Core/Route' {
  interface RouteGroupContract {
    yourMacroName(): this
  }
}Copy

// 主题：使用宏
Route.group().yourMacroName()Copy

// 主题：添加宏
Route.BriskRoute.macro('yourMacroName', fn)Copy

// 主题：扩展接口
declare module '@ioc:Adonis/Core/Route' {
  interface BriskRouteContract {
    yourMacroName(): this
  }
}Copy

// 主题：使用宏
Route.on('/').yourMacroName()Copy

本文章首发在 LearnKu.com 网站上。