By default, the native image builder will not integrate any of the resources which are on the classpath during the generation into the final image.
To make calls such as Class.getResource()
or Class.getResourceAsStream()
(or the corresponding ClassLoader methods) return specific resources (instead of null), the resources that should be accessible at image run time need to be explicitly specified. This can be done via a configuration file such as the following:
{
"resources": [
{"pattern": "<Java regexp that matches resource(s) to be included in the image>"},
{"pattern": "<another regexp>"},
...
]
}
The configuration file's path must be provided to the native image builder with -H:ResourceConfigurationFiles=/path/to/resource-config.json
. Alternatively, individual resource paths can also be specified directly to native-image
:
native-image -H:IncludeResources=<Java regexp that matches resources to be included in the image> ...
The -H:IncludeResources
option can be passed several times to define more than one regexp to match resources.
To see which resources get included into the image, you can enable the related logging info with -H:Log=registerResource:
.
Given this project structure:
my-app-root
└── src
├── main
│ └── com.my.app
│ ├── Resource0.txt
│ └── Resource1.txt
└── resources
├── Resource2.txt
└── Resource3.txt
Then:
- All resources can be loaded with
.*/Resource.*txt$
, specified as{"pattern":".*/Resource.*txt$"}
in a configuration file, or-H:IncludeResources='.*/Resource.*txt$'
on the command line. Resource0.txt
can be loaded with.*/Resource0.txt$
.Resource0.txt
andResource1.txt
can be loaded with.*/Resource0.txt$
and.*/Resource1.txt$
(or alternatively with a single.*/(Resource0|Resource1).txt$
).
See also the guide on assisted configuration of Java resources and other dynamic features.
Java localization support (java.util.ResourceBundle
) enables Java code to load L10N resources and show the right user messages suitable for actual runtime settings like time locale and format, etc.
Native Image needs ahead-of-time knowledge of the resource bundles your application needs so that it can load and store the appropriate bundles for usage in the generated binary. The bundles can be specified in the resource configuration file (see above), in the bundles
section:
{
"bundles": [
{"name":"your.pkg.Bundle"},
{"name":"another.pkg.Resource"},
{"name":"etc.Bundle"}
],
"resources": <see above>
}
Alternatively, bundles can be specified directly as options to the native image builder as follows:
native-image -H:IncludeResourceBundles=your.pgk.Bundle,another.pkg.Resource,etc.Bundle ...