NestJS dành cho người mới bắt đầu

npm i -g @nestjs/cli

nest new project-name

• main.ts: File để khởi tạo các đối tượng chạy ứng dụng, chẳng hạn ta có thể dùng lệnh NestFactory.create() để tạo instance cho Nest.
• app.module.ts: Là module gốc của ứng dụng, có trách nhiệm đóng gói mọi thứ có trong project.
• app.controller.ts: Chứa các router để xử lý các request và trả về response cho client.
• app.services.ts: Chứa các hàm xử lý logic cho service, chẳng hạn như ứng dụng có service kết nối đến DB hoặc xử lý file,…
• app.controller.spec.ts: File dùng để viết unit test cho các controller.

Nhìn chung thì có ba thành phần chính trong NestJS: controller, provider và module.

Trước hết, main.ts sẽ sử dụng static method create() của NestFactory để tạo server app như sau:

import { NestFactory } from '@nestjs/core'; import { AppModule } from './app.module'; async function bootstrap() {   const app = await NestFactory.create(AppModule);   await app.listen(3000); } bootstrap();

Controller

Khi có request HTTP đến, cơ chế routing sẽ chuyển request này đến controller tương ứng để xử lý và trả về phản hồi thích hợp. Để tạo một controller thì ta dùng @Controller() để liên kết class Controller với request tương ứng. Ngoài ra thì ta cũng có thể dùng lệnh $ nest g controller users trong cmd để tạo controller.

import { Controller, Get } from '@nestjs/common';  @Controller('users') export class UsersController {   @Get()   findAll(): string {     return 'This action returns all users';   } }

Như vậy chúng ta đã tạo ra một API với url GET: /users. Trong @Controller thì ta đã sử dụng tiền tố users làm route path, việc sử dụng như vậy sẽ tập hợp các route liên quan và giảm thiểu việc lặp code. Để xác định method cụ thể cho một request chúng ta sẽ định nghĩa @Get() trên hàm findAll(). Việc khai báo như vậy sẽ giúp Nest có thể ánh xạ request Get: /users đến hàm findAll() này để xử lý và response lại cho client.

Ngoài Get() thì Nest cũng cung cấp đầy đủ các phương thức như những framework khác, như @Post(), @Delete(), @Put(), @Path(),… Ta có thể cấu hình http status code và header như đoạn code dưới đây:

@Post() @HttpCode(204) @Header('Cache-Control', 'none') create() {   return 'This action adds a new cat'; }

Thêm một điểm nữa là Nest cho phép ràng buộc dữ liệu gửi lên từ request để ngăn lỗi dữ liệu không hợp lệ trước khi xử lý. Trong folder dto (Data Transfer Object) ta tạo file create-user.dto.ts như sau:

export class CreateUserDto {   name: string;   age: number;   address: string;   job: string; }

Rồi sau đó dùng CreateUserDto trong controller để ràng buộc kiểu dữ liệu. Thêm đoạn code sau vào users.controller.ts:

@Post() async create(@Body() createUserDto: CreateUserDto) {   return 'This action adds a new user'; }

Provider

Provider là thành phần cơ bản trong Nest, một provider có thể được đưa vào làm một dependency để tạo ra mối liên hệ giữa nhiều đối tượng khác nhau. Các lớp như services, repositories hay helpers có thể được xem như provider bằng cách thêm decorator @Injectable() vào.

Các provider trong NestJS có thể được đưa vào một class thông qua constructor, sau đó Nest sẽ đảm nhiệm việc xử lý các dependency, giúp cho việc quản lý những dependency này trở nên đơn giản hơn rất nhiều.

Để tạo một service chứa các logic xử lý của UserController, ta có thể tạo một UserService trong file user.service.ts dưới đây, hoặc dùng lệnh $ nest g service cats trong cmd:

import { Injectable } from '@nestjs/common'; import { User } from './interfaces/user.interface';  @Injectable() export class UsersService {   private readonly users: User[] = [];    create(user: User) {     this.users.push(cat);   }    findAll(): User[] {     return this.users;   } }

Trong service trên, ta đã dùng một interface để định nghĩa User. Bây giờ hãy tạo user.interface.ts trong folder interface như sau:

 export interface User {   name: string;   age: number;   job: string; }

Và cuối cùng là sử dụng bên trong các route của controller:

import { Controller, Get, Post, Body } from '@nestjs/common'; import { CreateUserDto } from './dto/create-user.dto'; import { UsersService } from './users.service'; import { User } from './interfaces/user.interface';  @Controller('users') export class UsersController {   constructor(private usersService: UsersService) {}    @Post()   async create(@Body() createUserDto: CreateUserDto) {     this.usersService.create(createUserDto);   }    @Get()   async findAll(): Promise<User[]> {     return this.usersService.findAll();   } }

Module

Một module được thiết kế để đóng gói các logic liên quan của những chức năng cần triển khai đến client một cách độc lập. Một module trong Nest là class được định nghĩa với decorator @Module() của Nest, dùng để mô tả các thuộc tính như controller, provider hay dependency của module này.

Một file module cơ bản sẽ có dạng như sau:

users/user.module.ts

import { Module } from '@nestjs/common'; import { UsersController } from './users.controller'; import { UsersService } from './users.service';  @Module({   controllers: [UsersController],   providers: [UsersService], }) export class UsersModule {}

Ngoài ra, Nest cũng cho phép tạo module, controller bằng CLI:

$ nest g module users

Sau khi định nghĩa xong module users, ta cần phải import vào module gốc của project (app.module.ts):

import { Module } from '@nestjs/common'; import { UsersModule } from './users/users.module';  @Module({   imports: [UsersModule], }) export class AppModule {}

Lời kết

Bài viết vừa rồi đã cung cấp những kiến thức cơ bản nhất về NestJS và các thành phần quan trọng của nó. NestJS là một framework cho phép xây dựng các ứng dụng dễ mở rộng, bảo trì và kiểm thử, giúp đơn giản hoá quá trình develop backend. Hy vọng bạn đọc đã có những hiểu biết về NestJS là gì để có thể dễ dàng làm việc với NestJS, chúc các bạn thành công!