spring jpa之实体属性类型转换器AttributeConverter,自定义Converter,通用Converter

在JPA注解中，有个@Convert注解，其中需要传入一个Class作为convert参数，该class需要实现AttributeConverter接口。下面来看看AttributeConverter接口的作用。

AttributeConverter

实体属性类型转换器。主要使用场景：

• 持久化enum
• 加解密数据
• 持久化日期

简单化操作，用持久化enum枚举来进行一个操作。AttributeConverter该接口中需要实现两个方法：

• y convertToDatabaseColumn(x) 作用：将实体属性x转化为y存储到数据库中，即插入和更新操作时执行；
• x convertToEntityAttribute(y) 作用：将数据库中的字段y转化为实体属性x，即查询操作时执行。

场景：用户登录时，记录用户的动作：登录，登出，注册，重置密码。

1. 创建一个枚举类UserAction

/**
 * 用户操作枚举.
 * @author Wang.ch
 *
 */
public enum UserAction {
    REG(0, "注册"), RESET(1, "重置密码"), LOGIN(2, "用户登录"), LOGOUT(3, "用户登出");
    private int value;
    private String desc;

    UserAction(int value, String desc) {
        this.value = value;
        this.desc = desc;
    }

    public int getValue() {
        return value;
    }

    public void setValue(int value) {
        this.value = value;
    }

    public String getDesc() {
        return desc;
    }

    public void setDesc(String desc) {
        this.desc = desc;
    }

    public static class Convert implements AttributeConverter {
        @Override
        public Integer convertToDatabaseColumn(UserAction attribute) {
            return attribute == null ? null : attribute.getValue();
        }

        @Override
        public UserAction convertToEntityAttribute(Integer dbData) {
            for (UserAction type : UserAction.values()) { //将数字转换为描述
                if (dbData.equals(type.getValue())) {
                    return type;
                }
            }
            throw new RuntimeException("Unknown database value: " + dbData);
        }
    }
}

其中，在已经把转换类Convert写入到了枚举当中。

2. 在实体内中添加注解

    @Convert(converter = UserAction.Convert.class)
    private UserAction action;

从转换类中的方法可以看出，在写入数据库时，jpa会调用convert的convertToDatabaseColumn方法，把UserAction枚举的value写入到库中，在反向查询时，通过数据库的值和遍历的枚举的value进行比较，然后返回UserAction实体。

数据的加密和日期的转换也就类似的操作了。

但是这样的每个枚举可能都要去写这样的转换类，可能会存在重复的操作。可以尝试写个通用的枚举转换类。

• 所有的枚举都实现一个接口:BaseEnum.java
• 写一个抽象类去实现AttributeConverter:BaseEnumConverter
• 所有的枚举中定义一个public静态类继承抽象类

1. BaseEnum.java

/**
 * 枚举基类.
 * @author Wang.ch
 *
 * @param  数据库存储的java类型
 */
public interface BaseEnum {
    /**
     * 存取到数据库中的值.
     * @return
     */
    public Y getValue();
}

2. BaseEnumConverter.java

public abstract class BaseEnumConverter, Y> implements AttributeConverter, Y> {
    private Class xclazz;
    private Method valuesMethod;

    @SuppressWarnings("unchecked")
    public BaseEnumConverter() {
        this.xclazz = (Class) (((ParameterizedType) this.getClass().getGenericSuperclass())
                .getActualTypeArguments())[0];
        try {
            valuesMethod = xclazz.getMethod("values");
        } catch (Exception e) {
            throw new RuntimeException("can't get values method from " + xclazz);
        }
    }

    @Override
    public Y convertToDatabaseColumn(BaseEnum attribute) {
        return attribute == null ? null : attribute.getValue();
    }

    @SuppressWarnings("unchecked")
    @Override
    public X convertToEntityAttribute(Y dbData) {
        try {
            X[] values = (X[]) valuesMethod.invoke(null);
            for (X x : values) {
                if (x.getValue().equals(dbData)) {
                    return x;
                }
            }
        } catch (Exception e) {
            throw new RuntimeException("can't convertToEntityAttribute" + e.getMessage());
        }
        throw new RuntimeException("unknown dbData " + dbData);
    }
}

3. 修改后的枚举:UserAction.java

/**
 * 用户操作枚举.
 * @author Wang.ch
 *
 */
public enum UserAction implements BaseEnum {
    REG(0, "注册"), RESET(1, "重置密码"), LOGIN(2, "用户登录"), LOGOUT(3, "用户登出");
    private Integer value;
    private String desc;

    UserAction(Integer value, String desc) {
        this.value = value;
        this.desc = desc;
    }

    public Integer getValue() {
        return value;
    }

    public void setValue(Integer value) {
        this.value = value;
    }

    public String getDesc() {
        return desc;
    }

    public void setDesc(String desc) {
        this.desc = desc;
    }
    
    public static class Convert2 extends BaseEnumConverter{
        
    }
}

需要注意的是，在上面的代码中，BaseEnumConverter使用了BaseEnum作为X的限定类型，但是实际上并未能真正限定传入的数据类型是一个枚举类型，显然BaseEnumConverter只适用于枚举类型，因为在类初始化时，使用了values这个Method反射，只有枚举类型才有。在其他的值类型转换时，可以参照枚举自定义其他的X限定类型。

---

小技巧，如果枚举没有这么复杂，则完全可以用@Enumerated(EnumType.ORDINAL)和@Enumerated(EnumType.STRING)让数据库自动进行转换。