如何使用JPA映射JSON列到Java对象

Question

我们有一张有很多柱子的大桌子。在我们移动到MySQL集群后，表无法创建，因为：

错误1118 (42000)：行大小过大。使用的表类型（不包括BLOB）的最大行大小为14000。这包括存储开销，检查手册。您必须将一些列更改为TEXT或BLOB

例如：

@Entity @Table (name = "appconfigs", schema = "myproject")
public class AppConfig implements Serializable
{
    @Id @Column (name = "id", nullable = false)
    @GeneratedValue (strategy = GenerationType.IDENTITY)
    private int id;

    @OneToOne @JoinColumn (name = "app_id")
    private App app;

    @Column(name = "param_a")
    private ParamA parama;

    @Column(name = "param_b")
    private ParamB paramb;
}

它是一个用于存储配置参数的表。我在想，我们可以将一些列组合成一个列，并将其存储为JSON对象，并将其转换为Java对象。

例如：

@Entity @Table (name = "appconfigs", schema = "myproject")
public class AppConfig implements Serializable
{
    @Id @Column (name = "id", nullable = false)
    @GeneratedValue (strategy = GenerationType.IDENTITY)
    private int id;

    @OneToOne @JoinColumn (name = "app_id")
    private App app;

    @Column(name = "params")
    //How to specify that this should be mapped to JSON object?
    private Params params;
}

我们定义了：

public class Params implements Serializable
{
    private ParamA parama;
    private ParamB paramb;
}

通过使用它，我们可以将所有列合并为一个列并创建表。或者我们可以把整张桌子分成几张桌子。就我个人而言，我更喜欢第一种解决方案。

无论如何，我的问题是如何映射Params列，它是文本，包含Java对象的JSON字符串？

Answer 1

如果在响应客户端时需要将json类型属性映射为json格式（例如rest API响应），请添加@JsonRawValue，如下所示：

@Column(name = "params", columnDefinition = "json")
@JsonRawValue
private String params;

这可能不会为服务器端使用进行DTO映射，但客户端会将属性正确格式化为json。

Answer 2

JPAAttributeConverter对于映射JSON对象类型来说太有限了，特别是如果您想将它们保存为JSON二进制文件的话。

您不必创建自定义Hibernate类型来获得JSON支持，只需使用Hibernate类型OSS项目即可。

例如，如果您使用的是Hibernate 5.2或更新版本，那么您需要在Mavenpom.xml配置文件中添加以下依赖项：

<dependency>
    <groupId>com.vladmihalcea</groupId>
    <artifactId>hibernate-types-52</artifactId>
    <version>${hibernate-types.version}</version> 
</dependency> 

现在，您需要使用@MappedSuperclass在实体属性级别或者更好的是在基类的类级别声明新类型：

@TypeDef(name = "json", typeClass = JsonType.class)

实体映射将如下所示：

@Type(type = "json")
@Column(columnDefinition = "json")
private Location location;

如果您使用的是Hibernate 5.2或更高版本，那么JSON类型将由mysql57dial自动注册。

否则，您需要自己注册：

public class MySQLJsonDialect extends MySQL55Dialect {

    public MySQLJsonDialect() {
        super();
        this.registerColumnType(Types.JAVA_OBJECT, "json");
    }
}

然后，设置hibernate。方言Hibernate属性使用刚刚创建的MySQLJsonDialect类的完全限定类名。

Answer 3

可以使用JPA转换器将实体映射到数据库。只需向params字段添加类似于此的注释：

@Convert(converter = JpaConverterJson.class)

然后以类似的方式创建类（这将转换泛型对象，您可能希望对其进行专门化）：

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

  private final static ObjectMapper objectMapper = new ObjectMapper();

  @Override
  public String convertToDatabaseColumn(Object meta) {
    try {
      return objectMapper.writeValueAsString(meta);
    } catch (JsonProcessingException ex) {
      return null;
      // or throw an error
    }
  }

  @Override
  public Object convertToEntityAttribute(String dbData) {
    try {
      return objectMapper.readValue(dbData, Object.class);
    } catch (IOException ex) {
      // logger.error("Unexpected IOEx decoding json from database: " + dbData);
      return null;
    }
  }

}

就是这样：您可以使用这个类将表中的任何对象序列化为json。