@flexent/http-router (英语)

HTTP 服务器基于装饰器的路由.

要点

• * 声明路线和参数定义
• 方便链式成分
• 基于 Schema 参数验证

使用量

定义路由处理器,用路由和参数装饰器来装饰同源函数.

export class UsersRouter {

    @dep() private userStorage!: UserStorage;

    @Get({ path: '/users' })
    async getUsers(
        @QueryParam('limit', { schema: { type: 'number', default: 10 } }) limit: number,
        @QueryParam('offset', { schema: { type: 'number', default: 0 } }) offset: number,
    ) {
        const users = await this.userStorage.listUsers(limit, offset);
        return {
            users,
        };
    }

    @Post({ path: '/users' })
    async createUser(
        @BodyParam('name', { schema: { type: 'string' } }) name: string,
        @BodyParam('email', { schema: { type: 'string', regex: /^[^\s@]+@[^\s@]+\.[^\s@]+$/ } }) email: string,
        @BodyParam('password', { schema: { type: 'string', minLength: 8 } }) password: string,
    ) {
        const user = await this.userStorage.createUser(name, email, password);
        return { user };
    }

}

连接网路。 大多数应用会使用单独的范围隔离请求范围状态.

约束 RouterHandler:它会解决在相同范围内所定义的所有路线.

export class HttpScope extends Mesh {

    constructor(parent: Mesh) {
        super('Http', parent);
        this.service(HttpRouteHandler);
        this.service(UsersRouter);
    }

}

在HttpServer中,即时将范围并授权请求处理给路由器汉德勒.

export class MainHttpServer extends HttpServer {

    @dep() private mesh!: Mesh;

    async handle(ctx: HttpContext, next: HttpNext) {
        const scope = new HttpScope(this.mesh);
        await scope.resolve(HttpRouteHandler).handle(ctx, next);
    }

}

HttpRouteHandler可以成为链条的一部分,在这种情况下,创建一个专门的处理器是有用的:

export class AppHandler extends HttpChain {

    @dep() private authHandler!: AuthHandler;
    @dep() private errorHandler!: ErrorHandler;
    @dep() private routeHandler!: HttpRouteHandler;

    handlers = [
        this.errorHandler,
        this.authHandler,
        this.routeHandler,
    ];
}

或者,每个路由器都可以从 HttpRouter。 。 。 .

export FooRouter extends HttpRouter {

    @Get({ path: '/foo' })
    async getFoo() {
        return {
            foo: 123,
        };
    }

}

这样路由器可以像往常一样被编成链子,对路由处理器的调用顺序有更微粒的控制.

export class AppHandler extends HttpChain {

    @dep() private authHandler!: AuthHandler;
    @dep() private errorHandler!: ErrorHandler;
    @dep() private fooRouter!: FooRouter;

    handlers = [
        this.errorHandler,
        this.authHandler,
        this.fooRouter,
    ];
}

注: HttpRouteHandler 通常效率更高,因为它可以跳过不符合请求的即时路由器(见下文).

规则

• 路线有两种:

  1. 终点 定义为 @Get, (中文(简体) ), @Post, (中文(简体) ), @Put, (中文(简体) ), @Delete, (中文(简体) ), @Patch 作装饰.
  2. 中间软件 定义为 @Middleware 装饰师.

• 每项请求a 单人 端点匹配 .

• 如果端点匹配 :

  • 同类的中件被执行,顺序是定义.
  • next() 无法调用, 因此链条中的其他处理器会被跳过 .

• 如果没有匹配的终点 :

  • 中间器件即使匹配,也不会被执行.
  • next() 以允许其他处理器执行.
  • 作为额外的优化,如果 RouteHandler ,它只会将路由器类与匹配的端点进行即时处理.