CDI integration guide

Quarkus の CDI コンテナである ArC は、ビルド時にブートストラップされます。 コンテナと統合するには、Quarkus固有のエクステンションAPIだけでなく、 CDI ビルド五感エクステンション も使用できます。 CDI Portable Extensions はサポートされていません。 このガイドでは、Quarkus 固有のエクステンション API を中心に説明します。

コンテナーは複数のフェーズでブートストラップされます。高レベルの視点から見ると、これらのフェーズは以下のようになります。

  1. 初期化

  2. Beanディスカバリ

  3. 合成コンポーネントの登録

  4. バリデーション

初期化 フェーズでは、準備作業が実行され、カスタムコンテキストが登録されます。次に Bean ディスカバリ は、コンテナーがすべてのアプリケーションクラスを分析し、Bean を識別し、提供されたメタデータに基づいてそれらすべてを結合するプロセスです。その後、エクステンションは 合成コンポーネント を登録できます。これらのコンポーネントの属性はエクステンションによって完全に制御されます。つまり、既存のクラスから派生したものではありません。最後に、デプロイメントが検証されます。たとえば、コンテナーはアプリケーション内のすべての注入ポイントを検証し、指定された必要な型と修飾子を満たす Bean がない場合、ビルドを失敗させます。

You can see more information about the bootstrap by enabling additional logging. Simply run the Maven build with -X or --debug and grep the lines that contain io.quarkus.arc. In dev mode, you can use quarkus.log.category."io.quarkus.arc.processor".level=DEBUG and two special endpoints are also registered automatically to provide some basic debug info in the JSON format.

Quarkus のビルドステップは、さまざまなビルドアイテムを生成および消費し、各フェーズにフックできます。以下のセクションでは、すべての関連するビルドアイテムと一般的なシナリオについて説明します。

1. メタデータソース

クラスとアノテーションは、Bean レベルのメタデータの主要なソースです。 初期のメタデータは、bean discovery の間にさまざまなソースからビルドされる不変の Jandex インデックス である _Beanアーカイブインデックス から読み込まれます。 しかし、エクステンションは、ブートストラップの特定の段階でメタデータを追加、削除、変換できます。 さらに、エクステンションは synthetic components を登録することもできます。 これは、CDI コンポーネントを Quarkus に統合する際に実現すべき重要な側面です。

このようにして、エクステンションは、そうでなければ無視されていたクラスをBeanに変えたり、その逆を行ったりすることができます。例えば、 @Scheduled メソッドを宣言するクラスは、たとえそれがBean定義アノテーションでアノテーションされておらず、通常は無視されるようなクラスであっても、常にBeanとして登録されます。

2. ユースケース - クラスがBeanとして認識されません

UnsatisfiedResolutionException は、タイプセーフな解決 中に問題が発生したことを示します。クラスパス上に注入に適しているように見えるクラスがあっても、注入ポイントが満たされない場合があります。クラスが認識されない理由はいくつかあり、それを修正する方法もいくつかあります。最初のステップでは、理由 を特定する必要があります。

2.1. Reason 1: Class Is Not discovered

Quarkusには 簡易ディスカバリー があります。クラスがアプリケーションのインデックスに含まれていないことが起こるかもしれません。例えば、Quarkusエクステンションの ランタイムモジュール のクラスは自動的にインデックス化されません。

解決策 。 AdditionalBeanBuildItem .このビルド項目は、ディスカバリー中に解析する1つ以上の追加クラスを指定するために使用することができます。追加のBean・クラスは、コンテナーによって処理されるアプリケーション・インデックスに透過的に追加されます。

It is not possible to conditionally enable/disable additional beans via the @IfBuildProfile, @UnlessBuildProfile, @IfBuildProperty and @UnlessBuildProperty annotations as described in /version/main/guides/cdi-reference/ and /version/main/guides/cdi-reference/. Extensions should inspect the configuration or the current profile and only produce an AdditionalBeanBuildItem if really needed.
AdditionalBeanBuildItem Example
@BuildStep
AdditionalBeanBuildItem additionalBeans() {
     return new AdditionalBeanBuildItem(SmallRyeHealthReporter.class, HealthServlet.class); (1)
}
1 AdditionalBeanBuildItem.Builder は、より複雑なユースケースに使用することができます。

AdditionalBeanBuildItem 経由で追加された Bean クラスは、デフォルトでは 取り外し可能です 。コンテナーがそれらを 未使用 とみなした場合、それらはただ無視されます。しかし、 AdditionalBeanBuildItem.Builder.setUnremovable() メソッドを使用して、このビルド項目を介して登録されたBeanクラスを絶対に削除しないようにコンテナーに指示することができます。詳細は、 未使用のBeanの削除 と 理由3: クラスが検出され、Bean 定義のアノテーションがあるが削除された も参照してください。

AdditionalBeanBuildItem.Builder#setDefaultScope() を介してデフォルトスコープを設定することも可能です。デフォルトスコープは、Bean クラスにスコープが宣言されていない場合にのみ使用されます。

If no default scope is specified the @Dependent pseudo-scope is used.

2.2. Reason 2: Class Is Discovered but Has No Bean Defining Annotation

Quarkus では、アプリケーションは Bean 検出モード annotated でアノテーションされた単一の Bean アーカイブで表現されます。 したがって、 Bean 定義アノテーション を持たない Bean クラスは無視されます。 Bean 定義アノテーションはクラスレベルで宣言され、スコープ、ステレオタイプ、 @Interceptor が含まれます。

解決策1 : AutoAddScopeBuildItem の使用。このビルドアイテムを使用すると、特定の条件を満たすクラスにスコープを追加することができます。

AutoAddScopeBuildItem Example
@BuildStep
AutoAddScopeBuildItem autoAddScope() {
   return AutoAddScopeBuildItem.builder().containsAnnotations(SCHEDULED_NAME, SCHEDULES_NAME) (1)
      .defaultScope(BuiltinScope.SINGLETON) (2)
      .build();
}
1 @Scheduled でアノテーションされたすべてのクラスを検索
2 デフォルトのスコープとして @Singleton を追加。既にスコープでアノテーションされているクラスは自動的にスキップされます。

解決策 2: 特定のアノテーションが付けられたクラスを処理する必要がある場合は、 BeanDefiningAnnotationBuildItem を介して Bean 定義アノテーションのセットを拡張できます。

BeanDefiningAnnotationBuildItem Example
@BuildStep
BeanDefiningAnnotationBuildItem additionalBeanDefiningAnnotation() {
   return new BeanDefiningAnnotationBuildItem(Annotations.GRAPHQL_API); (1)
}
1 Bean 定義アノテーションのセットに org.eclipse.microprofile.graphql.GraphQLApi を追加します。

BeanDefiningAnnotationBuildItem を介して追加された Bean クラスは、デフォルトでは 削除不可 です。つまり、結果の Bean は未使用とみなされても削除しないでください。ただし、デフォルトの動作は変更できます。詳細は、未使用の Bean の削除 および Reason 3: Class Was Discovered and Has a Bean Defining Annotation but Was Removed も参照してください。

デフォルトスコープを設定することもできます。デフォルトスコープは、Bean クラスにスコープが宣言されていない場合にのみ使用されます。

If no default scope is specified the @Dependent pseudo-scope is used.

2.3. Reason 3: Class Was Discovered and Has a Bean Defining Annotation but Was Removed

コンテナーは、デフォルトでビルド中に すべての未使用 Bean を削除 しようとします。この最適化により、フレームワークレベルでのデッドコード削除 が可能になります。いくつかの特殊なケースでは、未使用の Bean を正しく識別することはできません。特に、Quarkus は CDI.current() 静的メソッドの使用をまだ検出できません。エクステンションは UnremovableBeanBuildItem を生成することで、誤検出の可能性を排除できます。

UnremovableBeanBuildItem Example
@BuildStep
UnremovableBeanBuildItem unremovableBeans() {
   return UnremovableBeanBuildItem.targetWithAnnotation(STARTUP_NAME); (1)
}
1 @Startup でアノテーションされたすべてのクラスを削除できないようにする。

3. ユースケース - アノテーションが修飾子またはインターセプターバインディングとして認識されない

アノテーションクラスがアプリケーションインデックスに含まれていない可能性があります。たとえば、Quarkus エクステンションの ランタイムモジュール のクラスは自動的にインデックス化されません。

解決策: Reason 1: Class Is Not discovered で説明されているとおりに AdditionalBeanBuildItem を使用します。

4. ユースケース - アノテーションのメタデータを変換する必要がある場合

場合によっては、アノテーションメタデータを変更できると便利です。 Quarkus は、 jakarta.enterprise.inject.spi.ProcessAnnotatedType および jakarta.enterprise.inject.build.compatible.spi.Enhancement の強力な代替手段を提供します。 AnnotationsTransformerBuildItem を使用すると、Bean クラスに存在するアノテーションをオーバーライドできます。

Keep in mind that annotation transformers must be produced before the bean discovery starts.

たとえば、特定の Bean クラスにインターセプターバインディングを追加する必要があることもあります。 その場合は、便利なビルダー API を使用して変換インスタンスを作成できます。

Builder Example
@BuildStep
AnnotationsTransformerBuildItem transform() {
    return new AnnotationsTransformerBuildItem(AnnotationTransformation.forClasses() (1)
        .whenClass(DotName.createSimple("org.acme.Bar")) (2)
        .transform(t -> t.add(MyInterceptorBinding.class))); (3)
}
1 トランスフォーマーはクラスにのみ適用されます。
2 クラスが org.acme.Bar の場合にのみ変換を適用します。
3 @MyInterceptorBinding アノテーションを追加します。

上記の例は、匿名クラスを使用して書き直すことができます。

AnnotationsTransformerBuildItem Example
@BuildStep
AnnotationsTransformerBuildItem transform() {
    return new AnnotationsTransformerBuildItem(new AnnotationTransformation() {
        public boolean supports(AnnotationTarget.Kind kind) {
            return kind == AnnotationTarget.Kind.CLASS; (1)
        }

        public void apply(TransformationContext context) {
            if (context.declaration().asClass().name().toString().equals("org.acme.Bar")) {
                context.add(MyInterceptorBinding.class); (2)
            }
        }
    });
}
1 トランスフォーマーはクラスにのみ適用されます。
2 クラス名が org.acme.Bar と同じ場合は、 @MyInterceptorBinding を追加します。
The previous AnnotationsTransformer API from ArC is still supported, but the new AnnotationTransformation API from Jandex is preferred.

ビルドステップでは、 TransformedAnnotationsBuildItem を介して、特定のアノテーションターゲットの変換済みアノテーションをクエリーできます。

TransformedAnnotationsBuildItem Example
@BuildStep
void queryAnnotations(TransformedAnnotationsBuildItem transformedAnnotations,
        BuildProducer<MyBuildItem> myBuildItem) {
    ClassInfo myClazz = ...;
    if (transformedAnnotations.getAnnotations(myClazz).isEmpty()) { (1)
        myBuildItem.produce(new MyBuildItem());
    }
}
1 TransformedAnnotationsBuildItem.getAnnotations() は、変換された可能性のあるアノテーションのセットを返します。

4.1. Annotation TransformerのTrace Loggingを有効にする方法

io.quarkus.arc.processor のカテゴリーに TRACE レベルを設定し、その後、ログ出力の解析を試みてください。

application.properties Example
quarkus.log.category."io.quarkus.arc.processor".min-level=TRACE (1)
quarkus.log.category."io.quarkus.arc.processor".level=TRACE
1 また、関連するカテゴリーの最小ログレベルを調整する必要があります。

5. ユースケース - Bean、オブザーバー、インジェクションポイントの検査

5.1. Solution 1: BeanDiscoveryFinishedBuildItem

BeanDiscoveryFinishedBuildItem のコンシューマーは、アプリケーションに登録されているすべてのクラスベースの Bean、オブザーバー、およびインジェクションポイントを簡単に検査できます。ただし、このビルドアイテムは合成コンポーネントが登録される 前 に作成されるため、合成 Bean とオブザーバーは 含まれません 。

さらに、 BeanDiscoveryFinishedBuildItem#getBeanResolver() から返された Bean リゾルバーを使用して、タイプセーフな解決ルールを適用できます。たとえば、必要な型と修飾子の特定の組み合わせを満たす Bean があるかどうかを確認できます。

BeanDiscoveryFinishedBuildItem Example
@BuildStep
void doSomethingWithNamedBeans(BeanDiscoveryFinishedBuildItem beanDiscovery, BuildProducer<NamedBeansBuildItem> namedBeans) {
   List<BeanInfo> namedBeans = beanDiscovery.beanStream().withName().collect(toList())); (1)
   namedBeans.produce(new NamedBeansBuildItem(namedBeans));
}
1 結果のリストに @Named 合成 Bean は含まれません。

5.2. Solution 2: SynthesisFinishedBuildItem

SynthesisFinishedBuildItem のコンシューマーは、アプリケーションに登録されているすべての Bean、オブザーバー、およびインジェクションポイントを簡単に検査できます。このビルドアイテムは合成コンポーネントが登録された 後 に作成されるため、合成 Bean とオブザーバーも 含まれます 。

さらに、 SynthesisFinishedBuildItem#getBeanResolver() から返された Bean リゾルバーを使用して、タイプセーフな解決ルールを適用できます。たとえば、必要な型と修飾子の特定の組み合わせを満たす Bean があるかどうかを確認できます。

SynthesisFinishedBuildItem Example
@BuildStep
void doSomethingWithNamedBeans(SynthesisFinishedBuildItem synthesisFinished, BuildProducer<NamedBeansBuildItem> namedBeans) {
   List<BeanInfo> namedBeans = synthesisFinished.beanStream().withName().collect(toList())); (1)
   namedBeans.produce(new NamedBeansBuildItem(namedBeans));
}
1 結果のリストには、 @Named 合成 Bean が含まれます。

6. ユースケース - 合成 Bean の必要性

場合によっては、合成 Bean を登録できると便利です。 合成 Bean の Bean 属性は、Java クラス、メソッド、またはフィールドから導出されたものではありません。 すべての属性はエクステンションによって定義されます。 通常の CDI では、 AfterBeanDiscovery.addBean() メソッドと SyntheticComponents.addBean() メソッドを使用してこれを実現できます。

解決策: 合成 Bean を登録する必要がある場合は、 SyntheticBeanBuildItem を使用します。

SyntheticBeanBuildItem Example 1
@BuildStep
SyntheticBeanBuildItem syntheticBean() {
   return SyntheticBeanBuildItem.configure(String.class)
             .qualifiers(AnnotationInstance.builder(MyQualifier.class).build())
             .creator(mc -> mc.returnValue(mc.load("foo"))) (1)
             .done();
}
1 jakarta.enterprise.context.spi.Contextual#create(CreationalContext<T>) 実装のバイトコードを生成します。

Bean Configurator の出力は、バイトコードとして記録されます。したがって、実行時に合成 Bean インスタンスを作成する方法にはいくつかの制限があります。以下が可能です。

  1. Contextual#create(CreationalContext<T>) メソッドのバイトコードを、 ExtendedBeanConfigurator.creator(Consumer<MethodCreator>) を介して直接生成します。

  2. ExtendedBeanConfigurator#creator(Class<? extends BeanCreator<U>>) で io.quarkus.arc.BeanCreator のサブクラスを渡し、場合によっては ExtendedBeanConfigurator#param() でビルド時のパラメーターを、 ExtendedBeanConfigurator#addInjectionPoint() で合成注入ポイントを指定します。

  3. @Recorder method から返されたプロキシー経由でランタイムインスタンスを生成し、それを ExtendedBeanConfigurator#runtimeValue(RuntimeValue<?>)、 ExtendedBeanConfigurator#runtimeProxy(Object)、 ExtendedBeanConfigurator#supplier(Supplier<?>) または ExtendedBeanConfigurator#createWith(Function<SyntheticCreationalContext<?>, <?>) を介して設定します。

SyntheticBeanBuildItem Example 2
@BuildStep
@Record(STATIC_INIT) (1)
SyntheticBeanBuildItem syntheticBean(TestRecorder recorder) {
   return SyntheticBeanBuildItem.configure(Foo.class).scope(Singleton.class)
                .runtimeValue(recorder.createFoo()) (2)
                .done();
}
1 デフォルトでは、合成 Bean は STATIC_INIT の間に初期化されます。
2 Bean インスタンスは、レコーダーメソッドから返される値によって提供されます。

汎用合成 Bean `Foo<Bar> ` を作成することもできます。

SyntheticBeanBuildItem Example 3
@BuildStep
@Record(STATIC_INIT)
SyntheticBeanBuildItem syntheticBean(TestRecorder recorder) {
   return SyntheticBeanBuildItem.configure(Foo.class)
                .types(ParameterizedType.create(Foo.class, ClassType.create(Bar.class)))) (1)
                .scope(Singleton.class)
                .runtimeValue(recorder.createFooBar())
                .done();
}
1 汎用型を指定するには、 types() または addType() を使用する必要があります。

RUNTIME_INIT の間に初期化される合成 Bean をマークできます。 STATIC_INIT と RUNTIME_INIT の違いの詳細については、Three Phases of Bootstrap and Quarkus Philosophy を参照してください。

RUNTIME_INIT SyntheticBeanBuildItem Example
@BuildStep
@Record(RUNTIME_INIT) (1)
SyntheticBeanBuildItem syntheticBean(TestRecorder recorder) {
   return SyntheticBeanBuildItem.configure(Foo.class).scope(Singleton.class)
                .setRuntimeInit() (2)
                .runtimeValue(recorder.createFoo())
                .done();
}
1 レコーダーは、 ExecutionTime.RUNTIME_INIT フェーズで実行する必要があります。
2 Bean インスタンスは、 RUNTIME_INIT の間に初期化されます。

RUNTIME_INIT の間に初期化された合成 Bean は、 STATIC_INIT の間にアクセスしてはいけません。runtime-init 合成 Bean にアクセスする RUNTIME_INIT ビルドステップは、 SyntheticBeansRuntimeInitBuildItem を消費します。

@BuildStep
@Record(RUNTIME_INIT)
@Consume(SyntheticBeansRuntimeInitBuildItem.class) (1)
void accessFoo(TestRecorder recorder) {
   recorder.foo(); (2)
}
1 このビルドステップは、 syntheticBean() の完了後に実行する必要があります。
2 このレコーダーメソッドでは Foo Bean インスタンスが呼び出されるため、必ずすべての合成 Bean が初期化された後にビルドステップが実行されることを確認する必要があります。
It is also possible to use the BeanRegistrationPhaseBuildItem to register a synthetic bean. However, we recommend extension authors to stick with SyntheticBeanBuildItem which is more idiomatic for Quarkus.

6.1. 合成注入ポイント

合成 Bean は、 ExtendedBeanConfigurator#addInjectionPoint() メソッドを介して合成注入ポイントを登録できます。 この注入ポイントはビルド時に検証され、detecting unused beans で検討されます。 注入された参照は、実行時に SyntheticCreationalContext#getInjectedReference() メソッドを通じてアクセスできます。

Synthetic Injection Point - Build Step Example
import org.jboss.jandex.ClassType;
import org.jboss.jandex.DotName;

@BuildStep
@Record(RUNTIME_INIT) (1)
SyntheticBeanBuildItem syntheticBean(TestRecorder recorder) {
   return SyntheticBeanBuildItem.configure(Foo.class)
                .scope(Singleton.class)
                .addInjectionPoint(ClassType.create(DotName.createSimple(Bar.class))) (2)
                .createWith(recorder.createFoo()) (3)
                .done();
}
1 Bean インスタンスは、 RUNTIME_INIT の間に初期化されます。
2 必須の Bar 型の合成注入ポイントが追加されました。これは @Inject Bar と同じです。
3 Bean インスタンスは、レコーダーメソッドから返される関数を使用して作成されます。
Synthetic Injection Point - Recorder Example
@Recorder
public class TestRecorder {

   public Function<SyntheticCreationalContext<Foo>, Foo> createFoo() {
     return (context) -> {
        return new Foo(context.getInjectedReference(Bar.class)); (1)
     };
   }
}
1 Bar のコンテキスト参照を Foo のコンストラクターに渡します。

6.2. 非アクティブな合成 Bean

ビルド時に複数の合成 Bean を登録する必要があるが、実行時にはそのうちのサブセットのみをアクティブにする場合、合成 Bean を 非アクティブ としてマークできると便利です。 これは、"check active" 手順を設定して行い、レコーダーから取得した Supplier<ActiveResult> になります。

Inactive Synthetic Bean - Build Step Example
@BuildStep
@Record(RUNTIME_INIT)
SyntheticBeanBuildItem syntheticBean(TestRecorder recorder) {
    return SyntheticBeanBuildItem.configure(Foo.class)
            .scope(Singleton.class)
            .startup() (1)
            .checkActive(recorder.isFooActive()) (2)
            .createWith(recorder.createFoo())
            .done();
}
1 通常、非アクティブである可能性のある Bean は、アプリケーションの起動時に必ずエラーが出力されるように、即時初期化が行われます。 Bean が実際には非アクティブであるが、常にアクティブな Bean に注入されていない場合は、即時初期化がスキップされ、エラーは出力されません。
2 "check active" 手順を設定します。
Inactive Synthetic Bean - Recorder Example
@Recorder
public class TestRecorder {
    public Supplier<ActiveResult> isFooActive() {
        return () -> {
            if (... should not be active ...) { (1)
                return ActiveResult.inactive("explanation"); (2)
            }
            return ActiveResult.active();
        };
    }

    public Function<SyntheticCreationalContext<Foo>, Foo> createFoo() {
        return (context) -> {
            return new Foo();
        };
    }
}
1 合成 Bean が非アクティブになる条件。
2 Bean が非アクティブである理由の適切な説明。 この Bean の非アクティブが別の Bean の非アクティブに起因する場合、別の非アクティブな ActiveResult も原因として提供されることがあります。

非アクティブな Bean がどこかに注入されるか、動的に検索されると、 InactiveBeanException が出力されます。 エラーメッセージには、理由 (ActiveResult から)、原因のチェーン (同じく ActiveResult から) が含まれ、この Bean に解決されるすべての注入ポイントのリストがさらに含まれる場合もあります。

非アクティブなケースを適切に処理する必要がある場合は、必ず Instance<> を使用して非アクティブな可能性のある Bean を注入する必要があります。 実際のインスタンスを取得する前に、以下も確認する必要があります。

import io.quarkus.arc.InjectableInstance;

@Inject
InjectableInstance<Foo> foo;

if (foo.getHandle().getBean().isActive()) {
    Foo foo = foo.get();
    ...
}

アクティブな Bean のみを使用する場合は、 InjectableInstance<> を注入し、 getActive() を呼び出して 1 つのインスタンスを取得するか、 listActive() を呼び出してすべてのインスタンスを取得します。

import io.quarkus.arc.InjectableInstance;

@Inject
@Any
InjectableInstance<Foo> foos;

for (Foo foo : foos.listActive())
    ...
}

7. ユースケース - 合成オブザーバー

synthetic beans と同様に、合成オブザーバーメソッドの属性は Java メソッドから派生しません。代わりに、すべての属性がエクステンションによって定義されます。

解決策: 合成オブザーバーを登録する必要がある場合は、 ObserverRegistrationPhaseBuildItem を使用します。

A build step that consumes the ObserverRegistrationPhaseBuildItem should always produce an ObserverConfiguratorBuildItem or at least inject a BuildProducer for this build item, otherwise it could be ignored or processed at the wrong time (e.g. after the correct CDI bootstrap phase).
ObserverRegistrationPhaseBuildItem Example
@BuildStep
void syntheticObserver(ObserverRegistrationPhaseBuildItem observerRegistrationPhase,
            BuildProducer<MyBuildItem> myBuildItem,
            BuildProducer<ObserverConfiguratorBuildItem> observerConfigurationRegistry) {
   observerConfigurationRegistry.produce(new ObserverConfiguratorBuildItem(observerRegistrationPhase.getContext()
       .configure()
       .beanClass(DotName.createSimple(MyBuildStep.class.getName()))
       .observedType(String.class)
       .notify(mc -> {
           // do some gizmo bytecode generation...
       })));
   myBuildItem.produce(new MyBuildItem());
}

ObserverConfigurator の出力はバイトコードとして記録されます。 したがって、実行時に合成オブザーバーを呼び出す方法にはいくつかの制限があります。 現時点では、メソッド本体のバイトコードを直接生成する必要があります。

8. ユースケース - 生成された Bean クラスがある

問題ありません。 Bean クラスのバイトコードを手動で生成し、その後に GeneratedClassBuildItem ではなく GeneratedBeanBuildItem を生成してください。

GeneratedBeanBuildItem Example
@BuildStep
void generatedBean(BuildProducer<GeneratedBeanBuildItem> generatedBeans) {
    ClassOutput beansClassOutput = new GeneratedBeanGizmoAdaptor(generatedBeans); (1)
    ClassCreator beanClassCreator = ClassCreator.builder().classOutput(beansClassOutput)
                .className("org.acme.MyBean")
                .build();
    beanClassCreator.addAnnotation(Singleton.class);
    beanClassCreator.close(); (2)
}
1 io.quarkus.arc.deployment.GeneratedBeanGizmoAdaptor を使用すると、Gizmo コンストラクトから GeneratedBeanBuildItem を簡単に作成できます。
2 結果の Bean クラスは、次のようになります: public class @Singleton MyBean { }。

9. ユースケース - デプロイメントを検証する必要がある

エクステンションは、Bean、オブザーバー、およびインジェクションポイントを検査し、さらに追加の検証を実行して、何か問題がある場合はビルドを失敗にする必要があります。

解決策: エクステンションがデプロイメントを検証する必要がある場合、 ValidationPhaseBuildItem を使用します。

A build step that consumes the ValidationPhaseBuildItem should always produce a ValidationErrorBuildItem or at least inject a BuildProducer for this build item, otherwise it could be ignored or processed at the wrong time (e.g. after the correct CDI bootstrap phase).
@BuildStep
void validate(ValidationPhaseBuildItem validationPhase,
            BuildProducer<MyBuildItem> myBuildItem,
            BuildProducer<ValidationErrorBuildItem> errors) {
   if (someCondition) {
     errors.produce(new ValidationErrorBuildItem(new IllegalStateException()));
     myBuildItem.produce(new MyBuildItem());
   }
}
You can easily filter all registered beans via the convenient BeanStream returned from the ValidationPhaseBuildItem.getContext().beans() method.

10. ユースケース - カスタム CDI コンテキストの登録

時々、エクステンションは組み込みCDI コンテキストのセットを拡張する必要があります。

解決策: カスタムコンテキストを登録する必要がある場合は、 ContextRegistrationPhaseBuildItem を使用します。

A build step that consumes the ContextRegistrationPhaseBuildItem should always produce a ContextConfiguratorBuildItem or at least inject a BuildProducer for this build item, otherwise it could be ignored or processed at the wrong time (e.g. after the correct CDI bootstrap phase).

ContextRegistrationPhaseBuildItem の例

@BuildStep
ContextConfiguratorBuildItem registerContext(ContextRegistrationPhaseBuildItem phase) {
      return new ContextConfiguratorBuildItem(phase.getContext().configure(TransactionScoped.class).normal().contextClass(TransactionContext.class));
}

さらに、 ContextRegistrationPhaseBuildItem を介してカスタム CDI コンテキストを登録する各エクステンションは、Bean 定義アノテーションのセットにカスタムスコープアノテーション名を提供するために、 CustomScopeBuildItem も生成する必要があります。

CustomScopeBuildItem の例

@BuildStep
CustomScopeBuildItem customScope() {
   return new CustomScopeBuildItem(DotName.createSimple(TransactionScoped.class.getName()));
}

10.1. アプリケーションで使用されているすべてのスコープを知る必要がある場合はどうなりますか?

ソリューション: ビルドステップで CustomScopeAnnotationsBuildItem を挿入し、 CustomScopeAnnotationsBuildItem.isScopeDeclaredOn() などの便利なメソッドを使用できます。

11. ユースケース - 追加のインターセプターバインディング

まれに、インターセプターバインディングとし て @jakarta.interceptor.InterceptorBinding でアノテーションが付けられていない既存のアノテーションをプログラムで登録すると便利な場合があります。これは、CDI が BeforeBeanDiscovery#addInterceptorBinding() で達成するものと似ています。これを行うには、 InterceptorBindingRegistrarBuildItem を使用します。

InterceptorBindingRegistrarBuildItem Example
@BuildStep
InterceptorBindingRegistrarBuildItem addInterceptorBindings() {
    return new InterceptorBindingRegistrarBuildItem(new InterceptorBindingRegistrar() {
        @Override
        public List<InterceptorBinding> getAdditionalBindings() {
            return List.of(InterceptorBinding.of(NotAnInterceptorBinding.class));
        }
    });
}

12. 使用例 - 追加の修飾子

場合によっては、 @jakarta.inject.Qualifier でアノテーションされていない既存のアノテーションを CDI 修飾子として登録しておくと便利です。 これは CDI が BeforeBeanDiscovery#addQualifier() を通して実現していることに似ています。 ここでは QualifierRegistrarBuildItem を使ってそれを実現しようとしています。

QualifierRegistrarBuildItem Example
@BuildStep
QualifierRegistrarBuildItem addQualifiers() {
    return new QualifierRegistrarBuildItem(new QualifierRegistrar() {
        @Override
        public Map<DotName, Set<String>> getAdditionalQualifiers() {
            return Collections.singletonMap(DotName.createSimple(NotAQualifier.class.getName()),
                                        Collections.emptySet());
        }
    });
}

13. 使用例 - 追加のステレオタイプ

場合によっては、 @jakarta.enterprise.inject.Stereotype でアノテーションされていない既存のアノテーションを CDI ステレオタイプとして登録しておきます。 これは CDI が BeforeBeanDiscovery#addQualifier() を通して実現していることに似ています。ここでは QualifierRegistrarBuildItem を使ってそれを実現しようとしています。

StereotypeRegistrarBuildItem Example
@BuildStep
StereotypeRegistrarBuildItem addStereotypes() {
    return new StereotypeRegistrarBuildItem(new StereotypeRegistrar() {
        @Override
        public Set<DotName> getAdditionalStereotypes() {
            return Collections.singleton(DotName.createSimple(NotAStereotype.class.getName()));
        }
    });
}

新しく登録されたステレオタイプアノテーションに、スコープやインターセプターのバインディングなどの適切なメタアノテーションがない場合、 アノテーション変換 を使用してそれらを追加します。

14. ユースケース - インジェクションポイントの変換

プログラムでインジェクションポイントの修飾子を変更できると便利な場合があります。それは InjectionPointTransformerBuildItem で実行できます。次のサンプルは、修飾子 MyQualifier を含むタイプ Foo のインジェクションポイントに変換を適用する方法を示しています。

InjectionPointTransformerBuildItem Example
@BuildStep
InjectionPointTransformerBuildItem transformer() {
    return new InjectionPointTransformerBuildItem(new InjectionPointsTransformer() {

        public boolean appliesTo(Type requiredType) {
            return requiredType.name().equals(DotName.createSimple(Foo.class.getName()));
        }

        public void transform(TransformationContext context) {
            if (context.getQualifiers().stream()
                    .anyMatch(a -> a.name().equals(DotName.createSimple(MyQualifier.class.getName())))) {
                context.transform()
                        .removeAll()
                        .add(DotName.createSimple(MyOtherQualifier.class.getName()))
                        .done();
            }
        }
    });
}
In theory, you can use an AnnotationsTransformer to achieve the same goal. However, there are few differences that make InjectionPointsTransformer more suitable for this particular task: (1) annotation transformers are applied to all classes during bean discovery, whereas InjectionPointsTransformer is only applied to discovered injection points after bean discovery; (2) with InjectionPointsTransformer you don’t need to handle various types of injection points (field, parameters of initializer methods, etc.).

15. ユースケース - リソースアノテーションとインジェクション

ResourceAnnotationBuildItem を使用して、Jakarta EE リソースなどの非 CDI インジェクションポイントを解決できるリソースアノテーションを指定できます。インテグレーターは、対応する io.quarkus.arc.ResourceReferenceProvider サービスプロバイダー実装も提供する必要があります。

ResourceAnnotationBuildItem Example
@BuildStep
void setupResourceInjection(BuildProducer<ResourceAnnotationBuildItem> resourceAnnotations,
        BuildProducer<GeneratedServiceProviderBuildItem> serviceProviders) {
    serviceProviders.produce(new GeneratedServiceProviderBuildItem(
        "io.quarkus.arc.ResourceReferenceProvider",
        MyResourceReferenceProvider.class.getName()));
    resourceAnnotations.produce(new ResourceAnnotationBuildItem(DotName.createSimple(MyAnnotation.class.getName())));
}

16. Use Case - Custom Bean Suppression for Programmatic Lookup

Suppressed beans cannot be obtained by programmatic lookup via jakarta.enterprise.inject.Instance and io.quarkus.arc.All. Quarkus provides built-in support for declarative suppression through the @LookupIfProperty and @LookupUnlessProperty annotations. However, sometimes you need custom logic that cannot be expressed with annotations, for example when the suppression depends on dynamic configuration property names.

The SuppressConditionGeneratorBuildItem can be used to contribute custom logic to the generated method body of InjectableBean#isSuppressed(). The generator receives a SuppressConditionGeneration context that provides the bean metadata, the generated class, and the method body of the isSuppressed() method. The generator should use the Gizmo2 API to generate code that calls BlockCreator#returnTrue() if the bean should be suppressed. It is perfectly fine not to contribute any bytecode if the bean does not meet certain requirements, e.g. does not implement a specific interface or is not annotated with a specific annotation. Multiple generators are composed together - a bean is suppressed if any generator returns true from the method body.

SuppressConditionGeneratorBuildItem Example
@BuildStep
void suppressMyBeans(BuildProducer<SuppressConditionGeneratorBuildItem> generators) {
    generators.produce(new SuppressConditionGeneratorBuildItem(generation -> {
        BeanInfo bean = generation.bean();
        if (bean.getTarget().isPresent()
                && bean.getTarget().get().asClass().hasAnnotation(DotName.createSimple(MyAnnotation.class))) { (1)
            generation.method().returnTrue(); (2)
        }
    }));
}
1 Only apply suppression to beans annotated with @MyAnnotation.
2 Use BlockCreator#returnTrue() to suppress the bean.

17. 利用可能なビルドタイムメタデータ

BuildExtension.BuildContext で動作する上記のエクステンションはいずれも、ビルドタイムに生成される特定のビルドタイムメタデータを利用することができます。 io.quarkus.arc.processor.BuildExtension.Key にある組込キーは以下の通りです。

ANNOTATION_STORE

アノテーショントランスフォーマーを適用した後は、すべての AnnotationTarget`アノテーションに関する情報を保持する `AnnotationStore が含まれます

INJECTION_POINTS

すべてのインジェクションポイントを含む Collection<InjectionPointInfo>

BEANS

すべての Bean を含む Collection<BeanInfo>

REMOVED_BEANS

Collection<BeanInfo> 削除されたすべての Bean を含む

OBSERVERS

すべてのオブザーバーを含む Collection<ObserverInfo>

SCOPES

カスタムスコープも含め、すべてのスコープを含む Collection<ScopeInfo>

QUALIFIERS

すべての修飾子を含む Map<DotName, ClassInfo>

INTERCEPTOR_BINDINGS

すべてのインターセプターバインディングを含む Map<DotName, ClassInfo>

STEREOTYPES

すべてのステレオタイプを含む Map<DotName, StereotypeInfo>

これらを取得するには、指定されたキーのエクステンションコンテキストオブジェクトをクエリするだけです。これらのメタデータはビルドの進行とともに利用可能になるため、エクステンションは、エクステンションが呼び出される前にビルドされたメタデータのみを活用できることに注意してください。エクステンションがまだ生成されていないメタデータを取得しようとすると、null が返されます。どのエクステンションがどのメタデータにアクセスできるかを次に示します。

AnnotationsTransformer

ブートストラップのどのフェーズでもいつでも使えるので、メタデータに頼るべきではありません。

ContextRegistrar

ANNOTATION_STORE , QUALIFIERS , INTERCEPTOR_BINDINGS . STEREOTYPES にアクセスできます。

InjectionPointsTransformer

ANNOTATION_STORE , QUALIFIERS , INTERCEPTOR_BINDINGS . STEREOTYPES にアクセスできます。

ObserverTransformer

ANNOTATION_STORE , QUALIFIERS , INTERCEPTOR_BINDINGS . STEREOTYPES にアクセスできます。

BeanRegistrar

ANNOTATION_STORE, QUALIFIERS, INTERCEPTOR_BINDINGS, STEREOTYPES, BEANS (クラスベースBeanのみ), OBSERVERS (クラスベースobserverのみ), INJECTION_POINTS にアクセスできます。

ObserverRegistrar

ANNOTATION_STORE , QUALIFIERS , INTERCEPTOR_BINDINGS , STEREOTYPES , BEANS , OBSERVERS (クラスベースのオブザーバーのみ), INJECTION_POINTS にアクセス可能です。

BeanDeploymentValidator

すべてのビルドメタデータにアクセスできます