Add AOT runtime hints for infrastructure artifacts

This commit adds AOT runtime hints for common classes
and interfaces of the infrastructure module.

Technology specific APIs (mongodb, kafka, redis, etc)
are not included on purpose and are left for users
when needed.

Resolves #4785
This commit is contained in:
Mahmoud Ben Hassine
2025-03-18 09:15:44 +01:00
parent 42b1464a09
commit e110b359ef
2 changed files with 105 additions and 0 deletions

View File

@@ -0,0 +1,104 @@
/*
* Copyright 2025 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.batch.infrastructure.aot;
import org.springframework.aot.hint.MemberCategory;
import org.springframework.aot.hint.RuntimeHints;
import org.springframework.aot.hint.RuntimeHintsRegistrar;
import org.springframework.batch.item.ItemStreamSupport;
import org.springframework.batch.item.amqp.AmqpItemReader;
import org.springframework.batch.item.amqp.AmqpItemWriter;
import org.springframework.batch.item.amqp.builder.AmqpItemReaderBuilder;
import org.springframework.batch.item.amqp.builder.AmqpItemWriterBuilder;
import org.springframework.batch.item.database.JdbcBatchItemWriter;
import org.springframework.batch.item.database.JdbcCursorItemReader;
import org.springframework.batch.item.database.JdbcPagingItemReader;
import org.springframework.batch.item.database.JpaCursorItemReader;
import org.springframework.batch.item.database.JpaItemWriter;
import org.springframework.batch.item.database.JpaPagingItemReader;
import org.springframework.batch.item.database.builder.JdbcBatchItemWriterBuilder;
import org.springframework.batch.item.database.builder.JdbcCursorItemReaderBuilder;
import org.springframework.batch.item.database.builder.JdbcPagingItemReaderBuilder;
import org.springframework.batch.item.database.builder.JpaCursorItemReaderBuilder;
import org.springframework.batch.item.database.builder.JpaItemWriterBuilder;
import org.springframework.batch.item.database.builder.JpaPagingItemReaderBuilder;
import org.springframework.batch.item.file.FlatFileItemReader;
import org.springframework.batch.item.file.FlatFileItemWriter;
import org.springframework.batch.item.file.builder.FlatFileItemReaderBuilder;
import org.springframework.batch.item.file.builder.FlatFileItemWriterBuilder;
import org.springframework.batch.item.jms.JmsItemReader;
import org.springframework.batch.item.jms.JmsItemWriter;
import org.springframework.batch.item.jms.builder.JmsItemReaderBuilder;
import org.springframework.batch.item.jms.builder.JmsItemWriterBuilder;
import org.springframework.batch.item.json.JsonFileItemWriter;
import org.springframework.batch.item.json.JsonItemReader;
import org.springframework.batch.item.json.builder.JsonFileItemWriterBuilder;
import org.springframework.batch.item.json.builder.JsonItemReaderBuilder;
import org.springframework.batch.item.queue.BlockingQueueItemReader;
import org.springframework.batch.item.queue.BlockingQueueItemWriter;
import org.springframework.batch.item.queue.builder.BlockingQueueItemReaderBuilder;
import org.springframework.batch.item.queue.builder.BlockingQueueItemWriterBuilder;
import org.springframework.batch.item.support.AbstractFileItemWriter;
import org.springframework.batch.item.support.AbstractItemCountingItemStreamItemReader;
import org.springframework.batch.item.support.AbstractItemStreamItemReader;
import org.springframework.batch.item.support.AbstractItemStreamItemWriter;
import org.springframework.batch.item.xml.StaxEventItemReader;
import org.springframework.batch.item.xml.StaxEventItemWriter;
import org.springframework.batch.item.xml.builder.StaxEventItemReaderBuilder;
import org.springframework.batch.item.xml.builder.StaxEventItemWriterBuilder;
import java.util.Set;
/**
* {@link RuntimeHintsRegistrar} for Spring Batch infrastructure module.
*
* @author Mahmoud Ben Hassine
* @since 5.2.2
*/
public class InfrastructureRuntimeHints implements RuntimeHintsRegistrar {
@Override
public void registerHints(RuntimeHints hints, ClassLoader classLoader) {
// reflection hints
Set<Class<?>> classes = Set.of(
// File IO APIs
FlatFileItemReader.class, FlatFileItemReaderBuilder.class, FlatFileItemWriter.class,
FlatFileItemWriterBuilder.class, JsonItemReader.class, JsonItemReaderBuilder.class,
JsonFileItemWriter.class, JsonFileItemWriterBuilder.class, StaxEventItemReader.class,
StaxEventItemReaderBuilder.class, StaxEventItemWriter.class, StaxEventItemWriterBuilder.class,
// Database IO APIs
JdbcCursorItemReader.class, JdbcCursorItemReaderBuilder.class, JdbcPagingItemReader.class,
JdbcPagingItemReaderBuilder.class, JdbcBatchItemWriter.class, JdbcBatchItemWriterBuilder.class,
JpaCursorItemReader.class, JpaCursorItemReaderBuilder.class, JpaPagingItemReader.class,
JpaPagingItemReaderBuilder.class, JpaItemWriter.class, JpaItemWriterBuilder.class,
// Queue IO APIs
BlockingQueueItemReader.class, BlockingQueueItemReaderBuilder.class, BlockingQueueItemWriter.class,
BlockingQueueItemWriterBuilder.class, JmsItemReader.class, JmsItemReaderBuilder.class,
JmsItemWriter.class, JmsItemWriterBuilder.class, AmqpItemReader.class, AmqpItemReaderBuilder.class,
AmqpItemWriter.class, AmqpItemWriterBuilder.class,
// Support classes
AbstractFileItemWriter.class, AbstractItemStreamItemWriter.class,
AbstractItemCountingItemStreamItemReader.class, AbstractItemStreamItemReader.class,
ItemStreamSupport.class);
for (Class<?> type : classes) {
hints.reflection().registerType(type, MemberCategory.values());
}
}
}

View File

@@ -0,0 +1 @@
org.springframework.aot.hint.RuntimeHintsRegistrar=org.springframework.batch.infrastructure.aot.InfrastructureRuntimeHints