Spring Boot 4 Complete Guide · Lesson

Runtime Hints for Reflection and Resources

Runtime Hints for Reflection and Resources is a free Spring Boot 4 Complete Guide lesson on CoddyKit — lesson 2 of 4. You can read the complete lesson below for free — then practise it hands-on in the browser with a built-in code editor and a 24/7 AI tutor. It is part of the Spring Boot 4 Complete Guide learning path, one of 4 lessons in the course, and your progress syncs across the web and the CoddyKit app.

Why Native Images Break Reflection

GraalVM native compilation uses closed-world analysis: at build time it must see every class, method, and field that could ever be reached. Code paths it cannot statically prove are reachable are removed from the final binary.

Reflection (Class.forName, getDeclaredMethod) hides the target from static analysis.
Dynamic proxies generated at runtime have no class to scan at build time.
Resources loaded via getResourceAsStream are not bundled unless declared.

The fix is to feed the analyzer explicit metadata called runtime hints, so it keeps these elements in the image.

What Spring Boot Contributes Automatically

Spring Boot 4 and the AOT (ahead-of-time) engine already register hints for most framework internals: @Component beans, @ConfigurationProperties classes, Jackson-bound DTOs reached through controllers, and auto-configuration classes.

You only write your own hints when you do something the AOT engine cannot trace, such as:

Reflectively instantiating a class you load by name from config.
Serializing a type that no controller or repository references.
Reading a non-classpath-scanned resource file at runtime.
Creating a JDK dynamic proxy for an interface you build yourself.

The RuntimeHintsRegistrar Interface

The primary programmatic entry point is RuntimeHintsRegistrar. You implement a single method, registerHints, which receives a RuntimeHints object exposing sub-registries for reflection, resources, proxies, serialization, and resource bundles.

The ClassLoader parameter lets you conditionally register only when a type is actually present on the classpath.

package com.example.demo.hints;

import org.springframework.aot.hint.RuntimeHints;
import org.springframework.aot.hint.RuntimeHintsRegistrar;

public class MyRuntimeHints implements RuntimeHintsRegistrar {

    @Override
    public void registerHints(RuntimeHints hints, ClassLoader classLoader) {
        // reflection, resources and proxies are registered here
    }
}

Registering Reflection Hints

Use hints.reflection().registerType(...) and pass the member categories you need. Categories are coarse-grained switches that tell GraalVM which members to keep reflectively accessible.

INVOKE_DECLARED_CONSTRUCTORS — keep constructors callable.
INVOKE_DECLARED_METHODS — keep methods invokable.
DECLARED_FIELDS — keep fields readable/writable.

Grant only what you actually use; over-broad hints bloat the image.

import org.springframework.aot.hint.MemberCategory;
import org.springframework.aot.hint.RuntimeHints;
import org.springframework.aot.hint.RuntimeHintsRegistrar;

public class ReflectionHints implements RuntimeHintsRegistrar {

    @Override
    public void registerHints(RuntimeHints hints, ClassLoader classLoader) {
        hints.reflection().registerType(
            com.example.demo.PaymentProcessor.class,
            MemberCategory.INVOKE_DECLARED_CONSTRUCTORS,
            MemberCategory.INVOKE_DECLARED_METHODS);
    }
}

Activating Hints with @ImportRuntimeHints

A registrar does nothing until Spring is told to run it. Annotate any configuration or component class with @ImportRuntimeHints, referencing your registrar. The AOT engine then invokes it during the build.

Place it next to the code that needs the hint so the relationship stays discoverable.

import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.ImportRuntimeHints;

@Configuration
@ImportRuntimeHints(ReflectionHints.class)
public class PaymentConfig {
    // beans that rely on reflective access to PaymentProcessor
}

Conditional Registration with TypeReference

If a class might be absent at build time, register it by name using TypeReference instead of a hard .class literal. Combine with a presence check so the hint is only added when the type is on the classpath.

This pattern is common in starter libraries that adapt to optional dependencies.

import org.springframework.aot.hint.MemberCategory;
import org.springframework.aot.hint.RuntimeHints;
import org.springframework.aot.hint.RuntimeHintsRegistrar;
import org.springframework.aot.hint.TypeReference;
import org.springframework.util.ClassUtils;

public class OptionalHints implements RuntimeHintsRegistrar {

    @Override
    public void registerHints(RuntimeHints hints, ClassLoader classLoader) {
        if (ClassUtils.isPresent("com.example.optional.LegacyAdapter", classLoader)) {
            hints.reflection().registerType(
                TypeReference.of("com.example.optional.LegacyAdapter"),
                MemberCategory.INVOKE_DECLARED_CONSTRUCTORS);
        }
    }
}

Registering Resource Hints

Files loaded with getResourceAsStream or ClassPathResource must be declared, or they vanish from the native binary. Register exact paths or glob-style patterns through hints.resources().

registerPattern("config/*.json") — include matching classpath resources.
registerResource(...) — include a single known Resource.

import org.springframework.aot.hint.RuntimeHints;
import org.springframework.aot.hint.RuntimeHintsRegistrar;

public class ResourceHints implements RuntimeHintsRegistrar {

    @Override
    public void registerHints(RuntimeHints hints, ClassLoader classLoader) {
        hints.resources()
             .registerPattern("templates/email/*.html")
             .registerPattern("data/countries.json");
    }
}

Registering Proxy Hints

JDK dynamic proxies created with Proxy.newProxyInstance need every implemented interface declared, because GraalVM must generate the proxy class at build time. Use hints.proxies().registerJdkProxy(...) with the full interface set.

Spring registers proxies for its own @Transactional and repository interfaces automatically; you only add hints for proxies you create yourself.

import org.springframework.aot.hint.RuntimeHints;
import org.springframework.aot.hint.RuntimeHintsRegistrar;

public class ProxyHints implements RuntimeHintsRegistrar {

    @Override
    public void registerHints(RuntimeHints hints, ClassLoader classLoader) {
        hints.proxies().registerJdkProxy(
            com.example.demo.AuditLog.class,
            com.example.demo.Versioned.class);
    }
}

A Complete Multi-Category Registrar

Real registrars usually combine several hint types. Here a single registrar declares reflection for a dynamically loaded strategy, a resource pattern for its config, and a proxy for an interface the app wires at runtime.

Keeping related hints together documents exactly which dynamic features a feature depends on.

import org.springframework.aot.hint.MemberCategory;
import org.springframework.aot.hint.RuntimeHints;
import org.springframework.aot.hint.RuntimeHintsRegistrar;
import org.springframework.aot.hint.TypeReference;

public class StrategyHints implements RuntimeHintsRegistrar {

    @Override
    public void registerHints(RuntimeHints hints, ClassLoader classLoader) {
        hints.reflection().registerType(
            TypeReference.of("com.example.demo.JsonExportStrategy"),
            MemberCategory.INVOKE_DECLARED_CONSTRUCTORS,
            MemberCategory.INVOKE_DECLARED_METHODS);

        hints.resources().registerPattern("strategies/*.properties");

        hints.proxies().registerJdkProxy(
            com.example.demo.ExportStrategy.class);
    }
}

Hinting Serialization with @RegisterReflectionForBinding

For DTOs that are only reached reflectively (for example via a manually built ObjectMapper outside any controller), the convenience annotation @RegisterReflectionForBinding registers all members needed for Jackson binding in one line, avoiding hand-listing categories.

It is a shortcut that delegates to the same reflection registry under the hood.

import org.springframework.aot.hint.annotation.RegisterReflectionForBinding;
import org.springframework.stereotype.Component;

@Component
@RegisterReflectionForBinding({ InvoiceDto.class, LineItemDto.class })
public class InvoiceExporter {
    // serializes InvoiceDto with a hand-built ObjectMapper
}

Verifying Hints Before Going Native

Compiling a native image is slow, so verify hints on the JVM first. The GraalVM reachability metadata agent records actual reflection/resource access during a normal test run and emits JSON metadata you can compare against your hints.

Spring also offers RuntimeHintsPredicates to assert in a unit test that a given type or resource is registered — fast feedback without a full native build.

import org.junit.jupiter.api.Test;
import org.springframework.aot.hint.RuntimeHints;
import org.springframework.aot.hint.predicate.RuntimeHintsPredicates;
import static org.assertj.core.api.Assertions.assertThat;

class ReflectionHintsTest {

    @Test
    void registersPaymentProcessor() {
        RuntimeHints hints = new RuntimeHints();
        new ReflectionHints().registerHints(hints, getClass().getClassLoader());

        assertThat(RuntimeHintsPredicates.reflection()
                .onType(com.example.demo.PaymentProcessor.class))
            .accepts(hints);
    }
}

Quick Check: Proxy Hints

Your application creates a JDK dynamic proxy for two of your own interfaces using Proxy.newProxyInstance. It works on the JVM but throws at runtime in the native image. Which hint fixes it?

Recap

GraalVM's closed-world analysis strips anything it cannot statically prove reachable, so dynamic features need explicit runtime hints.

Implement RuntimeHintsRegistrar.registerHints and activate it with @ImportRuntimeHints.
hints.reflection().registerType(...) with the right MemberCategory values keeps reflective constructors, methods, and fields.
hints.resources().registerPattern(...) bundles runtime-loaded files.
hints.proxies().registerJdkProxy(...) declares custom JDK dynamic proxies.
@RegisterReflectionForBinding is a shortcut for serialization DTOs.
Verify with RuntimeHintsPredicates and the reachability metadata agent before a costly native build.

Frequently asked questions

Is the “Runtime Hints for Reflection and Resources” lesson free?

Yes — the full text of “Runtime Hints for Reflection and Resources” is free to read here on the web, and the Spring Boot 4 Complete Guide course includes 4 lessons in total. To practise it interactively (a built-in code editor and a 24/7 AI tutor) and unlock the rest of the Spring Boot 4 Complete Guide course, upgrade to CoddyKit PRO.

What will I learn in “Runtime Hints for Reflection and Resources”?

Register reflection, proxy, and resource hints so dynamic features survive native compilation. You practise Spring Boot 4 Complete Guide with hands-on code you run directly in the browser, and a 24/7 AI tutor answers your questions as you work through the lesson.

Do I need any experience to start Spring Boot 4 Complete Guide?

No prior experience is required. Spring Boot 4 Complete Guide on CoddyKit is structured for beginners through advanced learners; this is — lesson 2 of 4, so you can start here or from the beginning and move at your own pace.

How long does the “Runtime Hints for Reflection and Resources” lesson take?

Most CoddyKit lessons take about 5–10 minutes. Each one is bite-sized and interactive, so you make steady progress and pick up exactly where you left off across the web and the app.

Can I write and run code in this Spring Boot 4 Complete Guide lesson?

Yes. Every Spring Boot 4 Complete Guide lesson includes a built-in code editor, so you write and run real code right in your browser and get instant AI feedback — no local setup required.

All lessons in this course

AOT Processing and the Native Build Pipeline
Runtime Hints for Reflection and Resources
Class Data Sharing and JVM Startup Tuning
Diagnosing and Fixing Native Compatibility Issues

← Back to Spring Boot 4 Complete Guide