JPA+Enum枚舉實現(xiàn)步驟流程

更新時間：2025年10月16日 14:27:57 作者：匍匐前進の程序猿

本文介紹了如何在Java中創(chuàng)建學生實體類及Sex枚舉類,并通過@JsonValue注解實現(xiàn)枚舉序列化,使用JPA的@Converter及AttributeConverter完成枚舉與數(shù)據(jù)庫字段的轉換,最后通過controller層進行新增與查詢測試

1.創(chuàng)建實體類（學生實體，Sex枚舉類）

@Data
@Table
@Entity
public class Student {
	@Id
	@GeneratedValue(generator = "uuid")
	@GenericGenerator(name = "uuid",strategy = "org.hibernate.id.UUIDGenerator")
	private String id;
	private String name; // 姓名
	private Sex sex; // 性別
}

使用@JsonValue來標記枚舉想要返回的序列化值

注意：建議枚舉的編碼不要使用數(shù)字

public enum Sex { // 性別
    GIRL("FM","女"),BOY("M","男");

    private String code;
    private String sName;
    
    Sex(String code,String sName) {
        this.code = code;
        this.sName = sName;
    }
    
    public String getCode() {
        return code;
    }
   /**
     * 將數(shù)據(jù)庫查詢到編碼自動轉為文字返回給前端
     */
    @JsonValue
    public String getsName() {
        return sName;
    }
}

2.創(chuàng)建Converter（屬性轉換器）

@Converter注解的作用是告訴JPA這是一個屬性轉換器
autoApply =true的作用是表示這是一個全局的屬性轉換器，也就是說這個轉換器對所有的實體類都起作用
AttributeConverter<需要被轉換的enum,與數(shù)據(jù)庫表字段對應的java類型>

@Converter(autoApply = true)
public class SexConverter implements AttributeConverter<Sex, String> {
    /**
     * 此方法告訴jpa,數(shù)據(jù)庫里存的值,即插入和更新操作時執(zhí)行；
     */
    @Override
    public String convertToDatabaseColumn(Sex sex) {
        if(sex == null){
            return null;
        }
        return sex.getCode(); // 此處存儲的是編碼
    }

    /**
     * 此方法告訴Java從數(shù)據(jù)庫里取出的值對應的是哪個enum值，即查詢操作時執(zhí)行。
     */
    @Override
    public Sex convertToEntityAttribute(String code) {
         if(code == null){
            return null;
        }
        for (Sex sex : Sex.values()) {
            if(sex.getCode().equals(code)){
                return sex; // 獲取到當前Sex信息
            }
        }
        throw new IllegalArgumentException(); // 或者給個默認的enum eg: return Category.UNKNOWN
    }
}

3.創(chuàng)建controller層

@RestController
@RequestMapping("/student")
public class StudentController {
	@Autowired private StudentRepo repo;
	
	@PostMapping(path = "/save")
	public Student save(@RequestBody Student student) {
		repo.save(student);
		return student;
	}
	
	@GetMapping(path = "/list")
	public List<Student> list() {
		return repo.findAll();
	}
}

當需要在后端使用時，用此方法–>Sex.GIRL/Sex.BOY