MyBatis-Plus如何使用枚举自动关联注入详解

更新时间：2022年03月08日 10:27:07 作者：秋田君

这篇文章主要给大家介绍了关于MyBatis-Plus如何使用枚举自动关联注入的相关资料,文中通过实例代码介绍的非常详细,对大家学习或者使用MyBatis-Plus具有一定的参考学习价值,需要的朋友可以参考下

什么是枚举自动注入？

官方文档是这么解释的

解决了繁琐的配置，让 mybatis 优雅的使用枚举属性！

按我的理解是维护在内存中且不易修改的轻量级字典。目前觉得这个功能的使用场景相对有限，但是如果有用到的话开箱即用也是很棒的。废话不多说，接下来让我们看一下它的实际效果吧。

实际效果

通常情况下，我们会这样声明一个用户实体

public class User {
    private String id;
    private String name;
    private Integer age;
    private String phone;
    //省略getter&setter&constructor
    ...
}

那么最终获取到的JSON数据应该类似于这样

{
        id: "1",
        name: "张三",
        age: 18,
        phone: "10000"
}

如若使用MyBatis-Plus的枚举自动关联注入，可以更优雅的实现如下效果

{
        id: "1",
        name: "张三",
        age: "十八岁",
        phone: "中国电信"
}

实现步骤

实现过程仅有三步且非常简单，代码量也非常的少，下面介绍一下实现步骤。

1.创建两个枚举对象，分别为AgeEnum与PhoneEnum，这里使用枚举建立一个映射关系。

public enum AgeEnum implements IEnum {
    ONE(1, "一岁"),
    TWO(2, "二岁");

    private int age;
    private String desc;

    AgeEnum(final int age, final String desc) {
        this.age = age;
        this.desc = desc;
    }

    @Override
    public Serializable getValue() {
        return this.age;
    }

    @JsonValue
    public String getDesc(){
        return this.desc;
    }
}

public enum PhoneEnum implements IEnum {
    CMCC("10086", "中国移动"),
    CUCC("10010", "中国联通"),
    CT("10000", "中国电信");

    private String phone;
    private String desc;

    PhoneEnum(final String phone, final String desc) {
        this.phone = phone;
        this.desc = desc;
    }

    @Override
    public Serializable getValue() {
        return this.phone;
    }

    @JsonValue
    public String getDesc(){
        return this.desc;
    }
}

注意：

@JsonValue是使用JackSon解析时有效，若使用fastjson，请看官方文档提供的解决方案
不要把@JsonValue打成@JsonView了，否则自动关联注入的是枚举名（name属性），如下所示
别忘记实现IEnum接口，否则自动关联注入的是枚举名（name属性），如下所示

{
        id: "1",
        name: "张三",
        age: "十八岁",
        phone: "CT"
}

2.将User实体中的属性替换为枚举，例如

public class User {
    private String id;
    private String name;
    private AgeEnum age;
    private PhoneEnum phone;
    //省略getter&setter&constructor
    ...
}

3.配置扫描枚举，添加如下配置

mybatis-plus.typeEnumsPackage=com.xxx.xxx.enums//枚举所在路径

至此，使用MyBatis-Plus的枚举自动关联注入就完成了。

踩坑

在使用枚举自动关联注入时，还踩了一个坑。在代码正确的情况下出现了如下问题。

{
        id: null,
        name: null,
        age: null,
        phone: null
}

查出的所有值都为null，通过DEBUG跟踪代码发现问题。数据库中将实体中的某个枚举属性设置为了tinyint类型，在数据库中存储的值是1，枚举中也是使用1来映射关系，然而MyBaits-Plus在获取值是却读成了true，因此枚举并没有映射成功，返回null值。

当获取IsEnableEnum的枚举时，会执行这行代码获取枚举中的关系映射

EnumUtils.valueOf(this.type, rs.getObject(columnName));

但是MyBatis读取到的值变成了true

无法正确匹配到映射的值，返回null值，IsEnableEnum中声明的映射关系如下。

ENABLE(1, "可用"), LIMIT(-1, "禁用");

解决方法

1.将表中IsEnableEnum枚举对应的字段is_enable类型由tinyint改为int即可，这种解决方法的优点就是不用修改代码就解决问题。

2.MySQL中tinyint(1)对应Java中的boolean类型,非0为true，0为false。因此修改IsEnableEnum中的映射关系，如下。

ENABLE(true, "可用"), LIMIT(false, "禁用");

参数解析

当使用枚举注入的方式时，作为参数解析如果不注意会出现解析异常的情况。这里以修改User的is_enable值(数据库表中字段属性设置为int)为例看下具体解析异常情况的问题。例如，我们需要通过下面这个接口接收JSON请求参数来修改用户的信息。

@PostMapping
public User saveUser(@RequestBody User user) {
    return userService.insertOrUpdate(user) ? userService.selectById(user.getId()) : null;
}

使用Postman模拟请求，JSON参数

{
	"id":"922000984245391362",
	"isEnable":-1
}

响应结果

{
    "timestamp": "2018-05-12T04:20:15.920+0000",
    "status": 400,
    "error": "Bad Request",
    "exception": "org.springframework.http.converter.HttpMessageNotReadableException",
    "message": "JSON parse error: Can not deserialize value of type com.github.common.domain.enums.IsEnableEnum from number -1: index value outside legal index range [0..1]; nested exception is com.fasterxml.jackson.databind.exc.InvalidFormatException: Can not deserialize value of type com.github.common.domain.enums.IsEnableEnum from number -1: index value outside legal index range [0..1]\n at [Source: java.io.PushbackInputStream@25386a8e; line: 3, column: 13] (through reference chain: com.github.common.domain.User[\"isEnable\"])",
    "path": "/"
}

从错误信息我们可知，无法将-1映射成IsEnableEnum枚举，可用范围是0..1，那么应该怎么解决呢？

自己摸索出的解决方式有两种，分别为

使用value属性映射，经过测试0对应的是ENABLE(1, "可用")，1对应的是LIMIT(-1, "禁用")。很奇葩吧，因此不推荐此方式。
使用desc属性映射，将JSON请求参数改成如下就可以解析成功不报错。

{
	"id":"922000984245391362",
	"isEnable":"禁用"
}

总结

MyBatis-Plus这个特性目前用的还是不多，本质上其实还是把映射关系写死在代码中且个人觉得设计有些许不合理的地方，并不能替代字典，因此还是推荐使用字典方式，可以动态的修改映射关系。当项目遇到希望使用比字典更轻更快更容易上手的场景时，可以尝试使用枚举注入的方式。

针对于解决方法的选择个人想法是，当存储的值仅有两个且关系相对时，可以使用方法二，而在任何场景下方法一都适用，因此个人比较推荐方法一，因为可以存储更多的值和映射关系，例如上文的电话号码枚举。

最后，贴上MyBatis-Plus的官方文档，强烈推荐小伙伴们去尝试使用，非常棒的一个开源项目。

到此这篇关于MyBatis-Plus如何使用枚举自动关联注入的文章就介绍到这了,更多相关MyBatis-Plus枚举自动关联注入内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

彻底搞懂Java多线程(三)
这篇文章主要给大家介绍了关于Java面试题之多线程和高并发的相关资料，文中通过示例代码介绍的非常详细，对大家学习或者使用java具有一定的参考学习价值，需要的朋友们下面来一起学习学习吧
2021-07-07
SpringBoot实现短链接系统的使用示例
由于短链接可能涉及到用户隐私和安全问题,所以短链接系统也需要符合相关的数据保护和安全标准,本文主要介绍了SpringBoot实现短链接系统的使用示例,感兴趣的可以了解一下
2023-09-09
Java字符串查找的方法总结
在给定的字符串中查找字符或字符串是比较常见的操作,字符串查找分为两种形式：一种是在字符串中获取匹配字符（串）的索引值,另一种是在字符串中获取指定索引位置的字符,本文给大家总结了Java字符串查找的方法,需要的朋友可以参考下
2024-05-05
Java访问者设计模式详细讲解
大多数情况下你不需要访问者模式，但当一旦需要访问者模式时，那就是真的需要它了，这是设计模式创始人的原话。可以看出应用场景比较少，但需要它的时候是不可或缺的，这篇文章就开始学习最后一个设计模式——访问者模式
2022-11-11
详解安装Eclipse Maven插件的几种方法
本篇文章主要介绍了详解安装Eclipse Maven插件的几种方法，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2018-01-01
java实现excel导出合并单元格的步骤详解
这篇文章主要介绍了java实现excel导出合并单元格,通过使用Apache POI库，我们可以方便地创建Excel文件、填充数据、合并单元格和导出Excel文件，需要的朋友可以参考下
2023-04-04
带你快速搞定java IO
这篇文章主要介绍了Java IO流文件传输基础的相关资料,非常不错，具有参考借鉴价值，需要的朋友可以参考下，希望能给你带来帮助
2021-07-07
Thread.sleep(0)的写法原理深入解析
这篇文章主要为大家介绍了Thread.sleep(0)的写法原理深入解析，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
2022-12-12
使用SpringAop动态获取mapper执行的SQL,并保存SQL到Log表中
这篇文章主要介绍了使用SpringAop动态获取mapper执行的SQL，并保存SQL到Log表中问题，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2023-03-03
Java集合框架ArrayList源码分析（一）
这篇文章主要为大家详细介绍了Java集合框架ArrayList源码分析，感兴趣的小伙伴们可以参考一下
2016-08-08