Skip to content

giuseppe-trisciuoglio/developer-kit / plugins/developer-kit-java/skills/graalvm-native-image

graalvm-native-image

Verified

Provides expert guidance for building GraalVM Native Image executables from Java applications. Use when converting JVM applications to native binaries, optimizing cold start times, reducing memory footprint, configuring native build tools for Maven or Gradle, resolving reflection and resource issues in native builds, or implementing framework-specific native support for Spring Boot, Quarkus, and Micronaut. Triggers include "graalvm native image", "native executable java", "java cold start optimization", "native build tools", "ahead of time compilation java", "reflection config graalvm", "native image build failure".

references/reflection-resource-config.md

View on GitHub
# GraalVM Reflection & Resource Configuration

Complete guide for GraalVM metadata files that enable reflection, resources, proxies, and serialization in native images.

## Table of Contents

1. [Configuration File Location](#configuration-file-location)
2. [Unified Reachability Metadata](#unified-reachability-metadata)
3. [Reflection Configuration](#reflection-configuration)
4. [Resource Configuration](#resource-configuration)
5. [Proxy Configuration](#proxy-configuration)
6. [Serialization Configuration](#serialization-configuration)

---

## Configuration File Location

Place metadata files in:

```
src/main/resources/
  META-INF/native-image/
    <group.id>/
      <artifact.id>/
        reachability-metadata.json    # Unified format (recommended)
        reflect-config.json           # Legacy: reflection only
        resource-config.json          # Legacy: resources only
        proxy-config.json             # Legacy: dynamic proxies
        serialization-config.json     # Legacy: serialization
        jni-config.json               # Legacy: JNI access
        native-image.properties       # Build arguments
```

GraalVM automatically discovers files in the `META-INF/native-image/` directory.

## Unified Reachability Metadata

The unified `reachability-metadata.json` format (recommended for GraalVM 23+) combines all metadata:

```json
{
  "reflection": [
    {
      "type": "com.example.dto.UserDto",
      "allDeclaredConstructors": true,
      "allDeclaredMethods": true,
      "allDeclaredFields": true
    },
    {
      "condition": {
        "typeReached": "com.example.service.OrderService"
      },
      "type": "com.example.dto.OrderDto",
      "methods": [
        {"name": "<init>", "parameterTypes": []},
        {"name": "getId", "parameterTypes": []},
        {"name": "setId", "parameterTypes": ["java.lang.Long"]}
      ],
      "fields": [
        {"name": "id"},
        {"name": "status"}
      ]
    }
  ],
  "resources": [
    {"glob": "application.yml"},
    {"glob": "application-*.yml"},
    {"glob": "templates/**/*.html"},
    {"glob": "static/**"},
    {"glob": "META-INF/services/*"}
  ],
  "bundles": [
    {"name": "messages", "locales": ["en", "it", "de"]}
  ],
  "jni": [
    {
      "type": "com.example.NativeHelper",
      "methods": [
        {"name": "nativeMethod", "parameterTypes": ["int"]}
      ]
    }
  ]
}
```

## Reflection Configuration

### Legacy `reflect-config.json`

```json
[
  {
    "name": "com.example.dto.UserDto",
    "allDeclaredConstructors": true,
    "allPublicConstructors": true,
    "allDeclaredMethods": true,
    "allPublicMethods": true,
    "allDeclaredFields": true,
    "allPublicFields": true
  },
  {
    "name": "com.example.dto.OrderDto",
    "methods": [
      {"name": "<init>", "parameterTypes": []},
      {"name": "<init>", "parameterTypes": ["java.lang.Long", "java.lang.String"]},
      {"name": "getId", "parameterTypes": []},
      {"name": "setId", "parameterTypes": ["java.lang.Long"]}
    ],
    "fields": [
      {"name": "id", "allowWrite": true},
      {"name": "status", "allowWrite": true}
    ]
  },
  {
    "name": "com.example.entity.Product",
    "allDeclaredConstructors": true,
    "allDeclaredMethods": true,
    "allDeclaredFields": true,
    "unsafeAllocated": true
  }
]
```

### Common Reflection Flags

| Flag | Description |
|------|-------------|
| `allDeclaredConstructors` | Register all constructors (public and private) |
| `allPublicConstructors` | Register only public constructors |
| `allDeclaredMethods` | Register all methods (public and private) |
| `allPublicMethods` | Register only public methods |
| `allDeclaredFields` | Register all fields (public and private) |
| `allPublicFields` | Register only public fields |
| `unsafeAllocated` | Allow `Unsafe.allocateInstance()` |

## Resource Configuration

### Legacy `resource-config.json`

```json
{
  "resources": {
    "includes": [
      {"pattern": "application\\.yml"},
      {"pattern": "application-.*\\.yml"},
      {"pattern": "logback\\.xml"},
      {"pattern": "logback-spring\\.xml"},
      {"pattern": "META-INF/services/.*"},
      {"pattern": "templates/.*\\.html"},
      {"pattern": "static/.*"},
      {"pattern": "db/migration/.*\\.sql"}
    ],
    "excludes": [
      {"pattern": ".*\\.DS_Store"}
    ]
  },
  "bundles": [
    {"name": "messages", "locales": ["en", "it"]},
    {"name": "ValidationMessages"}
  ]
}
```

## Proxy Configuration

### Legacy `proxy-config.json`

Register interfaces for JDK dynamic proxy generation:

```json
[
  {
    "interfaces": [
      "com.example.service.UserService",
      "org.springframework.aop.SpringProxy",
      "org.springframework.aop.framework.Advised",
      "org.springframework.core.DecoratingProxy"
    ]
  },
  {
    "interfaces": [
      "com.example.repository.OrderRepository",
      "org.springframework.data.repository.Repository"
    ]
  }
]
```

## Serialization Configuration

### Legacy `serialization-config.json`

```json
{
  "types": [
    {"name": "com.example.dto.UserDto"},
    {"name": "com.example.dto.OrderDto"},
    {"name": "java.util.ArrayList"},
    {"name": "java.util.HashMap"}
  ],
  "lambdaCapturingTypes": [
    {"name": "com.example.service.UserService"}
  ]
}
```

## `native-image.properties`

Configure default build arguments:

```properties
Args = --no-fallback \
       -H:+ReportExceptionStackTraces \
       --enable-https \
       --initialize-at-build-time=org.slf4j
```
slack-gif-creatoranthropics/skillsKnowledge and utilities for creating animated GIFs optimized for Slack. Provides constraints, validation tools, and animation concepts. Use when users request animated GIFs for Slack like "make me a GIF of X doing Y for Slack."Stars: 198kUpdated Claude CodeCodexVerifiedInstall
ponytailDietrichGebert/ponytailLazy senior dev mode for any coding task: the smallest change that fully solves it, and a reply a busy human understands in one read.Stars: 194kUpdated Claude CodeCodexVerifiedInstall
ponytail-debtDietrichGebert/ponytailHarvest every shortcut: comment into one debt ledger, so deferrals get tracked instead of forgotten. One-shot report.Stars: 194kUpdated Claude CodeCodexVerifiedInstall
ponytail-debtDietrichGebert/ponytailList every `shortcut:` comment (and older `ponytail:` ones) as a debt ledger. One-shot report, changes nothing. Use for "ponytail debt", "what did ponytail defer", "list the shortcuts", /ponytail-debt.Stars: 194kUpdated Claude CodeCodexVerifiedInstall