当前位置: 代码迷 >> java >> 如何以编程方式为特定实体字段添加属性转换器?
  详细解决方案

如何以编程方式为特定实体字段添加属性转换器?

热度:31   发布时间:2023-07-31 13:44:13.0

假设我有名为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

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

我不确定有没有比@Convert(converter = FooConverter.class)@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>
  相关解决方案