Introduce @RegisterResourceBundle and @RegisterResources

These annotations are used to register resources in native image

Author: Eng-Fouad

core/deployment/src/main/java/io/quarkus/deployment/steps/RegisterResourceBundleBuildStep.java

@@ -0,0 +1,27 @@
+package io.quarkus.deployment.steps;
+
+import io.quarkus.deployment.annotations.BuildProducer;
+import io.quarkus.deployment.annotations.BuildStep;
+import io.quarkus.deployment.builditem.CombinedIndexBuildItem;
+import io.quarkus.deployment.builditem.nativeimage.NativeImageResourceBundleBuildItem;
+import io.quarkus.runtime.annotations.RegisterResourceBundle;
+import org.jboss.jandex.DotName;
+
+public class RegisterResourceBundleBuildStep {
+
+    @BuildStep
+    public void build(CombinedIndexBuildItem combinedIndexBuildItem,
+                      BuildProducer<NativeImageResourceBundleBuildItem> resourceBundle) {
+        for (var annotationInstance : combinedIndexBuildItem.getIndex()
+                .getAnnotations(DotName.createSimple(RegisterResourceBundle.class.getName()))) {
+            var bundleNameValue = annotationInstance.value("bundleName");
+            var moduleNameValue = annotationInstance.value("moduleName");
+            if (moduleNameValue == null) {
+                resourceBundle.produce(new NativeImageResourceBundleBuildItem(bundleNameValue.asString()));
+            } else {
+                resourceBundle.produce(new NativeImageResourceBundleBuildItem(bundleNameValue.asString(),
+                        moduleNameValue.asString()));
+            }
+        }
+    }
+}

core/deployment/src/main/java/io/quarkus/deployment/steps/RegisterResourcesBuildStep.java

@@ -0,0 +1,28 @@
+package io.quarkus.deployment.steps;
+
+import io.quarkus.deployment.annotations.BuildProducer;
+import io.quarkus.deployment.annotations.BuildStep;
+import io.quarkus.deployment.builditem.CombinedIndexBuildItem;
+import io.quarkus.deployment.builditem.nativeimage.NativeImageResourcePatternsBuildItem;
+import io.quarkus.runtime.annotations.RegisterResources;
+import org.jboss.jandex.DotName;
+
+public class RegisterResourcesBuildStep {
+
+    @BuildStep
+    public void build(CombinedIndexBuildItem combinedIndexBuildItem,
+                      BuildProducer<NativeImageResourcePatternsBuildItem> resources) {
+        for (var annotationInstance : combinedIndexBuildItem.getIndex()
+                .getAnnotations(DotName.createSimple(RegisterResources.class.getName()))) {
+            var includeGlobs = annotationInstance.value("includeGlobs").asStringArray();
+            var includePatterns = annotationInstance.value("includePatterns").asStringArray();
+            var excludeGlobs = annotationInstance.value("excludeGlobs").asStringArray();
+            var excludePatterns = annotationInstance.value("excludePatterns").asStringArray();
+            resources.produce(NativeImageResourcePatternsBuildItem.builder()
+                    .includeGlobs(includeGlobs)
+                    .includePatterns(includePatterns)
+                    .excludeGlobs(excludeGlobs)
+                    .excludePatterns(excludePatterns).build());
+        }
+    }
+}

core/runtime/src/main/java/io/quarkus/runtime/annotations/RegisterResourceBundle.java

@@ -0,0 +1,40 @@
+package io.quarkus.runtime.annotations;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Repeatable;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * Annotation that can be used to register a resource bundle to be included in the native image.
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@Target(ElementType.TYPE)
+@Repeatable(RegisterResourceBundle.List.class)
+public @interface RegisterResourceBundle {
+
+    /**
+     * The bundle name.
+     */
+    String bundleName();
+
+    /**
+     * The module name (optional).
+     */
+    String moduleName() default "";
+
+    /**
+     * The repeatable holder for {@link RegisterResourceBundle}.
+     */
+    @Retention(RetentionPolicy.RUNTIME)
+    @Target(ElementType.TYPE)
+    @interface List {
+        /**
+         * The {@link RegisterResourceBundle} instances.
+         *
+         * @return the instances
+         */
+        RegisterResourceBundle[] value();
+    }
+}

core/runtime/src/main/java/io/quarkus/runtime/annotations/RegisterResources.java

@@ -0,0 +1,44 @@
+package io.quarkus.runtime.annotations;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * Annotation that can be used to register resource files to be included in the native image.
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@Target(ElementType.TYPE)
+public @interface RegisterResources {
+
+    /**
+     * Add an array of glob patterns for matching resource paths that should be added to the native image.
+     * <p>
+     * Use slash ({@code /}) as a path separator on all platforms. Globs must not start with slash.
+     */
+    String[] includeGlobs() default {};
+
+    /**
+     * Add an array of regular expressions for matching resource paths that should be added to the native image.
+     * <p>
+     * Use slash ({@code /}) as a path separator on all platforms. The patterns must not start with slash.
+     */
+    String[] includePatterns() default {};
+
+    /**
+     * Add an array of glob patterns for matching resource paths that should <strong>not</strong> be added to the
+     * native image.
+     * <p>
+     * Use slash ({@code /}) as a path separator on all platforms. Globs must not start with slash.
+     */
+    String[] excludeGlobs() default {};
+
+    /**
+     * Add an array of regular expressions for matching resource paths that should <strong>not</strong> be added
+     * to the native image.
+     * <p>
+     * Use slash ({@code /}) as a path separator on all platforms. The pattern must not start with slash.
+     */
+    String[] excludePatterns() default {};
+}

docs/src/main/asciidoc/writing-native-applications-tips.adoc

@@ -261,6 +261,27 @@ public class MyReflectionConfiguration {
 Note that the order of the specified proxy interfaces is significant. For more information, see link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/reflect/Proxy.html[Proxy javadoc].
 ====
 
+=== Registering resource bundles and resource files
+
+Resource bundles can be registered to be included in the native image by using `@RegisterResourceBundle`:
+
+[source,java]
+----
+@RegisterResourceBundle(bundleName = "messages")
+@RegisterResourceBundle(bundleName = "errors", moduleName = "foo")
+public class NativeConfiguration {
+}
+----
+
+Other resources files can be registered to be included in the native image by using `@RegisterResources`:
+
+[source,java]
+----
+@RegisterResources(includePatterns = {"^resource-file.txt$", ".*/Resource.*txt$"}, excludePatterns = {".*/Resource2.txt$"})
+public class NativeConfiguration {
+}
+----
+
 [[delay-class-init-in-your-app]]
 === Delaying class initialization