JPA属性コンバータ

JPA属性コンバーター

1. 前書き

このクイック記事では、JPA 2.1で使用可能な属性コンバーターの使用法について説明します。これにより、簡単に言えば、JDBCタイプをJavaクラスにマップできます。

ここでは、JPA実装としてHibernate5を使用します。

2. コンバーターの作成

カスタムJavaクラスの属性コンバーターを実装する方法を示します。

まず、PersonNameクラスを作成しましょう–後で変換されます：

public class PersonName implements Serializable {

    private String name;
    private String surname;

    // getters and setters
}

次に、タイプPersonNameの属性を@Entityクラスに追加します。

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

    private PersonName personName;

    //...
}

次に、PersonName属性をデータベース列に（またはその逆に）変換するコンバーターを作成する必要があります。この例では、属性を名前フィールドと名前フィールドの両方を含むString値に変換します。

これを行うには、we have to annotate our converter class with @Converter and implement the AttributeConverter interface.クラスのタイプとデータベース列を使用して、インターフェイスを次の順序でパラメータ化します。

@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;
    }
}

convertToDatabaseColumn()とconvertToEntityAttribute().の2つのメソッドを実装する必要があることに注意してください。

2つのメソッドは、属性からデータベース列へ、またはその逆に変換するために使用されます。

3. コンバーターを使用する

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;

    // ...
}

最後に、単体テストを作成して、実際に機能することを確認しましょう。

そのためには、最初にPersonオブジェクトをデータベースに保存します。

@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();
}

次に、データベーステーブルからそのフィールドを取得することにより、PersonNameがコンバータで定義したとおりに格納されていることをテストします。

@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);
}

また、データベースに格納されている値からPersonNameクラスへの変換が、Personクラス全体を取得するクエリを記述して、コンバーターで定義されているとおりに機能することをテストしましょう。

@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. 結論

この短いチュートリアルでは、JPA 2.1で新しく導入された属性コンバーターの使用方法を示しました。

いつものように、例の完全なソースコードはover on GitHubで入手できます。

TOC

JPA属性コンバータ