Toidicode.com

Toidicode.com

BASIC TO ADVANCE

Bài 13: Interceptor trong NestJS

Tiếp tục với series, ở bài trước chúng ta đã khoá TaskFlow API bằng guard. Bài này mình sẽ giới thiệu với mọi người về interceptor trong NestJS và dùng nó bọc mọi response thành dạng { data }.

1. Interceptor là gì?

Interceptor là class có @Injectable(), cài đặt interface NestInterceptor, "bọc" quanh route handler để chạy thêm logic trước và sau khi handler xử lý.

Nhờ vậy interceptor đo được thời gian, biến đổi kết quả hoặc exception của handler, hay trả kết quả luôn mà không gọi handler (VD cache, Bài 27). Method intercept(context, next) nhận ExecutionContext như guard, next.handle() gọi route handler (không gọi thì handler không chạy) và trả về một Observable của RxJS.

2. RxJS cơ bản đủ dùng.

RxJS (cài sẵn trong project) xử lý dữ liệu dạng luồng. Các bạn chỉ cần nắm:

  • Observable: luồng phát ra các giá trị, chỉ chạy khi có người subscribe() (trong interceptor thì NestJS tự subscribe).
  • pipe(): nối các operator xử lý từng giá trị đi qua luồng.
  • tap(): chạy một hàm với giá trị mà không đổi nó, hợp để ghi log; map(): đổi thành giá trị mới.

VD: Tạo file rxjs-demo.ts ở thư mục gốc project, chạy bằng node rxjs-demo.ts (Bài 2) rồi xoá đi.

import { map, of, tap } from 'rxjs';

// of() tạo một Observable phát ra 1, 2 rồi kết thúc
const numbers$ = of(1, 2);

numbers$
    .pipe(
        tap((value) => console.log('Nhận:', value)), // chỉ "nhìn", không đổi giá trị
        map((value) => value * 10), // đổi giá trị
    )
    .subscribe((value) => console.log('Kết quả:', value));

// Output:
// Nhận: 1
// Kết quả: 10
// Nhận: 2
// Kết quả: 20

Luồng của next.handle() chỉ phát ra một giá trị: kết quả của route handler.

3. Interceptor đo thời gian xử lý.

Các bạn tạo interceptor bằng nest g interceptor common/interceptors/logging --no-spec --flat --format rồi sửa lại để in tên handler và thời gian xử lý:

- src/common/interceptors/logging.interceptor.ts

import {
    CallHandler,
    ExecutionContext,
    Injectable,
    NestInterceptor,
} from '@nestjs/common';
import { Observable, tap } from 'rxjs';

@Injectable()
export class LoggingInterceptor implements NestInterceptor {
    intercept(
        context: ExecutionContext,
        next: CallHandler,
    ): Observable<unknown> {
        // Trước route handler
        const handler = `${context.getClass().name}.${context.getHandler().name}`;
        const start = Date.now();

        // Sau route handler: tap() chạy khi handler trả về kết quả
        return next
            .handle()
            .pipe(
                tap(() => console.log(`${handler} - ${Date.now() - start}ms`)),
            );
    }
}

Interceptor gắn được ở cấp method, controller hoặc toàn cục như guard. Các bạn thử gắn @UseInterceptors(LoggingInterceptor) ngay dưới @Controller('projects') của ProjectsController (UseInterceptors import từ @nestjs/common, LoggingInterceptor từ ../common/interceptors/logging.interceptor.js), rồi chạy ứng dụng với API_KEY như Bài 12 (biến K chứa header key):

K='X-API-Key: <key vừa tạo>'
curl http://localhost:3000/api/v1/projects -H "$K"
curl http://localhost:3000/api/v1/projects/99 -H "$K"

# Terminal chạy ứng dụng:
# ProjectsController.findAll - 3ms
# GET /api/v1/projects 200 - 22ms
# GET /api/v1/projects/99 404 - 4ms

Khác LoggerMiddleware, interceptor biết handler nào chạy và không tính thời gian của middleware, guard. /99 không có log vì handler ném exception nên tap() không chạy (cần thì dùng finalize()). Thử xong các bạn xoá file này và @UseInterceptors.

4. Chuẩn hoá response thành { data }.

Mình muốn mọi response thành công có dạng { "data": ... } (sau này thêm phân trang cạnh data). Các bạn tạo interceptor bằng nest g interceptor common/interceptors/transform --no-spec --flat --format và decorator bỏ qua route không cần bọc:

- src/common/decorators/skip-transform.decorator.ts

import { SetMetadata } from '@nestjs/common';

export const SKIP_TRANSFORM_KEY = 'skipTransform';

// Đánh dấu route không bọc response trong { data }
export const SkipTransform = () => SetMetadata(SKIP_TRANSFORM_KEY, true);

- src/common/interceptors/transform.interceptor.ts

import {
    CallHandler,
    ExecutionContext,
    Injectable,
    NestInterceptor,
} from '@nestjs/common';
import { Reflector } from '@nestjs/core';
import { map, Observable } from 'rxjs';
import { SKIP_TRANSFORM_KEY } from '../decorators/skip-transform.decorator.js';

@Injectable()
export class TransformInterceptor implements NestInterceptor {
    constructor(private readonly reflector: Reflector) {}

    intercept(
        context: ExecutionContext,
        next: CallHandler,
    ): Observable<unknown> {
        const skip = this.reflector.get<boolean>(
            SKIP_TRANSFORM_KEY,
            context.getHandler(),
        );
        if (skip) {
            return next.handle();
        }
        return next.handle().pipe(map((data) => ({ data })));
    }
}

Interceptor inject Reflector (Bài 12) nên mình đăng ký toàn cục bằng token APP_INTERCEPTOR:

- src/app.module.ts (đoạn trích)

import { APP_GUARD, APP_INTERCEPTOR } from '@nestjs/core';
import { TransformInterceptor } from './common/interceptors/transform.interceptor.js';

// ...
    providers: [
        AppService,
        { provide: APP_GUARD, useClass: ApiKeyGuard },
        { provide: APP_INTERCEPTOR, useClass: TransformInterceptor },
    ],

Chú ý: @Redirect() lấy url từ giá trị handler trả về, bị bọc thành { data: { url } } thì /projects/latest luôn chuyển về /api/v1/projects. Các bạn gắn @SkipTransform() (import từ ../common/decorators/skip-transform.decorator.js) lên findLatest(), dưới @Get('latest').

curl http://localhost:3000/api/v1/projects/1 -H "$K"
# {"data":{"id":1,"name":"Website toidicode.com","description":"Viết lại giao diện","ownerId":1}}

Lỗi (VD /projects/99) không đi qua map() nên vẫn do AllExceptionsFilter trả về như cũ. GET /api/v1 giờ trả {"data":"Xin chào TaskFlow API!"}, các bạn sửa kỳ vọng trong test/app.e2e-spec.ts thành .expect({ data: 'Xin chào TaskFlow API!' }).

5. Giới hạn thời gian xử lý với timeout.

timeout() báo lỗi TimeoutError nếu luồng không phát ra giá trị kịp, catchError() đổi lỗi đó thành RequestTimeoutException (408). Tạo file bằng nest g interceptor common/interceptors/timeout --no-spec --flat --format:

- src/common/interceptors/timeout.interceptor.ts

import {
    CallHandler,
    ExecutionContext,
    Injectable,
    NestInterceptor,
    RequestTimeoutException,
} from '@nestjs/common';
import {
    catchError,
    Observable,
    throwError,
    timeout,
    TimeoutError,
} from 'rxjs';

@Injectable()
export class TimeoutInterceptor implements NestInterceptor {
    constructor(private readonly ms: number) {}

    intercept(
        context: ExecutionContext,
        next: CallHandler,
    ): Observable<unknown> {
        return next.handle().pipe(
            timeout(this.ms),
            catchError((err: unknown) => {
                if (err instanceof TimeoutError) {
                    return throwError(() => new RequestTimeoutException());
                }
                return throwError(() => err); // lỗi khác giữ nguyên
            }),
        );
    }
}

Interceptor nhận số mili giây qua constructor nên mình tạo instance bằng new và đăng ký bằng app.useGlobalInterceptors():

- src/main.ts (đoạn trích, ngay sau app.use(requestId))

import { TimeoutInterceptor } from './common/interceptors/timeout.interceptor.js';

// ...
    app.useGlobalInterceptors(new TimeoutInterceptor(5000));

Để thử, thêm tạm vào ProjectsController một route chạy 6 giây:

@Get('slow')
async slow(): Promise<string> {
    await new Promise((resolve) => setTimeout(resolve, 6000));
    console.log('slow() chạy xong');
    return 'xong';
}
curl http://localhost:3000/api/v1/projects/slow -H "$K"
# (chờ 5 giây)
# {"statusCode":408,"errorCode":"REQUEST_TIMEOUT","message":"Request Timeout","path":"/api/v1/projects/slow","timestamp":"2026-11-15T07:06:55.969Z"}

# Terminal chạy ứng dụng:
# slow() chạy xong

Lưu ý: Handler vẫn chạy tới hết (dòng slow() chạy xong), timeout không huỷ được việc đang làm dở như query database. Thử xong các bạn xoá route slow.

6. Thứ tự xử lý một request.

Một request đi qua các thành phần theo thứ tự:

  • Middleware: app.use() trước, rồi middleware của module.
  • Guard → interceptor (phần trước handle()) → pipe, mỗi loại theo thứ tự toàn cục → controller → route.
  • Route handler (và service nó gọi).
  • Interceptor (phần sau handle()): ngược lại, route → controller → toàn cục.
  • Exception filter: chỉ khi có exception chưa bắt, route → controller → toàn cục.

Vì vậy guard từ chối thì interceptor không chạy, còn lỗi của pipe hay handler xảy ra trong handle() nên interceptor bắt được bằng catchError(). Exception chưa bắt sẽ bỏ qua các bước còn lại, đi thẳng tới filter.

7. Lời kết.

Như vậy mình đã giới thiệu với mọi người về interceptor trong NestJS: RxJS cơ bản, đo thời gian, chuẩn hoá response { data }, timeout và thứ tự xử lý request. TaskFlow API đang đọc key từ process.env và viết cứng timeout, nên bài sau mình sẽ giới thiệu về cấu hình với ConfigModule trong NestJS.

Đăng ký nhận tin.

Chúng tôi chỉ gửi tối đa 2 lần trên 1 tháng. Tuyên bố không spam mail!

Vũ Thanh Tài

About author
The best way to learn is to share
Xem tất cả bài đăng

0 Comments

Bài viết chưa có ai bình luận, hãy là người đầu tiên đi bạn!

Bình luận

Captcha