Merge pull request #39941 from schauder

* pr/39941:
  Polish "Add property spring.data.jdbc.dialect"
  Add property spring.data.jdbc.dialect

Closes gh-39941
This commit is contained in:
Moritz Halbritter 2024-03-15 11:55:04 +01:00
commit ab5dee819b
3 changed files with 68 additions and 1 deletions

View File

@ -0,0 +1,45 @@
/*
* Copyright 2024 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.autoconfigure.data.jdbc;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.data.relational.core.dialect.Dialect;
/**
* Configuration properties for Spring Data JDBC.
*
* @author Jens Schauder
* @since 3.3.0
*/
@ConfigurationProperties(prefix = "spring.data.jdbc")
public class JdbcDataProperties {
/**
* Dialect to use. By default, the dialect is determined by inspecting the database
* connection.
*/
private Class<? extends Dialect> dialect;
public Class<? extends Dialect> getDialect() {
return this.dialect;
}
public void setDialect(Class<? extends Dialect> dialect) {
this.dialect = dialect;
}
}

View File

@ -19,6 +19,7 @@ package org.springframework.boot.autoconfigure.data.jdbc;
import java.util.Optional;
import java.util.Set;
import org.springframework.beans.BeanUtils;
import org.springframework.boot.autoconfigure.AutoConfiguration;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
@ -28,6 +29,7 @@ import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.boot.autoconfigure.domain.EntityScanner;
import org.springframework.boot.autoconfigure.jdbc.DataSourceTransactionManagerAutoConfiguration;
import org.springframework.boot.autoconfigure.jdbc.JdbcTemplateAutoConfiguration;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@ -59,6 +61,7 @@ import org.springframework.transaction.PlatformTransactionManager;
* @author Andy Wilkinson
* @author Stephane Nicoll
* @author Mark Paluch
* @author Jens Schauder
* @since 2.1.0
* @see EnableJdbcRepositories
*/
@ -67,6 +70,7 @@ import org.springframework.transaction.PlatformTransactionManager;
@ConditionalOnClass({ NamedParameterJdbcOperations.class, AbstractJdbcConfiguration.class })
@ConditionalOnProperty(prefix = "spring.data.jdbc.repositories", name = "enabled", havingValue = "true",
matchIfMissing = true)
@EnableConfigurationProperties(JdbcDataProperties.class)
public class JdbcRepositoriesAutoConfiguration {
@Configuration(proxyBeanMethods = false)
@ -82,8 +86,11 @@ public class JdbcRepositoriesAutoConfiguration {
private final ApplicationContext applicationContext;
SpringBootJdbcConfiguration(ApplicationContext applicationContext) {
private final JdbcDataProperties properties;
SpringBootJdbcConfiguration(ApplicationContext applicationContext, JdbcDataProperties properties) {
this.applicationContext = applicationContext;
this.properties = properties;
}
@Override
@ -141,6 +148,9 @@ public class JdbcRepositoriesAutoConfiguration {
@Bean
@ConditionalOnMissingBean
public Dialect jdbcDialect(NamedParameterJdbcOperations operations) {
if (this.properties.getDialect() != null) {
return BeanUtils.instantiateClass(this.properties.getDialect(), Dialect.class);
}
return super.jdbcDialect(operations);
}

View File

@ -40,6 +40,7 @@ import org.springframework.data.jdbc.core.JdbcAggregateTemplate;
import org.springframework.data.jdbc.core.convert.DataAccessStrategy;
import org.springframework.data.jdbc.core.convert.JdbcConverter;
import org.springframework.data.jdbc.core.convert.JdbcCustomConversions;
import org.springframework.data.jdbc.core.dialect.JdbcPostgresDialect;
import org.springframework.data.jdbc.core.mapping.JdbcMappingContext;
import org.springframework.data.jdbc.repository.config.AbstractJdbcConfiguration;
import org.springframework.data.jdbc.repository.config.EnableJdbcRepositories;
@ -58,6 +59,7 @@ import static org.mockito.Mockito.mock;
* @author Andy Wilkinson
* @author Stephane Nicoll
* @author Mark Paluch
* @author Jens Schauder
*/
class JdbcRepositoriesAutoConfigurationTests {
@ -181,6 +183,16 @@ class JdbcRepositoriesAutoConfigurationTests {
allowsUserToDefineCustomBean(DialectConfiguration.class, Dialect.class, "customDialect");
}
@Test
void allowsConfigurationOfDialectByProperty() {
this.contextRunner.with(database())
.withPropertyValues("spring.data.jdbc.dialect:" + JdbcPostgresDialect.class.getName())
.withConfiguration(AutoConfigurations.of(JdbcTemplateAutoConfiguration.class,
DataSourceTransactionManagerAutoConfiguration.class))
.withUserConfiguration(TestConfiguration.class)
.run((context) -> assertThat(context).hasSingleBean(JdbcPostgresDialect.class));
}
private void allowsUserToDefineCustomBean(Class<?> configuration, Class<?> beanType, String beanName) {
this.contextRunner.with(database())
.withConfiguration(AutoConfigurations.of(JdbcTemplateAutoConfiguration.class,