MyBaits中枚举类型——在数据库字段类型为字符串、数字等非枚举类型情况下的使用

本文链接：https://blog.youkuaiyun.com/houyefeng/article/details/45886613

本文讲述了在遇到遗留系统中数据库字段为字符串或数字等非枚举类型时，如何在MyBatis中使用枚举类型。分析了为何要采用枚举类型的原因，如值的合法性校验和字段意义的明确，并探讨了javaType与jdbcType的对应关系。同时，详细介绍了自定义MyBatis TypeHandler和枚举接口的定义，以及特定枚举类型的使用方法。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

遇到的问题

当枚举类型的值类型为String时不管数据库字段类型是varchar还是其他字符串类型总能成功转换为相应的枚举类型，当是数字类型时有时可以有时不可以，主要原因是枚举类型转换器的Handler实现导致的，详见后面的讨论。

为什么要这么设计？

因为是在处理遗留系统无法更改数据库字段类型，需要字符串、数字等非枚举类型到枚举类型的转换。

为什么要用枚举类型而不直接用字符串、数字等类型？

在字段的值是可穷举的情况下，使用枚举类型有以下几个优点：

当相应字段做为查询参数时省去了参数值合法性的校验，如：用户性别字段，这是一个典型的可以使用枚举类型的例子，当业务层的方法中关于性别的参数定义为Sex，只有MAN和FEMALE时，不可能向业务层传入第三个值，从语言本身就保证了值的合法性
对字段值的意义进行说明，相当于数据库字段的注释，这一点也相当重要。你可能会说这一点不必要，因为我们有文档，有数据库字段的注释，但我告诉你，现实情况中文档是稀少的、数据库字段的注释是会丢的

javaType与jdbcType的对应关系

请参考文章“jdbcType与javaType的对应关系”，这里列举的已经相当明确，因使用情况所限，这里只针对自定义枚举类型讨论在使用MySQL数据库时的情况。这里需要特别说明的是“TINYINT”类型，“TINYINT”并不总是转换成java.lang.Byte，当字段类型为“TINYINT(1)”时，MyBaits会将其转换为java.lang.Boolean。

枚举在MyBaits中的使用

自定义MyBaits的TypeHandler

在使用MyBaits时类型转换由TypeHandler完成，MyBaits提供了org.apache.ibaits.type.EnumTypeHandler提供对枚举的支持，有兴趣的请查看源码了解结节。这个实现有一写的局限性，请参考文章“ 万恶的Mybatis的EnumTypeHandler”的部分析。

在我们的项目中我们使用了自定义的EnumHandler，见

/**
 * Created by houyefeng on 2015-02-12.
 */
package com.emar.adx.yiqifa.dal.util;

import org.apache.ibatis.type.BaseTypeHandler;
import org.apache.ibatis.type.JdbcType;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.sql.CallableStatement;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.util.HashMap;
import java.util.Map;

/**
 * 基于MyBaits实现的枚举类型转换工具类。
 *
 * @author houyefeng
 * @version 4.0.0
 * @see com.emar.adx.yiqifa.dal.util.Enum
 * @see org.apache.ibatis.type.BaseTypeHandler
 * @since 4.0.0 2015-02-12
 */
public class EnumHandler
   
    > extends BaseTypeHandler
    
      {
    private final static Logger log = LoggerFactory.getLogger(EnumHandler.class);
    private Class
     
       type;
    private final Map
      
        enumMap;

    public EnumHandler(Class
       
         type) {
        if (type == null)
            throw new IllegalArgumentException("type argument cannot be null");
        this.type = type;
        T[] enums = type.getEnumConstants();
        if (enums == null)
            throw new IllegalArgumentException(type.getSimpleName()
                    + " does not represent an enum type.");
        this.enumMap = new HashMap
        
         (); loadEnumMap(enums); } @Override public void setNonNullParameter(PreparedStatement ps, int i, T parameter, JdbcType jdbcType) throws SQLException { ps.setObject(i, parameter.getValue()); log.debug("jdbcType:" + jdbcType.getClass()); } @Override public T getNullableResult(ResultSet rs, String columnName) throws SQLException { X value = (X) rs.getObject(columnName); T status = this.enumMap.get(value); if (null == status) { log.warn("Unknown enum type:" + value + ",refer to " + this.enumMap); } return status; } @Override public T getNullableResult(ResultSet rs, int columnIndex) throws SQLException { X value = (X) rs.getObject(columnIndex); T status = this.enumMap.get(value); if (null == status) { log.warn("Unknown enum type:" + value + ",refer to " + this.enumMap); } return status; } @Override public T getNullableResult(CallableStatement cs, int columnIndex) throws SQLException { X value = (X) cs.getObject(columnIndex); T status = this.enumMap.get(value); if (null == status) { log.warn("Unknown enum type:" + value + ",refer to " + this.enumMap); } return status; } private void loadEnumMap(T[] enums) { for (T status : enums) { this.enumMap.put(status.getValue(), status); } } protected Map
         
           getEnumMap() { return this.enumMap; } }

，实现方式与EnumTypeHandler大同小异，相对简单些，使用中遇到的问题也是因这个实现上的缺陷导致的。

定义项目使用的枚举接口

在项目中我们没有使用java自己的枚举类，而是定义了自已的Enum接口，这个实现会导致使用上的局限性，但因是为了项目中使用MyBaits所定制，所能通用性就不是考虑的重点，见

/**
 * Created by houyefeng on 2015-02-12.
 */
package com.emar.adx.yiqifa.dal.util;

/**
 * 枚举类型接口，用于MyBaits中将某个字段的值转成相应的枚举类型和在保存数据时将枚举类型转换成字段值。
 *
 * @author houyefeng
 * @version 4.0.0
 * @since 4.0.0 2015-02-12
 */
public interface Enum
   
     {
    public T getValue();
}

。

特定枚举类型的使用

由于type handler无法得到javaType，所以每个具体的枚举类型需要一个Handler，继承EnumHandler类，见

/**
 * Created by houyefeng on 2015-04-21.
 */
package com.emar.adx.yiqifa.dal.util;


import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.lang.*;
import java.sql.CallableStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.util.Map;

/**
 * 重写了{@link EnumHandler}类的{@link EnumHandler#getNullableResult(CallableStatement, int)}、
 * {@link EnumHandler#getNullableResult(ResultSet, String)}、{@link EnumHandler#getNullableResult(ResultSet, int)}方法，
 * 使得同时能支持将数据库中为TINYINT,SMALLINT,INTEGER,BIGINT的字段的值转换为{@link ZeroOne}
 *
 * @author houyefeng
 * @version 4.0.0
 * @see EnumHandler
 * @since 4.0.0 2015-04-21
 */
public class ZeroOneHandler extends EnumHandler
   
     {
    private final static Logger log = LoggerFactory.getLogger(ZeroOneHandler.class);

    public ZeroOneHandler(Class
    
      type) {
        super(type);
    }

    @Override
    public ZeroOne getNullableResult(ResultSet rs, String columnName) throws SQLException {
        Object value = rs.getObject(columnName);
        return getZeroOne(value);
    }

    @Override
    public ZeroOne getNullableResult(ResultSet rs, int columnIndex) throws SQLException {
        Object value = rs.getObject(columnIndex);
        return getZeroOne(value);
    }

    @Override
    public ZeroOne getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {
        Object value = cs.getObject(columnIndex);
        return getZeroOne(value);
    }

    /**
     * @param value 从数据库叫取到的值
     * @return {@link ZeroOne}
     * @throws SQLException 数据库中值的类型为不支持的类型时抛出，支持的类型有：Integer、Byte、Short、Long
     */
    private ZeroOne getZeroOne(Object value) throws SQLException {
        Map
     
       enumMap = getEnumMap();
        ZeroOne status = null;
        /*
        如果value类型为Integer则直接使用；如果value的类型为Byte、Short、Long则强制转换为Integer；
        其它类型不支持，则抛出异常
         */
        if (null!=value) {
            if (!(value instanceof Integer)) {
                if (value instanceof Byte || value instanceof Short || value instanceof Long) {
                    value = Integer.valueOf(value.toString());
                } else {
                    throw new SQLException("not support type，only support Byte、Short、Integer、Long");
                }
            }
        }

        status = enumMap.get(value);
        if (null == status) {
            log.warn("Unknown enum type:" + value + ",refer to " + enumMap);
        }
        return status;
    }
}

和

/**
 * Created by houyefeng on 2015-04-21.
 */
package com.emar.adx.yiqifa.dal.util;

/**
 * @author houyefeng
 * @version 4.0.0
 * @see
 * @since 4.0.0 2015-04-21
 */
public class YesNoHandler extends EnumHandler
    
      {
    public YesNoHandler(Class
     
       type) {
        super(type);
    }
}