中间件

中间件在请求到达控制器之前以管道方式处理请求。它们处理诸如身份验证、日志记录、验证和请求转换等横切关注点。

概述

YasuiJS 支持两种类型的中间件：

• 基于类的中间件使用 @Middleware() 装饰器
• Express RequestHandler 函数用于与现有 Express 中间件兼容

中间件可以在三个级别应用，具有不同的执行优先级：

1. 应用程序级别 - 应用于所有请求
2. 控制器级别 - 应用于控制器中的所有路由
3. 端点级别 - 应用于特定路由

import { Middleware } from 'yasui';

@Middleware()
export class LoggingMiddleware {
  use() {
    console.log('Request received');
  }
}

基于类的中间件

中间件装饰器

@Middleware() 装饰器将类标记为中间件。该类必须实现 use() 方法。您可以选择实现 YasuiJS 提供的 IMiddleware 接口来强制执行方法签名。

import { Middleware, IMiddleware, Request, Response, Req, Res } from 'yasui';

@Middleware()
export class AuthMiddleware implements IMiddleware {
  use(
    @Req() req: Request,
    @Res() res: Response
  ) {
    const token = req.headers.authorization;
    
    if (!token) {
      return res.status(401).json({ error: 'Unauthorized' });
    }
    // 在此处验证令牌逻辑

    // 如果返回 nothing/void 将继续执行下一个中间件或控制器逻辑
  }
}

中间件中的参数装饰器

中间件可以使用与控制器相同的参数装饰器，并且也能受益于自动错误捕获：

@Middleware()
export class ValidationMiddleware {
  use(
    @Body() body: any,
    @Query('validate') shouldValidate: boolean,
    @Header('content-type') contentType: string
  ) {
    if (shouldValidate && !this.isValid(body)) {
      throw new HttpError(400, 'Invalid request data');
    }
  }

  private isValid(data: any): boolean {
    // 验证逻辑
    return true;
  }
}

自动类型转换： 中间件中的所有参数装饰器都享有与控制器相同的自动类型转换。参数在中间件执行前被转换为其指定类型。

依赖注入

由于中间件类的行为类似于控制器，它们也以相同的方式允许依赖注入：

@Middleware()
export class LoggingMiddleware {
  constructor (
    private validationService: ValidationService, // 标准注入
    @Inject('CONFIG') private config: AppConfig, // 预注册的自定义注入
  ) {}

  use(
    @Body() body: any,
    @Inject() anotherService: AnotherService, // 方法级别相同
  ) {
    if (!this.validationService.isValid(body)) {
      throw new HttpError(400, 'Invalid request data');
    }
  }
}

Express RequestHandler 中间件

您可以直接使用标准的 Express 中间件函数：

import cors from 'cors';
import helmet from 'helmet';

yasui.createServer({
  middlewares: [
    cors(),
    helmet(),
  ]
});

中间件使用级别

应用程序级别

应用于整个应用程序的所有请求：

yasui.createServer({
  controllers: [UserController],
  middlewares: [LoggingMiddleware, SecurityMiddleware]
});

控制器级别

应用于特定控制器中的所有路由：

// 单个中间件
@Controller('/api/users', AuthMiddleware)
export class UserController {
  // 所有路由都需要身份验证
}

// 多个中间件
@Controller('/api/admin', AuthMiddleware, ValidationMiddleware)
export class AdminController {
  // 所有路由都有身份验证和验证
}

端点级别

仅应用于特定路由：

@Controller('/api/users')
export class UserController {
  @Get('/')
  getUsers() {
    // 无中间件
  }
  
  @Post('/', ValidationMiddleware)
  createUser() {
    // 仅验证中间件
  }
  
  @Delete('/:id', AuthMiddleware, ValidationMiddleware)
  deleteUser() {
    // 同时使用身份验证和验证中间件
  }
}

执行顺序

中间件按以下顺序执行：

1. 应用程序中间件（按注册顺序）
2. 控制器中间件（按声明顺序）
3. 端点中间件（按声明顺序）
4. 控制器方法

// 执行顺序示例：
yasui.createServer({
  middlewares: [GlobalMiddleware] // 1. 首先
});

@Controller('/users', ControllerMiddleware) // 2. 其次
export class UserController {
  @Post('/', EndpointMiddleware) // 3. 第三
  createUser() {
    // 4. 最后是控制器方法
  }
}