响应

5.x

5.x

Route.get('/', (ctx) => {
  ctx.response.send('hello world')
})Copy

Route.get('/', () => {
  /** 纯字符串 */
  return 'This is the homepage'

  /** Html 片段 */
  return '<p> This is the homepage </p>'

  /** JSON */
  return { page: 'home' }

  /** 转换成 ISO 字符串 */
  return new Date()
})Copy

response.send({ hello: 'world' })

// 使用 etag
response.send({ hello: 'world' }, true)Copy

import snakeCaseKeys from 'snakecase-keys'

Route
  .get('/', async ({ response }) => {
    response.send({ fullName: 'Harminder Virk' })
  })
  .middleware(async ({ response }, next) => {
    await next()

    /**
     * Following code is executed after the route handler.
     * Read the middleware guide to learn how it works
     */
    const existingBody = response.lazyBody[0]
    if (!existingBody || existingBody.constructor !== Object) {
      return
    }

    response.send(snakeCaseKeys(existingBody))
  })Copy

response.header('Content-type', 'text/html')Copy

response.append('Set-cookie', 'cookie-value')Copy

response.removeHeader('Content-type')Copy

const cookie = response.getHeader('Set-cookie')Copy

response.safeHeader('Content-type', 'application/json')Copy

response.status(401)Copy

response.safeStatus(401)Copy

const image = fs.createReadStream('./some-file.jpg')
response.stream(image)Copy

response.stream(image, (error) => {
  return ['Unable to send file', 400]
})Copy

const filePath = Application.tmpPath('uploads/some-file.jpg')
response.download(filePath)Copy

const filePath = Application.tmpPath('uploads/some-file.jpg')
response.download(filePath, true)Copy

const filePath = Application.tmpPath('uploads/some-file.jpg')

response.download(filePath, true, (error) => {
  if (error.code === 'ENOENT') {
    return ['File does not exists', 404]
  }

  return ['Cannot download file', 400]
})Copy

const filePath = Application.tmpPath('uploads/some-file.jpg')
response.attachment(filePath)

// 自定义名称
response.attachment(filePath, 'foo.jpg')

// 自定义处理方式
response.attachment(filePath, 'foo.jpg', 'inline')Copy

// 重定向回上一页
response.redirect().back()

// 重定向到 URL
response.redirect().toPath('/some/url')Copy

response.redirect().status(301).toPath('/some/url')Copy

response.redirect().toRoute('PostsController.show', { id: 1 })Copy

response
  .redirect()
  .withQs() // 👈 转发现有的查询字符串
  .back()

response
  .redirect()
  .withQs({ sort: 'id' }) // 👈 自定义
  .back()Copy

response
  .redirect()
  .withQs({ sort: 'id' })
  .clearQs()
  .withQs({ filters: { name: 'virk' } })
  .toPath('/users')

// URL: /users?filters[name]=virkCopy

response.redirect().withQs().back() // 👈 这里采用了 referrer 响应头Copy

response.redirect().withQs().toPath('/users') // 👈 这里采用了当前 URLCopy

if (!auth.user) {
  response.abort('Not authenticated')

  // 自定义状态
  response.abort('Not authenticated', 401)
}Copy

response.abortIf(!auth.user, 'Not authenticated', 401)Copy

response.abortUnless(auth.user, 'Not authenticated', 401)Copy

if (!response.finished) {
  response.send()
}Copy

if (response.isPending) {
  response.send()
}Copy

response.vary('Origin')

// 设置多个响应头
response.vary('Accept, User-Agent')Copy

response.location('/dashboard')Copy

response.type('application/json')Copy

response.type('json') // 定义 content-type=application/json
response.type('html') // 定义 content-type=text/htmlCopy

response.badRequest({ error: 'Invalid login credentials' })
response.forbidden({ error: 'Unauthorized' })
response.created({ data: user })Copy

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

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

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

    Response.macro('flash', function (messages) {
      this.ctx!.session.flash(messages)
      return this
    })
  }
}Copy

Route.post('users', ({ response }) => {
  response.flash({ success: 'User created' })
})Copy

// 文件名: contracts/response.ts
declare module '@ioc:Adonis/Core/Response' {
  interface ResponseContract {
    flash(messages: any): this
  }
}Copy

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