如何在编程中为特定实体字段添加属性转换器？

Question

假设我有一个名为FooConverter的javax.persistence.AttributeConverter实现，并且我想将此转换器应用于特定实体字段。

如果我使用注释方法，它会像这样：

@Column
@Convert(converter = FooConverter.class)
private String barField;

在ORM XML映射中，它看起来像这样:

<entity class="com.example.FooBarEntity">
  <convert converter="com.example.FooConverter" attribute-name="barField"/>
</entity>

但是，我想在javax.persistence.EntityManagerFactory配置期间通过程序添加此转换器。

import org.hibernate.cfg.Configuration;
import org.springframework.orm.hibernate5.LocalSessionFactoryBuilder;

private EntityManagerFactory buildEntityManagerFactory() {
  Configuration config = new LocalSessionFactoryBuilder(dataSource);
  config.addAnnotatedClass(com.example.FooBarEntity.class);
  // I looking for something like config.addConverter(FooConverter, FooBarEntity, barField);
  return config.buildSessionFactory();
}

虽然有 config.addAttributeConverter 方法，但它似乎只创建转换器实例而不将其绑定到特定的实体属性。然而，我想仅针对特定的 String 字段应用该转换器，因此 autoApply 不是一个选项。

- user9440008

---

你是否检查了addAttributeConverter(org.hibernate.cfg.AttributeConverterDefinition)，以便与https://docs.jboss.org/hibernate/orm/4.3/javadocs/org/hibernate/cfg/AttributeConverterDefinition.html一起使用？ - rakwaht

Answer 1

JPA规范只提供了两种应用转换器的选项：全局@Converter（autoApply = true）和字段级别@ Convert（converter = FooConverter.class）（或它们的XML等效项）。

JPA转换器仅了解实体属性类型和数据库列类型。 没有访问实体实例甚至实体类型以构建条件（由实体字段）转换逻辑。

您可以像这样通过编程方式添加一个AttributeConverter转换器：

LocalSessionFactoryBuilder builder = new LocalSessionFactoryBuilder(dataSource);
builder.addAnnotatedClasses(FooBarEntity.class);
builder.addAttributeConverter(FooConverter.class, /*autoApply:*/true);
EntityManagerFactory entityManagerFactory = builder.buildSessionFactory();

我不确定有比使用@Convert(converter = FooConverter.class)更简洁的方法来告诉Hibernate仅转换特定实体字段。

将转换器应用于特定实体字段的解决方法：

包装类

创建需要转换的字符串的包装器：

public class Bar {

  private final String value;

  public Bar(String value) {
    this.value = value;
  }

  public String getValue() {
    return value;
  }
}

@Entity
public class FooBarEntity {

  private Bar barField;

  public void setBarField(String value) {
    this.barField = new Bar(value);
  }

  //...
}

声明一个自动应用的转换器：

@Converter(autoApply = true)
public class FooConverter implements AttributeConverter<Bar, String> {

  @Override
  public String convertToDatabaseColumn(Bar bar) {
    return Optional.ofNullable(bar).map(Bar::getValue/*anything*/).orElse(null);
  }

  @Override
  public Status convertToEntityAttribute(String value) {
    return Optional.ofNullable(value).map(Bar::new).orElse(null);
  }
}

JPA实体监听器

如果需要将String类型转换为String类型（即源类型和目标类型相同），则可以使用实体监听器。实体监听器可以访问实体本身，因此可以具备复杂的条件逻辑。

@Entity
public class FooBarEntity {

  private String barField;
}

创建一个实体监听器：

public class FooEntityListener {

  @PrePersist
  @PreUpdate
  public void convertToDatabaseColumn(Object entity) {
    if (entity instanceof FooBar) {
      entity.setBarField(/*conversion to DB column*/entity.getBarField());
    }
  }

  @PostLoad
  public void convertToEntityAttribute(Object entity) {
    if (entity instanceof FooBar) {
      entity.setBarField(/*conversion to entity attribute*/entity.getBarField());
    }
  }
}

在 META-INF/orm.xml 中注册默认实体监听器：

<entity-mappings>
    <persistence-unit-metadata>
        <persistence-unit-defaults>
            <entity-listeners>
                <entity-listener class="com.example.FooEntityListener"/>
            </entity-listeners>
        </persistence-unit-defaults>
    </persistence-unit-metadata>
</entity-mappings>

- Eugene Khyst