From 5c68a278b552a1f57f15ea404319862f1f42c0ad Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Deleuze?= Date: Thu, 21 Jul 2022 16:18:03 +0200 Subject: [PATCH] Add SchedulerFactoryBean runtime hints Also require oracle/graalvm-reachability-metadata#19. Closes gh-28725 --- .../SchedulerFactoryBeanRuntimeHints.java | 64 ++++++++++++++++ .../resources/META-INF/spring/aot.factories | 3 +- ...SchedulerFactoryBeanRuntimeHintsTests.java | 73 +++++++++++++++++++ 3 files changed, 139 insertions(+), 1 deletion(-) create mode 100644 spring-context-support/src/main/java/org/springframework/scheduling/quartz/SchedulerFactoryBeanRuntimeHints.java create mode 100644 spring-context-support/src/test/java/org/springframework/scheduling/quartz/SchedulerFactoryBeanRuntimeHintsTests.java diff --git a/spring-context-support/src/main/java/org/springframework/scheduling/quartz/SchedulerFactoryBeanRuntimeHints.java b/spring-context-support/src/main/java/org/springframework/scheduling/quartz/SchedulerFactoryBeanRuntimeHints.java new file mode 100644 index 0000000000..044031ea8a --- /dev/null +++ b/spring-context-support/src/main/java/org/springframework/scheduling/quartz/SchedulerFactoryBeanRuntimeHints.java @@ -0,0 +1,64 @@ +/* + * Copyright 2002-2022 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.scheduling.quartz; + +import java.util.List; + +import org.springframework.aot.hint.MemberCategory; +import org.springframework.aot.hint.RuntimeHints; +import org.springframework.aot.hint.RuntimeHintsRegistrar; +import org.springframework.aot.hint.TypeReference; +import org.springframework.util.ClassUtils; + +/** + * {@link RuntimeHintsRegistrar} implementation that makes sure {@link SchedulerFactoryBean} + * reflection entries are registered. + * + * @author Sebastien Deleuze + * @since 6.0 + */ +public class SchedulerFactoryBeanRuntimeHints implements RuntimeHintsRegistrar { + + private static String SCHEDULER_FACTORY_CLASS_NAME = "org.quartz.impl.StdSchedulerFactory"; + + private static TypeReference FACTORY_BEAN_TYPE_REFERENCE = TypeReference.of(SchedulerFactoryBean.class); + + @Override + public void registerHints(RuntimeHints hints, ClassLoader classLoader) { + if (ClassUtils.isPresent(SCHEDULER_FACTORY_CLASS_NAME, classLoader)) { + hints.reflection().registerType(TypeReference.of(SCHEDULER_FACTORY_CLASS_NAME), + builder -> builder + .withMembers(MemberCategory.INVOKE_DECLARED_CONSTRUCTORS) + .onReachableType(FACTORY_BEAN_TYPE_REFERENCE)); + hints.reflection().registerType(ResourceLoaderClassLoadHelper.class, + builder -> builder + .withMembers(MemberCategory.INVOKE_DECLARED_CONSTRUCTORS) + .onReachableType(FACTORY_BEAN_TYPE_REFERENCE)); + hints.reflection().registerType(LocalTaskExecutorThreadPool.class, + builder -> builder + .withMembers(MemberCategory.INVOKE_DECLARED_CONSTRUCTORS) + .withMethod("setInstanceId", List.of(TypeReference.of(String.class)), b -> {}) + .withMethod("setInstanceName", List.of(TypeReference.of(String.class)), b -> {}) + .onReachableType(FACTORY_BEAN_TYPE_REFERENCE)); + hints.reflection().registerType(LocalDataSourceJobStore.class, + builder -> builder + .withMembers(MemberCategory.INVOKE_DECLARED_CONSTRUCTORS) + .onReachableType(FACTORY_BEAN_TYPE_REFERENCE)); + + } + } +} diff --git a/spring-context-support/src/main/resources/META-INF/spring/aot.factories b/spring-context-support/src/main/resources/META-INF/spring/aot.factories index bc5928dbef..a0f69394ac 100644 --- a/spring-context-support/src/main/resources/META-INF/spring/aot.factories +++ b/spring-context-support/src/main/resources/META-INF/spring/aot.factories @@ -1,2 +1,3 @@ org.springframework.aot.hint.RuntimeHintsRegistrar= \ -org.springframework.mail.javamail.JavaMailMimeTypesRuntimeHints \ No newline at end of file +org.springframework.mail.javamail.JavaMailMimeTypesRuntimeHints,\ +org.springframework.scheduling.quartz.SchedulerFactoryBeanRuntimeHints \ No newline at end of file diff --git a/spring-context-support/src/test/java/org/springframework/scheduling/quartz/SchedulerFactoryBeanRuntimeHintsTests.java b/spring-context-support/src/test/java/org/springframework/scheduling/quartz/SchedulerFactoryBeanRuntimeHintsTests.java new file mode 100644 index 0000000000..7e422ed9b3 --- /dev/null +++ b/spring-context-support/src/test/java/org/springframework/scheduling/quartz/SchedulerFactoryBeanRuntimeHintsTests.java @@ -0,0 +1,73 @@ +/* + * Copyright 2002-2022 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.scheduling.quartz; + +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; + +import org.springframework.aot.hint.MemberCategory; +import org.springframework.aot.hint.RuntimeHints; +import org.springframework.aot.hint.RuntimeHintsRegistrar; +import org.springframework.aot.hint.TypeReference; +import org.springframework.aot.hint.predicate.RuntimeHintsPredicates; +import org.springframework.beans.factory.aot.AotServices; +import org.springframework.util.ClassUtils; + +import static org.assertj.core.api.Assertions.assertThat; + +/** + * Tests for {@link SchedulerFactoryBeanRuntimeHints}. + * + * @author Sebastien Deleuze + */ +public class SchedulerFactoryBeanRuntimeHintsTests { + + private final RuntimeHints hints = new RuntimeHints(); + + @BeforeEach + void setup() { + AotServices.factories().load(RuntimeHintsRegistrar.class) + .forEach(registrar -> registrar.registerHints(this.hints, + ClassUtils.getDefaultClassLoader())); + } + + @Test + void stdSchedulerFactoryHasHints() { + assertThat(RuntimeHintsPredicates.reflection().onType(TypeReference.of("org.quartz.impl.StdSchedulerFactory")) + .withMemberCategory(MemberCategory.INVOKE_DECLARED_CONSTRUCTORS)).accepts(this.hints); + } + + @Test + void defaultClassLoadHelperHasHints() { + assertThat(RuntimeHintsPredicates.reflection().onType(ResourceLoaderClassLoadHelper.class) + .withMemberCategory(MemberCategory.INVOKE_DECLARED_CONSTRUCTORS)).accepts(this.hints); + } + + @Test + void defaultThreadPoolHasHints() { + assertThat(RuntimeHintsPredicates.reflection().onType(LocalTaskExecutorThreadPool.class) + .withMemberCategory(MemberCategory.INVOKE_DECLARED_CONSTRUCTORS)) + .accepts(this.hints); + } + + @Test + void defaultJobStoreHasHints() { + assertThat(RuntimeHintsPredicates.reflection().onType(LocalDataSourceJobStore.class) + .withMemberCategory(MemberCategory.INVOKE_DECLARED_CONSTRUCTORS)) + .accepts(this.hints); + } +}