枚举映射 - 标签 - lihuu — 系统工程、AI 工具链与 Rust 开发博客

Jpa中自定义枚举映射

lihuu — Thu, 26 Dec 2024 13:48:17 +0800

Jpa 中默认自带了@Enumerated 注解，它默认提供了两种形式 String 和 ordinal，表示按照枚举的名字和枚举值的顺序，但是有时候我们需要自定义枚举映射，比如枚举的值不是枚举的名字，而是枚举的某个属性值。这时候我们可以使用@Convert 注解来实现自定义枚举映射。

使用默认的@Enumerated 注解实现字段映射

        
        
        
    
@Entity
public class User{
  @Id
  private Integer userId;

  private String name;

  private Integer age;

  @Enumerated(STRING)
  private Status status;
}

public enum Status{
   ACTIVE,DELETED,BANED
}

使用自定义枚举映射

创建一个用于映射的枚举

        
        
        
    
public enum Status{
  ACTIVE(1),DELETED(0),BANED(-1);

  private final int value;

  public int getValue(){
    return this.value;
  }

  public static Status of(int value){
    for(Status status:Status.values()){
      if(status.getValue() == value){
        return status;
      }
    }
    throw new IllegalArgumentException("Invalid value: "+value);
  }

}

实现一个枚举转换器

        
        
        
    

//@Converter(autoApply=true)
public class StatusConverter implements AttributeConverter<Status,Integer>{

  @Override
  public Integer convertToDatabaseColumn(Status attribute){
    return attribute.getValue();
  }

  @Override
  public Status convertToEntityAttribute(Integer dbData){
    return Status.of(dbData);
  }
}

使用@Convert 注解 � 用

        
@Entity
public class User{
  @Id
  private Integer userId;

  private String name;

  private Integer age;

  @Convert(converter = StatusConverter.class, attributeName = "status")
  private Status status;

}

在上面的例子中使用了@Convert 注解，它有两个属性，一个是 converter，用于指定转换器，另一个是 attributeName，用于指定要转换的属性名，如果转换器设置了 autoApply，则可以省略这个注解。配置完之后，我们就可以在实体类中使用自定义的枚举映射了。