スケーラブルで保守しやすいコードベースを作るためのガイド
React Nativeアプリケーションでは、保守性とスケーラビリティのためにコードベースを整理することがとても重要です。ファイルやフォルダの構成のしかたは、将来そのコードベースでどれだけ楽に作業できるかに大きく影響します。
この記事では、React Nativeアプリケーションの機能ベースのフォルダ構成と、各フォルダの役割について見ていきます。
srcフォルダ
srcフォルダは、アプリケーションのすべてのソースコードのルートディレクトリです。このフォルダの中には、それぞれ特定の役割を持ついくつかのサブフォルダがあります。
Types
typesフォルダは、アプリケーションのグローバルな型を定義する場所です。モジュールの型、インターフェースの定義、そのほかアプリケーション全体で使う独自の型が含まれます。
すべての型を一か所にまとめておくと、アプリケーションが大きくなっても型を管理し、保守しやすくなります。さらに、すべての機能で型が一貫して使われるようになり、型に関連するバグのリスクを減らし、バグが起きたときにも見つけやすくなります。
Lib
libフォルダには、アプリ全体でグローバルに使われる、アプリケーション固有のファイルを置けます。API呼び出しのためのaxiosのインスタンス、エラー処理のサービス、定数、react-queryのquery clientのセットアップなどです。
これらのファイルを一か所にまとめておくと、保守しやすくなり、アプリケーション全体で一貫性が保たれます。
Components
componentsフォルダには、再利用可能なコンポーネントをすべて置きます。これらのコンポーネントは独立していて、特定の機能やドメインに依存しないものであるべきです。ヘッダー、ボタン、リストのアイテムなどがその例です。
これらのコンポーネントを機能固有のコンポーネントと分けておくと、アプリケーション全体で管理や再利用がしやすくなり、コードの重複も減ります。
Hooks
hooksフォルダには、アプリケーション全体で使う独自のhookを置きます。hookはReactの特別な関数で、stateを持つロジックをコンポーネント間で再利用できるようにするものです。
再利用可能な、または複数の場所で使われる独自のhookをすべて一か所にまとめておくと、管理や保守がしやすくなります。また、コードの重複のリスクが減り、アプリケーションのさまざまな部分でhookを共有しやすくなります。
Localization
localizationフォルダには、アプリケーションの国際化に関するすべてのファイルを置きます。言語ファイル、文字列の定数、そのほかアプリケーションで複数の言語をサポートするために必要なリソースが含まれます。
これらのファイルを一か所にまとめておくと、管理や保守がしやすくなります。また、コードの重複のリスクが減り、アプリケーションで複数の言語をサポートしやすくなります。
Navigation
navigationフォルダには、アプリケーションのナビゲーションに関するすべてのコードを置きます。スタック、型、ルート、そのほかナビゲーションを支えるために必要なコンポーネントや関数が含まれます。
ナビゲーションのコードをすべて一か所にまとめておくと、管理や保守がしやすくなります。また、コードの重複のリスクが減り、アプリケーションのさまざまな部分でナビゲーションの機能を共有しやすくなります。
Services
servicesフォルダには、アプリケーションの基盤となるインフラに関するすべてのコードを置きます。プッシュ通知やエラー監視を扱うコード、そのほかアプリケーションの基盤となる機能を提供するために使われるサービスが含まれます。
Theme
themeフォルダには、ダーク/ライトテーマなど、アプリのスタイルを置きます。スタイルやテーマのファイルを一か所にまとめておくと、必要に応じてアプリの見た目や雰囲気を管理し、更新しやすくなります。
Utils
ユーティリティ関数は、アプリケーションの複数の部分で使えるコードを再利用する手段なので、React Nativeアプリケーションの重要な一部になりえます。アプリケーションのutilsフォルダは、アプリケーション全体で使うユーティリティ関数を置くのにぴったりの場所です。これらの関数を一か所にまとめることで、コードのほかの部分から見つけやすく、使いやすくなります。たとえば、react-nativeのレイアウトに関するユーティリティ関数です。
Features
複雑なアプリケーションを作るときは、すべてのコードを一か所にまとめる、明確で簡潔なフォルダ構成が欠かせません。featuresフォルダは、アプリケーションのさまざまな機能を別々のカテゴリに分けるので、これを実現するのに役立ちます。これによって開発者は、アプリケーションのほかの部分に影響を与えずに、特定の機能をすばやく見つけて変更できます。
さらに、アプリケーションが大きくなって機能が増えても、フォルダ構成は整理されたままなので、新しい開発者がすぐに参加して、アプリケーションの仕組みを理解しやすくなります。関心の分離が明確なので、バグのリスクも減り、アプリケーション全体のパフォーマンスも向上します。
authフォルダはたとえば次のようになります。
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のストア、Zustandのストア、あるいは好みのほかの状態管理ライブラリでもかまいません。
アプリケーションをより小さく整理された部分に分けることで、コードを管理し、必要に応じて変更するのがずっと簡単になります。また、コードがきれいで読みやすい状態に保たれ、ほかの開発者がコードを理解して作業しやすくなります。
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
authフォルダは、アプリケーションの認証機能専用のサブフォルダです。このフォルダのファイルは、ログインやサインアップのためのAPIから、ユーザーが操作するUIの画面まで、認証と認可に関するすべてを扱います。
apiフォルダには、認証機能のためのAPIが入っています。たとえばlogin.tsやsignup.tsのファイルで、ユーザーのログインとサインアップのリクエストとレスポンスを扱います。refresh-token.tsのファイルはトークンの更新を扱います。
helpersフォルダには、認証の処理で使うヘルパー関数が入っています。たとえば、validateToken.tsのファイルはトークンの検証に使い、dataTransformer.tsのファイルは認証APIとの間でやり取りするデータを変換します。
screensフォルダには、ユーザーが操作するUIコンポーネントが入っています。たとえば、Login.tsxとSignup.tsxのファイルには、それぞれユーザーがログインするためのUIコンポーネントとサインアップするためのUIコンポーネントが入っています。
hooksフォルダには、認証に関する独自のhookが入っています。たとえば、useLoginAction.tsとuseSignupForm.tsのファイルには、それぞれログインフォームとサインアップフォームに関するstateとアクションの管理を助けるhookが入っています。
servicesフォルダには、認証に関するサービスが入っています。たとえばvalidation.tsのファイルには、ユーザーの入力を検証する関数が入っています。
storeフォルダには、認証に関する状態管理が入っています。auth.tsのファイルは、Zustand、Redux、あるいはほかの状態管理ライブラリを使って、認証に関するstateとアクションを持っています。
注意
フォルダやファイルの命名規則は、プロジェクトや開発者によって異なりうることに注意してください。大切なのはフォルダの構成と整理のしかたであり、各フォルダに使う正確な名前ではありません。たとえば、アプリのルートにあるutilsフォルダはhelpersやutilitiesという名前でもかまいませんし、_screens_の代わりに_pages_など、そのプロジェクトにとって意味のある名前にしてもかまいません。目標は、開発者がコードの構成を理解しやすく、アプリケーションの保守とスケールがしやすくなる、明確で一貫した構成を持つことです。
種類ベースのフォルダ構成と機能ベースのフォルダ構成
プロジェクトのコードベースを整理するもうひとつの広く使われている方法が、種類ベースのフォルダ構成で、これにも独自の長所と短所があります。次のセクションでは、この2つのフォルダ構成を視覚的に比較してみます。
比較
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フォルダにまとまっています。関連するコードがすべて一か所にあるので、コードベースを理解しやすくなります。このアプローチによってコードのカプセル化が進み、プロジェクトはスケーラブルで、将来の変更にも柔軟に対応できるものになります。
機能ベースのフォルダ構成の最終的な姿
ダミーのファイルを入れた機能ベースのフォルダ構成は、最終的に次のようになります。
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など)は例として示したもので、100%正確なものとして受け取らないでください。これらのファイルを入れた目的は、フォルダ構成を視覚的に示し、コードベースの構成を理解しやすくすることです。実際の実装は、プロジェクトの具体的な要件によって変わります。この記事の焦点は、個々のファイルの細かい内容ではなく、機能ベースのフォルダ構成と、それがスケーラブルで整理されたコードベースを作るのにどう役立つかにあります。
まとめ
私の考えでは、機能ベースのフォルダ構成は、React/React Nativeのプロジェクトを整理するのに役立つアプローチです。コードを別々の機能に分けることで、アプリケーションの保守、理解、開発がしやすくなると感じています。この構成によってコードのカプセル化が進み、プロジェクトはスケーラブルで、将来の変更にも柔軟に対応できるものになります。もちろん、これはどんな場合にも当てはまる解決策ではなく、正確な構成はプロジェクトの規模や複雑さによって変わるかもしれません。それでも、重要な考え方は、異なる機能と、それぞれのコンポーネント、サービス、データをはっきり分けておくことです。私の経験では、この構成のおかげで、時間とともに起こる成長や変化に対応できる、よく整理されたプロジェクトを作り、保守することができました。同じように役立つと感じる人がいるかもしれないので、このアプローチを共有したいと思いました。
掲載先
この記事は次の場所でも公開しています。