mybatis的内置类枚举和使用自定义枚举类解决自动装载问题

概述：

springboot使用mybatis时查询枚举值字段不能自动装载的问题,报错信息如下：

nested exception is org.apache.ibatis.executor.result.ResultMapException: Error attempting to get column ‘use_status’ from result set. Cause: java.lang.IllegalArgumentException: No enum constant com.cxstar.common.enums.UseStatusEnums.1

问题原因：

枚举类：

原因是我这里存入数据库的值是value，而不是 name 属性，因此无法使用Mybatis默认的转换器EnumTypeHandler 进行转换

存入数据库语句：

问题分析

内置枚举转换器

首先在MyBatis有两个内置枚举转换器
org.apache.ibatis.type.EnumTypeHandler org.apache.ibatis.type.EnumOrdinalTypeHandler

EnumTypeHandler
mybatis 中默认的枚举转换器，是获取枚举中的 name 属性。就是下面红框那玩意

EnumOrdinalTypeHandler
获取枚举中 ordinal 属性，就是例如索引一样的东西，不过是从0 开始递增的。
如下图，存入的数据库的就是枚举类中的顺序值

综上，内置类型不能满足我们的需求，因此需要自定义枚举转换器

自定义枚举转换器

MyBatis提供了 org.apache.ibatis.type.BaseTypeHandler 类用于我们自己扩展类型转换器，上面的EnumTypeHandler和EnumOrdinalTypeHandler 也都实现了这个接口。

继承 BaseTypeHandler 一共需要实现4个方法：

1. void setNonNullParameter(PreparedStatement ps, int i, T parameter, JdbcType jdbcType)
   用于定义设置参数时，该如何把Java类型的参数转换为对应的数据库类型；
2. T getNullableResult(ResultSet rs, String columnName)
   用于定义通过字段名称获取字段数据时，如何把数据库类型转换为对应的Java类型；
3. T getNullableResult(ResultSet rs, int columnIndex)
   用于定义通过字段索引获取字段数据时，如何把数据库类型转换为对应的Java类型；
4. T getNullableResult(CallableStatement cs, int columnIndex)
   用定义调用存储过程后，如何把数据库类型转换为对应的Java类型。
   注：此段引用自 https://www.cnblogs.com/qnight/p/8997496.html

解决问题

1.定义枚举基类

package com.cxstar.common.utils.enums.base;

/**
 * @author zhouquan
 * @description 枚举通用行为，规范枚举的实现
 * @date 2022-07-09 17:44
 **/
public interface BaseEnum<E extends Enum<?>, T> {
    /**
     * 获取枚举的值
     *
     * @return 枚举的值
     */
    T getValue();
}

2.定义抽象类继承BaseTypeHandler

public abstract class BaseEnumTypeHandler<E extends Enum<E> & BaseEnum> extends BaseTypeHandler<E> {
    /**
     * 枚举的class
     */
    private Class<E> type;
    /**
     * 枚举的每个子类枚
     */
    private E[] enums;

    /**
     * 一定要有默认的构造函数，不然抛出 not found method 异常
     */
    public BaseEnumTypeHandler() {
    }

    /**
     * 设置配置文件设置的转换类以及枚举类内容，供其他方法更便捷高效的实现
     *
     * @param type 配置文件中设置的转换类
     */
    public BaseEnumTypeHandler(Class<E> type) {
        if (type == null) {
            throw new IllegalArgumentException("Type argument cannot be null");
        }
        this.type = type;
        this.enums = type.getEnumConstants();
        if (this.enums == null) {
            throw new IllegalArgumentException(type.getSimpleName()
                    + " does not represent an enum type.");
        }
    }

    @Override
    public void setNonNullParameter(PreparedStatement ps, int i, E parameter,
                                    JdbcType jdbcType) throws SQLException {
        /*
         * BaseTypeHandler已经帮我们做了parameter的null判断
         * 数据库存储的是枚举的值，所以我们这里使用 value ， 如果需要存储 name，可以自定义修改
         */
        if (jdbcType == null) {
            ps.setString(i, Objects.toString(parameter.getValue()));
        } else {
            ps.setObject(i, parameter.getValue(), jdbcType.TYPE_CODE);
        }
    }

    @Override
    public E getNullableResult(ResultSet rs, String columnName)
            throws SQLException {
        String i = rs.getString(columnName);
        if (rs.wasNull()) {
            return null;
        } else {
            return locateEnumStatus(i);
        }
    }

    @Override
    public E getNullableResult(ResultSet rs, int columnIndex)
            throws SQLException {
        String i = rs.getString(columnIndex);
        if (rs.wasNull()) {
            return null;
        } else {
            return locateEnumStatus(i);
        }
    }

    @Override
    public E getNullableResult(CallableStatement cs, int columnIndex)
            throws SQLException {
        String i = cs.getString(columnIndex);
        if (cs.wasNull()) {
            return null;
        } else {
            return locateEnumStatus(i);
        }
    }

    /**
     * 枚举类型转换，由于构造函数获取了枚举的子类 enums，让遍历更加高效快捷，
     * <p>
     * 我将取出来的值 全部转换成字符串 进行比较，
     *
     * @param value 数据库中存储的自定义value属性
     * @return value 对应的枚举类
     */
    private E locateEnumStatus(String value) {
        for (E e : enums) {
            if (Objects.toString(e.getValue()).equals(value)) {
                return e;
            }
        }
        throw new IllegalArgumentException("未知的枚举类型：" + value + ",请核对"
                + type.getSimpleName());
    }
}

3.定义实现类

/**
 * @author zhouquan
 * @description 实现类用于枚举类转换
 * @date 2022-07-09 18:10
 **/
//@MappedTypes(value = {UserStatus.class})
public class SysEnumTypeHandler<E extends Enum<E> & BaseEnum> extends BaseEnumTypeHandler<E> {
    /**
     * 设置配置文件设置的转换类以及枚举类内容，供其他方法更便捷高效的实现
     *
     * @param type 配置文件中设置的转换类
     */
    public SysEnumTypeHandler(Class<E> type) {
        super(type);
    }
}

4.定义自己的枚举类

注意：务必实现BaseEnum类，泛型参数就是自定义参数的名称和value的类型

package com.cxstar.common.enums;

import com.cxstar.common.utils.enums.base.BaseEnum;

import java.util.Objects;

/**
 * 使用状态
 */
public enum UseStatusEnums implements BaseEnum<UseStatusEnums, Integer> {

    FORMAL(3, "正式：正式购买的客户"),

    TRIAL(2, "试用：试用的客户");

    private final int value;

    private final String description;

    public String getDescription() {
        return description;
    }

    UseStatusEnums(int value, String description) {
        this.value = value;
        this.description = description;
    }

    @Override
    public Integer getValue() {
        return this.value;
    }

    public static UseStatusEnums getByValue(int code) {
        for (UseStatusEnums value : UseStatusEnums.values()) {
            if (Objects.equals(code, value.getValue())) {
                return value;
            }
        }
        return null;
    }

}

5.在mapper.xml中指定typeHandler

6.查询结果：

转换器的配置

mybatis-config.xml中增加配置

除了直接在mapper.xml中指定typeHandler，也可以在mybatis-config.xml中增加配置，不过此种方式每新增一个枚举类型就要在其中增加配置属实繁琐。
注：此种方式并未测试

JavaConfig方式来干预SqlSessionFactory的创建过完成转换器的指定

详情见此博文：https://segmentfault.com/a/1190000010755321

引用

mybatis 中使用枚举
学习Spring Boot：（十二）Mybatis 中自定义枚举转换器

平时用mybatisplus开发比较多，对于mybatis多有不熟悉之处，如果不足之处，还请指出