How to Index Classes in External Modules for Quarkus?

Quarkus Jandex Indexing for External Module Classes

This inquiry addresses the challenge of indexing classes in an external module for Quarkus. Specifically, the user encounters a warning message indicating that certain classes are not included in the Jandex index, leading to reflection issues. Our goal is to explore methodologies for adding this indexing dependency to Quarkus.

Quarkus automatically indexes the primary module, but for additional modules containing beans, entities, or JSON serializations, explicit indexing is required. Various options are available:

Jandex Maven Plugin

For modules you wish to index, add the following to the pom.xml:

  <plugin>
    <groupid>io.smallrye</groupid>
    <artifactid>jandex-maven-plugin</artifactid>
    <executions>
      <execution>
        <id>make-index</id>
        <goals>
          <goal>jandex</goal>
        </goals>
      </execution>
    </executions>
  </plugin>

This method is ideal for external dependencies where you want a one-time index build.

Jandex Gradle Plugin

In Gradle environments, there is a third-party plugin for generating Jandex indexes: https://github.com/kordamp/jandex-gradle-plugin.

Empty META-INF/beans.xml

Adding an empty META-INF/beans.xml file to the additional module's src/main/resources will trigger indexing.

Indexing Other Dependencies

For dependencies you cannot modify, add entries to application.properties:

quarkus.index-dependency.<name>.group-id=<group-id>
quarkus.index-dependency.<name>.artifact-id=<artifact-id>
quarkus.index-dependency.<name>.classifier=<classifier> (optional)</classifier></name></artifact-id></name></group-id></name>

Here, is a unique identifier for the dependency.

The above is the detailed content of How to Index Classes in External Modules for Quarkus?. For more information, please follow other related articles on the PHP Chinese website!