Spring Boot 依存性注入

概要

Spring Boot のコンストラクタファーストな依存性注入パターンを提供します：

• コンストラクタインジェクションによる必須コラボレータ
• ObjectProvider またはノーオップフォールバックによるオプショナルコラボレータ
• @Primary と @Qualifier によるビーン選択
• フル統合テスト前の最小限のコンテキストテストによる検証

使用タイミング

以下の場合にこのスキルを使用してください：

• 新しい @Service、@Component、@Repository、または @Configuration クラスを作成するとき
• レガシー Spring コードのフィールドインジェクションを置き換えるとき
• 同じ型の複数ビーンをクォリファイアプライマリビーンで解決するとき
• null 駆動ワイヤリングなしでオプショナル機能、アダプタ、またはインテグレーションを処理するとき
• 循環依存性または脆弱なコンテキスト起動失敗を確認するとき
• コンストラクタベースのユニットテストに向けてコードを準備するとき

実装手順

1. 必須と選択的なコラボレータを分離する

各クラスについて以下を特定します：

• 正しい動作に必要な必須コラボレータ
• インテグレーション、キャッシング、通知、またはフィーチャーフラグされた動作を有効にするオプショナルコラボレータ

必須コラボレータはコンストラクタに属します。オプショナルなものは ObjectProvider、条件付きビーン、またはノーオップ実装などの明示的な戦略が必要です。

2. デフォルトはコンストラクタインジェクション

アプリケーションサービスとアダプタについて：

• 必須依存関係をコンストラクタを通じてインジェクトする
• インジェクトされたフィールドは final に保つ
• ユニットテストで Spring を起動せずにクラスを直接インスタンス化する

通常、単一コンストラクタで十分です。その場合、@Autowired は不要です。

3. オプショナル動作を意図的に解決する

よい選択肢は以下を含みます：

• ObjectProvider<T> はレイジーアクセスが有用な場合
• @ConditionalOnProperty または @ConditionalOnMissingBean はワイヤリングが設定で変わるべき場合
• ノーオップ実装は呼び出し元が機能が有効かどうか気にすべきでない場合

ランタイム動作を曖昧にしておく nullable コラボレータは避けてください。

4. ビーン選択アノテーションは必要な場合のみ使用する

複数ビーンが同じ型を共有する場合：

• デフォルト実装には @Primary を使用
• 名前付きバリアントには @Qualifier を使用
• クォリファイア名は安定し、grep で容易に検索可能に保つ

選択ルールが複雑になった場合、サービス全体に分散させる代わりに、専用の設定クラスに移動してください。

5. ワイヤリングはビジネスコードではなく設定に保つ

以下の場合に @Configuration と @Bean メソッドを使用します：

• オブジェクトがサードパーティライブラリから来る場合
• 条件付き作成ロジックが必要な場合
• 環境固有のワイヤリングまたは明示的な構成が必要な場合

ビジネスサービスは、インフラストラクチャコラボレータがどのようにインスタンス化されるかを知るべきではありません。

6. ワイヤリングを明示的に検証する

新しいサービスまたは設定を記述した後：

1. 最小限のコンテキストテストでビーンがロードされることを確認：

   @SpringBootTest
   @ContextConfiguration(classes = UserService.class)
   class UserServiceWiringTest {
       @Autowired UserService userService;
       @Test void serviceIsInstantiated() { assertNotNull(userService); }
   }
   

2. サービス動作のコンストラクタベースユニットテストを実行 (Spring は不要)。
3. MVC、JPA、またはメッセージング統合を検証する必要があるときのみスライステストを追加。
4. @SpringBootTest はコンテナ全体のワイヤリング検証用に予約。

ステップ 1 での失敗はビジネスロジックが追加される前にワイヤリング問題を示します。

例

例 1：コンストラクタファーストのアプリケーションサービス

@Service
public class UserService {

    private final UserRepository userRepository;
    private final EmailSender emailSender;

    public UserService(UserRepository userRepository, EmailSender emailSender) {
        this.userRepository = userRepository;
        this.emailSender = emailSender;
    }

    public User register(UserRegistrationRequest request) {
        User user = userRepository.save(User.from(request));
        emailSender.sendWelcome(user);
        return user;
    }
}

このクラスはユニットテストでモックを使用して直接インスタンス化するのが簡単です。

例 2：ノーオップフォールバック付きのオプショナル依存関係

@Service
public class ReportService {

    private final ReportRepository reportRepository;
    private final NotificationGateway notificationGateway;

    public ReportService(
        ReportRepository reportRepository,
        ObjectProvider<NotificationGateway> notificationGatewayProvider
    ) {
        this.reportRepository = reportRepository;
        this.notificationGateway = notificationGatewayProvider.getIfAvailable(NotificationGateway::noOp);
    }
}

これはクラスの残りの部分に null 処理を漏らさずにオプショナル動作を明示的に保ちます。

例 3：明確な選択で複数ビーン

@Configuration
public class PaymentConfiguration {

    @Bean
    @Primary
    PaymentGateway stripeGateway() {
        return new StripePaymentGateway();
    }

    @Bean
    @Qualifier("fallbackGateway")
    PaymentGateway mockGateway() {
        return new MockPaymentGateway();
    }
}

デフォルトパスには @Primary を使用し、特定のバリアントが必要な場合のみ @Qualifier を使用してください。

ベストプラクティス

• 必須依存関係にはコンストラクタインジェクションを推奨します。
• サービスコンストラクタは小さく保ちます。クラスが多くのコラボレータを必要とする場合、設計は別の抽象化を求めています。
• nullable なオプショナル依存関係の代わりにノーオップまたは条件付きビーンを使用してください。
• フレームワーク固有の作成ロジックは設定クラスに保ちます。
• まず Spring なしでサービスをテストし、その後、値を追加する場所にのみコンテナテストを追加してください。
• リファクタ中にフィールドインジェクションを削除する代わりに拡張します。

制約と警告

• フィールドインジェクションは依存関係を隠し、テストを書きにくくします。
• 循環依存性は通常、設計上の問題であり、@Lazy で解決するワイヤリングトリックではありません。
• クォリファイアを過度に使用するとコードベースが推論しにくくなります。より良い抽象化またはより明確な設定を推奨します。
• オプショナルコラボレータも不在時に決定論的な動作が必要です。
• フルコンテキストテストは、早期に使用した場合、ワイヤリング失敗の実際の原因を隠す可能性があります。

参考資料

• references/reference.md
• references/examples.md
• references/spring-official-dependency-injection.md

関連スキル

• spring-boot-crud-patterns
• spring-boot-rest-api-standards
• unit-test-service-layer