How to Create a Jandex Index for Classes in External Modules in Quarkus?

Jandex Index Creation in Quarkus for Classes in External Modules

When integrating classes from external modules in a Quarkus application, sometimes the classes may not be properly indexed, leading to warnings during quarkus startup. To resolve this issue, we need to create a Jandex index for the external module's classes.

Options for Jandex Index Creation

Quarkus provides several options for creating a Jandex index for external module classes.

• Jandex Maven Plugin:

  • Add the following configuration to the pom.xml of the module requiring indexing.

    <plugin>
    <groupId>io.smallrye</groupId>
    <artifactId>jandex-maven-plugin</artifactId>
    <version>3.1.2</version>
    <executions>
      <execution>
        <id>make-index</id>
        <goals>
          <goal>jandex</goal>
        </goals>
      </execution>
    </executions>
    </plugin>

• Gradle Jandex Plugin:

  • For Gradle users, a third-party plugin exists to generate a Jandex index. Refer to https://github.com/kordamp/jandex-gradle-plugin for details.

• Empty META-INF/beans.xml:

  • Adding an empty META-INF/beans.xml file to the additional module's src/main/resources enables Quarkus to index the classes automatically.

• Quarkus Application.properties Configuration:

  • For dependencies that cannot be modified (such as third-party libraries), create a Jandex index by adding an entry to application.properties.

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

    where is the identifier for the dependency.

By utilizing these options, developers can ensure that classes from external modules are indexed properly, preventing warnings and enabling seamless integration within Quarkus applications.

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