Blog

Tổ chức codebase React Native

9 tháng 2, 2023 7 phút đọc

Những cách làm tốt để tổ chức và cấu trúc các ứng dụng React Native lớn. Tìm hiểu về cấu trúc thư mục, cách tổ chức component và các pattern giúp code dễ bảo trì.

Tổ chức codebase React Native
React NativeKiến trúcTổ chức codeBest Practices

Tổ chức codebase React Native của bạn

Hướng dẫn xây dựng một codebase dễ mở rộng và dễ bảo trì

Trong một ứng dụng React Native, cách tổ chức codebase rất quan trọng cho khả năng bảo trì và mở rộng. Cách bạn sắp xếp file và thư mục có thể ảnh hưởng lớn đến việc làm việc với codebase dễ hay khó trong tương lai.

Bài viết này sẽ tìm hiểu cấu trúc thư mục theo feature cho một ứng dụng React Native và mục đích của từng thư mục.

Thư mục src

Thư mục src là thư mục gốc chứa toàn bộ source code của ứng dụng. Bên trong thư mục này, bạn sẽ thấy nhiều thư mục con, mỗi thư mục có một mục đích riêng.

Types

Thư mục types là nơi bạn định nghĩa các type dùng chung cho toàn ứng dụng. Bao gồm type cho module, định nghĩa interface và mọi type tùy chỉnh khác mà bạn cần dùng trong toàn bộ ứng dụng.

Có một nơi tập trung cho tất cả type giúp việc quản lý và bảo trì chúng dễ hơn khi ứng dụng lớn dần. Ngoài ra, nó đảm bảo các type được dùng nhất quán giữa các feature, giảm nguy cơ bug liên quan đến type và giúp phát hiện chúng dễ hơn khi chúng xảy ra.

Lib

Thư mục lib là nơi bạn có thể đặt các file riêng của ứng dụng nhưng được dùng chung trong toàn app. Có thể là axios instance để gọi API, các service xử lý lỗi, hằng số, phần thiết lập query client trong react-query, v.v.

Đặt các file này ở một nơi tập trung giúp việc bảo trì dễ hơn và đảm bảo chúng nhất quán trong toàn bộ ứng dụng.

Components

Thư mục components là nơi bạn đặt tất cả component có thể tái sử dụng. Các component này nên độc lập và không gắn với feature hay domain cụ thể nào. Ví dụ về loại component này là header, button và list item.

Tách các component này khỏi những component riêng của từng feature giúp bạn quản lý và tái sử dụng chúng trong toàn ứng dụng dễ hơn, đồng thời giảm lượng code bị lặp lại.

Hooks

Thư mục hooks là nơi bạn đặt các custom hook được dùng trong toàn ứng dụng. Hook là một loại hàm đặc biệt trong React, cho phép bạn tái sử dụng logic có state giữa các component.

Đặt tất cả custom hook **có thể tái sử dụng/được dùng ở nhiều nơi **ở một nơi tập trung giúp việc quản lý và bảo trì dễ hơn, đồng thời giảm nguy cơ lặp code và giúp chia sẻ hook giữa các phần khác nhau của ứng dụng dễ hơn.

Localization

Thư mục localization là nơi bạn đặt tất cả file liên quan đến quốc tế hóa (internationalization) trong ứng dụng. Bao gồm file ngôn ngữ, hằng số chuỗi và mọi tài nguyên khác cần thiết để hỗ trợ nhiều ngôn ngữ trong ứng dụng.

Khi các file này nằm ở một nơi tập trung, việc quản lý và bảo trì chúng dễ hơn, đồng thời giảm nguy cơ lặp code và giúp hỗ trợ nhiều ngôn ngữ trong ứng dụng dễ hơn.

Navigation

Thư mục navigation là nơi bạn đặt toàn bộ code liên quan đến navigation trong ứng dụng. Bao gồm các stack, type, route và mọi component hay hàm khác cần cho navigation.

Khi toàn bộ code navigation nằm ở một nơi tập trung, việc quản lý và bảo trì dễ hơn, đồng thời giảm nguy cơ lặp code và giúp chia sẻ chức năng navigation giữa các phần khác nhau của ứng dụng dễ hơn.

Services

Thư mục services là nơi bạn đặt toàn bộ code liên quan đến hạ tầng bên dưới của ứng dụng. Bao gồm code làm việc với push notification, theo dõi lỗi (error monitoring) và mọi service khác cung cấp chức năng nền tảng cho ứng dụng.

Theme

Thư mục theme là nơi bạn nên đặt phần styling của app, ví dụ theme tối/sáng. Giữ các file styling và theme ở một chỗ giúp bạn quản lý và cập nhật giao diện của app dễ hơn khi cần.

Utils

Các hàm tiện ích (utility function) có thể là một phần quan trọng của ứng dụng React Native, vì chúng cho phép tái sử dụng code ở nhiều phần của ứng dụng. Thư mục utils là nơi rất phù hợp để đặt các hàm tiện ích được dùng trong toàn ứng dụng. Khi tập trung các hàm này ở một chỗ, bạn đảm bảo chúng dễ tìm và dễ dùng ở những phần khác của code. Ví dụ: các hàm tiện ích liên quan đến layout trong react-native.

Features

Khi xây dựng ứng dụng phức tạp, việc có một cấu trúc thư mục rõ ràng, gọn gàng, gom toàn bộ code vào một chỗ là rất cần thiết. Thư mục features giúp làm được điều đó vì nó tách các feature khác nhau của ứng dụng thành những nhóm riêng biệt. Nhờ vậy lập trình viên có thể nhanh chóng tìm và sửa một feature cụ thể mà không ảnh hưởng đến các phần khác của ứng dụng.

Hơn nữa, khi ứng dụng lớn dần và có thêm nhiều feature, cấu trúc thư mục vẫn gọn gàng, giúp lập trình viên mới dễ bắt nhịp và hiểu ứng dụng hoạt động thế nào. Việc tách biệt rõ trách nhiệm (separation of concerns) cũng giúp giảm nguy cơ bug và cải thiện hiệu năng tổng thể của ứng dụng.

Đây là một ví dụ thư mục auth có thể trông như thế nào:

    src/
    ├── ...
    └── features/
        ├── auth/
        |   ├── api/
        |   ├── helpers/
        |   ├── hooks/
        |   ├── screens/
        |   ├── services/
        |   └── store/
        └── ... (other features)

Tầm quan trọng của thư mục features nằm ở chỗ nó giúp chia codebase thành những phần nhỏ hơn, dễ quản lý hơn. Mỗi feature có các thư mục con riêng như api, helpers (hoặc utils), hooks, screens, services và store, dành riêng cho feature đó. Điều này giúp hiểu dễ hơn từng feature hoạt động thế nào và chúng tương tác với nhau ra sao.

Thư mục api chứa toàn bộ code liên quan đến API dành riêng cho xác thực. Nhờ vậy việc quản lý các lời gọi API và giữ chúng ngăn nắp dễ hơn.

Thư mục helpers chứa các hàm hỗ trợ hoặc hàm tiện ích dành riêng cho feature xác thực. Chúng có thể chỉ được dùng bên trong feature xác thực và không cần chia sẻ với các phần khác của ứng dụng.

Thư mục hooks chứa các hook liên quan riêng đến xác thực. Vì React phụ thuộc nhiều vào hook, điều này giúp quản lý các hook và giữ chúng ngăn nắp dễ hơn.

Thư mục screens chứa tất cả màn hình của feature xác thực. Bao gồm màn hình đăng nhập, màn hình đăng ký, màn hình quên mật khẩu và các màn hình khác.

Thư mục services chứa các service dành riêng cho feature xác thực. Ví dụ, bạn có thể có một service xác thực chịu trách nhiệm xử lý việc đăng nhập và đăng ký của người dùng.

Cuối cùng, thư mục store chứa code quản lý state dành riêng cho feature xác thực. Có thể là một Redux store, một Zustand store hoặc bất kỳ thư viện quản lý state nào bạn thích.

Khi chia ứng dụng thành những phần nhỏ hơn, có tổ chức, việc quản lý code và thay đổi khi cần trở nên dễ hơn nhiều. Nó cũng giúp code sạch và dễ đọc, để các lập trình viên khác dễ hiểu và làm việc với code hơn.

Cấu trúc mẫu của thư mục feature auth

    src/
    └── features/
        └── auth/
            ├── api/
            |   ├── login.ts
            |   ├── signup.ts
            |   └── refresh-token.ts
            ├── helpers/
            |   ├── validateToken.ts
            |   └── dataTransformer.ts
            ├── screens/
            |   ├── Login.tsx
            |   └── Signup.tsx
            ├── services/
            |   └── validation.ts
            └── store/
                └── auth.ts

Thư mục auth là thư mục con dành cho feature xác thực của ứng dụng. Các file trong thư mục này xử lý mọi thứ liên quan đến xác thực và phân quyền, từ các API đăng nhập và đăng ký cho đến các màn hình UI để người dùng tương tác.

Thư mục api chứa các API cho feature xác thực, như file login.ts và signup.ts, xử lý request và response cho yêu cầu đăng nhập và đăng ký của người dùng. File refresh-token.ts xử lý việc làm mới token.

Thư mục helpers chứa các hàm hỗ trợ được dùng trong quá trình xác thực. Ví dụ, file validateToken.ts dùng để kiểm tra token, còn file dataTransformer.ts chuyển đổi dữ liệu gửi đến và nhận về từ các API xác thực.

Thư mục screens chứa các component UI mà người dùng tương tác. Ví dụ, file Login.tsx và Signup.tsx chứa các component UI để người dùng đăng nhập và đăng ký.

Thư mục hooks chứa các custom hook liên quan đến xác thực. Ví dụ, file useLoginAction.ts và useSignupForm.ts chứa các hook giúp quản lý state và action của form đăng nhập và form đăng ký.

Thư mục services chứa các service liên quan đến xác thực, như file validation.ts chứa các hàm kiểm tra dữ liệu người dùng nhập vào.

Thư mục store chứa phần quản lý state liên quan đến xác thực. File auth.ts chứa state và action liên quan đến xác thực, dùng một thư viện quản lý state như Zustand, Redux hoặc thư viện khác.

LƯU Ý

Cần lưu ý rằng quy ước đặt tên thư mục và file có thể khác nhau giữa các dự án và giữa các lập trình viên. Điều quan trọng là cấu trúc và cách tổ chức thư mục, chứ không phải tên chính xác của từng thư mục. Ví dụ, thư mục utils ở gốc app cũng có thể được đặt tên là helpers, utilities, hoặc thay vì screens cũng có thể đặt là pages hay một tên khác hợp lý với dự án cụ thể. Mục tiêu là có một cấu trúc rõ ràng, nhất quán, giúp lập trình viên hiểu cách code được tổ chức và giúp việc bảo trì, mở rộng ứng dụng dễ hơn.

Cấu trúc thư mục theo type và cấu trúc thư mục theo feature

Một cách tổ chức codebase khác cũng được dùng rộng rãi là cấu trúc thư mục theo type, với những ưu và nhược điểm riêng. Trong phần tiếp theo, chúng ta sẽ so sánh trực quan hai cấu trúc thư mục này.

So sánh

    Feature-based folder structure:

    src/
    └── features/
        ├── auth/
        |   ├── api/
        |   │     ├── register.tsx
        |   │     ├── login.tsx
        |   │     ├── types.tsx
        |   │     └── helpers.tsx
        |   ├── helpers/
        |   ├── hooks/
        |   └── screens/
        |   │     ├── LoginScreen.tsx
        |   │     ├── SignupScreen.tsx
        |   │     ├── WelcomeScreen.tsx
        |   │     └── HomeScreen.tsx
        |   ├── services/
        |   └── store/
        ├── todo/
        |   └── screens/
        |   │    └── TodoListScreen.tsx
        |   ├── services/
        |   └── store/
        └── ... (other features)

    Type-based folder structure:

    src/
    ├── screens/
    |   ├── LoginScreen.tsx
    |   ├── SignupScreen.tsx
    |   ├── TodoListScreen.tsx
    |   ├── WelcomeScreen.tsx
    |   └── HomeScreen.tsx
    ├── api/
    |   └── auth/
    |       ├── register.ts
    |       ├── login.ts
    |       ├── types.ts
    |       └── helpers.ts

Như bạn thấy ở trên, trong cấu trúc thư mục theo type, các màn hình bị tách khỏi lời gọi API và helper, điều này có thể khiến codebase khó hiểu hơn. Hãy để ý cách chúng ta có thể đặt những màn hình không liên quan như LoginScreen.tsx và TodoListScreen.tsx vào cùng một thư mục trong cấu trúc theo type. Ngoài ra, nó cũng có thể khiến việc bảo trì code khó hơn vì code liên quan không được gom lại một chỗ. Trong khi đó, với cấu trúc thư mục theo feature, toàn bộ code liên quan đến xác thực, gồm màn hình, lời gọi API, helper và service, được gom lại trong một thư mục auth. Điều này giúp codebase dễ hiểu hơn, vì toàn bộ code liên quan nằm ở một chỗ. Cách làm này cho phép đóng gói code tốt hơn và giúp dự án dễ mở rộng, linh hoạt cho những thay đổi trong tương lai.

Bức tranh cuối cùng với cấu trúc thư mục theo feature

Dưới đây là kết quả cuối cùng với cấu trúc thư mục theo feature, kèm các file mẫu:

    Feature-based folder structure:

    src/
    ├── components/
    │   ├── Button.tsx
    │   └── Header.tsx
    ├── hooks/
    │   └── useHeader.ts
    ├── localization/
    │   ├── languages.ts
    │   └── locales.ts
    ├── lib/
    │   ├── axios-instance.ts
    │   └── constants.ts
    ├── navigation/
    │   ├── root-navigator.tsx
    │   └── auth-stack.tsx
    ├── services/
    │   ├── notification.ts
    │   └── logging.ts
    ├── theme/
    │   └── index.ts
    ├── types/
    │   ├── env.d.ts
    │   └── react-augment.d.ts
    ├── utils/
    │   └── layout.ts
    └── features/
        ├── auth/
        │   ├── api/
        │   │   ├── login.ts
        │   │   ├── signup.ts
        │   │   └── refresh-token.ts
        │   ├── helpers/
        │   │   ├── validateToken.ts
        │   │   └── dataTransformer.ts
        │   ├── hooks/
        │   │   ├── useLoginAction.ts
        │   │   └── useSignupForm.ts
        │   ├── screens/
        │   │   ├── Login.tsx
        │   │   └── Signup.tsx
        │   ├── services/
        │   │   └── validation.ts
        │   └── store/
        │       └── auth.ts (zustand, redux, jotai etc.)
        └── ... (other features)

Các file được thêm vào các thư mục ở trên (ví dụ button.tsx, header.tsx trong thư mục components, useHeader.ts trong thư mục hooks, v.v.) chỉ nhằm làm ví dụ và không nên xem là chính xác 100%. Mục đích của các file này là minh họa trực quan cấu trúc thư mục và giúp hiểu rõ hơn cách tổ chức codebase. Cách triển khai thực tế có thể khác tùy theo yêu cầu cụ thể của dự án. Trọng tâm của bài viết này là cấu trúc thư mục theo feature và cách nó giúp xây dựng một codebase có tổ chức, dễ mở rộng, chứ không phải chi tiết của từng file.


Kết luận

Theo tôi, cấu trúc thư mục theo feature là một cách tiếp cận hữu ích để tổ chức dự án React/React Native. Khi chia code thành các feature riêng biệt, tôi thấy việc bảo trì, hiểu và phát triển ứng dụng dễ hơn. Cấu trúc này cho phép đóng gói code tốt hơn, giúp dự án dễ mở rộng và linh hoạt cho những thay đổi trong tương lai. Tất nhiên, đây không phải giải pháp phù hợp cho mọi trường hợp, và cấu trúc cụ thể có thể khác tùy theo quy mô và độ phức tạp của dự án. Tuy nhiên, ý chính là giữ sự tách biệt rõ ràng giữa các feature khác nhau cùng component, service và dữ liệu của từng feature. Theo kinh nghiệm của tôi, cấu trúc này đã giúp tôi xây dựng và bảo trì những dự án có tổ chức tốt, đủ sức đáp ứng sự phát triển và thay đổi theo thời gian. Tôi muốn chia sẻ cách tiếp cận này với những ai cũng có thể thấy nó hữu ích.

Đã đăng trên

Bài viết này cũng được đăng trên: