请求

5.x

5.x

Route.get('/', (ctx) => {
  console.log(ctx.request.url())
})Copy

Route.get('/', async ({ request }) => {
  console.log(request.url())
})Copy

Route.get('/', async ({ request }) => {
  /*
   * URL: /?username=virk
   * qs: { username: 'virk' }
   */
  request.qs()
})Copy

Route.get('/posts/:id/:slug', async ({ request }) => {
  /*
   * URL: /posts/1/hello-world
   * Params: { id: '1', slug: 'hello-world' }
   */
  request.params()
})Copy

request.param('id')

// 可以设置一个默认值（可选）
request.param('id', 1)Copy

Route.post('/', async ({ request }) => {
  request.body()
})Copy

request.all()Copy

request.input('title')

// 读嵌套的值
request.input('user.profile.username')Copy

// 缺失标题时返回 "Hello world" 
request.input('title', 'Hello world')Copy

// 特定筛选
const body = request.only(['title', 'description'])

// 过滤
const body = request.except(['submit', 'csrf_token'])Copy

// 文件名: start/kernel.ts
Server.middleware.register([
  () => import('@ioc:Adonis/Core/BodyParser')
])Copy

// 文件名: config/bodyparser.ts
{
  form: {
    // ... 其余的配置
    convertEmptyStringsToNull: true
  },

  multipart: {
    // ... 其余的配置
    convertEmptyStringsToNull: true
  }
}Copy

// 文件名: config/bodyparser.ts
{
  raw: {
    // ...
    types: ['text/*', 'my-custom-content-type']
  }
}Copy

Route
  .get('/', ({ request }) => {
    console.log(request.all())
  })
  .middleware(async ({ request }, next) => {
    const contentType = request.header('content-type')

    if (contentType === 'my-custom-content-type') {
      const body = request.raw()
      const parsed = someCustomParser(body)
      request.updateBody(parsed)
    }

    await next()
  })Copy

Route.get('/', ({ request }) => {
  /**
   * 路由匹配
   */
  console.log(request.route.pattern)

  /**
   * 处理路由请求的处理器
   */
  console.log(request.route.handler)

  /**
   * 附加到路由的中间件
   */
  console.log(request.route.middleware)

  /**
   * 路由名称(如果路由被命名，则存在)
   */
  console.log(request.route.name)
})Copy

if (request.matchesRoute('/posts/:id')) {
}Copy

if (request.matchesRoute(['/posts/:id', '/posts/:id/comments'])) {
}Copy

request.url()

// 包含查询字符串
request.url(true)Copy

request.completeUrl()

// 包含查询字符串
request.completeUrl(true)Copy

request.method()Copy

request.intended()Copy

// 文件名: config/app.ts
{
  http: {
    generateRequestId: true
  }
}Copy

request.id()Copy

Route.get('/', ({ logger }) => {
  // { msg: 'hello world', request_id: 'ckk9oliws0000qt3x9vr5dkx7' }
  logger.info('hello world')
})Copy

// 获取所有请求头
console.log(request.headers())Copy

request.header('X-CUSTOM-KEY') === request.header('x-custom-key')

// 具有默认值的请求头
request.header('x-header-name', 'default value')Copy

request.ip()Copy

request.ips()Copy

http: {
  getIp(request) {
    const nginxRealIp = request.header('X-Real-Ip')
    if (nginxRealIp) {
      return nginxRealIp
    }

    return request.ips()[0]
  }
}Copy

<form method="POST" action="/posts/1?_method=PUT"></form>Copy

Route.get('posts', async ({ request, view }) => {
  const posts = [
    {
      title: 'Adonis 101',
    },
  ]

  switch (request.accepts(['html', 'json'])) {
    case 'html':
      return view.render('posts/index', { posts })
    case 'json':
      return posts
    default:
      return view.render('posts/index', { posts })
  }
})Copy

const types = request.types()Copy

const language = request.language(['fr', 'de'])

if (language) {
  return view.render(`posts/${language}/index`)
}

return view.render('posts/en/index')Copy

const languages = request.languages()Copy

switch (request.encoding(['gzip', 'br'])) {
  case 'gzip':
    return compressAsGzip(someValue)
  case 'br':
    return compressAsBr(someValue)
  default:
    return value
}Copy

const encodings = request.encodings()Copy

const charset = request.charset(['utf-8', 'hex', 'ascii'])
return Buffer.from('hello-world').toString(charset || 'utf-8')Copy

const charsets = request.charsets()Copy

// 文件名: config/app.ts
{
  http: {
    trustProxy: proxyAddr.compile(valueComesHere)
  }
}Copy

{
  trustProxy: proxyAddr.compile('127.0.0.0/8')
}

// 或者
{
  trustProxy: proxyAddr.compile(['127.0.0.0/8', 'fc00:ac:1ab5:fff::1/64'])
}Copy

{
  trustProxy: proxyAddr.compile((address, index) => {
    return address === '127.0.0.1' || address === '123.123.123.123'
  })
}Copy

// 文件名: config/cors.ts
{
  enabled: true,
  // ... 余下的配置
}Copy

request.hostname()Copy

if (request.ajax()) {
  // 返回 ajax 请求的响应
}Copy

if (request.matchesRoute('posts.show')) {
}Copy

if (request.matchesRoute(['posts.show', 'posts.edit'])) {
}Copy

const contentType = request.is(['json', 'xml'])

if (contentType === 'json') {
  // 以 JSON 方式处理请求主体
}

if (contentType === 'xml') {
  // 以 XML 方式处理请求主体
}Copy

request.updateBody(myCustomPayload)Copy

request.updateRawBody(JSON.stringify(myCustomPayload))Copy

request.updateQs(someCustomParser(request.parsedUrl.query))Copy

request.original()Copy

if (request.hasBody()) {
  // 解析请求主体
}Copy

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

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

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

    Request.macro('wantsJSON', function () {
      const types = this.types()
      return (
        types[0] && (types[0].includes('/json') || types[0].includes('+json'))
      )
    })
  }
}Copy

Route.get('/', ({ request }) => {
  if (request.wantsJSON()) {
    return {}
  }
})Copy

// 文件名: contracts/request.ts
declare module '@ioc:Adonis/Core/Request' {
  interface RequestContract {
    wantsJSON(): boolean
  }
}Copy

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