springboot+mybatis+枚举处理器的实现

 更新时间:2022年03月24日 10:53:27   作者:我想飞,你想不  
在Spring boot项目开发中经常遇到需要使用枚举的场景,本文就介绍了springboot+mybatis+枚举处理器的实现,具有一定的参考价值,感兴趣的小伙伴们可以参考一下

背景

在Spring boot项目开发中经常遇到需要使用枚举的场景,比如描述状态、性别、类型等相关字段。通常这些字段在数据库会以tinyint类型存在,比如:0:女性,1:男性;或者,0:设备掉线,1:设备在线。如果在系统中我们也以int的方式到处使用,后期在维护的时候对数字的理解会非常困难,所以通常这种字段我们一般采用枚举的方式在系统的流转,而在存储的时候我们使用数字的方式存储。

以上,因为数据库存储字段的类型和我们在系统中流转的类型不同,我们需要实现一个两者自动转换的功能,也就是标题中提到的枚举处理器。

现状

如果我们采用全数字的方式在系统中流转,最终系统代码就会变成这样:

if(status == 1){ // 时间一长,谁来告诉我1代表什么状态
    ...
}else if (status == 0){ // 0又代表什么状态
    ...
}
...

以上这种操作会造成代码的可读性非常低,非常需要依靠对其中数字的注释进行编码。

期望

希望类型性别、状态这类字段可以全部使用枚举类型,提高代码的可维护性。考虑到大部分我们使用枚举的时候都可以使用ONLINE(1, "在线"), OFFLINE(0, "掉线")这样的方式,可以总结出一个通用的枚举接口,后续类似的枚举类都实现这个接口。

实现

为了满足期望的功能,通过一个通用的枚举接口和mybatis的枚举处理器来实现业务系统中使用枚举类型和mysql中使用数值类型的功能。

通用的枚举接口

简单粗暴的命名这个通用枚举接口为KeyValueEnum:

public interface KeyValueEnum {

    int getKey();

    String getValue();

}

基于该接口实现一个状态枚举类:

public enum StatusEnum implements KeyValueEnum {

    ONLINE(1, "在线"),
    
    OFFLINE(0, "掉线");
    
    private int key;

    private String value;

    StatusEnum(int key, String value){
        this.key = key;
        this.value = value;
    }

    @Override
    public int getKey() {
        return key;
    }

    @Override
    public String getValue() {
        return value;
    }
}

由此,所有类似的接口都可以用过getKey()getValue()方法来获取相关数值。

mybaits枚举处理器

@MappedTypes(value = {Status.class, Sex.class}) // 每增加一种枚举类型,就在此添加。
public class EnumTypeHandler<E extends KeyValueEnum> extends BaseTypeHandler<E> {

    private Class<E> type;
    private E[] enums;

    public EnumTypeHandler(Class<E> type){
        this.type = type;
        this.enums = type.getEnumConstants();
    }

    @Override
    public void setNonNullParameter(PreparedStatement preparedStatement, int i, KeyValueEnum keyValueEnum, JdbcType jdbcType) throws SQLException {
        preparedStatement.setInt(i, keyValueEnum.getKey());
    }

    @Override
    public E getNullableResult(ResultSet resultSet, int i) throws SQLException {
        int key = resultSet.getInt(i);
        return getEnum(key);
    }

    @Override
    public E getNullableResult(ResultSet resultSet, String s) throws SQLException {
        int key = resultSet.getInt(s);
        return getEnum(key);
    }

    @Override
    public E getNullableResult(CallableStatement callableStatement, int i) throws SQLException {
        int key = callableStatement.getInt(i);
        return getEnum(key);
    }

    private E getEnum(int key){
        for (E keyValue:
             enums) {
            if (keyValue.getKey() == key){
                return keyValue;
            }
        }
        return null;
    }
}

枚举处理器是通过继承mybatis自带的BaseTypeHandler抽象类实现的,其中包含的具体方法参考mybatis的BaseTypeHandler文档即可。

需要注意的是,如果每增加一种需要存储到数据库的枚举类型就需要在@MappedTypes(value = {Status.class, Sex.class})注解中添加一个对应的枚举类。

配置枚举处理器

# application.yaml
mybatis:
  configuration:
    map-underscore-to-camel-case: true # 下划线转驼峰
  type-handlers-package: xxx.xxx.xxx.handler.mybatisTypeHandler # 配置刚才编辑的枚举处理器

包含枚举类型字段的实体类

@Data
public class device {

    private long id;

    private Status status;
}

期望实现的目标是直接通过数据库查询出对应的枚举类型。

查询mapper

public interface deviceMapper {

    @Results(id="aaa", value = {
            @Result(id = true, column = "id", property = "id"),
            @Result(column = "status", property = "status")
    })
    @Select("select * from device where id = #{id}")
    Device getDeviceById(long id);
}

通过mapper查询最终可以实现数据库tinyint类型查询后转换为实体类字段对应的枚举类型。

到此这篇关于springboot+mybatis+枚举处理器的实现的文章就介绍到这了,更多相关springboot mybatis 枚举处理器内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Java文件与IO流操作原理详细分析

    Java文件与IO流操作原理详细分析

    在java中提供有对于文件操作系统的支持,这个支持在java.io.File类中进行了定义,也就是说在整个java.io包中File类是唯一一个与文件本身操作有关的类(创建,删除,重命名)有关的类,而如果想要进行File类的操作,我们需要提供有完整的路径支持,而后可以调用相应的方法进行处理
    2022-09-09
  • JavaEE实现前后台交互的文件上传与下载

    JavaEE实现前后台交互的文件上传与下载

    这篇文章主要介绍了JavaEE实现前后台交互的文件上传与下载,分享相关技术,实现文件上传下载功能,需要的朋友可以参考下
    2015-11-11
  • Mybatis逆工程jar包的修改和打包

    Mybatis逆工程jar包的修改和打包

    这篇文章主要介绍了Mybatis逆工程jar包的修改和打包的相关资料,需要的朋友可以参考下
    2016-06-06
  • Java日常练习题,每天进步一点点(6)

    Java日常练习题,每天进步一点点(6)

    下面小编就为大家带来一篇Java基础的几道练习题(分享)。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧,希望可以帮到你
    2021-07-07
  • java转化为exe程序步骤详解

    java转化为exe程序步骤详解

    在本篇内容里我们给大家分享了关于java转化为exe程序的具体步骤和相关知识点,需要的朋友们学习下。
    2019-03-03
  • 深度deepin安装以及jdk、tomcat、Nginx安装教程

    深度deepin安装以及jdk、tomcat、Nginx安装教程

    这篇文章主要给大家介绍了关于深度deepin安装以及jdk、tomcat、Nginx安装的相关资料,按照文中介绍的方法可以轻松的实现安装,对大家的工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2024-01-01
  • 使用Java DOM解析器修改XML文件内容的操作方法

    使用Java DOM解析器修改XML文件内容的操作方法

    在Java中,XML文件的解析和修改可以通过多种方法实现,其中DOM(Document Object Model)是一种常用的方式,在本文中,我们将介绍如何使用Java DOM解析器修改XML文件中的内容,并给出一个具体的示例,需要的朋友可以参考下
    2024-08-08
  • JDK1.8中ConcurrentHashMap中computeIfAbsent死循环bug问题

    JDK1.8中ConcurrentHashMap中computeIfAbsent死循环bug问题

    这篇文章主要介绍了JDK1.8中ConcurrentHashMap中computeIfAbsent死循环bug,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-08-08
  • SpringMVC获取请求参数实现方法介绍

    SpringMVC获取请求参数实现方法介绍

    Spring MVC 是 Spring 提供的一个基于 MVC 设计模式的轻量级 Web 开发框架,本质上相当于 Servlet,Spring MVC 角色划分清晰,分工明细,这篇文章主要介绍了SpringMVC实现获取请求参数方法
    2022-11-11
  • 在Spring Boot项目中引入本地JAR包的步骤和配置

    在Spring Boot项目中引入本地JAR包的步骤和配置

    本文探讨了在Spring Boot项目中引入本地JAR包的步骤和必要的配置,通过使用Maven的system作用域,开发者可以将自定义的本地库或功能集成到Spring Boot应用程序中,,需要的朋友可以参考下
    2023-10-10

最新评论