Upgrade to Hibernate 5.1
Upgrade to Hibernate 5.1, whilst still retaining compatibility with Hibernate 4.3. This commit introduces the following changes: * Add SpringPhysicalNamingStrategy to provides lowercase/underscore table names support. This should be equivalent to the previous SpringNamingStrategy that was used with Hibernate 4. No ImplicitNamingStrategy is provided since the Hibernate 5 defaults appear to be roughly equivalent to the conventions used in Spring Boot 1.3 spring.jpa.hibernate.naming. * Migrate `spring.jpa.hibernate.naming-strategy` to `spring.jpa.hibernate.naming.strategy` and provide additional properties for physical and implicit. * Add `spring.jpa.hibernate.use-new-id-generator-mappings` property and default to `false` when on Hibernate 5 to retain back compatibility. See gh-2763pull/5535/merge
Phillip Webb
9 years ago
parent
7fc990a3cb
commit
0db1194007
@ -0,0 +1,54 @@
|
||||
/*
|
||||
* Copyright 2012-2016 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
|
||||
*
|
||||
* http://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.orm.jpa;
|
||||
|
||||
import org.springframework.util.ClassUtils;
|
||||
|
||||
/**
|
||||
* Supported Hibernate versions.
|
||||
*
|
||||
* @author Phillip Webb
|
||||
*/
|
||||
enum HibernateVersion {
|
||||
|
||||
/**
|
||||
* Version 4.
|
||||
*/
|
||||
V4,
|
||||
|
||||
/**
|
||||
* Version 5.
|
||||
*/
|
||||
V5;
|
||||
|
||||
private static final String HIBERNATE_5_CLASS = "org.hibernate.boot.model."
|
||||
+ "naming.PhysicalNamingStrategy";
|
||||
|
||||
private static HibernateVersion running;
|
||||
|
||||
public static HibernateVersion getRunning() {
|
||||
if (running == null) {
|
||||
setRunning(ClassUtils.isPresent(HIBERNATE_5_CLASS, null) ? V5 : V4);
|
||||
}
|
||||
return running;
|
||||
}
|
||||
|
||||
static void setRunning(HibernateVersion running) {
|
||||
HibernateVersion.running = running;
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,176 @@
|
||||
/*
|
||||
* Copyright 2012-2016 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
|
||||
*
|
||||
* http://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.orm.jpa;
|
||||
|
||||
import java.sql.SQLException;
|
||||
import java.util.Map;
|
||||
|
||||
import javax.sql.DataSource;
|
||||
|
||||
import org.hibernate.cfg.AvailableSettings;
|
||||
import org.junit.After;
|
||||
import org.junit.Test;
|
||||
|
||||
import org.springframework.boot.context.properties.EnableConfigurationProperties;
|
||||
import org.springframework.boot.orm.jpa.hibernate.SpringPhysicalNamingStrategy;
|
||||
import org.springframework.boot.test.util.EnvironmentTestUtils;
|
||||
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
|
||||
import org.springframework.context.annotation.Configuration;
|
||||
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
import static org.assertj.core.api.Assertions.entry;
|
||||
import static org.mockito.BDDMockito.given;
|
||||
import static org.mockito.Mockito.mock;
|
||||
|
||||
/**
|
||||
* Tests for {@link JpaProperties}.
|
||||
*
|
||||
* @author Stephane Nicoll
|
||||
*/
|
||||
public class JpaPropertiesTests {
|
||||
|
||||
private AnnotationConfigApplicationContext context;
|
||||
|
||||
@After
|
||||
public void close() {
|
||||
HibernateVersion.setRunning(null);
|
||||
if (this.context != null) {
|
||||
this.context.close();
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
public void hibernate4CustomNamingStrategy() throws Exception {
|
||||
JpaProperties properties = load(HibernateVersion.V4,
|
||||
"spring.jpa.hibernate.naming.strategy:"
|
||||
+ "org.hibernate.cfg.EJB3NamingStrategy");
|
||||
Map<String, String> hibernateProperties = properties
|
||||
.getHibernateProperties(mockStandaloneDataSource());
|
||||
assertThat(hibernateProperties).contains(entry("hibernate.ejb.naming_strategy",
|
||||
"org.hibernate.cfg.EJB3NamingStrategy"));
|
||||
assertThat(hibernateProperties).doesNotContainKeys(
|
||||
"hibernate.implicit_naming_strategy",
|
||||
"hibernate.physical_naming_strategy");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void hibernate4CustomNamingStrategyViaJpaProperties() throws Exception {
|
||||
JpaProperties properties = load(HibernateVersion.V4,
|
||||
"spring.jpa.properties.hibernate.ejb.naming_strategy:"
|
||||
+ "org.hibernate.cfg.EJB3NamingStrategy");
|
||||
Map<String, String> hibernateProperties = properties
|
||||
.getHibernateProperties(mockStandaloneDataSource());
|
||||
String actual = hibernateProperties.get("hibernate.ejb.naming_strategy");
|
||||
// You can't override this one from spring.jpa.properties because it has an
|
||||
// opinionated default
|
||||
assertThat(actual).isNotEqualTo("org.hibernate.cfg.EJB3NamingStrategy");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void hibernate5NoCustomNamingStrategy() throws Exception {
|
||||
JpaProperties properties = load(HibernateVersion.V5);
|
||||
Map<String, String> hibernateProperties = properties
|
||||
.getHibernateProperties(mockStandaloneDataSource());
|
||||
assertThat(hibernateProperties).doesNotContainKeys(
|
||||
"hibernate.ejb.naming_strategy", "hibernate.implicit_naming_strategy");
|
||||
assertThat(hibernateProperties).containsEntry(
|
||||
"hibernate.physical_naming_strategy",
|
||||
SpringPhysicalNamingStrategy.class.getName());
|
||||
}
|
||||
|
||||
@Test
|
||||
public void hibernate5CustomNamingStrategies() throws Exception {
|
||||
JpaProperties properties = load(HibernateVersion.V5,
|
||||
"spring.jpa.hibernate.naming.implicit-strategy:com.example.Implicit",
|
||||
"spring.jpa.hibernate.naming.physical-strategy:com.example.Physical");
|
||||
Map<String, String> hibernateProperties = properties
|
||||
.getHibernateProperties(mockStandaloneDataSource());
|
||||
assertThat(hibernateProperties).contains(
|
||||
entry("hibernate.implicit_naming_strategy", "com.example.Implicit"),
|
||||
entry("hibernate.physical_naming_strategy", "com.example.Physical"));
|
||||
assertThat(hibernateProperties)
|
||||
.doesNotContainKeys("hibernate.ejb.naming_strategy");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void hibernate5CustomNamingStrategiesViaJpaProperties() throws Exception {
|
||||
JpaProperties properties = load(HibernateVersion.V5,
|
||||
"spring.jpa.properties.hibernate.implicit_naming_strategy:com.example.Implicit",
|
||||
"spring.jpa.properties.hibernate.physical_naming_strategy:com.example.Physical");
|
||||
Map<String, String> hibernateProperties = properties
|
||||
.getHibernateProperties(mockStandaloneDataSource());
|
||||
// You can override them as we don't provide any default
|
||||
assertThat(hibernateProperties).contains(
|
||||
entry("hibernate.implicit_naming_strategy", "com.example.Implicit"),
|
||||
entry("hibernate.physical_naming_strategy", "com.example.Physical"));
|
||||
assertThat(hibernateProperties)
|
||||
.doesNotContainKeys("hibernate.ejb.naming_strategy");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void useNewIdGeneratorMappingsDefaultHibernate4() throws Exception {
|
||||
JpaProperties properties = load(HibernateVersion.V4);
|
||||
Map<String, String> hibernateProperties = properties
|
||||
.getHibernateProperties(mockStandaloneDataSource());
|
||||
assertThat(hibernateProperties)
|
||||
.doesNotContainKey(AvailableSettings.USE_NEW_ID_GENERATOR_MAPPINGS);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void useNewIdGeneratorMappingsDefaultHibernate5() throws Exception {
|
||||
JpaProperties properties = load(HibernateVersion.V5);
|
||||
Map<String, String> hibernateProperties = properties
|
||||
.getHibernateProperties(mockStandaloneDataSource());
|
||||
assertThat(hibernateProperties)
|
||||
.containsEntry(AvailableSettings.USE_NEW_ID_GENERATOR_MAPPINGS, "false");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void useNewIdGeneratorMappingsTrue() throws Exception {
|
||||
JpaProperties properties = load(HibernateVersion.V5,
|
||||
"spring.jpa.hibernate.use-new-id-generator-mappings:true");
|
||||
Map<String, String> hibernateProperties = properties
|
||||
.getHibernateProperties(mockStandaloneDataSource());
|
||||
assertThat(hibernateProperties)
|
||||
.containsEntry(AvailableSettings.USE_NEW_ID_GENERATOR_MAPPINGS, "true");
|
||||
}
|
||||
|
||||
@SuppressWarnings("unchecked")
|
||||
private DataSource mockStandaloneDataSource() throws SQLException {
|
||||
DataSource ds = mock(DataSource.class);
|
||||
given(ds.getConnection()).willThrow(SQLException.class);
|
||||
return ds;
|
||||
}
|
||||
|
||||
private JpaProperties load(HibernateVersion hibernateVersion, String... environment) {
|
||||
HibernateVersion.setRunning(hibernateVersion);
|
||||
AnnotationConfigApplicationContext ctx = new AnnotationConfigApplicationContext();
|
||||
EnvironmentTestUtils.addEnvironment(ctx, environment);
|
||||
ctx.register(TestConfiguration.class);
|
||||
ctx.refresh();
|
||||
this.context = ctx;
|
||||
JpaProperties properties = this.context.getBean(JpaProperties.class);
|
||||
return properties;
|
||||
}
|
||||
|
||||
@Configuration
|
||||
@EnableConfigurationProperties(JpaProperties.class)
|
||||
static class TestConfiguration {
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,82 @@
|
||||
/*
|
||||
* Copyright 2012-2016 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
|
||||
*
|
||||
* http://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.orm.jpa.hibernate;
|
||||
|
||||
import java.util.Locale;
|
||||
|
||||
import org.hibernate.boot.model.naming.Identifier;
|
||||
import org.hibernate.boot.model.naming.PhysicalNamingStrategy;
|
||||
import org.hibernate.engine.jdbc.env.spi.JdbcEnvironment;
|
||||
|
||||
/**
|
||||
* Hibernate {@link PhysicalNamingStrategy} that follows Spring recommended naming
|
||||
* conventions.
|
||||
*
|
||||
* @author Phillip Webb
|
||||
* @since 1.4.0
|
||||
*/
|
||||
public class SpringPhysicalNamingStrategy implements PhysicalNamingStrategy {
|
||||
|
||||
@Override
|
||||
public Identifier toPhysicalCatalogName(Identifier name,
|
||||
JdbcEnvironment jdbcEnvironment) {
|
||||
return apply(name);
|
||||
}
|
||||
|
||||
@Override
|
||||
public Identifier toPhysicalSchemaName(Identifier name,
|
||||
JdbcEnvironment jdbcEnvironment) {
|
||||
return apply(name);
|
||||
}
|
||||
|
||||
@Override
|
||||
public Identifier toPhysicalTableName(Identifier name,
|
||||
JdbcEnvironment jdbcEnvironment) {
|
||||
return apply(name);
|
||||
}
|
||||
|
||||
@Override
|
||||
public Identifier toPhysicalSequenceName(Identifier name,
|
||||
JdbcEnvironment jdbcEnvironment) {
|
||||
return apply(name);
|
||||
}
|
||||
|
||||
@Override
|
||||
public Identifier toPhysicalColumnName(Identifier name,
|
||||
JdbcEnvironment jdbcEnvironment) {
|
||||
return apply(name);
|
||||
}
|
||||
|
||||
private Identifier apply(Identifier name) {
|
||||
if (name == null) {
|
||||
return null;
|
||||
}
|
||||
StringBuilder text = new StringBuilder(name.getText().replace('.', '_'));
|
||||
for (int i = 1; i < text.length() - 1; i++) {
|
||||
if (isDashRequired(text.charAt(i - 1), text.charAt(i), text.charAt(i + 1))) {
|
||||
text.insert(i++, '_');
|
||||
}
|
||||
}
|
||||
return new Identifier(text.toString().toLowerCase(Locale.ROOT), name.isQuoted());
|
||||
}
|
||||
|
||||
private boolean isDashRequired(char before, char current, char after) {
|
||||
return Character.isLowerCase(before) && Character.isUpperCase(current)
|
||||
&& Character.isLowerCase(after);
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,64 @@
|
||||
/*
|
||||
* Copyright 2012-2016 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
|
||||
*
|
||||
* http://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.orm.jpa.hibernate;
|
||||
|
||||
import org.hibernate.boot.Metadata;
|
||||
import org.hibernate.boot.MetadataSources;
|
||||
import org.hibernate.boot.registry.BootstrapServiceRegistry;
|
||||
import org.hibernate.boot.registry.StandardServiceRegistry;
|
||||
import org.hibernate.boot.registry.StandardServiceRegistryBuilder;
|
||||
import org.hibernate.cfg.AvailableSettings;
|
||||
import org.hibernate.dialect.H2Dialect;
|
||||
import org.hibernate.mapping.PersistentClass;
|
||||
import org.hibernate.service.ServiceRegistry;
|
||||
import org.junit.Before;
|
||||
import org.junit.Test;
|
||||
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
|
||||
/**
|
||||
* Tests for {@link SpringPhysicalNamingStrategy}.
|
||||
*
|
||||
* @author Phillip Webb
|
||||
*/
|
||||
public class SpringPhysicalNamingStrategyTests {
|
||||
|
||||
private Metadata metadata;
|
||||
|
||||
@Before
|
||||
public void setup() throws Exception {
|
||||
MetadataSources metadataSources = new MetadataSources();
|
||||
metadataSources.addAnnotatedClass(TelephoneNumber.class);
|
||||
StandardServiceRegistry serviceRegistry = getServiceRegistry(metadataSources);
|
||||
this.metadata = metadataSources.getMetadataBuilder(serviceRegistry)
|
||||
.applyPhysicalNamingStrategy(new SpringPhysicalNamingStrategy()).build();
|
||||
}
|
||||
|
||||
private StandardServiceRegistry getServiceRegistry(MetadataSources metadataSources) {
|
||||
ServiceRegistry registry = metadataSources.getServiceRegistry();
|
||||
return new StandardServiceRegistryBuilder((BootstrapServiceRegistry) registry)
|
||||
.applySetting(AvailableSettings.DIALECT, H2Dialect.class).build();
|
||||
}
|
||||
|
||||
@Test
|
||||
public void tableNameShouldBeLowercaseUnderscore() throws Exception {
|
||||
PersistentClass binding = this.metadata
|
||||
.getEntityBinding(TelephoneNumber.class.getName());
|
||||
assertThat(binding.getTable().getQuotedName()).isEqualTo("telephone_number");
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,39 @@
|
||||
/*
|
||||
* Copyright 2012-2016 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
|
||||
*
|
||||
* http://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.orm.jpa.hibernate;
|
||||
|
||||
import javax.persistence.Entity;
|
||||
import javax.persistence.GeneratedValue;
|
||||
import javax.persistence.Id;
|
||||
|
||||
/**
|
||||
* Simple entity used in {@link SpringPhysicalNamingStrategyTests}.
|
||||
*
|
||||
* @author Phillip Webb
|
||||
*/
|
||||
@Entity
|
||||
public class TelephoneNumber {
|
||||
|
||||
@Id
|
||||
@GeneratedValue
|
||||
Long id;
|
||||
|
||||
String areaCode;
|
||||
|
||||
String number;
|
||||
|
||||
}
|
||||
Loading…
Reference in New Issue