mybatis plus 枚举类型处理

来源：CSDN 作者：linzhiji
链接：https://blog.csdn.net/linzhiji/article/details/109705536

前言：
在开发中，我们经常会用到诸如：性别(男/女)、审核状态(未审核/审核中/已审核)之类的数据，通常会在数据库中使用一个数字类型的字段来标识，比如：性别，用1来表示男，2来表示女，而在代码中一般会定义成enum类型或静态常量来避免在业务代码中出现“0/1”这种魔法值，但是在数据库存储及前后端交互的时候，就需要进行转化；无论是在SQL、前端还是后台转化，都需要写相应的代码，无形中增加了开发工作量；mybatis-plus实现了对该问题的处理，能够让我们在查询数据库时，直接能够返回字段标识的意思。配置如下：

第一步：
创建枚举类，在需要存储数据库的属性上添加@EnumValue注解，在需要前端展示的属性上添加@JsonValue注解；

package com.demo.mybatisplus.constant;

import com.baomidou.mybatisplus.annotation.EnumValue;
import com.fasterxml.jackson.annotation.JsonValue;

public enum SexEnum {

    MAN(1, "男"),
    WOMAN(2, "女");

    @EnumValue
    private Integer key;

    @JsonValue
    private String display;

    SexEnum(Integer key, String display) {
        this.key = key;
        this.display = display;
    }

    public Integer getKey() {
        return key;
    }

    public String getDisplay() {
        return display;
    }
}

第二步：
application.properties文件里添加配置，定义扫描枚举类的包路径；

#配置枚举 支持通配符 * 或者 ; 分割
mybatis-plus.type-enums-package=com.demo.mybatisplus.constant
#mybatis-plus.configuration.default-enum-type-handler=org.apache.ibatis.type.EnumOrdinalTypeHandler

或

#配置枚举 支持通配符 * 或者 ; 分割
mybatis-plus:
  type-enums-package: com.demo.mybatisplus.constant
  configuration:
    default-enum-type-handler: org.apache.ibatis.type.EnumOrdinalTypeHandler

第三步：
pojo中的sex属性设置为枚举SexEnum；

    @ApiModelProperty(value = "性别")
    @TableField("sex")
    private SexEnum sex;

测试：

    @Test
    public void insert() {
        UserInfo userInfo = new UserInfo();
        userInfo.setAge(22);
        userInfo.setName("李四");
        userInfo.setSex(SexEnum.WOMAN);
        userInfoMapper.insert(userInfo);
        System.out.println(userInfo);
    }

数据库保存的值：

前端显示的值：

[
    {"id":"1","name":"张三","age":11,"sex":"男"},
    {"id":"2","name":"李四","age":22,"sex":"女"},
    {"id":"3","name":"王五","age":33,"sex":"男"}
]

注意事项：
@EnumValue标记的枚举类属性的类型要和数据库字段的类型对应，否则在查询数据的时候无法转化为枚举类型，并显示为null；
如果查询的时候，数据库字段的值匹配不到枚举，程序运行时并不会报错，而是显示为null；
在保存的时候，前端需要传递@JsonValue标记的枚举类属性的值，即"男/女"；因为Enum的属性ordinal(int)，在测试过程中，传枚举值在枚举类中的定义顺序(或者称为索引，顺序从0开始)，也可以转换为相应的枚举值，比如：上面定义的SexEnum枚举，前端传0或者"0"，会转换成MAN，传1或者"1"会转换成WOMAN；传其他值会报异常：com.fasterxml.jackson.databind.exc.InvalidFormatException: Cannot deserialize value of type com.demo.mybatisplus.constant.SexEnum from String "3": not one of the values accepted for Enum class: [女, 男]或com.fasterxml.jackson.databind.exc.InvalidFormatException: Cannot deserialize value of type com.demo.mybatisplus.constant.SexEnum from number 3: index value outside legal index range [0..2]；