Tiếp tục với series, ở bài trước POST /projects vẫn tạo project với tên cố định vì chưa đọc được dữ liệu client gửi lên. Bài này mình sẽ giới thiệu với mọi người về request, param, query, body và DTO trong NestJS, để TaskFlow API nhận tên project, tìm kiếm và cập nhật project.
1. Lấy dữ liệu từ request.
NestJS (adapter Express mặc định) cho phép inject cả request object vào handler bằng @Req() (VD minh hoạ, không thêm vào project):
import { Controller, Get, Req } from '@nestjs/common';
import type { Request } from 'express';
@Controller('req')
export class ReqController {
@Get()
show(@Req() request: Request) {
return { url: request.url, query: request.query };
}
}
Cách này chạy được nhưng handler phụ thuộc vào Express và khó test. Trong đa số trường hợp các bạn nên dùng các decorator lấy đúng phần cần thiết:
@Param(key?): route param, tương ứngreq.params/req.params[key].@Query(key?): query string, tương ứngreq.query.@Body(key?): body của request, tương ứngreq.body.@Headers(name?): header, tương ứngreq.headers. Tên header không phân biệt hoa thường.@Ip(): địa chỉ IP của client (req.ip).
Truyền key thì nhận một giá trị, bỏ trống thì nhận cả object. Tất cả đều import từ @nestjs/common.
2. Param, query và header.
VD: Thử thêm handler sau vào ProjectsController (đoạn trích, nhớ import Headers và Query):
@Get('debug/:id')
debug(
@Param() params: Record<string, string>,
@Query() query: Record<string, string>,
@Headers('user-agent') userAgent: string,
) {
return { params, query, userAgent };
}
curl "http://localhost:3000/api/v1/projects/debug/5?search=api&page=2" -A 'curl/8.5.0'
# {"params":{"id":"5"},"query":{"search":"api","page":"2"},"userAgent":"curl/8.5.0"}
Để ý id và page đều là chuỗi: param và query luôn đến dưới dạng string, ghi kiểu number cũng không tự chuyển. Chuyển kiểu bằng pipe (ParseIntPipe...) mình sẽ giới thiệu ở Bài 9. Thử xong các bạn xoá handler debug() đi nhé.
Với TaskFlow API, mình dùng @Query('search') để tìm project theo tên (code đầy đủ ở phần 4):
curl "http://localhost:3000/api/v1/projects?search=api"
# [{"id":2,"name":"TaskFlow API","description":"Học NestJS","ownerId":1}]
Lưu ý: Kiểu string chỉ là "lời hứa" với TypeScript. Gửi ?search=web&search=api thì Express trả về mảng ['web', 'api'], search.toLowerCase() lỗi và client nhận 500 Internal server error. Kiểm tra dữ liệu đầu vào là nội dung của Bài 8.
3. Body và DTO.
DTO (Data Transfer Object) là object mô tả cấu trúc dữ liệu gửi qua mạng, ở đây là body client gửi lên.
Các bạn tạo DTO trong thư mục src/projects/dto:
nest g class projects/dto/create-project.dto --no-spec --flat --format
# CREATE src/projects/dto/create-project.dto.ts (33 bytes)
- src/projects/dto/create-project.dto.ts
export class CreateProjectDto {
name: string;
description?: string;
}
Project mới chỉ cần name và description (không bắt buộc), id do server sinh, ownerId tạm cố định là 1 tới khi có đăng nhập ở Bài 20. Trong controller, @Body() lấy body và gán kiểu DTO:
@Post()
@Header('Cache-Control', 'no-store')
create(@Body() createProjectDto: CreateProjectDto): Project {
return this.projectsService.create(createProjectDto);
}
curl -X POST http://localhost:3000/api/v1/projects \
-H 'Content-Type: application/json' \
-d '{"name":"Blog cá nhân","description":"Viết blog bằng NestJS"}'
# {"id":3,"name":"Blog cá nhân","description":"Viết blog bằng NestJS","ownerId":1}
NestJS đã bật sẵn body parser cho JSON và form (application/x-www-form-urlencoded), các bạn không phải cấu hình gì thêm.
Vì sao DTO là class, không phải interface?
Interface bị xoá khi biên dịch, còn class vẫn tồn tại trong JavaScript. Kiểu của tham số được ghi vào metadata design:paramtypes (Bài 2): với class CreateProjectDto metadata là [class CreateProjectDto], với interface chỉ còn [Function: Object]. ValidationPipe ở Bài 8 dựa vào class này để biết phải kiểm tra gì, và PartialType() ở phần 4 cũng chỉ nhận class.
Chú ý: DTO lúc này mới chỉ là kiểu. Body vẫn là object thường (createProjectDto instanceof CreateProjectDto là false) và không được kiểm tra: gửi {"name":123} vẫn tạo project, gửi request không có body thì lỗi 500.
4. Mapped types và UpdateProjectDto.
DTO để cập nhật có cùng các field với CreateProjectDto nhưng tất cả đều không bắt buộc. Thay vì viết lại, các bạn dùng mapped types của package @nestjs/mapped-types:
npm install @nestjs/mapped-types
nest g class projects/dto/update-project.dto --no-spec --flat --format
- src/projects/dto/update-project.dto.ts
import { PartialType } from '@nestjs/mapped-types';
import { CreateProjectDto } from './create-project.dto.js';
export class UpdateProjectDto extends PartialType(CreateProjectDto) {}
Ngoài PartialType() (mọi field thành không bắt buộc) còn có PickType(Dto, ['name'] as const) (chỉ lấy một số field), OmitType() (bỏ một số field) và IntersectionType(A, B) (gộp hai class). Các hàm này lồng được vào nhau, VD PartialType(OmitType(...)).
Service nhận DTO thay cho tên cố định và thêm method update() (đoạn trích, các method khác giữ nguyên):
- src/projects/projects.service.ts
import type { CreateProjectDto } from './dto/create-project.dto.js';
import type { UpdateProjectDto } from './dto/update-project.dto.js';
// ...
findAll(search?: string): Project[] {
if (!search) {
return this.projects;
}
const keyword = search.toLowerCase();
return this.projects.filter((project) =>
project.name.toLowerCase().includes(keyword),
);
}
create(dto: CreateProjectDto): Project {
const project: Project = {
id: this.nextId++,
name: dto.name,
description: dto.description ?? '',
ownerId: 1,
};
this.projects.push(project);
return project;
}
update(id: number, dto: UpdateProjectDto): Project | undefined {
const project = this.findOne(id);
if (project) {
Object.assign(project, dto);
}
return project;
}
Service chỉ dùng DTO làm kiểu nên import bằng import type. Controller thì import thường, vì kiểu của tham số có decorator phải là class thật để ghi vào metadata:
- src/projects/projects.controller.ts
import {
Body,
Controller,
Delete,
Get,
Header,
HttpCode,
Param,
Patch,
Post,
Query,
Redirect,
} from '@nestjs/common';
import { CreateProjectDto } from './dto/create-project.dto.js';
import { UpdateProjectDto } from './dto/update-project.dto.js';
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(@Query('search') search?: string): Project[] {
return this.projectsService.findAll(search);
}
@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(@Body() createProjectDto: CreateProjectDto): Project {
return this.projectsService.create(createProjectDto);
}
@Patch(':id')
update(
@Param('id') id: string,
@Body() updateProjectDto: UpdateProjectDto,
): Project | undefined {
return this.projectsService.update(Number(id), updateProjectDto);
}
@Delete(':id')
@HttpCode(204)
remove(@Param('id') id: string): void {
this.projectsService.remove(Number(id));
}
}
Sau khi tạo project 3 như ở phần 3, các bạn sửa riêng description:
curl -X PATCH http://localhost:3000/api/v1/projects/3 \
-H 'Content-Type: application/json' \
-d '{"description":"Blog về lập trình"}'
# {"id":3,"name":"Blog cá nhân","description":"Blog về lập trình","ownerId":1}
Nhưng vì chưa có kiểm tra, client gửi thêm field lạ cũng được ghi vào:
curl -X PATCH http://localhost:3000/api/v1/projects/3 \
-H 'Content-Type: application/json' \
-d '{"ownerId":99,"isAdmin":true}'
# {"id":3,"name":"Blog cá nhân","description":"Blog về lập trình","ownerId":99,"isAdmin":true}
Đây là lỗ hổng gán dữ liệu hàng loạt (mass assignment): client tự đổi được chủ project. Bài 8 sẽ chặn nó bằng option whitelist của ValidationPipe. Thử xong các bạn khởi động lại ứng dụng để dữ liệu trở về hai project mẫu.
5. Lời kết.
Như vậy mình đã giới thiệu với mọi người về request, param, query, body và DTO trong NestJS: các decorator @Param(), @Query(), @Body(), @Headers(), DTO bằng class và mapped types. DTO hiện mới chỉ mô tả dữ liệu chứ chưa kiểm tra gì, bài sau mình sẽ giới thiệu về validation trong NestJS để chặn dữ liệu sai ngay từ đầu.
Đă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