Mybatis中自定义TypeHandler处理枚举的示例代码

 更新时间:2024年01月08日 10:39:33   作者:啊Q老师  
typeHandler,是 MyBatis 中的一个接口,用于处理数据库中的特定数据类型,下面简单介绍创建自定义 typeHandler 来处理枚举类型的示例,感兴趣的朋友跟随小编一起看看吧

MyBatis

枚举类型

枚举类型,在 Java 中属于基本数据类型,而不是构造数据类型,用于声明一组命名的常数。枚举可以根据 Integer 、Long 、Short 或 Byte 中的任意一种数据类型来创建一种新型变量。这种变量可以设置为已经定义的一组之中的一个,有效防止用户提供无效值,使代码更加清晰。

简单示例:
首先,创建枚举类型 UserState

package cn.edu.MyBatisDemo.enums;
//使用枚举将实体类 User 的 state 属性设定为三种状态
public enum UserState {
    //每个枚举对象有四种值:索引值(从0开始)、名字(如 OnLine )、属性1(如343)、属性2(如在线)
    OnLine(343,"在线"),
    OffLine(8899,"离线"),
    BeBusy(1414,"忙碌");
    private int code; //定义括号中第一个属性
    private String msg; //定义括号中第二个属性
    private UserState(int code,String msg){
        this.code = code;
        this.msg = msg;
    }
    public int getCode() {
        return code;
    }
    public void setCode(int code) {
        this.code = code;
    }
    public String getMsg() {
        return msg;
    }
    public void setMsg(String msg) {
        this.msg = msg;
    }
    //通过 code 值获取对应的枚举对象
    public static UserState getUserStateByCode(int code){
        if(code == 343){
            return UserState.OnLine;
        } else if (code == 8899){
            return UserState.OffLine;
        } else {
            return UserState.BeBusy;
        }
    }
}

然后,创建获取枚举对象四种值的测试类 EnumTest

package cn.edu.MyBatisDemo.test;
import cn.edu.MyBatisDemo.enums.UserState;
import org.junit.Test;
public class EnumTest {
    @Test
    public void enumTest(){
        UserState userState = UserState.OnLine;
        //获取枚举对象的四种值
        System.out.println(userState.ordinal()); //索引值
        System.out.println(userState.name()); //名字
        System.out.println(userState.getCode()); //属性1
        System.out.println(userState.getMsg()); //属性2
    }
}

最后,测试结果,结果如图:

typeHandler

typeHandler,是 MyBatis 中的一个接口,用于处理数据库中的特定数据类型。MyBatis 默认提供了两个枚举数据类型的 typeHandler — EnumTypeHandlerEnumOrdinalTypeHandler 。在 MyBatis 中,也可以通过自定义 typeHandler 来处理数据库中的特定数据类型。另外,创建自定义的 typeHandler ,需要实现 typeHandler 接口,并实现其中的几个方法。下面简单介绍创建自定义 typeHandler 来处理枚举类型。

简单示例:
首先,创建一个数据表 enum_user
表结构信息如图:

接着,通过 Generator 来根据数据库表结构自动生成对应的实体类、DAO 接口和 SQL 映射文件

然后,在自动生成后,需要将实体类 state 属性的类型修改为 UserState 类型,同时添加上 toString() 方法

另外,还需要将 SQL 映射文件中所有 state 指定的 jdbcType 部分去除

在创建自定义 typeHandler 前,先了解 typeHandler 默认使用的是 EnumTypeHandler ,属性 state 信息在数据库中的值为四种值中的名字(BeBusy);而若指定使用 EnumOrdinalTypeHandler ,则属性 state 信息在数据库中的值为四种值中的索引值(2)

这些往往不是所需要的结果。所以,需要创建自定义 typeHandler 将属性 state 信息在数据库中的值设定为四种值中的属性1(1414)。创建实现 TypeHandler< T > 接口的类 CustomTypeHandler

package cn.edu.MyBatisDemo.enums;
import org.apache.ibatis.type.JdbcType;
import org.apache.ibatis.type.TypeHandler;
import java.sql.CallableStatement;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
public class CustomTypeHandler implements TypeHandler<UserState> {
    @Override
    public void setParameter(PreparedStatement preparedStatement, int i, UserState userState, JdbcType jdbcType) throws SQLException {
        preparedStatement.setObject(i,userState.getCode());
    }
    @Override
    public UserState getResult(ResultSet resultSet, String s) throws SQLException {
        int code = resultSet.getInt(s);
        return UserState.getUserStateByCode(code);
    }
    @Override
    public UserState getResult(ResultSet resultSet, int i) throws SQLException {
        int code = resultSet.getInt(i);
        return UserState.getUserStateByCode(code);
    }
    @Override
    public UserState getResult(CallableStatement callableStatement, int i) throws SQLException {
        int code = callableStatement.getInt(i);
        return UserState.getUserStateByCode(code);
    }
}

随之,在全局配置文件 mybatis.xml 中配置指定使用自定义的 typeHandler

<typeHandlers>
    <typeHandler handler="cn.edu.MyBatisDemo.enums.CustomTypeHandler" javaType="cn.edu.MyBatisDemo.enums.UserState" />
</typeHandlers>

最后,测试结果

结果如图:

到此这篇关于Mybatis中自定义TypeHandler处理枚举详解的文章就介绍到这了,更多相关Mybatis自定义TypeHandler内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Java规则引擎easy-rules详细介绍

    Java规则引擎easy-rules详细介绍

    本文主要介绍了Java规则引擎easy-rules详细介绍,文中通过示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2022-01-01
  • Java中RedissonClient基本使用指南

    Java中RedissonClient基本使用指南

    RedissonClient 是一个强大的 Redis 客户端,提供了丰富的功能和简单的 API,本文就来介绍一下Java中RedissonClient基本使用指南,具有一定的参考价值,感兴趣的可以了解一下
    2024-03-03
  • SpringBoot定时任务参数运行代码实例解析

    SpringBoot定时任务参数运行代码实例解析

    这篇文章主要介绍了SpringBoot定时任务运行代码实例解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-06-06
  • 详解springboot集成websocket的两种实现方式

    详解springboot集成websocket的两种实现方式

    这篇文章主要介绍了springboot集成websocket的两种实现方式,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2021-01-01
  • 使用dynamic datasource springboot starter实现多数据源及源码分析

    使用dynamic datasource springboot starter实现多数据源及源码分析

    这篇文章主要介绍了使用dynamic-datasource-spring-boot-starter做多数据源及源码分析,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2021-09-09
  • Java 超详细讲解SpringMVC拦截器

    Java 超详细讲解SpringMVC拦截器

    Spring MVC 的拦截器(Interceptor)与 Java Servlet 的过滤器(Filter)类似,它主要用于拦截用户的请求并做相应的处理,通常应用在权限验证、记录请求信息的日志、判断用户是否登录等功能上。本文将代码演示和文字描述详解拦截器的使用
    2022-04-04
  • java中Websocket的使用方法例子

    java中Websocket的使用方法例子

    这篇文章主要给大家介绍了关于java中Websocket的使用方法,WebSocket是HTML5开始提供的一种在浏览器和服务器间进行全双工通信的协议,文中通过代码介绍的非常详细,需要的朋友可以参考下
    2023-11-11
  • 四个实例超详细讲解Java 贪心和枚举的特点与使用

    四个实例超详细讲解Java 贪心和枚举的特点与使用

    贪心算法是指,在对问题求解时,总是做出在当前看来是最好的选择。也就是说,不从整体最优上加以考虑,他所做出的是在某种意义上的局部最优解,枚举法的本质就是从所有候选答案中去搜索正确的解,枚举算法简单粗暴,他暴力的枚举所有可能,尽可能地尝试所有的方法
    2022-04-04
  • 详谈@Autowired和static的关系

    详谈@Autowired和static的关系

    这篇文章主要介绍了@Autowired和static的关系,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-08-08
  • Spring整合Quartz定时任务并在集群、分布式系统中的应用

    Spring整合Quartz定时任务并在集群、分布式系统中的应用

    这篇文章主要介绍了Spring整合Quartz定时任务并在集群、分布式系统中的应用,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2019-04-04

最新评论