Configure Native Image with the Tracing Agent

To build a native executable for a Java application that uses Java reflection, dynamic proxy objects, JNI, or class path resources, you should either provide the native-image tool with JSON-formatted configuration files or pre-compute metadata in the code.

You can create configuration file(s) by hand, but a more convenient approach is to generate the configuration using the Tracing agent (from now on, the agent). This guide demonstrates how to configure native-image with the agent. The agent generates the configuration for you automatically when you run an application on a JVM.

To learn how to build a native executable with the metadata pre-computed in the code, follow this guide.

The example application in this guide uses Java reflection. The native-image tool only partially detects application elements that are accessed using the Java Reflection API. So, you need to provide it with details about reflectively accessed classes, methods, and fields.

Example with No Configuration

The following application demonstrates the use of Java reflection.

Make sure you have installed a GraalVM JDK. The easiest way to get started is with SDKMAN!. For other installation options, visit the Downloads section.

Save the following source code in a file named ReflectionExample.java:

 import java.lang.reflect.Method;
    
 class StringReverser {
     static String reverse(String input) {
         return new StringBuilder(input).reverse().toString();
     }
 }
    
 class StringCapitalizer {
     static String capitalize(String input) {
         return input.toUpperCase();
     }
 }
    
 public class ReflectionExample {
     public static void main(String[] args) throws ReflectiveOperationException {
         if (args.length == 0) {
             System.err.println("You must provide the name of a class, the name of its method and input for the method");
             return;
         }
         String className = args[0];
         String methodName = args[1];
         String input = args[2];
    
         Class<?> clazz = Class.forName(className);
         Method method = clazz.getDeclaredMethod(methodName, String.class);
         Object result = method.invoke(null, input);
         System.out.println(result);
     }
 }

This Java application uses command-line arguments to determine the operation to be performed.

Compile the example and then run each command below.
```
 $JAVA_HOME/bin/javac ReflectionExample.java
```
```
 $JAVA_HOME/bin/java ReflectionExample StringReverser reverse "hello"
```
```
 $JAVA_HOME/bin/java ReflectionExample StringCapitalizer capitalize "hello"
```
The output of each command should be "olleh" and "HELLO", respectively. (An exception is thrown if you provide any other string to identify the class or method.)
Use the native-image utility to create a native executable, as follows:
```
 $JAVA_HOME/bin/native-image --no-fallback ReflectionExample
```
NOTE: The --no-fallback option to native-image causes the utility to fail if it can not create an executable file.

Run the resulting native executable, using the following command:

 ./reflectionexample StringReverser reverse "hello"

You’ll see an exception, similar to:

 Exception in thread "main" java.lang.ClassNotFoundException: StringReverser
     at java.lang.Class.forName(DynamicHub.java:1338)
     at java.lang.Class.forName(DynamicHub.java:1313)
     at ReflectionExample.main(ReflectionExample.java:25)

This shows that, from its static analysis, the native-image tool was unable to determine that class StringReverser is used by the application and therefore did not include it in the native executable.

Example with Configuration

The following steps demonstrate how to use the agent, and its output, to create a native executable that relies on reflection and requires configuration.

Create a directory named META-INF/native-image in the working directory:
```
 mkdir -p META-INF/native-image
```

Run the application with the agent enabled, as follows:

 $JAVA_HOME/bin/java -agentlib:native-image-agent=config-output-dir=META-INF/native-image ReflectionExample StringReverser reverse "hello"

This command creates a file named reflect-config.json containing the name of the class StringReverser and its reverse() method.

 [
     {
     "name":"StringReverser",
     "methods":[{"name":"reverse","parameterTypes":["java.lang.String"] }]
     }
 ]

Build a native executable:
```
 $JAVA_HOME/bin/native-image ReflectionExample
```
The native-image tool automatically uses configuration files in the META-INF/native-image directory. However, we recommend that the META-INF/native-image directory is on the class path, either via a JAR file or using the -cp flag. (This avoids confusion for IDE users where a directory structure is defined by the IDE itself.)
Test your executable.
```
 ./reflectionexample StringReverser reverse "hello"
 olleh
```
```
 ./reflectionexample StringCapitalizer capitalize "hello"
```
You’ll see again an exception, similar to:
```
 Exception in thread "main" java.lang.ClassNotFoundException: StringCapitalizer
     at java.lang.Class.forName(DynamicHub.java:1338)
     at java.lang.Class.forName(DynamicHub.java:1313)
     at ReflectionExample.main(ReflectionExample.java:25)
```
Neither the tracing agent nor the native-image tool can ensure that the configuration file is complete. The agent observes and records which program elements are accessed using reflection when you run the program. In this case, the native-image tool has not been configured to include references to class StringCapitalizer.

Update the configuration to include class StringCapitalizer. You can manually edit the reflect-config.json file or re-run the tracing agent to update the existing configuration file using the config-merge-dir option, as follows:

 $JAVA_HOME/bin/java -agentlib:native-image-agent=config-merge-dir=META-INF/native-image ReflectionExample StringCapitalizer capitalize "hello"

This command updates the reflect-config.json file to include the name of the class StringCapitalizer and its capitalize() method.

 [
     {
     "name":"StringCapitalizer",
     "methods":[{"name":"capitalize","parameterTypes":["java.lang.String"] }]
     },
     {
     "name":"StringReverser",
     "methods":[{"name":"reverse","parameterTypes":["java.lang.String"] }]
     }
 ]

Rebuild the native executable and run it.

 $JAVA_HOME/bin/native-image ReflectionExample

 ./reflectionexample StringCapitalizer capitalize "hello"

The application should now work as intended.

Configure Native Image with the Tracing Agent

Example with No Configuration

Example with Configuration

Related Documentation