Android開発のベストプラクティス

Kotlinの一般的なガイドライン

基本原則

• すべてのコードとドキュメントに英語を使用する
• 変数と関数の型は常に明示的に宣言する
• any型を避ける。必要なカスタム型を作成する
• 関数本体内の空行を削除する

命名規則

• PascalCase: クラス、インターフェース、列挙型
• camelCase: 変数、関数、メソッド
• underscores_case: ファイルとディレクトリ
• UPPERCASE: 環境変数、定数
• マジックナンバーを避ける。代わりに定数を定義する
• 関数は動作を表す動詞で始める
• ブール変数はisLoading、hasError、canDeleteといったプレフィックスを使用する

関数設計

• 関数は20命令以下で、単一責任を持たせる
• 動詞ベースの命名を使用する
• ブール戻り値にはis、has、canというプレフィックスを付ける
• void戻り値にはexecute、save、sendというプレフィックスを付ける
• 早期リターン、ユーティリティ抽出、高階関数によってネストを減らす
• nullチェックの代わりにデフォルトパラメータを使用する
• パラメータをオブジェクトに統合する(RO-ROパターン)

データとクラス

• データ構造にはデータクラスを使用する
• プリミティブをコンポジット型でカプセル化し、内部で検証する
• イミュータビリティを優先する。変わらない値にはvalを使用する
• SOLIDの原則に従う。継承よりコンポジションを優先する
• クラスは200命令以下、10個以下の公開メソッド、10個以下のプロパティに保つ

例外処理

• 例外は予期しないエラーのためだけに予約する
• 例外をキャッチするのは予想される問題を修正または文脈を追加する場合のみ
• ドメインエラーにはカスタム例外型を作成する

Androidアーキテクチャ

クリーンアーキテクチャ

• レイヤー分離を明確にしたクリーンアーキテクチャを実装する
• データの永続化とキャッシングにはリポジトリパターンを使用する
• ビジネスロジックをUseCasesまたはInteractorsに保つ
• UI、ドメイン、データレイヤー間の関心事を分離する

プロジェクト構成

app/
├── data/           # Data sources, repositories, models
├── domain/         # Use cases, domain models, interfaces
├── presentation/   # UI components, ViewModels, state
└── di/             # Dependency injection modules

MVIパターン

• 状態とイベント管理にMVIパターンを導入する
• ViewModelはUI状態を単一の不変状態オブジェクトとして管理する
• UIコンポーネントは状態を観察してレンダリングする
• ユーザーのインテント/イベントを単一のエントリーポイントで処理する
• 副作用は予測可能で追跡可能に保つ

UI開発

ナビゲーション

• フラグメントとアクティビティのルーティングにNavigation Componentを使用する
• アプリフローのナビゲーショングラフを定義する
• Navigation Componentを通じてディープリンクを処理する
• タイプセーフなナビゲーション引数にはsafe argsを実装する

MainActivityの構成

• MainActivityはプライマリナビゲーションを管理する
• メインの宛先(Home、Profile、Settings等)にはBottomNavigationViewを使用する
• 設定変更を通じてナビゲーション状態を適切に処理する

View バインディングと状態

• タイプセーフなビューアクセスにはViewBindingを使用する
• UI状態管理にはFlowまたはLiveDataを使用する
• ライフサイクル認識の方法で状態変更を観察する
• ローディング、エラー、成功状態を一貫して処理する

UIフレームワークの推奨

• Jetpack Composeが特に必要な場合を除き、XMLレイアウトとFragmentsを優先する
• 複雑なレイアウトにはConstraintLayoutを使用する
• Material 3デザインガイドラインを適用する
• 異なる画面サイズに対応したレスポンシブデザインプラクティスに従う

認証フロー

認証スクリーンを適切に構成する:

1. スプラッシュスクリーン - アプリ初回起動
2. ログインスクリーン - ユーザー認証
3. 登録スクリーン - 新規ユーザー登録
4. パスワード忘却スクリーン - パスワード回復
5. メール確認スクリーン - メール検証

テスト

ユニットテスト

• Arrange-Act-Assert規則に従う
• ViewModel、UseCase、Repositoryをテストする
• 依存性にはテストダブルを使用する
• ビジネスロジックの優れたカバレッジを達成する

UIテスト

• UIコンポーネント向けにウィジェットテストを実装する
• APIモジュール向けに統合テストを記述する
• ナビゲーションフローをテストする
• インストルメンテーションテストにはEspressoを使用する

ベストプラクティス

ライフサイクル管理

• ライフサイクルイベントを適切に処理する
• 不適切なライフサイクル処理からのメモリリークを回避する
• ライフサイクル認識コンポーネントを使用する

バックグラウンド処理

• 非同期操作にはCoroutinesを使用する
• キャンセルを適切に処理する
• 遅延可能なバックグラウンド作業にはWorkManagerを使用する

依存性注入

• 依存性注入にHiltまたはDaggerを使用する
• 依存性を適切にスコープする
• DI設定を整理された状態に保つ

パフォーマンス

• メインスレッド上での作業を避ける
• RecyclerViewをDiffUtilで最適化する
• 重いリソースにはレイジーローディングを使用する
• メモリ使用量をプロファイリングして最適化する