如何在JPA中持久化带PostgreSQL XML列的实体模型？

这问题我之前在项目里也碰到过，PostgreSQL的xml类型比较特殊，JPA默认不会自动把String映射成PostgreSQL的xml类型，所以才会报那个类型不匹配的错误。下面给你两种实用的解决方案，涵盖持久化和读取的全流程：

方案一：用Hibernate专属注解（适用于Hibernate作为JPA实现的场景） #

如果你的项目用的是Hibernate作为JPA的底层实现，直接用Hibernate提供的@Type注解就能搞定，它会自动处理String和PostgreSQL xml类型的转换：

@Entity
class StorageOfXml {
    @Id
    String id;
    // 去掉@Lob，改用Hibernate的SqlXmlType
    @Column(columnDefinition = "xml")
    @Type(type = "org.hibernate.type.SqlXmlType")
    String myXml;
}

持久化操作 #

直接传入原始的XML字符串就行，不需要转义（比如不用写<，直接写<）：

StorageOfXml s = new StorageOfXml();
s.setId("sample");
// 直接传正常的XML内容
s.setMyXml("<foo><bar></bar></foo>");
entityManager.persist(s);

读取操作 #

读取的时候JPA会自动把数据库里的xml类型转换成String，直接获取字段值即可：

StorageOfXml stored = entityManager.find(StorageOfXml.class, "sample");
String xmlContent = stored.getMyXml();
// xmlContent就是"<foo><bar></bar></foo>"

方案二：自定义JPA属性转换器（通用方案，不依赖Hibernate） #

如果不想绑定到Hibernate的专属API，可以写一个JPA标准的AttributeConverter，手动把String转换成PostgreSQL的PGobject类型：

第一步：实现转换器类 #

import javax.persistence.AttributeConverter;
import javax.persistence.Converter;
import org.postgresql.util.PGobject;
import java.sql.SQLException;

// autoApply=true表示自动应用到所有映射到xml列的String字段
@Converter(autoApply = true)
public class StringToXmlConverter implements AttributeConverter<String, PGobject> {

    @Override
    public PGobject convertToDatabaseColumn(String xmlString) {
        PGobject xmlPgObject = new PGobject();
        xmlPgObject.setType("xml");
        try {
            xmlPgObject.setValue(xmlString);
        } catch (SQLException e) {
            throw new RuntimeException("转换String到PostgreSQL XML类型失败", e);
        }
        return xmlPgObject;
    }

    @Override
    public String convertToEntityAttribute(PGobject dbXmlObject) {
        return dbXmlObject != null ? dbXmlObject.getValue() : null;
    }
}

第二步：在实体中应用转换器 #

@Entity
class StorageOfXml {
    @Id
    String id;
    @Column(columnDefinition = "xml")
    // 如果转换器没开autoApply，就手动指定转换器
    @Convert(converter = StringToXmlConverter.class)
    String myXml;
}

持久化与读取 #

和方案一完全一样，直接用原始XML字符串持久化，读取时直接获取String即可，转换器会在后台自动处理类型转换。

注意事项 #

• 不要转义XML实体：如果你传入<foo>这种转义后的内容，数据库里会存储转义后的字符串，读取出来也会是转义后的内容，这不是我们想要的XML格式。
• 依赖PostgreSQL驱动：方案二中用到了PGobject，需要确保项目里引入了PostgreSQL的JDBC驱动依赖。

内容的提问来源于stack exchange，提问作者bumblebeen