Đây là một cấu trúc component cho project nodejs, mỗi một component đều có một chức năng, vai trò riêng trong ứng dụng. Mỗi component đều có context riêng và quản lý các component con trong nó, không component nào vi phạm tới component nào. Tuy nhiên thì để cho một project có thể hoạt động được thì cần tất cả các component này.
Trong template phát triển BE này thì có một số thứ được cài mặc định như là
- Book Module: chứa tính năng lấy thông tin của sách cũng như là các thông tin khác của sách.
- Auth Module: chứa tính năng ủy quyền cho người dùng (trong tương lai sẽ có thêm xác thực người dùng), trong module này gồm có các controllers (
token,role,user), middlewares (authorization) và services (authorization). Cùng với nhau thì nó tạo ra một module cung cấp tính năng xác thực và ủy quyền người dùng. - Database: hỗ trợ
mysqlvàmongo(một cách trừu tượng).
Để có thể chạy thử được template này thì đầu tiên là phải cài đặt một số thứ liên quan
- Cài MySQL
- Cài MongoDB
- Cài các dependencies
npm run install
- Chạy script và import dữ liệu mẫu
Import các file dữ liệu mẫu theo từng loại cơ sở dữ liệu. Với MySQL thì vào trong thư mục
sqlcó script tên làinitialize.sql, chạy tất cả script đó với mysql shell hoặc là MySQL Workbench. Còn với MongoDB thì vào trong thưc mụcdatacó các file json, import các file đó vào trong mongo comppass là ok, và nhớ là phải đặt tên cácdatabase,tablehoặccollectiongiống trong filesettings.tshoặc là file đó chỉnh lại cho giống với tên của các objects mà các bạn đặt.
- Khởi động dự án
npm run dev
- Test
Import các enpoints trong
postman/endpoints.jsonđể tiến hành thử và kiểm tra các endpoints.
Cấu trúc của dự án này sẽ bao gồm các folder gồm file index.ts để làm file export tổng theo cấu trúc component. Các thành phần tạo nên một project nodejs dễ quản lý và bảo trì. Trong tươnng lai thì template này sẽ còn được phát triển thêm dựa vào kinh nghiệm của tác giả.
Chú thích:
databases: folder này dùng để chứa các configs của MongoDB. Với mỗi folder sẽ là một DB, trong mỗi db sẽ có foldermodels, folder này sẽ define một số operations để thao tác với cơ sỡ dữ liệu (output), cũng như là với các dữ liệu vào (input). Cái này là mình sẽ không thể biết được là template này dùng loại csdl nào (relational or non-relational), chỉ cần biết là nó expose cho mình các funcion để có thể đọc/thêm/sửa/xóa dữ liệu thôi. Lưu ý là nên sử dụng csdl theo loại (relational và non-relational) hoặc mục đích như là (cache, search). Không nên dùng nhiều Database Management trong 1 project như là PosgreSQL, MySQL, MSSQL trong cùng 1 project hay CouchDB, Mongo, Aphache trong cùng 1 projectservices: là các service từ bên ngoài, có thể kể đến như là google, cloudinary. Ngoài ra cũng có thể chứa các service nội bộ.controllers: phần này sẽ là nơi xử lý chính các yêu cầu từ client, nó sẽ dùng db, service, utils và có thể là các thành phần khác để xử lý yêu cầu đó.middlewares: là các phần mà trong đó nó sẽ tiền xử lý trước các yêu cầu từ người dùng, nói đúng hơn là xử lý trước khi vào tới controllers.modules: folder này chứa các module để thực hiện yêu cầu từ client, tổng hợp lại các controllers, setup các middlewares và sau đó là export ra các endpoints.types: chứa type trong project.utils: các hàm helpers.constants.ts: là file chứa các dữ liệu hằng trong app (cái này có thể xem xét bỏ qua).settings.ts: là file chứa các thông tin dùng để startup server.MyServer.ts: là lớp đối tượng dùng instance củaServerBuilderđể tạo ra một instance server.ServerBuilder.ts: là lớp đối tượng dùng để gòm các thuộc tính lại và build ra một instance server.index.ts: file này dùng để set-up, config server và chạy!!!
.
└── src/
├── classes/
| ├── MyServer.ts
| ├── ServerBuilder.ts
| └── Util.ts
├── databases/
│ └── mongodb/
│ ├── models/
│ │ └── book/
│ │ └── index.ts
│ ├── utils/
│ │ └── index.ts
│ ├── types.ts
│ └── index.ts
├── services/
│ └── gapis/
│ ├── types.ts
│ └── index.ts
├── controllers/
│ └── book/
│ ├── types.ts
│ └── index.ts
├── middlewares/
│ ├── auth/
│ │ └── index.ts
│ └── index.ts
├── modules/
│ └── book/
│ └── index.ts
├── utils/
│ ├── string/
│ │ └── index.ts
│ ├── number/
│ │ └── index.ts
│ └── inxex.ts
├── types/
│ └── index.ts
├── constants.ts
├── settings.ts
└── index.ts
Khác với Modules 001, thì Modules 002 sẽ dùng OOP hầu hết (hoặc hoàn toàn) để phát triển ứng dụng. Đồng thời giảm bớt các layer setup (đại loại là nó là một function nhận các tham số, sau đó là trả về kết quả. Ví dụ như các templates), để cho quá trình bảo trì dễ dàng hơn, tránh làm rối mã nguồn. Các components trong Modules 002 này nó rõ ràng hơn, đồng thời mỗi component đều có một instance đại diện cho nó.
Với mỗi component thì nó sẽ (hoặc không) là wrapper để implement một số operations, ví dụ:
Mình lưu một đối tượng trong mongo, mà mongo thì có hàm lấy nhiều dữ liệu là find hoặc là aggregate (hai thằng này phải có setup khác biệt), nhưng trong mysql thì nó phải dùng một query string để làm điều đó. Điều này lại khiến cho việc sử dụng cơ sở dữ liệu rối rắm hơn một tí nếu như trong app mình đang xử dụng nhiều cơ sở dữ liệu cùng lúc. Vậy để cho dễ phát triển hơn thì việc mình cần làm là phải chuẩn hóa nó bằng cách wrap một function ở bên ngoài, dùng các thông tin thêm để implement operation đó, từ đó thì khi tìm nhiều record trong mongo hay mysql thì sẽ chỉ còn là DB.Object.queryRecord.
Hay một ví dụ khác nữa là với service, trong ứng dụng cần lưu dữ liệu, mình có 2 phương án là lưu ở google hoặc là lưu ở aws hoặc là cả 2. Trong trường hợp lưu ở google trước như trong tương lai thì có thể thay đổi sang aws, thì sẽ rất bất tiện nếu như mình phải thay đổi tên của method lẫn tên của service và một số thuộc tính khác để có thể làm phù hợp service mới. Giống với trường hợp trên thì mình cũng phải wrap nó lại và dùng một số thuộc tính.
Từ 2 ví dụ trên thì việc implement OOP là hợp lý.
Vẫn đang trong quá trình phát triển và tìm hiểu cấu trúc này, cho nên là vẫn chưa nhận thấy nhiều điểm tiện/bất tiện.
- Có các lợi ích của M001.
- Dễ dàng thay đổi, bảo trì hơn.
- Một số hạn chề về cấu trúc code khi mà có một số component nên được tạo thành 1 object đơn thay vì là một lớp đối tượng tĩnh (Static Class).