Spring JPA实体属性类型转换器并反序列化工具类详解

背景介绍

在开发中，我们经常会用到Spring Data JPA（Java Persistence API）来访问数据库并进行数据持久化，而在实际开发中，我们会面临很多原本无法直接与数据库进行映射的数据类型。这时候我们需要将其转换为数据库可以映射的类型进行存储操作。针对这一问题，Spring提供了很好的解决方案，即使用Spring JPA的实体属性类型转换器并反序列化工具类，以实现实体属性类型转换的功能。

解决方案

JPA为了让应用程序只需要使用对象而不用了解具体的ORM技术细节，将Java对象映射到数据库中，提供了一系列属性转换器，可以将Java类型与数据库类型进行映射。Spring JPA的实体属性类型转换器并反序列化工具类则是应用上述思想的一种较为方便的方式。

实体属性类型转换器

在JPA的实体类中，我们可以使用@Convert注解来进行类型转换，具体而言，我们需要进行以下操作：

步骤一：编写类型转换器

首先我们需要编写一个类，实现javax.persistence.AttributeConverter接口，用于数据类型的转换。假设我们现在要把Java中的Color类型转换成数据库的String类型，可以写以下代码：

@Converter
public class ColorToStringConverter implements AttributeConverter<Color, String> {
    @Override
    public String convertToDatabaseColumn(Color color) {
        return color.getRed() + "," + color.getGreen() + "," + color.getBlue();
    }

    @Override
    public Color convertToEntityAttribute(String dbData) {
        if(dbData == null) {
            return null;
        }

        String[] rgb = dbData.split(",");
        int r = Integer.parseInt(rgb[0]);
        int g = Integer.parseInt(rgb[1]);
        int b = Integer.parseInt(rgb[2]);
        return new Color(r, g, b);
    }
}

这里，我们编写了一个将Color类型转换成字符串的类型转换器ColorToStringConverter。在该类型转换器中，convertToDatabaseColumn()方法把Java中的Color对象转换成了String类型，并将其写入数据库；而convertToEntityAttribute()方法则将数据库中的String类型转换成Java中的Color类型。我们可以按需编写其他类型转换器。

步骤二：标记转换器

接下来，在我们的实体类的属性上使用@Convert注解标记上面编写的类型转换器，让其自动将属性转换成指定的类型。下面是一个例子：

@Entity
@Table(name = "book")
public class Book {

  ...

  @Convert(converter = ColorToStringConverter.class)
  private Color color;

  ...

}

这表示Book实体类的color属性将会被ColorToStringConverter天然地转换成数据库中的String类型，而在从数据库中读取出的String类型数据将会被自动转换成Java的Color类型。

反序列化工具类

除了类型转换，我们有时还需要在数据库中持久化自定义的对象。在这种情况下，我们还需为这些类编写相应的序列化与反序列化方法。

Spring提供了很好的解决方案，它为我们提供了一种可以自动把Java对象进行序列化和反序列化的工具类，这便是JpaRepository。

步骤一：创建工具类

以一个Book实体类为例，我们首先创建一个接口继承JpaRepository接口，并在泛型参数中指定实体类类型：

public interface BookRepository extends JpaRepository<Book, Long> {

}

接着我们可以在BookRepository中添加一些自定义的方法。

步骤二：使用工具类

通过使用工具类，就可以实现序列化与反序列化。以下为将List转换为String类型并存储到数据库中的示例：

  @Autowired
  private BookRepository bookRepository;

  private void storeList() {
    List<String> tags = Arrays.asList("tag1", "tag2", "tag3");
    Book book = new Book();
    book.setTags(tags);

    bookRepository.save(book);
  }

在这个示例中，我们创建了一个List<String>并把它赋值给一个Book实例的tags属性。接下来，我们把该实例存储到数据库中。JPA自动把List<String>转换成String类型，存储到了数据库中。

以下是从数据库中读出存储的字符串并转换成List的示例：

  private void loadList() {
    List<Book> books = bookRepository.findAll();
    for (Book book : books) {
      List<String> tags = book.getTags();
      System.out.println(tags);
    }
  }

在这个示例中，我们从数据库中读取到了一个Book实例，其中包含有关于存储在其中的tags的字符串信息。我们仅要调用标准getter方法，就可以获得转换回原来的List类型了。