如何编程添加特定实体字段的属性转换器

Question

假设我有javax.persistence.AttributeConverter实现FooConverter，我想将此转换器应用于特定实体字段。

如果我使用注释方法，它看起来像：

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

ON 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不是选项。

Answer 1

jpa规格仅提供2个应用转换器的选项：全局@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();

我不确定是否有一种更干净的方法来告诉Hibernate仅转换特定实体字段，而不是@Convert(converter = FooConverter.class)。

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

包装班

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

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>