Giới thiệu

Trong bài viết này, chúng ta sẽ tìm hiểu cách thiết lập một dự án Express 5 sử dụng TypeScript, từ khâu khởi tạo cho đến cấu trúc thư mục. Đây là một hướng dẫn chi tiết giúp bạn xây dựng một API mạnh mẽ và dễ bảo trì. Hãy cùng bắt đầu!

Nội dung bài viết

• Khởi tạo dự án
• Cấu trúc dự án
• Thực hành tốt nhất
• Những cạm bẫy phổ biến
• Mẹo nâng cao hiệu suất
• Giải quyết sự cố
• Kết luận

Khởi tạo dự án

Tạo thư mục dự án

Đầu tiên, mở terminal và tạo thư mục cho dự án:

mkdir my-express-api
cd my-express-api

Khởi tạo dự án npm

Tiếp theo, khởi tạo một dự án npm:

npm init -y

Cài đặt Express 5 và các phụ thuộc chính

Chúng ta sẽ cài đặt Express 5 cùng với một số thư viện cần thiết:

npm install express@^5.0.0
npm install cors helmet morgan compression dotenv
npm install bcrypt jsonwebtoken express-rate-limit
npm install express-validator

Cài đặt TypeScript và các phụ thuộc phát triển

Để sử dụng TypeScript, ta cần cài đặt TypeScript và các định nghĩa kiểu:

npm install -D typescript @types/node @types/express
npm install -D @types/cors @types/helmet @types/morgan
npm install -D @types/compression @types/bcrypt @types/jsonwebtoken
npm install -D @types/express-rate-limit

Cài đặt công cụ linting và định dạng

Để đảm bảo mã nguồn sạch và có định dạng đúng, chúng ta sẽ cài đặt ESLint và Prettier:

npm install -D eslint @typescript-eslint/parser @typescript-eslint/eslint-plugin
npm install -D prettier eslint-config-prettier eslint-plugin-prettier
npm install -D @eslint/js typescript-eslint

Cài đặt công cụ kiểm thử

Để kiểm thử ứng dụng, chúng ta cài đặt Jest:

npm install -D jest @types/jest ts-jest supertest @types/supertest

Cài đặt công cụ phát triển

Các công cụ hỗ trợ phát triển cũng rất quan trọng:

npm install -D tsx nodemon concurrently cross-env

Cài đặt tiện ích sản xuất bổ sung

Cuối cùng, cài đặt một số tiện ích để sử dụng trong môi trường sản xuất:

npm install winston express-async-errors http-status-codes
npm install -D @types/http-status-codes

Cấu trúc dự án

Sau khi cài đặt xong, cấu trúc thư mục của dự án sẽ như sau:

my-express-api/
├── src/
│   ├── controllers/         # Bộ xử lý route
│   ├── middleware/          # Middleware tùy chỉnh
│   ├── models/             # Mô hình/dữ liệu
│   ├── routes/             # Định nghĩa route
│   ├── services/           # Logic nghiệp vụ
│   ├── types/              # Định nghĩa kiểu TypeScript
│   ├── utils/              # Hàm tiện ích
│   ├── config/             # Tập tin cấu hình
│   └── app.ts              # Thiết lập ứng dụng Express
├── tests/                  # Tập tin kiểm thử
├── dist/                   # JavaScript đã biên dịch (tự động tạo)
├── docs/                   # Tài liệu API
├── .env                    # Biến môi trường
├── .env.example           # Mẫu biến môi trường
├── package.json
├── tsconfig.json
├── eslint.config.js
├── prettier.config.js
├── jest.config.js
├── docker-compose.yml
├── Dockerfile
└── README.md

Thực hành tốt nhất

• Sử dụng TypeScript: Luôn sử dụng TypeScript cho các dự án mới để tận dụng các tính năng như kiểm tra kiểu và tự hoàn thành.
• Tổ chức mã nguồn: Đảm bảo mã nguồn được tổ chức rõ ràng với các thư mục riêng biệt cho controllers, services, và models.
• Sử dụng middleware: Sử dụng middleware để xử lý các yêu cầu và phản hồi một cách hiệu quả hơn.

Những cạm bẫy phổ biến

• Không sử dụng dotenv: Đừng quên sử dụng thư viện dotenv để quản lý các biến môi trường, điều này giúp bảo mật thông tin nhạy cảm.
• Thiếu kiểm thử: Nên viết kiểm thử cho ứng dụng để đảm bảo mọi thứ hoạt động như mong đợi.

Mẹo nâng cao hiệu suất

• Sử dụng cấu hình caching: Sử dụng caching cho các API để giảm tải cho server.
• Tối ưu hóa middleware: Chỉ sử dụng các middleware cần thiết để cải thiện hiệu suất.

Giải quyết sự cố

• Kiểm tra log: Sử dụng Winston để ghi lại log giúp dễ dàng phát hiện lỗi.
• Sử dụng supertest: Dùng supertest để kiểm thử các route trong ứng dụng Express của bạn.

Kết luận

Bài viết này đã hướng dẫn bạn cách thiết lập một dự án Express 5 với TypeScript, từ khâu khởi tạo cho đến việc tổ chức mã nguồn. Hãy áp dụng những kiến thức này vào thực tế để xây dựng các ứng dụng web mạnh mẽ và hiệu quả hơn. Nếu bạn có bất kỳ câu hỏi nào, hãy để lại câu hỏi bên dưới!

Câu hỏi thường gặp (FAQ)

TypeScript có cần thiết không?

Có, TypeScript giúp phát hiện lỗi sớm và cải thiện khả năng bảo trì mã nguồn.

Làm thế nào để kiểm thử API trong Express?

Bạn có thể sử dụng Jest và supertest để viết các bài kiểm thử cho API của mình.

Có cách nào để tối ưu hóa hiệu suất ứng dụng không?

Có, bạn có thể sử dụng caching và tối ưu hóa middleware để cải thiện hiệu suất ứng dụng.