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枚举自动关联注入内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们!

(0)

相关推荐

  • MyBatis-Plus通过version机制实现乐观锁的思路

    MyBatis-Plus是通过version机制实现乐观锁的. 大致思路: 取出记录,携带记录的当前version: 更新记录的时候,比较记录当前的version是否有改变: 如果version未改变,则更新记录,并更新version,一般值+1: 如果version改变了,则不更新记录. version机制的核心思想就是,假设发生并发冲突的几率很低,只有当更新数据的时候采取检查是否有冲突,而判断是否有冲突的依据就是version的值是否被改变了. 配置 MyBatis-Plus中配置乐观锁分两

  • MP(MyBatis-Plus)实现乐观锁更新功能的示例代码

    实现步骤 step1:添加乐观锁拦截器 MP的其他拦截器功能可以参考官网 @Bean public MybatisPlusInterceptor mybatisPlusInterceptor() { MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor(); interceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor()); return int

  • MyBatis-Plus 使用枚举自动关联注入

    目录 什么是枚举自动注入? 实际效果 实现步骤 踩坑 解决方法 参数解析 总结 什么是枚举自动注入? 官方文档是这么解释的 解决了繁琐的配置,让 mybatis 优雅的使用枚举属性! 按我的理解是维护在内存中且不易修改的轻量级字典.目前觉得这个功能的使用场景相对有限,但是如果有用到的话开箱即用也是很棒的.废话不多说,接下来让我们看一下它的实际效果吧. 实际效果 通常情况下,我们会这样声明一个用户实体 public class User { private String id; private S

  • mybatis-plus乐观锁实现方式详解

    悲观锁.乐观锁简介: 悲观锁:同步操作.即用户A在操作某条数据时,为其上锁,限制其他用户操作,用户A操作完成提交事务后其他用户方可操作此数据. 乐观锁:使用版本控制字段.更新某条数据时,先判断此数据的version是否符合条件,若符合则更新反之更新失败. mybatis-plus乐观锁实现方式 1.向数据库中添加版本控制字段version ALTER TABLE `user` ADD COLUMN `version` INT 2.实体类中对应此字段添加@Version注解 特别说明: 特别说明:

  • MyBatis-Plus分页时排序的实现方法

    目录 简介 建库建表 依赖 配置 Entity Service Controller 测试 1.不指定顺序 2.后端OrderItem排序(create_time倒序) 3.后端Wrapper排序(create_time倒序,id升序) 4.前端指定排序(create_time倒序) 简介 说明 本文用示例介绍MyBtisPlus分页时排序的方法. 分页时排序的方法 后端OrderItems排序 后端Wrapper排序 前端指定排序 排序涉及到的类 排序涉及到Page类的List<OrderIt

  • MyBatis-Plus实现多数据源的示例代码

    多数据源的目的在于一个代码模块可调用多个数据库的数据进行某些业务操作. MyBatis-Plus开发者写了一个多数据源叫dynamic-datasource-spring-boot-starter,非常简单易用. dynamic-datasource-spring-boot-starter文档 官方文档部分截图: 第三方集成的,基本上是目前比较主流的(用的比较多). 一.添加Maven依赖 <dependency> <groupId>com.baomidou</groupId

  • mybatis-plus 分页类型转换工具类

    前言 用mybatis-plus 的分页对象的时候,因为用mybatis-puls 查询出来的分页对象的records里的泛型是实体,有时候需要将实体转换为前端展示的对象,所有写了一个分页数据的类型转换工具,解决这个问题. 代码示例 public IPage<TransparentGeologicalVO> pageList(TransparentGeologicalQueryDTO query) { IPage<TransparentGeological> page=this.l

  • MyBatis-Plus 分页查询的实现示例

    方法: 使用selectPage()方法,第一个参数是传入分页方法(传入当前页和当前显示多少条数据),第二个参数是传入查询条件(如果查询全部的话,可以传null). 前提: 表中的数据为: 第一种方式: //分页查询 Page<Employee> employees = employeeMapper.selectPage(new Page<>(3, 2), null); System.out.println("数据为:"+employees.getRecords

  • Mybatis-Plus进阶分页与乐观锁插件及通用枚举和多数据源详解

    分页插件   MP中自带了分页插件的功能,只需要在配置类中进行简单的配置即可使用分页的相关功能.分页插件常常与前端的分页显示功能相关,为了在前端美观的显示查询到的数据,通常会使用分页插件,将所有的数据分成许多页一页一页的进行显示,不同页的切换使用按钮来完成 MP的插件配置类 @Configuration public class MybatisPlusConfiguration { @Bean public MybatisPlusInterceptor mybatisPlusIntercepto

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

    目录 什么是枚举自动注入? 实际效果 实现步骤 踩坑 解决方法 参数解析 总结 什么是枚举自动注入? 官方文档是这么解释的 解决了繁琐的配置,让 mybatis 优雅的使用枚举属性! 按我的理解是维护在内存中且不易修改的轻量级字典.目前觉得这个功能的使用场景相对有限,但是如果有用到的话开箱即用也是很棒的.废话不多说,接下来让我们看一下它的实际效果吧. 实际效果 通常情况下,我们会这样声明一个用户实体 public class User {     private String id; priva

  • MyBatis-Plus通用枚举自动关联注入的实现

    目录 一.通用枚举 二.声明通用枚举属性 三.配置扫描通用枚举 四.注意.注意.注意 一.通用枚举 解决了繁琐的配置,让 mybatis 优雅的使用枚举属性! 按我的理解是维护在内存中且不易修改的轻量级字典.目前觉得这个功能的使用场景相对有限,但是如果有用到的话开箱即用也是很棒的.废话不多说,接下来让我们看一下它的实际效果吧. 一般搜索用户信息列表,列如用户有禁用和启用两个状态 @Data public class User implements Serializable { private s

  • Mybatis模糊查询及自动映射实现详解

    这篇文章主要介绍了Mybatis模糊查询及自动映射实现详解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下 Mybatis的模糊查询 1. 参数中直接加入%% 1 2 3 4 5 6 7 8 9 param.setUsername("%CD%"); param.setPassword("%11%"); <select id="selectPersons" resultType="p

  • 你所不知道的Spring自动注入详解

    自动注入和@Autowire @Autowire不属于自动注入! 注入方式(重要) 在Spring官网上(文档),定义了在Spring中的注入方式一共有两种:set方法和构造函数. 也就是说,你想在A类里面注入另外一个B类,无论你是通过写 XML文件,或者通过 @Autowried,他们最终都是通过这个A类的set方法或者构造函数,将B类注入到A类中! 换句话说,你如果A类里面没有setB(B b){-},那你就别想通过set方法把B类注入到A类中 自动注入 首先摆出一个比较颠覆的观点:@Aut

  • SQL注入详解及防范方法

    目录 一:什么是sql注入 二:SQL注入攻击的总体思路 三:SQL注入攻击实例 四:如何防御SQL注入 1.检查变量数据类型和格式 2.过滤特殊符号 3.绑定变量,使用预编译语句 五:什么是sql预编译 1.1:预编译语句是什么 1.2:MySQL的预编译功能 (1)建表 (2)编译 (3)执行 (4)释放 六:为什么PrepareStatement可以防止sql注入 (1):为什么Statement会被sql注入 (2)为什么Preparement可以防止SQL注入. 七:mybatis是如

  • MyBatis-Plus实现公共字段自动填充功能详解

    目录 1.问题分析 2.实现步骤 3. 实现字段全局填充 1.问题分析 我们在开发中经常遇到多个实体类有共同的属性字段,例如在用户注册时需要设置创建时间.创建人.修改时间.修改人等字段,在用户编辑信息时需要设置修改时间和修改人等字段.这些字段属于公共字段,也就是很多表中都有这些字段,能不能对于这些公共字段在某个地方统一处理,来简化开发呢? 答案就是我们可是使用Mybatis Plus提供的公共字段自动填充功能. 2.实现步骤 Mybatis Plus公共字段自动填充,也就是在插入或者更新的时候为

  • springboot整合mybatis将sql打印到日志的实例详解

    在前台请求数据的时候,sql语句一直都是打印到控制台的,有一个想法就是想让它打印到日志里,该如何做呢? 见下面的mybatis配置文件: <?xml version="1.0" encoding="UTF-8" ?> <!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN" "http://mybatis.org/dtd/mybatis-3-

  • mybatis多层嵌套resultMap及返回自定义参数详解

    1.两层嵌套,一个list中加另外一个list data:[ {a:123,b:456,c:[{d:7,e:8}]} ] xml文件定义的sql select * from zhy z LEFT JOIN wl w on z.id = w.zid resultMap可以定义: <resultMap id="zhyResultMap" type="zhy的doman实体" extends="zhy自动生成的BaseResultMap">

  • Java SpringBoot在RequestBody中高效的使用枚举参数原理案例详解

    在优雅的使用枚举参数(原理篇)中我们聊过,Spring对于不同的参数形式,会采用不同的处理类处理参数,这种形式,有些类似于策略模式.将针对不同参数形式的处理逻辑,拆分到不同处理类中,减少耦合和各种if-else逻辑.本文就来扒一扒,RequestBody参数中使用枚举参数的原理. 找入口 对 Spring 有一定基础的同学一定知道,请求入口是DispatcherServlet,所有的请求最终都会落到doDispatch方法中的ha.handle(processedRequest, respons

随机推荐