Tiếp tục với series, ở bài trước dữ liệu mẫu và logic xử lý project đang nằm luôn trong ProjectsController. Bài này mình sẽ giới thiệu với mọi người về provider và dependency injection trong NestJS, và chuyển phần đó sang ProjectsService.
1. Provider và dependency injection là gì?
Provider là những class (hoặc giá trị) mà NestJS có thể khởi tạo và inject vào class khác dưới dạng một phụ thuộc (dependency).
Service, repository, helper... đều có thể là provider. Controller chỉ nên nhận request rồi giao việc cho provider để logic dễ dùng lại và dễ test. Dependency injection (DI) nghĩa là class không tự new các phụ thuộc của nó, mà chỉ khai báo "mình cần gì". IoC container của NestJS sẽ tạo instance theo đúng thứ tự rồi truyền vào khi khởi động.
2. Tạo ProjectsService.
Các bạn tạo service bằng Nest CLI (--format chạy luôn Prettier cho file mới tạo):
nest g service projects --format
# CREATE src/projects/projects.service.spec.ts (509 bytes)
# CREATE src/projects/projects.service.ts (92 bytes)
# UPDATE src/projects/projects.module.ts (279 bytes)
CLI đã thêm ProjectsService vào mảng providers của ProjectsModule. Provider phải được khai báo trong module thì mới inject được (xem phần đóng gói ở Bài 4).
Interface Project tách ra file riêng để dùng chung:
- src/projects/interfaces/project.interface.ts
export interface Project {
id: number;
name: string;
description: string;
ownerId: number;
}
Dữ liệu mẫu và logic chuyển hết sang service:
- src/projects/projects.service.ts
import { Injectable } from '@nestjs/common';
import type { Project } from './interfaces/project.interface.js';
@Injectable()
export class ProjectsService {
// Dữ liệu mẫu trong bộ nhớ, mất khi khởi động lại ứng dụng
private readonly projects: Project[] = [
{
id: 1,
name: 'Website toidicode.com',
description: 'Viết lại giao diện',
ownerId: 1,
},
{
id: 2,
name: 'TaskFlow API',
description: 'Học NestJS',
ownerId: 1,
},
];
private nextId = 3;
findAll(): Project[] {
return this.projects;
}
findOne(id: number): Project | undefined {
return this.projects.find((project) => project.id === id);
}
findLatest(): Project | undefined {
return this.projects.at(-1);
}
create(): Project {
const id = this.nextId++;
const project: Project = {
id,
name: `Project ${id}`,
description: '',
ownerId: 1,
};
this.projects.push(project);
return project;
}
remove(id: number): void {
const index = this.projects.findIndex((project) => project.id === id);
if (index !== -1) {
this.projects.splice(index, 1);
}
}
}
@Injectable() báo cho IoC container rằng ProjectsService do nó quản lý. Controller giờ chỉ còn nhận request và gọi service:
- src/projects/projects.controller.ts
import {
Controller,
Delete,
Get,
Header,
HttpCode,
Param,
Post,
Redirect,
} from '@nestjs/common';
import type { Project } from './interfaces/project.interface.js';
import { ProjectsService } from './projects.service.js';
@Controller('projects')
export class ProjectsController {
constructor(private readonly projectsService: ProjectsService) {}
@Get()
findAll(): Project[] {
return this.projectsService.findAll();
}
@Get('latest')
@Redirect('/api/v1/projects', 302)
findLatest() {
const latest = this.projectsService.findLatest();
if (latest) {
return { url: `/api/v1/projects/${latest.id}` };
}
}
@Get(':id')
findOne(@Param('id') id: string): Project | undefined {
return this.projectsService.findOne(Number(id));
}
@Post()
@Header('Cache-Control', 'no-store')
create(): Project {
return this.projectsService.create();
}
@Delete(':id')
@HttpCode(204)
remove(@Param('id') id: string): void {
this.projectsService.remove(Number(id));
}
}
Constructor dùng parameter property (Bài 2) để nhận service. NestJS tìm phụ thuộc theo kiểu của tham số: TypeScript ghi kiểu vào metadata design:paramtypes lúc biên dịch, NestJS đọc nó và truyền instance ProjectsService vào.
Chạy npm run start, các route vẫn trả về kết quả như ở bài trước.
Chú ý: Kiểu dùng để inject phải là class. Interface, hay class import bằng import type, bị xoá khi biên dịch: tsc không báo lỗi nhưng ứng dụng dừng khi khởi động với lỗi Nest can't resolve dependencies of the ProjectsController (?). import type chỉ dùng cho thứ làm kiểu như Project.
Lưu ý: npm test giờ báo lỗi tương tự ở projects.controller.spec.ts. Các bạn import ProjectsService và thêm providers: [ProjectsService] vào Test.createTestingModule() trong file đó (testing ở Bài 34).
3. Scope của provider.
Mặc định provider là singleton: một instance tạo lúc khởi động, dùng chung cho mọi class và mọi request. Có ba scope:
Scope.DEFAULT: singleton, nên dùng trong đa số trường hợp.Scope.REQUEST: tạo instance mới cho mỗi request, xử lý xong thì bỏ đi.Scope.TRANSIENT: mỗi class inject nó nhận một instance riêng.
VD: Thử đổi ProjectsService sang request scope:
import { Injectable, Scope } from '@nestjs/common';
@Injectable({ scope: Scope.REQUEST })
export class ProjectsService {
// ...
}
curl -X POST http://localhost:3000/api/v1/projects
# {"id":3,"name":"Project 3","description":"","ownerId":1}
curl http://localhost:3000/api/v1/projects/3
# (body rỗng)
Project 3 không còn vì request thứ hai nhận một ProjectsService mới, chỉ có hai project mẫu ban đầu. Request scope còn lan lên trên: ProjectsController cũng bị tạo lại mỗi request, nên chỉ dùng khi thật sự cần. Thử xong các bạn trả ProjectsService về @Injectable() nhé.
4. Custom provider.
providers: [ProjectsService] là cách viết tắt của { provide: ProjectsService, useClass: ProjectsService }. provide là token dùng để tìm provider khi inject, phần còn lại cho biết giá trị được tạo thế nào:
useValue: dùng một giá trị có sẵn (hằng số, object mock khi test...).useClass: chọn class sẽ được khởi tạo cho token, VD đổi class theo môi trường.useFactory: giá trị là kết quả của một hàm. Hàm có thể nhận provider khác qua mảnginject.
VD1: Đổi providers của ProjectsModule thành [{ provide: ProjectsService, useValue: { findAll: () => [] } }], controller không sửa gì nhưng GET /api/v1/projects trả về []. Đây là cách thay service thật bằng mock khi test.
VD2: Giới hạn số project trả về bằng useFactory với token là Symbol. Token không phải class thì inject bằng @Inject(token):
- src/projects/projects.constants.ts
export const MAX_PROJECTS = Symbol('MAX_PROJECTS');
Trong projects.module.ts và projects.service.ts, các bạn import MAX_PROJECTS từ ./projects.constants.js (và Inject từ @nestjs/common), rồi sửa như sau (đoạn trích):
// src/projects/projects.module.ts
providers: [
ProjectsService,
{
provide: MAX_PROJECTS,
useFactory: () => Number(process.env.MAX_PROJECTS ?? 100),
},
],
// src/projects/projects.service.ts
constructor(@Inject(MAX_PROJECTS) private readonly maxProjects: number) {}
findAll(): Project[] {
return this.projects.slice(0, this.maxProjects);
}
Khởi động với biến môi trường MAX_PROJECTS=1:
MAX_PROJECTS=1 npm run start
curl http://localhost:3000/api/v1/projects
# [{"id":1,"name":"Website toidicode.com","description":"Viết lại giao diện","ownerId":1}]
Đọc thẳng process.env chỉ để ví dụ, cách chuẩn là ConfigService ở Bài 14.
5. @Optional và thay đổi ở NestJS 12.
Xoá provider MAX_PROJECTS khỏi ProjectsModule, ứng dụng dừng khi khởi động:
ERROR [ExceptionHandler] UnknownDependenciesException [Error]: Nest can't resolve dependencies of the ProjectsService (?). Please make sure that the argument Symbol(MAX_PROJECTS) at index [0] is available in the ProjectsModule module.
Với phụ thuộc không bắt buộc, các bạn gắn thêm @Optional() (import từ @nestjs/common). Thiếu provider thì NestJS truyền undefined thay vì báo lỗi, và giá trị mặc định của tham số được dùng:
constructor(
@Optional()
@Inject(MAX_PROJECTS)
private readonly maxProjects: number = 100,
) {}
NestJS 12 đổi cách đọc @Optional() khi kế thừa: class con tự viết constructor không còn thừa hưởng @Optional() của class cha. NestJS 11 lặng lẽ truyền undefined, còn NestJS 12 báo UnknownDependenciesException; cách sửa là gắn lại @Optional() trong constructor của class con. Class con không viết constructor thì vẫn giữ @Optional() của class cha (từ bản 12.1).
Lưu ý: MAX_PROJECTS chỉ để thử, các bạn xoá projects.constants.ts và trả module, service về như phần 2 nhé.
6. Lời kết.
Như vậy mình đã giới thiệu với mọi người về provider và dependency injection trong NestJS: @Injectable(), inject qua constructor, scope, custom provider và @Optional() ở NestJS 12. Bài sau mình sẽ giới thiệu về param, query, body và DTO, để POST /projects nhận tên project từ client.
Đă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!





0 Comments