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

时间:2019-02-14 07:03:26

标签: java hibernate

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

如果我要使用注释方法,它将看起来像:

FooConverter

在orm XML映射上,它看起来像:

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

但是,我想在<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不是一个选择。

1 个答案:

答案 0 :(得分:4)

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

我不确定是否有一种更干净的方法来告诉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>