Nest.js 中如何在控制器级别应用拦截器?

推荐答案

在 Nest.js 中,可以通过在控制器类上使用 @UseInterceptors() 装饰器来应用拦截器。以下是一个示例:

-- -------------------- ---- -------
------ - ----------- ---- --------------- - ---- -----------------
------ - ------------------ - ---- ------------------------

----------------------
------------------------------------
------ ----- ----------------- -
  ------
  ---------- ------ -
    ------ ----- ------ ------- --- ----------
  -
-

在这个示例中,LoggingInterceptor 拦截器被应用到了 ExampleController 控制器的所有路由处理程序上。

本题详细解读

1. 拦截器的作用

拦截器是 Nest.js 中的一种强大的机制,允许你在请求处理的不同阶段插入自定义逻辑。拦截器可以用于以下场景:

  • 在方法执行前后添加额外的逻辑
  • 转换从方法返回的结果
  • 转换从方法抛出的异常
  • 扩展基本方法行为
  • 根据特定条件完全重写方法

2. 控制器级别应用拦截器

在控制器级别应用拦截器意味着该拦截器将应用于该控制器中的所有路由处理程序。通过在控制器类上使用 @UseInterceptors() 装饰器,你可以轻松地将拦截器应用到整个控制器。

3. 示例代码解析

  • @Controller('example'):定义了一个名为 example 的路由控制器。
  • @UseInterceptors(LoggingInterceptor):将 LoggingInterceptor 拦截器应用到 ExampleController 控制器的所有路由处理程序上。
  • @Get():定义了一个处理 GET 请求的路由处理程序。
  • findAll():路由处理程序方法,返回一个字符串。

4. 自定义拦截器

LoggingInterceptor 是一个自定义的拦截器,通常你会这样定义它:

-- -------------------- ---- -------
------ - ----------- ---------------- ----------------- ----------- - ---- -----------------
------ - ---------- - ---- -------
------ - --- - ---- -----------------

-------------
------ ----- ------------------ ---------- --------------- -
  ------------------ ----------------- ----- ------------- --------------- -
    -------------------------

    ----- --- - -----------
    ------ ----
      ---------
      ------
        ------ -- --------------------- ------------ - ----------
      --
  -
-

在这个拦截器中,intercept 方法会在请求处理前后分别打印日志,并计算请求处理的时间。

5. 总结

通过在控制器级别应用拦截器,你可以轻松地为整个控制器中的所有路由处理程序添加统一的逻辑处理。这种方式非常适合需要在多个路由处理程序之间共享相同逻辑的场景。

纠错
反馈