【Mybatis-Plus】之通用枚举

表中有些值是固定的。例如（性别）。此时，我们可以使用Mybatis-Plus通用枚举来实现。

前提条件

• 以安装适合版本的Java、Maven仓库。
• 已搭建SpringBoot框架。
• 存在可连接的数据库（这里为MySQL）。
• 已经配置好Mybatis环境以及数据库配置、依赖项。

通用枚举步骤示例

创建通用枚举的步骤如下

• 添加包含枚举字段的数据表
• 添加通用枚举类型
• 配置通用扫描枚举
• 测试

添加数据表，包含枚举字段

这里表t_user设置性别字段。

 

创建通用枚举类型

新建枚举类型SexEnum，这里我使用了lombok，当然，不使用lombok可以直接编写枚举值的Getter方法。

 

/**
 * 性别枚举
 */
@Getter
public enum  SexEnum {

    MALE(1, "男"),
    FEMALE(2, "女");

    @EnumValue
    private  Integer sex;
    private  String sexName;

    SexEnum(Integer sex, String sexName){
        this.sex = sex;
        this.sexName = sexName;
    }

}  

对应的实体类如下：

@Data
@Builder
//@TableName("t_user")        // 设置实体类对应的表名
public class User  {

    // 将属性对应的字段指定为主键
    @TableId(value = "id",type = IdType.AUTO)             // 只有一个values属性，可以省略value = 。属性对应字段
    // ,type = IdType.AUTO 自动递增
    private Integer uid;
    private String username;
    private String password;

    private String name;
    private  Integer age;
    private  String email;
    private SexEnum sex;
    @TableLogic
    private Boolean isDelete;
}

扫描通用配置

可以根据习惯打开配置文件（.yml或.properties）,这里打开application.yml文件（ type-enums-package 表示枚举的包路径）。

mybatis-plus:
configuration:
# 配置MyBatis日志
log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
global-config:
db-config:
# 配置MyBatis-Plus操作表的默认前缀
table-prefix: t_
# 配置MyBatis-Plus的主键策略
id-type: auto
# 配置扫描通用枚举
type-enums-package: com.atguigu.mybatisplus.enums

测试

新建测试方法。我们看看能否将枚举值更新到数据库。

/**
 * 测试写入枚举
 */
@Test
public void  testSexEnum (){
    //设置性别信息为枚举项，会将@EnumValue注解所标识的属性值存储到数据库
    User user  = User.builder().name("李磊").sex(SexEnum.FEMALE).build();
    val result =userMapper.insert(user);
    System.out.println(result);
}

查看数据库，发现已经将枚举值写入数据库：

 

这里1表示“男”，2表示女。

查看样式时，显示的是枚举字符串，测试如下。

/**
 * 测试查询时写入值
 */
@Test
public void testSexEnumSelect(){
    userMapper.selectList(null).forEach(System.out::println);
}

输出的值如下：