SpringBootで特定のBeanの注入を除外する方法

2年 ago
海斗, 葵
1 minute

Spring Boot では、@Conditional アノテーションを使って特定の Bean の注入を除外できる。よく使われる方法としては、以下のようなものがある。

  1. 除外したいBeanを構成する独自のカスタム@Configurationクラスを作成する。
  2. 当該クラスでは@Beanアノテーションで定義し、@Conditionalアノテーションを付与し、インジェクションするかどうか条件を指定します。
  3. ConditionクラスでConditionインターフェイスを実装し、matchesメソッドをオーバーライド하여カスタム条件に基づいてBeanのインジェクションを決定します。
  4. ConditionContextを利用すると、matchesメソッド内でアプリケーションの環境変数やシステムプロパティなどの情報が得られるため、そのBeanの注入可否を決定する際に役立つ。
  5. 特定の Bean を除外する必要がある @Configuration クラスで、 @Import アノテーションを使用して、カスタマイズされた @Configuration クラスをインポートします。

例えば

@Configuration
@Import(MyCustomConfiguration.class)
public class MyAppConfiguration {
@Bean
public MyBean myBean() {
return new MyBean();
}
// 其他的bean定义...
}

@Configuration
public class MyCustomConfiguration {
@Bean
@Conditional(MyCondition.class)
public MyExcludedBean myExcludedBean() {
return new MyExcludedBean();
}
}

public class MyCondition implements Condition {
@Override
public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
// 根据自定义的条件来决定是否注入该bean
// 可以使用context对象来获取应用程序的环境变量、系统属性等信息
return false; // 返回true表示注入，返回false表示排除
}
}

上記の例で、MyExcludedBeanはMyConditionクラスのmatchesメソッドの返り値によりアプリケーションに注入するかどうかが決まります。matchesメソッドがtrueであれば注入し、falseであれば除外されます。

bannerAds