Page Contents
Page Contents

总览

控制器(Controller)是一个用于实现应用 API 定义的操作的类。它实现一个应用的业务逻辑, 它实现了一个应用的业务逻辑,并作为“HTTP / REST API”和“域 / 数据库模型”之间的桥梁。

添加修饰符到Controller类及其成员,可以映射应用的 API 操作到对应的 Controller(控制器)操作。 控制器(Controller)仅对“已处理的输入”和“后端服务/数据库”的抽象进行操作。

本页面仅涵盖用于 REST API 的控制器(Controller)。

操作(Operations)

路由(Routes)示例的操作(Operation)中,greet()操作被定义为一个普通的 JavaScript 函数。The

// 普通函数Operation
function greet(name: string) {
  return `hello ${name}`;
}

// 控制器方法Operation
class MyController {
  greet(name: string) {
    return `hello ${name}`;
  }
}

路由到控制器(Controller)

下面的示例是一个基本的 API 规范。这是一个操作对象(Operation Object).

const spec = {
  parameters: [{ name: "name", schema: { type: "string" }, in: "query" }],
  responses: {
    "200": {
      description: "greeting text",
      content: {
        "application/json": {
          schema: { type: "string" }
        }
      }
    }
  }
};

定义路由(Routes)到控制器(Controller)方法,有数种方式。 第一个示例是普通地定义路由到控制器方法:

// ... 在你的application构造函数中
this.route("get", "/greet", spec, MyController, "greet");

修饰符允许你使用路由元数据描述你的控制器方法,然后 LoopBack 可以替你调用app.route()函数。

import { get } from "@loopback/rest";

class MyController {
  @get("/greet", spec)
  greet(name: string) {
    return `hello ${name}`;
  }
}

// ... 在你的application构造函数中
this.controller(MyController);

指明控制器(Controller)的 API

大型的 LoopBack 应用中,你可以使用 OpenAPI 规范来组织你的路由。 @api修饰符会取得一个类型为ControllerSpec,包含basePath字符串和Paths Object的规范。 注意,这不是一个完整的OpenAPI规范。

// ... 在你的application构造函数中
this.api({
  openapi: "3.0.0",
  info: {
    title: "Hello World App",
    version: "1.0.0"
  },
  paths: {
    "/greet": {
      get: {
        "x-operation-name": "greet",
        "x-controller-name": "MyController",
        parameters: [{ name: "name", schema: { type: "string" }, in: "query" }],
        responses: {
          "200": {
            description: "greeting text",
            content: {
              "application/json": {
                schema: { type: "string" }
              }
            }
          }
        }
      }
    }
  }
});
this.controller(MyController);

@api修饰符允许你使用一个规范来描述你的 Controller(控制器),然后 LoopBack 可以替你调用app.api() 函数。

@api({
  openapi: "3.0.0",
  info: {
    title: "Hello World App",
    version: "1.0.0"
  },
  paths: {
    "/greet": {
      get: {
        "x-operation-name": "greet",
        "x-controller-name": "MyController",
        parameters: [{ name: "name", schema: { type: "string" }, in: "query" }],
        responses: {
          "200": {
            description: "greeting text",
            content: {
              "application/json": {
                schema: { type: "string" }
              }
            }
          }
        }
      }
    }
  }
})
class MyController {
  greet(name: string) {
    return `hello ${name}`;
  }
}
app.controller(MyController);

编写控制器(Controller)方法

下面是一个控制器(Controller)的示例,使用了数种内置的助手(修饰符)。 这些助手给了 LoopBack 关于控制器(Controller)方法的提示。

import { HelloRepository } from "../repositories";
import { HelloMessage } from "../models";
import { get, param } from "@loopback/rest";
import { repository } from "@loopback/repository";

export class HelloController {
  constructor(
    @repository(HelloRepository) protected repository: HelloRepository
  ) {}

  // 返回我们的对象的列表
  @get("/messages")
  async list(@param.query.number("limit") limit = 10): Promise<HelloMessage[]> {
    if (limit > 100) limit = 100; // 我们的逻辑
    return this.repository.find({ limit }); // 来自我们的存储库的CRUD方法
  }
}
  • HelloRepository扩展自Repository(存储库),这是 LoopBack 的一个数据库抽象。 查阅存储库(Repositories) 获得更多信息。
  • HelloMessage 返回一个随意的对象的list列表。
  • @get('/messages')为 OpenAPI 规范自动创建Paths Item Object,同时也处理请求路由。
  • @param.query.number指明了此规范的路由接受一个参数,此参数通过 Query(查询)传递,并且为一个数字。

在控制器(Controller)中处理错误

为了控制器(Controller)方法抛出异常,需要用到HttpErrors类。HttpErrors导出自 http-errors,包含在@loopback/rest 包中。

Listed below are some of the most common error codes. The full list of supported codes is found here.

Status Code(状态码) 错误 描述
400 BadRequest 错误请求
401 Unauthorized 未授权
403 Forbidden 被禁止
404 NotFound 未找到
500 InternalServerError 内部服务器错误
502 BadGateway 错误网关
503 ServiceUnavailable 服务不可用
504 GatewayTimeout 网关超时

下列示例展示了上述示例带有HttpErrors的改版,并附加了一个测试,以验证错误能够被确实地抛出。

src/tests/integration/controllers/hello.controller.integration.ts

import { HelloController } from "../../../controllers";
import { HelloRepository } from "../../../repositories";
import { testdb } from "../../fixtures/datasources/testdb.datasource";
import { expect } from "@loopback/testlab";
import { HttpErrors } from "@loopback/rest";

const HttpError = HttpErrors.HttpError;

describe("Hello Controller", () => {
  it("returns 422 Unprocessable Entity for non-positive limit", () => {
    const repo = new HelloRepository(testdb);
    const controller = new HelloController(repo);

    return expect(controller.list(0.4)).to.be.rejectedWith(HttpError, {
      message: "limit is non-positive",
      statusCode: 422
    });
  });
});

src/controllers/hello.controller.ts

import { HelloRepository } from "../repositories";
import { HelloMessage } from "../models";
import { get, param, HttpErrors } from "@loopback/rest";
import { repository } from "@loopback/repository";

export class HelloController {
  constructor(@repository(HelloRepository) protected repo: HelloRepository) {}

  // returns a list of our objects
  @get("/messages")
  async list(@param.query.number("limit") limit = 10): Promise<HelloMessage[]> {
    // throw an error when the parameter is not a non-positive integer
    if (!Number.isInteger(limit) || limit < 1) {
      throw new HttpErrors.UnprocessableEntity("limit is non-positive");
    } else if (limit > 100) {
      limit = 100;
    }
    return this.repo.find({ limit });
  }
}