在JPA注解中，有個@Convert注解，其中需要傳入一個Class作為convert參數，該class需要實現AttributeConverter<X,Y>接口。下面來看看AttributeConverter接口的作用。

AttributeConverter<X,Y>

實體屬性類型轉換器。主要使用場景：

• 持久化enum
• 加解密數據
• 持久化日期

簡單化操作，用持久化enum枚舉來進行一個操作。AttributeConverter<X,Y>該接口中需要實現兩個方法：

• 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<UserAction, Integer> {
        @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<X,Y>:BaseEnumConverter<X,Y>
• 所有的枚舉中定義一個public靜態類繼承抽象類

1. BaseEnum.java

/**
 * 枚舉基類.
 * @author Wang.ch
 *
 * @param <T> 數據庫存儲的java類型
 */
public interface BaseEnum<Y> {
    /**
     * 存取到數據庫中的值.
     * @return
     */
    public Y getValue();
}

2. BaseEnumConverter.java

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

    @SuppressWarnings("unchecked")
    public BaseEnumConverter() {
        this.xclazz = (Class<X>) (((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<Y> 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<Integer> {
    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<UserAction, Integer>{
        
    }
}

需要注意的是，在上面的代碼中，BaseEnumConverter使用了BaseEnum作為X的限定類型，但是實際上并未能真正限定傳入的數據類型是一個枚舉類型，顯然BaseEnumConverter只適用于枚舉類型，因為在類初始化時，使用了values這個Method反射，只有枚舉類型才有。在其他的值類型轉換時，可以參照枚舉自定義其他的X限定類型。

小技巧，如果枚舉沒有這么復雜，則完全可以用@Enumerated(EnumType.ORDINAL)和@Enumerated(EnumType.STRING)讓數據庫自動進行轉換。