From ff81d64fb56d5e4b679f72886a2a0b98a612523b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Deleuze?= Date: Wed, 5 Oct 2022 14:06:33 +0200 Subject: [PATCH] Add reflection hint for EmbeddedDataSourceProxy#shutdown This commit adds a reflection hint on EmbeddedDatabaseFactory$EmbeddedDataSourceProxy#shutdown when EmbeddedDatabaseFactory is reachable in order to allow its usage as bean destroy method. Closes gh-29259 --- .../EmbeddedDatabaseFactoryRuntimeHints.java | 44 +++++++++++++++ .../resources/META-INF/spring/aot.factories | 2 + ...eddedDatabaseFactoryRuntimeHintsTests.java | 54 +++++++++++++++++++ 3 files changed, 100 insertions(+) create mode 100644 spring-jdbc/src/main/java/org/springframework/jdbc/datasource/embedded/EmbeddedDatabaseFactoryRuntimeHints.java create mode 100644 spring-jdbc/src/main/resources/META-INF/spring/aot.factories create mode 100644 spring-jdbc/src/test/java/org/springframework/jdbc/datasource/embedded/EmbeddedDatabaseFactoryRuntimeHintsTests.java diff --git a/spring-jdbc/src/main/java/org/springframework/jdbc/datasource/embedded/EmbeddedDatabaseFactoryRuntimeHints.java b/spring-jdbc/src/main/java/org/springframework/jdbc/datasource/embedded/EmbeddedDatabaseFactoryRuntimeHints.java new file mode 100644 index 00000000000..f39c3cc0e2b --- /dev/null +++ b/spring-jdbc/src/main/java/org/springframework/jdbc/datasource/embedded/EmbeddedDatabaseFactoryRuntimeHints.java @@ -0,0 +1,44 @@ +/* + * 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.jdbc.datasource.embedded; + +import java.util.Collections; + +import org.springframework.aot.hint.ExecutableMode; +import org.springframework.aot.hint.RuntimeHints; +import org.springframework.aot.hint.RuntimeHintsRegistrar; + +/** + * {@link RuntimeHintsRegistrar} implementation that registers reflection hints for + * {@code EmbeddedDataSourceProxy#shutdown} in order to allow it to be used as a bean + * destroy method. + * + * @author Sebastien Deleuze + * @since 6.0 + */ +class EmbeddedDatabaseFactoryRuntimeHints implements RuntimeHintsRegistrar { + + @Override + public void registerHints(RuntimeHints hints, ClassLoader classLoader) { + hints.reflection().registerTypeIfPresent(classLoader, + "org.springframework.jdbc.datasource.embedded.EmbeddedDatabaseFactory$EmbeddedDataSourceProxy", + builder -> builder + .onReachableType(EmbeddedDatabaseFactory.class) + .withMethod("shutdown", Collections.emptyList(), ExecutableMode.INVOKE)); + } + +} diff --git a/spring-jdbc/src/main/resources/META-INF/spring/aot.factories b/spring-jdbc/src/main/resources/META-INF/spring/aot.factories new file mode 100644 index 00000000000..fe433bd2035 --- /dev/null +++ b/spring-jdbc/src/main/resources/META-INF/spring/aot.factories @@ -0,0 +1,2 @@ +org.springframework.aot.hint.RuntimeHintsRegistrar=\ +org.springframework.jdbc.datasource.embedded.EmbeddedDatabaseFactoryRuntimeHints diff --git a/spring-jdbc/src/test/java/org/springframework/jdbc/datasource/embedded/EmbeddedDatabaseFactoryRuntimeHintsTests.java b/spring-jdbc/src/test/java/org/springframework/jdbc/datasource/embedded/EmbeddedDatabaseFactoryRuntimeHintsTests.java new file mode 100644 index 00000000000..df37aac9f65 --- /dev/null +++ b/spring-jdbc/src/test/java/org/springframework/jdbc/datasource/embedded/EmbeddedDatabaseFactoryRuntimeHintsTests.java @@ -0,0 +1,54 @@ +/* + * 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.jdbc.datasource.embedded; + +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; + +import org.springframework.aot.hint.RuntimeHints; +import org.springframework.aot.hint.RuntimeHintsRegistrar; +import org.springframework.aot.hint.predicate.RuntimeHintsPredicates; +import org.springframework.core.io.support.SpringFactoriesLoader; +import org.springframework.util.ClassUtils; + +import static org.assertj.core.api.Assertions.assertThat; + +/** + * Tests for {@link EmbeddedDatabaseFactoryRuntimeHints}. + * + * @author Sebastien Deleuze + */ +public class EmbeddedDatabaseFactoryRuntimeHintsTests { + + private RuntimeHints hints; + + @BeforeEach + void setup() { + this.hints = new RuntimeHints(); + SpringFactoriesLoader.forResourceLocation("META-INF/spring/aot.factories") + .load(RuntimeHintsRegistrar.class).forEach(registrar -> registrar + .registerHints(this.hints, ClassUtils.getDefaultClassLoader())); + } + + @Test + void embeddedDataSourceProxyTypeHasHint() throws ClassNotFoundException { + assertThat(RuntimeHintsPredicates.reflection() + .onMethod("org.springframework.jdbc.datasource.embedded.EmbeddedDatabaseFactory$EmbeddedDataSourceProxy", "shutdown")) + .accepts(this.hints); + } + +}