# 组织 React Native 代码库

By Tarik Pinarci (https://tarikpinarci.com). Published 2023-02-09. Canonical: https://tarikpinarci.com/zh/blog/organizing-react-native-codebase

# 组织你的 React Native 代码库

## 打造可扩展、易维护代码库的指南

在 React Native 应用中，组织好代码库对可维护性和可扩展性至关重要。你如何组织文件和文件夹，会在很大程度上影响将来使用这个代码库的难易程度。

本文将介绍 React Native 应用的**_按功能划分（feature-based）_**的文件夹结构，以及每个文件夹的用途。

### src 文件夹

src 文件夹是应用全部源代码的根目录。在这个文件夹里，你会看到另外几个子文件夹，每个都有特定的用途。

### Types

types 文件夹用来定义应用的全局类型，包括模块类型、接口定义，以及整个应用中需要用到的其他自定义类型。

把所有类型集中放在一个地方，能让它们在应用不断增长时更容易管理和维护。此外，这也能确保各个功能对类型的使用保持一致，降低出现类型相关 bug 的风险，即使出现了也更容易发现。

### Lib

lib 文件夹用来存放在整个应用中全局使用的、与应用相关的文件。比如用于发起 API 请求的 axios 实例、错误处理服务、常量、react-query 中 query client 的配置等。

把这些文件集中放在一个地方，更便于维护，也能保证它们在整个应用中保持一致。

### Components

components 文件夹用来存放所有可复用的组件。这些组件应该是独立的，不属于任何特定功能或业务领域。例如 header、按钮和列表项。

把这些组件和特定功能的组件分开，能让你在整个应用中更方便地管理和复用它们，也能减少代码重复。

### Hooks

hooks 文件夹用来存放整个应用中使用的自定义 hook。hook 是 React 中一种特殊的函数，可以让你在组件之间复用有状态的逻辑。

把所有**可复用、在多处使用的**自定义 hook 集中放在一个地方，更便于管理和维护，也能降低代码重复的风险，并让不同部分之间共享 hook 更加容易。

### Localization

localization 文件夹用来存放应用国际化相关的所有文件，包括语言文件、字符串常量，以及支持多语言所需的其他资源。

把这些文件集中放在一个地方，更便于管理和维护，也能降低代码重复的风险，让应用支持多语言变得更容易。

### Navigation

navigation 文件夹用来存放应用中所有与导航相关的代码，包括各个 stack、类型、路由，以及支持导航所需的其他组件或函数。

把所有导航代码集中放在一个地方，更便于管理和维护，也能降低代码重复的风险，并让应用的不同部分更容易共享导航功能。

### Services

services 文件夹用来存放与应用底层基础设施相关的所有代码，包括推送通知、错误监控，以及为应用提供底层功能的其他服务。

### Theme

theme 文件夹用来存放应用的样式，比如深色和浅色主题。把样式和主题文件放在一起，便于在需要时管理和更新应用的外观与风格。

### Utils

工具函数在 React Native 应用中很重要，它们让你可以在应用的多个地方复用代码。utils 文件夹很适合存放整个应用中都会用到的工具函数。把这些函数集中在一个位置，可以确保它们容易被找到，也方便在代码的其他部分使用。例如：与 React Native 布局相关的工具函数。

### Features

构建复杂应用时，拥有一个清晰简洁、把相关代码都封装在一处的文件夹结构是必不可少的。features 文件夹正好能做到这一点，它把应用的不同功能分成各自独立的类别。这样开发者可以快速找到并修改某个特定功能，而不会影响应用的其他部分。

而且，随着应用不断增长、加入更多功能，文件夹结构依然井然有序，新加入的开发者也更容易上手并理解应用的工作方式。清晰的关注点分离还能降低出现 bug 的风险，并提升应用的整体性能。

下面是 auth 文件夹可能的样子：

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

features 文件夹的价值在于，它能帮助把代码库拆分成更小、更易管理的部分。每个功能都有自己专属的子文件夹，比如 api、helpers（或 utils）、hooks、screens、services 和 store。这样更容易理解每个功能如何工作，以及它们之间如何交互。

api 文件夹包含所有与认证相关的 API 代码。这样更便于管理 API 调用，让它们保持有序。

helpers 文件夹包含认证功能专属的辅助方法或工具函数。它们只在认证功能内部使用，不需要与应用的其他部分共享。

hooks 文件夹包含专门与认证相关的 hook。由于 React 高度依赖 hook，这样做能更方便地管理 hook，让它们保持有序。

screens 文件夹包含认证功能的所有页面，比如登录页、注册页和忘记密码页等。

services 文件夹包含认证功能专属的服务。例如，你可能有一个负责处理用户登录和注册的认证服务。

最后，store 文件夹包含认证功能专属的状态管理代码。它可以是 Redux store、Zustand store，或者你喜欢的任何其他状态管理库。

把应用拆分成更小、更有条理的部分之后，管理代码和按需修改都会容易得多。这也有助于保持代码整洁可读，让其他开发者更容易理解和使用这些代码。

### auth 功能文件夹的示例结构

```tsx
    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
```

auth 文件夹是专门用于应用认证功能的子文件夹。这里的文件处理与认证和授权相关的一切，从登录和注册的 API 到用户交互的 UI 页面。

api 文件夹存放认证功能的 API，比如 login.ts 和 signup.ts 文件，它们处理用户登录和注册请求的请求与响应。refresh-token.ts 文件负责刷新 token。

helpers 文件夹存放认证流程中用到的辅助函数。例如，validateToken.ts 文件用于校验 token，dataTransformer.ts 文件负责转换发往认证 API 和从认证 API 返回的数据。

screens 文件夹存放用户交互的 UI 组件。例如，Login.tsx 和 Signup.tsx 文件分别包含用户登录和注册的 UI 组件。

hooks 文件夹存放与认证相关的自定义 hook。例如，useLoginAction.ts 和 useSignupForm.ts 文件包含的 hook 分别帮助管理登录表单和注册表单相关的 state 和操作。

services 文件夹存放与认证相关的服务，比如 validation.ts 文件，其中包含校验用户输入的函数。

store 文件夹存放与认证相关的状态管理。auth.ts 文件使用 Zustand、Redux 或其他状态管理库，保存与认证相关的 state 和操作。

### 注意

> 需要注意的是，文件夹和文件的命名约定会因项目和开发者而异。重要的是文件夹的结构和组织方式，而不是每个文件夹具体叫什么。例如，应用根目录下的 utils 文件夹也可以叫 helpers、utilities；_screens_ 也可以叫 _pages_，或者任何对具体项目有意义的名字。目标是拥有清晰一致的结构，帮助开发者理解代码的组织方式，让应用更容易维护和扩展。

### 按类型划分 vs 按功能划分的文件夹结构

另一种被广泛采用的代码库组织方式是按类型划分（type-based）的文件夹结构，它有自己的优缺点。在下面的部分，我们会直观地对比这两种文件夹结构。

### 对比

```tsx
    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
```

如上所示，在按类型划分的结构中，页面与 API 调用、辅助函数是分开的，这会让代码库更难理解。注意，在按类型划分的结构中，我们可能会把 LoginScreen.tsx 和 TodoListScreen.tsx 这样毫不相关的页面放在同一个文件夹下。此外，**_由于相关代码没有集中在一处，代码也会更难维护。_** 而在按功能划分的结构中，所有与认证相关的代码，包括页面、API 调用、辅助函数和服务，都集中在一个 auth 文件夹里。由于相关代码都在一个地方，代码库也更容易理解。这种方式能更好地封装代码，让项目具备可扩展性，也能灵活应对未来的变化。

### 采用按功能划分结构后的最终样子

下面是采用按功能划分的文件夹结构、加上示例文件之后的最终样子：

```tsx
    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)
```

> 上面各个文件夹中添加的文件（比如 components 文件夹中的 button.tsx、header.tsx，hooks 文件夹中的 useHeader.ts 等）只是示例，不应被视为百分之百准确。加入这些文件的目的是直观展示文件夹结构，帮助更好地理解代码库的组织方式。实际实现可能因项目的具体需求而有所不同。本文的重点是按功能划分的文件夹结构，以及它如何帮助构建可扩展、有条理的代码库，而不是单个文件的具体细节。

---

### 总结

在我看来，按功能划分的文件夹结构是组织 React/React Native 项目的一种实用方式。把代码拆分成独立的功能后，我发现应用更容易维护、理解和开发。这种结构能更好地封装代码，让项目具备可扩展性，也能灵活应对未来的变化。当然，这并不是放之四海而皆准的方案，具体结构可能因项目的规模和复杂度而不同。但核心思想是：在不同功能及其各自的组件、服务和数据之间保持清晰的分隔。根据我的经验，这种结构帮助我构建并维护了组织良好、能够应对长期增长和变化的项目。我想把这种方法分享给可能同样觉得有用的人。

### 发布于

本文也发布在：

- [Medium](https://medium.com/gitconnected/how-to-structure-react-native-application-679e36c63efd)

