Browse Source

Consider PGobject as simple type.

Closes #920
Original pull request: #1008.
pull/1018/head
Nikita Konev 5 years ago committed by Mark Paluch
parent
commit
d1e8e722c1
No known key found for this signature in database
GPG Key ID: 4406B84C1661DCD1
  1. 2
      .gitignore
  2. 239
      spring-data-jdbc/src/test/java/org/springframework/data/jdbc/core/dialect/PostgresDialectIntegrationTests.java
  3. 8
      spring-data-jdbc/src/test/resources/org.springframework.data.jdbc.core.dialect/PostgresDialectIntegrationTests-postgres.sql
  4. 26
      spring-data-relational/src/main/java/org/springframework/data/relational/core/dialect/PostgresDialect.java

2
.gitignore vendored

@ -10,4 +10,4 @@ target/ @@ -10,4 +10,4 @@ target/
*.graphml
#prevent license accepting file to get accidentially commited to git
container-license-acceptance.txt
container-license-acceptance.txt

239
spring-data-jdbc/src/test/java/org/springframework/data/jdbc/core/dialect/PostgresDialectIntegrationTests.java

@ -0,0 +1,239 @@ @@ -0,0 +1,239 @@
package org.springframework.data.jdbc.core.dialect;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.junit.jupiter.api.AfterAll;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.condition.EnabledIfSystemProperty;
import org.junit.jupiter.api.extension.ExtendWith;
import org.postgresql.util.PGobject;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.*;
import org.springframework.core.convert.converter.Converter;
import org.springframework.data.annotation.Id;
import org.springframework.data.convert.CustomConversions;
import org.springframework.data.convert.ReadingConverter;
import org.springframework.data.convert.WritingConverter;
import org.springframework.data.jdbc.core.convert.JdbcCustomConversions;
import org.springframework.data.jdbc.core.mapping.JdbcSimpleTypes;
import org.springframework.data.jdbc.repository.config.EnableJdbcRepositories;
import org.springframework.data.jdbc.testing.TestConfiguration;
import org.springframework.data.mapping.model.SimpleTypeHolder;
import org.springframework.data.relational.core.dialect.Dialect;
import org.springframework.data.relational.core.mapping.Table;
import org.springframework.data.repository.CrudRepository;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit.jupiter.SpringExtension;
import org.springframework.transaction.annotation.Transactional;
import java.io.ByteArrayOutputStream;
import java.io.PrintStream;
import java.sql.SQLException;
import java.util.ArrayList;
import java.util.List;
import java.util.Optional;
import static org.assertj.core.api.Assertions.assertThat;
/**
* Tests for PostgreSQL Dialect.
* Start this test with -Dspring.profiles.active=postgres
*
* @author Nikita Konev
*/
@EnabledIfSystemProperty(named = "spring.profiles.active", matches = "postgres")
@ContextConfiguration
@Transactional
@ExtendWith(SpringExtension.class)
public class PostgresDialectIntegrationTests {
private static final ByteArrayOutputStream capturedOutContent = new ByteArrayOutputStream();
private static PrintStream previousOutput;
@Profile("postgres")
@Configuration
@Import(TestConfiguration.class)
@EnableJdbcRepositories(considerNestedRepositories = true,
includeFilters = @ComponentScan.Filter(value = CustomerRepository.class, type = FilterType.ASSIGNABLE_TYPE))
static class Config {
private final ObjectMapper objectMapper = new ObjectMapper();
@Bean
Class<?> testClass() {
return PostgresDialectIntegrationTests.class;
}
@WritingConverter
static class PersonDataWritingConverter extends AbstractPostgresJsonWritingConverter<PersonData> {
public PersonDataWritingConverter(ObjectMapper objectMapper) {
super(objectMapper, true);
}
}
@ReadingConverter
static class PersonDataReadingConverter extends AbstractPostgresJsonReadingConverter<PersonData> {
public PersonDataReadingConverter(ObjectMapper objectMapper) {
super(objectMapper, PersonData.class);
}
}
@WritingConverter
static class SessionDataWritingConverter extends AbstractPostgresJsonWritingConverter<SessionData> {
public SessionDataWritingConverter(ObjectMapper objectMapper) {
super(objectMapper, true);
}
}
@ReadingConverter
static class SessionDataReadingConverter extends AbstractPostgresJsonReadingConverter<SessionData> {
public SessionDataReadingConverter(ObjectMapper objectMapper) {
super(objectMapper, SessionData.class);
}
}
private List<Object> storeConverters(Dialect dialect) {
List<Object> converters = new ArrayList<>();
converters.addAll(dialect.getConverters());
converters.addAll(JdbcCustomConversions.storeConverters());
return converters;
}
protected List<?> userConverters() {
final List<Converter> list = new ArrayList<>();
list.add(new PersonDataWritingConverter(objectMapper));
list.add(new PersonDataReadingConverter(objectMapper));
list.add(new SessionDataWritingConverter(objectMapper));
list.add(new SessionDataReadingConverter(objectMapper));
return list;
}
@Primary
@Bean
CustomConversions jdbcCustomConversions(Dialect dialect) {
SimpleTypeHolder simpleTypeHolder = new SimpleTypeHolder(dialect.simpleTypes(), JdbcSimpleTypes.HOLDER);
return new JdbcCustomConversions(CustomConversions.StoreConversions.of(simpleTypeHolder, storeConverters(dialect)),
userConverters());
}
}
@BeforeAll
public static void ba() {
previousOutput = System.out;
System.setOut(new PrintStream(capturedOutContent));
}
@AfterAll
public static void aa() {
System.setOut(previousOutput);
previousOutput = null;
}
/**
* An abstract class for building your own converter for PostgerSQL's JSON[b].
*/
static class AbstractPostgresJsonReadingConverter<T> implements Converter<PGobject, T> {
private final ObjectMapper objectMapper;
private final Class<T> valueType;
public AbstractPostgresJsonReadingConverter(ObjectMapper objectMapper, Class<T> valueType) {
this.objectMapper = objectMapper;
this.valueType = valueType;
}
@Override
public T convert(PGobject pgObject) {
try {
final String source = pgObject.getValue();
return objectMapper.readValue(source, valueType);
} catch (JsonProcessingException e) {
throw new RuntimeException("Unable to deserialize to json " + pgObject, e);
}
}
}
/**
* An abstract class for building your own converter for PostgerSQL's JSON[b].
*/
static class AbstractPostgresJsonWritingConverter<T> implements Converter<T, PGobject> {
private final ObjectMapper objectMapper;
private final boolean jsonb;
public AbstractPostgresJsonWritingConverter(ObjectMapper objectMapper, boolean jsonb) {
this.objectMapper = objectMapper;
this.jsonb = jsonb;
}
@Override
public PGobject convert(T source) {
try {
final PGobject pGobject = new PGobject();
pGobject.setType(jsonb ? "jsonb" : "json");
pGobject.setValue(objectMapper.writeValueAsString(source));
return pGobject;
} catch (JsonProcessingException | SQLException e) {
throw new RuntimeException("Unable to serialize to json " + source, e);
}
}
}
@Data
@AllArgsConstructor
@Table("customers")
public static class Customer {
@Id
private Long id;
private String name;
private PersonData personData;
private SessionData sessionData;
}
@Data
@NoArgsConstructor
@AllArgsConstructor
public static class PersonData {
private int age;
private String petName;
}
@Data
@NoArgsConstructor
@AllArgsConstructor
public static class SessionData {
private String token;
private Long ttl;
}
interface CustomerRepository extends CrudRepository<Customer, Long> {
}
@Autowired
CustomerRepository customerRepository;
@Test
void testWarningShouldNotBeShown() {
final Customer saved = customerRepository.save(new Customer(null, "Adam Smith", new PersonData(30, "Casper"), null));
assertThat(saved.getId()).isNotZero();
final Optional<Customer> byId = customerRepository.findById(saved.getId());
assertThat(byId.isPresent()).isTrue();
final Customer foundCustomer = byId.get();
assertThat(foundCustomer.getName()).isEqualTo("Adam Smith");
assertThat(foundCustomer.getPersonData()).isNotNull();
assertThat(foundCustomer.getPersonData().getAge()).isEqualTo(30);
assertThat(foundCustomer.getPersonData().getPetName()).isEqualTo("Casper");
assertThat(foundCustomer.getSessionData()).isNull();
assertThat(capturedOutContent.toString()).doesNotContain("although it doesn't convert from a store-supported type");
}
}

8
spring-data-jdbc/src/test/resources/org.springframework.data.jdbc.core.dialect/PostgresDialectIntegrationTests-postgres.sql

@ -0,0 +1,8 @@ @@ -0,0 +1,8 @@
DROP TABLE customers;
CREATE TABLE customers (
id BIGSERIAL PRIMARY KEY,
name TEXT NOT NULL,
person_data JSONB,
session_data JSONB
);

26
spring-data-relational/src/main/java/org/springframework/data/relational/core/dialect/PostgresDialect.java

@ -17,7 +17,10 @@ package org.springframework.data.relational.core.dialect; @@ -17,7 +17,10 @@ package org.springframework.data.relational.core.dialect;
import java.util.Collection;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import java.util.function.Consumer;
import org.springframework.data.relational.core.sql.IdentifierProcessing;
import org.springframework.data.relational.core.sql.LockOptions;
@ -34,6 +37,7 @@ import org.springframework.util.ClassUtils; @@ -34,6 +37,7 @@ import org.springframework.util.ClassUtils;
* @author Mark Paluch
* @author Myeonghyeon Lee
* @author Jens Schauder
* @author Nikita Konev
* @since 1.1
*/
public class PostgresDialect extends AbstractDialect {
@ -203,4 +207,26 @@ public class PostgresDialect extends AbstractDialect { @@ -203,4 +207,26 @@ public class PostgresDialect extends AbstractDialect {
return IdentifierProcessing.create(Quoting.ANSI, LetterCasing.LOWER_CASE);
}
/*
* (non-Javadoc)
* @see org.springframework.data.relational.core.dialect.Dialect#simpleTypes()
*/
@Override
public Set<Class<?>> simpleTypes() {
Set<Class<?>> simpleTypes = new HashSet<>();
ifClassPresent("org.postgresql.util.PGobject", simpleTypes::add);
return Collections.unmodifiableSet(simpleTypes);
}
/**
* If the class is present on the class path, invoke the specified consumer {@code action} with the class object,
* otherwise do nothing.
*
* @param action block to be executed if a value is present.
*/
private static void ifClassPresent(String className, Consumer<Class<?>> action) {
if (ClassUtils.isPresent(className, PostgresDialect.class.getClassLoader())) {
action.accept(ClassUtils.resolveClassName(className, PostgresDialect.class.getClassLoader()));
}
}
}

Loading…
Cancel
Save