tôi muốn biết standardized project structure
- User
tôi muốn biết standardized project structure
Assistant
Chắc chắn rồi! Một cấu trúc project chuẩn mực (standardized project structure) là yếu tố cực kỳ quan trọng để dự án dễ dàng bảo trì, mở rộng và làm việc nhóm. NestJS khuyến khích mạnh mẽ việc tổ chức code theo module, dựa trên các tên miền nghiệp vụ (business domains) hoặc tính năng (features).
Dưới đây là một cấu trúc project được cộng đồng NestJS ưa chuộng và áp dụng rộng rãi.
Nguyên tắc cốt lõi: Group by Feature/Domain
Thay vì nhóm các file theo loại (ví dụ: một thư mục
controllers, một thư mụcservices), chúng ta sẽ nhóm chúng theo tính năng mà chúng phục vụ.
Cấu trúc tổng thể (Ví dụ cho một ứng dụng Blog)
/my-nest-app ├── dist/ # Thư mục chứa code đã được build (cho production) ├── node_modules/ # Thư mục chứa các package ├── src/ # << NƠI CHỨA TOÀN BỘ SOURCE CODE CỦA BẠN │ ├── app.controller.ts # Controller gốc của ứng dụng │ ├── app.module.ts # Module gốc của ứng dụng │ ├── app.service.ts # Service gốc của ứng dụng │ ├── main.ts # File khởi chạy ứng dụng (bootstrap) │ │ │ ├── auth/ # << MODULE TÍNH NĂNG "Authentication" │ │ ├── dto/ │ │ │ ├── login.dto.ts │ │ │ └── register.dto.ts │ │ ├── guards/ │ │ │ ├── jwt-auth.guard.ts │ │ │ └── roles.guard.ts │ │ ├── strategies/ │ │ │ └── jwt.strategy.ts │ │ ├── auth.controller.ts │ │ ├── auth.module.ts │ │ └── auth.service.ts │ │ │ ├── users/ # << MODULE TÍNH NĂNG "Users" │ │ ├── dto/ │ │ │ ├── create-user.dto.ts │ │ │ └── update-user.dto.ts │ │ ├── entities/ │ │ │ └── user.entity.ts # (cho TypeORM) hoặc user.schema.ts (cho Mongoose) │ │ ├── users.controller.ts │ │ ├── users.module.ts │ │ └── users.service.ts │ │ │ ├── posts/ # << MODULE TÍNH NĂNG "Posts" │ │ ├── dto/ │ │ │ ├── create-post.dto.ts │ │ │ └── update-post.dto.ts │ │ ├── entities/ │ │ │ └── post.entity.ts │ │ ├── posts.controller.ts │ │ ├── posts.module.ts │ │ └── posts.service.ts │ │ │ ├── common/ hoặc shared/ # << MODULE CHỨA CÁC THÀNH PHẦN DÙNG CHUNG │ │ ├── decorators/ │ │ │ └── get-user.decorator.ts │ │ ├── filters/ │ │ │ └── http-exception.filter.ts │ │ ├── pipes/ │ │ │ └── custom-validation.pipe.ts │ │ └── common.module.ts │ │ │ └── config/ # << THƯ MỤC CHỨA CẤU HÌNH │ ├── app.config.ts │ ├── database.config.ts │ └── jwt.config.ts │ ├── test/ # Thư mục chứa các file test end-to-end (e2e) │ ├── app.e2e-spec.ts │ └── jest-e2e.json │ ├── .eslintrc.js ├── .prettierrc ├── nest-cli.json ├── package.json ├── tsconfig.build.json └── tsconfig.json
Giải thích chi tiết các thành phần trong
src/1. Các file/thư mục gốc
main.ts: Điểm khởi đầu (entry point) của ứng dụng. Nó khởi tạo Nest application instance và lắng nghe các kết nối đến. Đây là nơi bạn áp dụng các pipe, filter, interceptor... ở phạm vi toàn cục (global).app.module.ts: Module gốc (root module) của toàn bộ ứng dụng. Nó sẽimporttất cả các module tính năng khác (nhưUsersModule,PostsModule,AuthModule) để kết nối chúng lại với nhau.app.controller.ts&app.service.ts: Thường chỉ dùng cho các endpoint cơ bản như kiểm tra health check (/hoặc/status). Trong các dự án lớn, chúng có thể được xóa đi.
2. Thư mục Module tính năng (Ví dụ:
users/)Đây là cách tổ chức code cho một đơn vị nghiệp vụ cụ thể.
users.module.ts: Định nghĩaUsersModule, khai báo controller, provider (service), và import/export các module cần thiết khác.users.controller.ts: Chịu trách nhiệm xử lý các request đến (HTTP requests) và trả về response. Nó gọi các phương thức từUsersServiceđể thực thi logic.users.service.ts: Chứa logic nghiệp vụ (business logic). Nó tương tác với database, gọi các service khác, và xử lý dữ liệu. Controller không nên chứa logic phức tạp.dto/(Data Transfer Object): Thư mục chứa các class định nghĩa cấu trúc dữ liệu cho request và response. Ví dụ:create-user.dto.tssẽ định nghĩa các trường client cần gửi lên khi tạo user mới (sử dụng các thư viện nhưclass-validator,class-transformer).entities/hoặcschemas/: Thư mục chứa các class định nghĩa cấu trúc của bảng trong database (với TypeORM) hoặc collection trong MongoDB (với Mongoose).
3. Thư mục
common/hoặcshared/- Nơi chứa các thành phần có thể tái sử dụng trên toàn bộ ứng dụng và không thuộc về một module tính năng cụ thể nào.
- Ví dụ:
filters/: Custom exception filters (ví dụ:http-exception.filter.ts).decorators/: Custom decorators (ví dụ:@GetUser()để lấy thông tin user từ request).pipes/: Custom validation pipes.interceptors/: Custom interceptors (ví dụ:logging.interceptor.ts).
- Thư mục này thường có một
common.module.tsđể export tất cả các thành phần này, sau đóAppModulesẽ importCommonModuleđể sử dụng toàn cục.
4. Thư mục
config/- Dùng để quản lý cấu hình ứng dụng một cách tập trung, sử dụng module
@nestjs/config. - Tách biệt các cấu hình như database credentials, JWT secret, port... ra khỏi source code.
- Ví dụ:
database.config.tssẽ export một function trả về đối tượng cấu hình cho database.
Lợi ích của cấu trúc này
- Dễ tìm kiếm (High Cohesion): Tất cả những gì liên quan đến tính năng "users" đều nằm trong thư mục
users/. Khi cần sửa đổi, bạn biết chính xác cần tìm ở đâu. - Dễ bảo trì và mở rộng (Scalability): Khi có một tính năng mới, bạn chỉ cần tạo một thư mục module mới mà không làm ảnh hưởng đến các module hiện có.
- Tính đóng gói (Encapsulation): Mỗi module có thể kiểm soát những gì nó public ra bên ngoài thông qua
exports. Điều này giúp giảm sự phụ thuộc lằng nhằng (low coupling) giữa các module. - Phù hợp làm việc nhóm: Các thành viên trong nhóm có thể làm việc trên các module khác nhau một cách độc lập mà ít bị xung đột.
- Dễ dàng tái sử dụng: Bạn có thể dễ dàng sao chép một module tính năng từ dự án này sang dự án khác.
Đây là một cấu trúc rất mạnh mẽ và là tiêu chuẩn "de facto" trong cộng đồng NestJS. Bắt đầu với cấu trúc này sẽ giúp dự án của bạn đi đúng hướng ngay từ đầu.
Other models, same or similar prompt
Responses were produced in different, uncontrolled contexts (system prompts, settings, prior turns). This is not a benchmark.