请求处理

Ipare 有开箱即用的获取请求参数的方式,同时也内置了一些处理返回结果的功能

请求上下文 HttpContext

中间件管道中的内容都在 HttpContext 对象之中,每个中间件都可以调用 this.ctx 来获取或修改中间件管道内容

该对象包含以下内容:

  • res 字段: Response 实例对象
  • req 字段: Request 实例对象
  • bag 函数:用于在中间件管道中传递更多内容

Response

作为 API 返回内容(在 Startup 可能会被解析后返回)

包含以下内容

  • headers: 返回的头部
  • body: 返回的内容
  • status: 返回状态码
  • isSuccess: 返回值是否成功,status >= 200 && status < 300
  • setHeaders: 设置多个 header
  • setHeader: 设置单个 header
  • hasHeader: 判断 header 是否存在,忽略 key 大小写
  • removeHeader: 移除一个 header,忽略 key 大小写
  • getHeader: 获取一个 header 值,忽略 key 大小写

在每个中间件都可以修改 this.ctx.res 中的内容

Request

在中间件中,可通过 this.ctx.req 方式获取请求内容

req 对象包含以下内容

  • path: 访问路径,不带域名和查询参数,自动去除开头 /
  • params: 查询参数
  • body: body 内容
  • headers: 获取 header 的深拷贝值,get 属性
  • setHeaders: 设置多个 header
  • setHeader: 设置单个 header
  • hasHeader: 判断 header 是否存在,忽略 key 大小写
  • removeHeader: 移除一个 header,忽略 key 大小写
  • getHeader: 获取一个 header 值,忽略 key 大小写

X-HTTP-Method-Override

如果请求头部包含 X-HTTP-Method-Override 参数,则访问方法 httpMethodX-HTTP-Method-Override 值为准

比如 Action 要求 PATCH 请求,但微信小程序不支持 PATCH,那么可以使用 POST 访问,并在头部加上此参数,值为 PATCH

"headers":{
  "X-HTTP-Method-Override": "PATCH"
}

bag 函数

可以在管道中传递更多自定义内容。

如果使用 TS,可以借泛型特性获得更多智能提示。

ipare 支持两种引用类型的 bag

  • Singleton: 单例模式,添加后可多次获取同一引用
  • Transient: 临时模式,添加后每次获取都会创建一个新引用

如果是值类型,每次获取的都是该值的拷贝

添加或修改 bag

// Singleton
this.ctx.bag("BAG_NAME", { /*bag content*/ });

OR

// Transient
this.ctx.bag("BAG_NAME", () => { /*bag content*/ });

获取 bag

const val = this.ctx.bag("BAG_NAME")

或 TS

const val = this.ctx.bag<string>("BAG_NAME")

ctx 中的头部

HttpContext 中的头部处理比较特殊,和 ResponseRequest 都不一样

获取的头部,都来自于请求头 Request,如 headers, hasHeader, getHeader

设置的头部,都位于返回头 Response,如 setHeader, setHeaders, removeHeader

内置结果函数

HttpContext 和中间件中,内置一些返回结果,用于快速设置返回结果:

  • ok, 200
  • created, 201
  • accepted, 202
  • noContent, 204
  • partialContent, 206
  • redirect, 30*
  • badRequest, 400
  • badRequestMsg, 400
  • forbidden, 403
  • forbiddenMsg, 403
  • notFound, 404
  • notFoundMsg, 404
  • methodNotAllowed, 405
  • methodNotAllowedMsg, 405
  • notAcceptable, 406
  • notAcceptableMsg, 406
  • requestTimeout, 408
  • requestTimeoutMsg, 40
  • conflict, 409
  • conflictMsg, 409
  • gone, 410
  • goneMsg, 410
  • preconditionFailed, 412
  • preconditionFailedMsg, 412
  • requestTooLong, 413
  • requestTooLongMsg, 413
  • unsupportedMediaType, 415
  • unsupportedMediaTypeMsg, 415
  • imATeapot, 418
  • imATeapotMsg, 418
  • misdirected, 421
  • misdirectedMsg, 421
  • unprocessableEntity, 421
  • unprocessableEntityMsg, 421
  • internalServerError, 500
  • internalServerErrorMsg, 500
  • notImplemented, 501
  • notImplementedMsg, 501
  • badGateway, 502
  • badGatewayMsg, 502
  • serviceUnavailable, 503
  • serviceUnavailableMsg, 503
  • gatewayTimeout, 504
  • gatewayTimeoutMsg, 504
  • httpVersionNotSupported, 505
  • httpVersionNotSupportedMsg, 505

如在类中间件中

this.ok("success");

等同于

this.ctx.res.body = "success";
this.ctx.res.status = 200;
import { Middleware } from "@ipare/core";
export class extends Middleware {
  async invoke() {
    this.noContent();
    // or this.ok('success');
  }
}
import { Middleware } from "@ipare/core";
export class extends Middleware {
  async invoke() {
    const { account, password } = this.ctx.req.query;

    if (/*Incorrect username or password*/) {
      this.notFoundMsg({ message: "Incorrect username or password" });
    } else {
      this.ok({
        /*messages*/
      });
    }
  }
}

多数内置类型支持传入 body 可选参数,body 为返回的内容。

API 返回错误时,可统一返回 ErrorMessage,命名以 Msg 结尾的内置类型接受 ErrorMessage 参数。