Mybatis中自定义TypeHandler处理枚举详解

 更新时间:2017年02月20日 10:55:26   作者:南轲梦  
本文主要介绍了Mybatis中自定义TypeHandler处理枚举的相关知识。具有很好的参考价值,下面跟着小编一起来看下吧

在Mybatis中,处理枚举类的TypeHandler有两个:

  • EnumTypeHandler: 用于保存枚举名
  • EnumOrdinalTypeHandler: 用于保存枚举的序号。

在实际项目中,以上往往不能满足我们的需求。

需求分析

枚举需要包含两个属性,label(用于显示), value(实际的枚举值)。数据库保存枚举值(value)。

这很明显Mybatis提供的两个枚举TypeHandler不能满足我们的需求。此时,我们可以自定义一个通用的枚举TypeHandler来满足我们的需求。

自定义枚举TypeHandler

通用枚举DisplayedEnum

public interface DisplayedEnum {
 String DEFAULT_VALUE_NAME = "value";
 String DEFAULT_LABEL_NAME = "label";
 default Integer getValue() {
 Field field = ReflectionUtils.findField(this.getClass(), DEFAULT_VALUE_NAME);
 if (field == null)
  return null;
 try {
  field.setAccessible(true);
  return Integer.parseInt(field.get(this).toString());
 } catch (IllegalAccessException e) {
  throw new RuntimeException(e);
 }
 }
 @JsonValue
 default String getLabel() {
 Field field = ReflectionUtils.findField(this.getClass(), DEFAULT_LABEL_NAME);
 if (field == null)
  return null;
 try {
  field.setAccessible(true);
  return field.get(this).toString();
 } catch (IllegalAccessException e) {
  throw new RuntimeException(e);
 }
 }
 static <T extends Enum<T>> T valueOfEnum(Class<T> enumClass, Integer value) {
 if (value == null)
  throw new IllegalArgumentException("DisplayedEnum value should not be null");
 if (enumClass.isAssignableFrom(DisplayedEnum.class))
  throw new IllegalArgumentException("illegal DisplayedEnum type");
 T[] enums = enumClass.getEnumConstants();
 for (T t: enums) {
  DisplayedEnum displayedEnum = (DisplayedEnum)t;
  if (displayedEnum.getValue().equals(value))
  return (T) displayedEnum;
 }
 throw new IllegalArgumentException("cannot parse integer: " + value + " to " + enumClass.getName());
 }
}

说明:

普通枚举类通过实现DisplayedEnum接口,就可以:

  1. 通过getValue()获取枚举值。
  2. 通过getLabel()获取枚举的label属性。
  3. 通过valueOfEnum()将Integer值转换为指定的枚举类型。

普通枚举类

public enum CommonsType implements DisplayedEnum {
 NORMAL("正常", 0), INVALID("无效", 1);
 String label;
 Integer value;
 private CommonsType(String label, Integer value) {
 this.label = label;
 this.value = value;
 }
}

以上就是一个普通枚举类的示例。

自定义枚举TypeHandler

@MappedJdbcTypes(value = JdbcType.TINYINT, includeNullJdbcType = true)
public class DefaultEnumTypeHandler extends BaseTypeHandler<DisplayedEnum> {
 private Class<DisplayedEnum> type;
 public EnumTypeHandler(){};
 public EnumTypeHandler(Class<DisplayedEnum> type) {
 if (type == null) throw new IllegalArgumentException("Type argument cannot be null");
 this.type = type;
 }
 @Override
 public void setNonNullParameter(PreparedStatement ps, int i, DisplayedEnum parameter, JdbcType jdbcType)
  throws SQLException {
 ps.setInt(i, parameter.getValue());
 }
 @Override
 public DisplayedEnum getNullableResult(ResultSet rs, String columnName) throws SQLException {
 return convert(rs.getInt(columnName));
 }
 @Override
 public DisplayedEnum getNullableResult(ResultSet rs, int columnIndex) throws SQLException {
 return convert(rs.getInt(columnIndex));
 }
 @Override
 public DisplayedEnum getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {
 return convert(cs.getInt(columnIndex));
 }
 private DisplayedEnum convert(int status){
 DisplayedEnum[] objs = type.getEnumConstants();
 for(DisplayedEnum em: objs){
  if(em.getValue() == status){
  return em;
  }
 }
 return null;
 }
}

使用我们自定义的DefaultEnumTypeHandler

由于Mybatis默认在处理枚举类型的时候会使用EnumTypeHandler(只保存及转换枚举类型的名字), 因此,我们需要手动指定使用DefaultEnumTypeHandler。示例如下:

<resultMap id="xxx" type="xxx">
 ...
 <result column="type" jdbcType="TINYINT" property="type" typeHandler="xxx.xxx.xxx.DefaultEnumTypeHandler" />
 ...
</resultMap> 

即我们需要通过使用typeHandler来指定。

小结

以上是我们应用在实际项目中的一个对于Mybatis处理枚举类的方案。我看大多数人也都是这样在用。然而,在实际项目中,我们会发现随着枚举类的增多,这样写起来会很繁琐。我看了一下网络上似乎也没人处理这种情况。那么,下一篇文章将针对这种情况进行处理。

以上就是本文的全部内容,希望本文的内容对大家的学习或者工作能带来一定的帮助,同时也希望多多支持脚本之家!

相关文章

  • ThreadLocal线程在Java框架中的应用及原理深入理解

    ThreadLocal线程在Java框架中的应用及原理深入理解

    这篇文章主要介绍了ThreadLocal在Java框架中的应用及原理深入理解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2024-01-01
  • Spring Cloud Stream微服务消息框架原理及实例解析

    Spring Cloud Stream微服务消息框架原理及实例解析

    这篇文章主要介绍了Spring Cloud Stream微服务消息框架原理及实例解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-06-06
  • 从log4j切换到logback后项目无法启动的问题及解决方法

    从log4j切换到logback后项目无法启动的问题及解决方法

    这篇文章主要介绍了从log4j切换到logback后项目无法启动的问题及解决方法,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2023-01-01
  • 使用logback日志文件多环境配置路径方式

    使用logback日志文件多环境配置路径方式

    文章介绍了两种解决Spring Boot项目中日志文件多环境配置路径问题的方法,第一种方法是通过启动jar包时添加参数指定日志配置文件;第二种方法是通过配置logback-spring.xml文件根据不同的环境加载不同的日志路径
    2025-02-02
  • springboot整合vue项目(小试牛刀)

    springboot整合vue项目(小试牛刀)

    这篇文章主要介绍了springboot整合vue项目(小试牛刀),小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-09-09
  • 在SpringBoot3中spring.factories配置不起作用的原因和解决方法

    在SpringBoot3中spring.factories配置不起作用的原因和解决方法

    本文给大家介绍了在SpringBoot3中spring.factories配置的自动装配不生效的原因和解决方法,文中通过代码和图文给出了详细的解决方法,具有一定的参考价值,需要的朋友可以参考下
    2024-02-02
  • 如何解决getReader() has already been called for this request问题

    如何解决getReader() has already been called&

    这篇文章主要介绍了如何解决getReader() has already been called for this request问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-05-05
  • mybatis selectKey赋值未生效的原因分析

    mybatis selectKey赋值未生效的原因分析

    这篇文章主要介绍了mybatis selectKey赋值未生效的原因分析,selectKey 会将 SELECT LAST_INSERT_ID()的结果放入到传入的实体类的主键里面,文中通过代码示例给大家讲解非常详细,需要的朋友可以参考下
    2024-02-02
  • springboot自动装配之@ComponentScan使用方式

    springboot自动装配之@ComponentScan使用方式

    @componentScan注解用于扫描指定路径下的组件,并自动将它们注册为Spring Bean,该注解支持多种过滤规则,可以自定义扫描过滤规则,Spring Boot通过ConfigurationClassPostProcessor处理@ComponentScan注解,并在启动时创建和注册BeanDefinition对象
    2025-01-01
  • 将Java项目打包为可执行JAR 文件的四种方法

    将Java项目打包为可执行JAR 文件的四种方法

    本文主要介绍了Java项目打包为可执行JAR的四种方法,包括IDE配置、Maven/Gradle插件、手动创建及依赖管理,具有一定的参考价值,感兴趣的可以了解一下
    2025-08-08

最新评论