Conversores de atributo JPA

1. Introdução

Neste artigo rápido, cobriremos o uso dos Conversores de Atributo disponíveis no JPA 2.1 - que, simplesmente, nos permitem mapear tipos JDBC para classes Java.

Usaremos o Hibernate 5 como nossa implementação JPA aqui.

2. Criando um conversor

Vamos mostrar como implementar um conversor de atributo para uma classe Java personalizada.

Primeiro, vamos criar uma classePersonName - que será convertida mais tarde:

public class PersonName implements Serializable {

    private String name;
    private String surname;

    // getters and setters
}

Então, vamos adicionar um atributo do tipoPersonName a uma classe@Entity:

@Entity(name = "PersonTable")
public class Person {

    private PersonName personName;

    //...
}

Agora precisamos criar um conversor que transforme o atributoPersonName em uma coluna do banco de dados e vice-versa. Em nosso caso, converteremos o atributo em um valorString que contém os campos de nome e sobrenome.

Para fazer issowe have to annotate our converter class with @Converter and implement the AttributeConverter interface. Vamos parametrizar a interface com os tipos da classe e a coluna do banco de dados, nesta ordem:

@Converter
public class PersonNameConverter implements
  AttributeConverter {

    private static final String SEPARATOR = ", ";

    @Override
    public String convertToDatabaseColumn(PersonName personName) {
        if (personName == null) {
            return null;
        }

        StringBuilder sb = new StringBuilder();
        if (personName.getSurname() != null && !personName.getSurname()
            .isEmpty()) {
            sb.append(personName.getSurname());
            sb.append(SEPARATOR);
        }

        if (personName.getName() != null
          && !personName.getName().isEmpty()) {
            sb.append(personName.getName());
        }

        return sb.toString();
    }

    @Override
    public PersonName convertToEntityAttribute(String dbPersonName) {
        if (dbPersonName == null || dbPersonName.isEmpty()) {
            return null;
        }

        String[] pieces = dbPersonName.split(SEPARATOR);

        if (pieces == null || pieces.length == 0) {
            return null;
        }

        PersonName personName = new PersonName();
        String firstPiece = !pieces[0].isEmpty() ? pieces[0] : null;
        if (dbPersonName.contains(SEPARATOR)) {
            personName.setSurname(firstPiece);

            if (pieces.length >= 2 && pieces[1] != null
              && !pieces[1].isEmpty()) {
                personName.setName(pieces[1]);
            }
        } else {
            personName.setName(firstPiece);
        }

        return personName;
    }
}

Observe que tivemos que implementar 2 métodos:convertToDatabaseColumn()econvertToEntityAttribute().

Os dois métodos são usados para converter do atributo em uma coluna do banco de dados e vice-versa.

3. Usando o conversor

To use our converter, we just need to add the @Convert annotation to the attribute and specify the converter class we want to use:

@Entity(name = "PersonTable")
public class Person {

    @Convert(converter = PersonNameConverter.class)
    private PersonName personName;

    // ...
}

Finalmente, vamos criar um teste de unidade para ver se realmente funciona.

Para fazer isso, primeiro vamos armazenar um objetoPerson em nosso banco de dados:

@Test
public void givenPersonName_whenSaving_thenNameAndSurnameConcat() {
    String name = "name";
    String surname = "surname";

    PersonName personName = new PersonName();
    personName.setName(name);
    personName.setSurname(surname);

    Person person = new Person();
    person.setPersonName(personName);

    Long id = (Long) session.save(person);

    session.flush();
    session.clear();
}

A seguir, vamos testar sePersonName foi armazenado conforme definimos no conversor - recuperando esse campo da tabela do banco de dados:

@Test
public void givenPersonName_whenSaving_thenNameAndSurnameConcat() {
    // ...

    String dbPersonName = (String) session.createNativeQuery(
      "select p.personName from PersonTable p where p.id = :id")
      .setParameter("id", id)
      .getSingleResult();

    assertEquals(surname + ", " + name, dbPersonName);
}

Vamos também testar se a conversão do valor armazenado no banco de dados para a classePersonName funciona conforme definido no conversor, escrevendo uma consulta que recupera toda a classePerson:

@Test
public void givenPersonName_whenSaving_thenNameAndSurnameConcat() {
    // ...

    Person dbPerson = session.createNativeQuery(
      "select * from PersonTable p where p.id = :id", Person.class)
        .setParameter("id", id)
        .getSingleResult();

    assertEquals(dbPerson.getPersonName()
      .getName(), name);
    assertEquals(dbPerson.getPersonName()
      .getSurname(), surname);
}

4. Conclusão

Neste breve tutorial, mostramos como usar os recém-introduzidos Conversores de Atributos no JPA 2.1.

Como sempre, o código-fonte completo dos exemplos está disponívelover on GitHub.

TOC

Conversores de atributo JPA