MybatisPlus 处理保存实体对象时，对于枚举类型的数据库存储问题

MybatisPlus 处理保存实体对象时，对于枚举类型的数据库存储问题以及解决 @EnumValue 失效问题

1. 前言
- 1.1 先看问题代码
- 1.2 存在的问题
2. 解决前言问题（自定义）
3. 解决上述 @EnumValue 失效问题
4. 推荐 Mybatis、MybatisPlus 其他相关问题的文章

1. 前言

1.1 先看问题代码

如下：
枚举类：

实体：
用自带的枚举解析器：

@TableField(typeHandler = EnumTypeHandler.class)
1

service 里：（通过mybatisPlus自带方法保存对象）

1.2 存在的问题

发现问题，如下：
数据库存的不是我想要的枚举的key，想存 1 和 2，这种方式没有实现
所以需自己写枚举转换器

2. 解决前言问题（自定义）

2.1 自定义枚举转换器

看代码：

核心代码还是看下面源码吧
看效果：

问题解决

2.2 附源码：

MyBaseEnum.java

package com.liu.susu.enums.handler;

/**
 * description
 *
 * @author susu
 * @date 2022-12-01
 **/
public interface MyBaseEnum {

    Object getCode();

    String getDesc();

}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

ValueEnumTypeHandler.java

package com.liu.susu.enums.handler;

import org.apache.ibatis.type.BaseTypeHandler;
import org.apache.ibatis.type.JdbcType;
import org.apache.ibatis.type.MappedTypes;

import java.sql.CallableStatement;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;

/**
 * 值枚举转换处理器
 * @param  枚举类型
 */
@MappedTypes({MyBaseEnum.class})
public class ValueEnumTypeHandler<E extends Enum<?> & MyBaseEnum> extends BaseTypeHandler<MyBaseEnum> {

    private Class<E> type;

    public ValueEnumTypeHandler(Class<E> type) {
        if (type == null) {
            throw new IllegalArgumentException("Type argument cannot be null");
        }
        this.type = type;
    }

    @Override
    public void setNonNullParameter(PreparedStatement ps, int i, MyBaseEnum parameter, JdbcType jdbcType)
            throws SQLException {
//        ps.setInt(i, parameter.getCode());
        ps.setObject(i, parameter.getCode());
    }

    @Override
    public E getNullableResult(ResultSet rs, String columnName) throws SQLException {
        int code = rs.getInt(columnName);
        return rs.wasNull() ? null : codeOf(code);
    }

    @Override
    public E getNullableResult(ResultSet rs, int columnIndex) throws SQLException {
        int code = rs.getInt(columnIndex);
        return rs.wasNull() ? null : codeOf(code);
    }

    @Override
    public E getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {
        int code = cs.getInt(columnIndex);
        return cs.wasNull() ? null : codeOf(code);
    }

    private E codeOf(int code){
        try {
            return codeOf(type, code);
        } catch (Exception ex) {
            throw new IllegalArgumentException("Cannot convert" + code + "to" + type.getSimpleName() + "by code value.", ex);
        }
    }

    private static <E extends Enum<?> & MyBaseEnum> E codeOf(Class<E> enumClass, Object code) {
        E[] enumConstants = enumClass.getEnumConstants();
        for (E e : enumConstants) {
            if (e.getCode() == code) {
                return e;
            }
        }
        return null;
    }

}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72

SexEnum.java
在这里插入图片描述

package com.liu.susu.enums;

import com.baomidou.mybatisplus.annotation.EnumValue;
import com.liu.susu.enums.handler.MyBaseEnum;

public enum SexEnum implements MyBaseEnum {

    BOY("1","男孩"),
    GIRL("2","女孩");

//    @EnumValue
    private String code;
    private String desc;

    SexEnum(String code, String desc) {
        this.code = code;
        this.desc = desc;
    }

    @Override
    public String getCode() {
        return this.code;
    }

    @Override
    public String getDesc() {
        return this.desc;
    }

}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

实体（实体里要注意换成ValueEnumTypeHandler）：

@TableField(typeHandler = ValueEnumTypeHandler.class)
    private SexEnum sex;
1
2

2.3. 参考

上述源码参考文章地址：
基于 SpringBoot+MybatisPlus+Jackson 优雅使用枚举值的方案.

3. 解决上述 @EnumValue 失效问题

上面自定义虽然解决问题了，但是略显麻烦，既然有简单的方法肯定还是想用简单的，就是想解决问题就失效了呢？继续往下看吧

3.1 首先，配置文件

需要配置枚举的扫描包
（其中 type-enums-package 也可用 typeEnumsPackage）：

mybatis-plus:
  type-aliases-package: com.liu.susu.*.entity
  type-enums-package: com.liu.susu.*.entity.enums;com.liu.susu.message.enums
1
2
3

3.2 实现效果的方式

3.2.1 使用 @EnumValue 注解

代码如下：

package com.liu.susu.message.enums;

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

public enum SexEnum {
    BOY("1", "男孩"),
    GIRL("2", "女孩");

    SexEnum(String code, String desc) {
        this.code = code;
        this.desc = desc;
    }

    @EnumValue //标注：存数据库里存 1 2
    private final String code;

    @JsonValue //给前端返回时用
    private final String desc;

}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

3.2.2 使用 implements IEnum

如下：

package com.liu.susu.message.enums;

import com.baomidou.mybatisplus.annotation.IEnum;

public enum ColourEnum implements IEnum<String> {
    BLACK("b", "黑色"),
    WHITE("w", "白色");

    private String value;

    private String name;

    ColourEnum(String value, String name) {
        this.value = value;
        this.name = name;
    }

    public String getValue() {
        return value;
    }

    public void setValue(String value) {
        this.value = value;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35