Re-run Spring Boot Configuration Annotation Processor to update generated metadata

Metadata update: A step-by-step guide

Spring Boot's spring-configuration-metadata.json serves as the lifeline of your app's properties. It powers auto-completion, making your IDE smarter!

Step 1: Dependencies are key

Just how a recipe is incomplete without its ingredients, our metadata update needs the right dependencies:

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-configuration-processor</artifactId>
    <optional>true</optional>
</dependency>


Note: Remember to mark the dependency as optional!

Step 2: Wake up IntelliJ

Navigate to File > Settings, search for Annotation Processors and check the box! IntelliJ can then keep an eye on metadata changes.

Step 3: Configure annotation processors

Define annotation processors for precise control over how configuration metadata is generated:

• For Lombok (those who ignore Lombok are "lacking-off" something 😉):

  <!-- For folks who love reducing boilerplate -->
  <annotationProcessorPaths>
      <path>
          <groupId>org.projectlombok</groupId>
          <artifactId>lombok</artifactId>
          <version>${lombok.version}</version>
      </path>
  </annotationProcessorPaths>
  

• For JPA, just in case your app can't get enough of databases:

  <!-- For JPA connoisseurs -->
  <dependency>
      <groupId>org.hibernate</groupId>
      <artifactId>hibernate-jpamodelgen</artifactId>
      <version>${hibernate.version}</version>
  </dependency>
  

Step 4: Locate metadata

After rebuilding, find spring-configuration-metadata.json in /target/classes/META-INF.

Step 5: Respond to prompts

Persistent requests to re-run the Annotation Processor often hint at an out-of-sync situation. Pay attention!

Unleashing the power of metadata

What makes spring-configuration-metadata.json so special? Well, the answer is as simple as ABC: Assistance, Benefits, and Control.

Benefits of timely updates

• Speed: Faster development with auto-completion and real-time error checking.
• Accuracy: Misconfiguration risks decrease as metadata validates your changes.
• Maintainability: Keep your project in sync with any changes and updates.

Troubleshooting IDE issues

If IntelliJ IDEA doesn't recognize updated metadata, try these:

• Confirm that target directory is not listed under Excluded Folders.
• Occasionally, turning off Show Spring Boot metadata panel in Editor settings can solve your troubles.
• Heed warnings or error messages in IDE event logs pertaining to annotation processors.