Spring/spring-data-relational
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

DATAJDBC-455 - Polishing.

Browse Source 
Rename Dialect bean to jdbcDialect to avoid generic bean names. Require JdbcOperations in DialectResolver. Rename JdbcDialectResolver to DialectResolver for consistent naming with R2DBC the underlying type is a Dialect.

Tweak Javadoc and extend documentation with custom conversions include from Spring Data Commons. Extract MySQL identifier processing defaults into constant.

Original pull request: #202.
This commit is contained in:
Mark Paluch
2020-03-26 11:07:50 +01:00
parent 1c4ff416c9
commit ef02b6e9cd
10 changed files with 157 additions and 93 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
spring-data-jdbc/src/main/java/org/springframework/data/jdbc/repository/config/AbstractJdbcConfiguration.java
View File

@@ -130,8 +130,17 @@ public class AbstractJdbcConfiguration {
jdbcConverter, operations);
}
/**
* Resolves a {@link Dialect JDBC dialect} by inspecting {@link NamedParameterJdbcOperations}.
*
* @param operations the {@link NamedParameterJdbcOperations} allowing access to a {@link java.sql.Connection}.
* @return
* @since 2.0
* @throws org.springframework.data.jdbc.repository.config.DialectResolver.NoDialectException if the {@link Dialect}
* cannot be determined.
*/
@Bean
public Dialect dialect(NamedParameterJdbcOperations template) {
return JdbcDialectResolver.getDialect(template);
public Dialect jdbcDialect(NamedParameterJdbcOperations operations) {
return DialectResolver.getDialect(operations.getJdbcOperations());
}
}

47
spring-data-jdbc/src/main/java/org/springframework/data/jdbc/repository/config/JdbcDialectResolver.java → spring-data-jdbc/src/main/java/org/springframework/data/jdbc/repository/config/DialectResolver.java
View File

@@ -19,6 +19,7 @@ import java.sql.Connection;
import java.sql.DatabaseMetaData;
import java.sql.SQLException;
import java.util.List;
import java.util.Locale;
import java.util.Optional;
import javax.sql.DataSource;
@@ -34,42 +35,43 @@ import org.springframework.data.relational.core.sql.IdentifierProcessing;
import org.springframework.data.util.Optionals;
import org.springframework.jdbc.core.ConnectionCallback;
import org.springframework.jdbc.core.JdbcOperations;
import org.springframework.jdbc.core.namedparam.NamedParameterJdbcOperations;
import org.springframework.lang.Nullable;
import org.springframework.util.StringUtils;
/**
* Resolves a {@link Dialect} from a {@link DataSource} using {@link JdbcDialectProvider}. Dialect resolution uses
* Spring's {@link SpringFactoriesLoader spring.factories} to determine available extensions.
* Resolves a {@link Dialect}. Resolution typically uses {@link JdbcOperations} to obtain and inspect a
* {@link Connection}. Dialect resolution uses Spring's {@link SpringFactoriesLoader spring.factories} to determine
* available {@link JdbcDialectProvider extensions}.
*
* @author Jens Schauder
* @since 2.0
* @see Dialect
* @see SpringFactoriesLoader
*/
public class JdbcDialectResolver {
public class DialectResolver {
private static final List<JdbcDialectProvider> DETECTORS = SpringFactoriesLoader
.loadFactories(JdbcDialectProvider.class, JdbcDialectResolver.class.getClassLoader());
.loadFactories(JdbcDialectProvider.class, DialectResolver.class.getClassLoader());
// utility constructor.
private JdbcDialectResolver() {}
private DialectResolver() {}
/**
* Retrieve a {@link Dialect} by inspecting a {@link DataSource}.
* Retrieve a {@link Dialect} by inspecting a {@link Connection}.
*
* @param template must not be {@literal null}.
* @param operations must not be {@literal null}.
* @return the resolved {@link Dialect} {@link NoDialectException} if the database type cannot be determined from
* {@link DataSource}.
* @throws NoDialectException if no {@link Dialect} can be found.
*/
public static Dialect getDialect(NamedParameterJdbcOperations template) {
public static Dialect getDialect(JdbcOperations operations) {
return DETECTORS.stream() //
.map(it -> it.getDialect(template)) //
.map(it -> it.getDialect(operations)) //
.flatMap(Optionals::toStream) //
.findFirst() //
.orElseThrow(() -> new NoDialectException(
String.format("Cannot determine a dialect for %s. Please provide a Dialect.", template)));
String.format("Cannot determine a dialect for %s. Please provide a Dialect.", operations)));
}
/**
@@ -84,22 +86,18 @@ public class JdbcDialectResolver {
/**
* Returns a {@link Dialect} for a {@link DataSource}.
*
* @param template the {@link org.springframework.jdbc.core.namedparam.NamedParameterJdbcTemplate} to be used with
* the {@link Dialect}.
* @param operations the {@link JdbcOperations} to be used with the {@link Dialect}.
* @return {@link Optional} containing the {@link Dialect} if the {@link JdbcDialectProvider} can provide a dialect
* object, otherwise {@link Optional#empty()}.
*/
Optional<Dialect> getDialect(NamedParameterJdbcOperations template);
Optional<Dialect> getDialect(JdbcOperations operations);
}
static public class DefaultDialectProvider implements JdbcDialectProvider {
@Override
public Optional<Dialect> getDialect(NamedParameterJdbcOperations template) {
JdbcOperations operations = template.getJdbcOperations();
public Optional<Dialect> getDialect(JdbcOperations operations) {
return Optional.ofNullable(operations.execute((ConnectionCallback<Dialect>) DefaultDialectProvider::getDialect));
}
@Nullable
@@ -107,7 +105,7 @@ public class JdbcDialectResolver {
DatabaseMetaData metaData = connection.getMetaData();
String name = metaData.getDatabaseProductName().toLowerCase();
String name = metaData.getDatabaseProductName().toLowerCase(Locale.ENGLISH);
if (name.contains("hsql")) {
return HsqlDbDialect.INSTANCE;
@@ -129,10 +127,12 @@ public class JdbcDialectResolver {
// getIdentifierQuoteString() returns a space " " if identifier quoting is not
// supported.
final String quoteString = metaData.getIdentifierQuoteString();
final IdentifierProcessing.Quoting quoting = " ".equals(quoteString) ? IdentifierProcessing.Quoting.NONE : new IdentifierProcessing.Quoting(quoteString);
String quoteString = metaData.getIdentifierQuoteString();
IdentifierProcessing.Quoting quoting = StringUtils.hasText(quoteString)
? new IdentifierProcessing.Quoting(quoteString)
: IdentifierProcessing.Quoting.NONE;
final IdentifierProcessing.LetterCasing letterCasing;
IdentifierProcessing.LetterCasing letterCasing;
// IdentifierProcessing tries to mimic the behavior of unquoted identifiers for their quoted variants.
if (metaData.supportsMixedCaseIdentifiers()) {
letterCasing = IdentifierProcessing.LetterCasing.AS_IS;
@@ -144,12 +144,13 @@ public class JdbcDialectResolver {
// But if it does happen, we go with the ANSI default.
letterCasing = IdentifierProcessing.LetterCasing.UPPER_CASE;
}
return IdentifierProcessing.create(quoting, letterCasing);
}
}
/**
* Exception thrown when {@link JdbcDialectResolver} cannot resolve a {@link Dialect}.
* Exception thrown when {@link DialectResolver} cannot resolve a {@link Dialect}.
*/
public static class NoDialectException extends NonTransientDataAccessException {

2
spring-data-jdbc/src/main/resources/META-INF/spring.factories
View File

@@ -1,2 +1,2 @@
org.springframework.data.repository.core.support.RepositoryFactorySupport=org.springframework.data.jdbc.repository.support.JdbcRepositoryFactory
org.springframework.data.jdbc.repository.config.JdbcDialectResolver$JdbcDialectProvider=org.springframework.data.jdbc.repository.config.JdbcDialectResolver.DefaultDialectProvider
org.springframework.data.jdbc.repository.config.DialectResolver$JdbcDialectProvider=org.springframework.data.jdbc.repository.config.DialectResolver.DefaultDialectProvider

4
spring-data-jdbc/src/test/java/org/springframework/data/jdbc/repository/config/AbstractJdbcConfigurationIntegrationTests.java
View File

@@ -76,7 +76,7 @@ public class AbstractJdbcConfigurationIntegrationTests {
}
@Configuration
static class Infrastructure {
static class Infrastructure {
@Bean
public NamedParameterJdbcOperations jdbcOperations() {
@@ -90,7 +90,7 @@ public class AbstractJdbcConfigurationIntegrationTests {
@Override
@Bean
public Dialect dialect(NamedParameterJdbcOperations template) {
public Dialect jdbcDialect(NamedParameterJdbcOperations operations) {
return HsqlDbDialect.INSTANCE;
}
}

4
spring-data-jdbc/src/test/java/org/springframework/data/jdbc/repository/config/EnableJdbcRepositoriesIntegrationTests.java
View File

@@ -158,8 +158,8 @@ public class EnableJdbcRepositoriesIntegrationTests {
}
@Bean
Dialect dialect(@Qualifier("qualifierJdbcOperations") NamedParameterJdbcOperations template) {
return JdbcDialectResolver.getDialect(template);
Dialect jdbcDialect(@Qualifier("qualifierJdbcOperations") NamedParameterJdbcOperations operations) {
return DialectResolver.getDialect(operations.getJdbcOperations());
}
}
}

2
spring-data-jdbc/src/test/java/org/springframework/data/jdbc/repository/config/MyBatisJdbcConfigurationIntegrationTests.java
View File

@@ -69,7 +69,7 @@ public class MyBatisJdbcConfigurationIntegrationTests extends AbstractJdbcConfig
@Override
@Bean
public Dialect dialect(NamedParameterJdbcOperations template) {
public Dialect jdbcDialect(NamedParameterJdbcOperations operations) {
return HsqlDbDialect.INSTANCE;
}
}

6
spring-data-jdbc/src/test/java/org/springframework/data/jdbc/testing/TestConfiguration.java
View File

@@ -37,7 +37,7 @@ import org.springframework.data.jdbc.core.convert.JdbcCustomConversions;
import org.springframework.data.jdbc.core.convert.RelationResolver;
import org.springframework.data.jdbc.core.convert.SqlGeneratorSource;
import org.springframework.data.jdbc.core.mapping.JdbcMappingContext;
import org.springframework.data.jdbc.repository.config.JdbcDialectResolver;
import org.springframework.data.jdbc.repository.config.DialectResolver;
import org.springframework.data.jdbc.repository.support.JdbcRepositoryFactory;
import org.springframework.data.relational.core.dialect.Dialect;
import org.springframework.data.relational.core.mapping.NamingStrategy;
@@ -125,7 +125,7 @@ public class TestConfiguration {
}
@Bean
Dialect dialect(NamedParameterJdbcOperations template) {
return JdbcDialectResolver.getDialect(template);
Dialect jdbcDialect(NamedParameterJdbcOperations operations) {
return DialectResolver.getDialect(operations.getJdbcOperations());
}
}