diff --git a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/jdbc/DataSourceBuilderRuntimeHints.java b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/jdbc/DataSourceBuilderRuntimeHints.java new file mode 100644 index 00000000000..52305b881db --- /dev/null +++ b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/jdbc/DataSourceBuilderRuntimeHints.java @@ -0,0 +1,60 @@ +/* + * Copyright 2012-2023 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.boot.jdbc; + +import java.util.ArrayList; +import java.util.Collections; +import java.util.List; + +import javax.sql.DataSource; + +import org.springframework.aot.hint.MemberCategory; +import org.springframework.aot.hint.RuntimeHints; +import org.springframework.aot.hint.RuntimeHintsRegistrar; + +/** + * {@link RuntimeHintsRegistrar} implementation for {@link DataSource} types supported by + * the {@link DataSourceBuilder}. + * + * @author Phillip Webb + */ +class DataSourceBuilderRuntimeHints implements RuntimeHintsRegistrar { + + private static final List TYPE_NAMES; + static { + List typeNames = new ArrayList<>(); + typeNames.add("com.mchange.v2.c3p0.ComboPooledDataSource"); + typeNames.add("org.h2.jdbcx.JdbcDataSource"); + typeNames.add("com.zaxxer.hikari.HikariDataSource"); + typeNames.add("org.apache.commons.dbcp2.BasicDataSource"); + typeNames.add("oracle.jdbc.datasource.OracleDataSource"); + typeNames.add("oracle.ucp.jdbc.PoolDataSource"); + typeNames.add("org.postgresql.ds.PGSimpleDataSource"); + typeNames.add("org.springframework.jdbc.datasource.SimpleDriverDataSource"); + typeNames.add("org.apache.tomcat.jdbc.pool.DataSource"); + TYPE_NAMES = Collections.unmodifiableList(typeNames); + } + + @Override + public void registerHints(RuntimeHints hints, ClassLoader classLoader) { + for (String typeName : TYPE_NAMES) { + hints.reflection().registerTypeIfPresent(classLoader, typeName, + (hint) -> hint.withMembers(MemberCategory.INVOKE_PUBLIC_CONSTRUCTORS)); + } + } + +} diff --git a/spring-boot-project/spring-boot/src/main/resources/META-INF/spring/aot.factories b/spring-boot-project/spring-boot/src/main/resources/META-INF/spring/aot.factories index e9c75fb7d30..905cd717406 100644 --- a/spring-boot-project/spring-boot/src/main/resources/META-INF/spring/aot.factories +++ b/spring-boot-project/spring-boot/src/main/resources/META-INF/spring/aot.factories @@ -5,6 +5,7 @@ org.springframework.boot.WebApplicationType.WebApplicationTypeRuntimeHints,\ org.springframework.boot.context.config.ConfigDataLocationRuntimeHints,\ org.springframework.boot.context.config.ConfigDataPropertiesRuntimeHints,\ org.springframework.boot.env.PropertySourceRuntimeHints,\ +org.springframework.boot.jdbc.DataSourceBuilderRuntimeHints,\ org.springframework.boot.json.JacksonRuntimeHints,\ org.springframework.boot.logging.java.JavaLoggingSystemRuntimeHints,\ org.springframework.boot.logging.logback.LogbackRuntimeHints,\ diff --git a/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/jdbc/DataSourceBuilderRuntimeHintsTests.java b/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/jdbc/DataSourceBuilderRuntimeHintsTests.java new file mode 100644 index 00000000000..8f5658db804 --- /dev/null +++ b/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/jdbc/DataSourceBuilderRuntimeHintsTests.java @@ -0,0 +1,61 @@ +/* + * Copyright 2012-2023 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.boot.jdbc; + +import java.util.Set; +import java.util.stream.Stream; + +import org.junit.jupiter.api.Test; + +import org.springframework.aot.hint.MemberCategory; +import org.springframework.aot.hint.ReflectionHints; +import org.springframework.aot.hint.RuntimeHints; +import org.springframework.aot.hint.TypeHint; + +import static org.assertj.core.api.Assertions.assertThat; + +/** + * Tests for {@link DataSourceBuilderRuntimeHints}. + * + * @author Phillip Webb + */ +class DataSourceBuilderRuntimeHintsTests { + + @Test + void shouldRegisterDataSourceConstructors() { + ReflectionHints hints = registerHints(); + Stream.of(com.mchange.v2.c3p0.ComboPooledDataSource.class, org.h2.jdbcx.JdbcDataSource.class, + com.zaxxer.hikari.HikariDataSource.class, org.apache.commons.dbcp2.BasicDataSource.class, + oracle.jdbc.datasource.OracleDataSource.class, oracle.ucp.jdbc.PoolDataSource.class, + org.postgresql.ds.PGSimpleDataSource.class, + org.springframework.jdbc.datasource.SimpleDriverDataSource.class, + org.apache.tomcat.jdbc.pool.DataSource.class).forEach((dataSourceType) -> { + TypeHint typeHint = hints.getTypeHint(dataSourceType); + assertThat(typeHint).withFailMessage(() -> "No hints found for data source type " + dataSourceType) + .isNotNull(); + Set memberCategories = typeHint.getMemberCategories(); + assertThat(memberCategories).containsExactly(MemberCategory.INVOKE_PUBLIC_CONSTRUCTORS); + }); + } + + private ReflectionHints registerHints() { + RuntimeHints hints = new RuntimeHints(); + new DataSourceBuilderRuntimeHints().registerHints(hints, getClass().getClassLoader()); + return hints.reflection(); + } + +}