Mybatis之discriminator(鉴别器)详解

简介: 前言最近干了一个工作是使用discriminator去写一个新的API,那么写这个新的API原因是什么呢?原因是这样的:我们的项目使用Mybatis,我们项目中有一个实体类叫做User,在User中还含有很多别的实体类,例如Role,Permission,Address等(有经验的肯定知道这种嵌套实体类的情况,使用和)。

前言

最近干了一个工作是使用discriminator去写一个新的API,那么写这个新的API原因是什么呢?原因是这样的:我们的项目使用Mybatis,我们项目中有一个实体类叫做User,在User中还含有很多别的实体类,例如Role,Permission,Address等(有经验的肯定知道这种嵌套实体类的情况,使用和)。然后之前有一个API是把User以及关联的所有实体类都给查出来。从现在看起来,并没有什么不合理的地方。

但是随着项目不断扩大很多地方需要查询User一个这有一个现成的API就直接使用了,哪怕需求只是获取一个简单的用户名称。这种大材小用的地方多了,不但导致了调用的地方回来的很慢,还导致了服务器性能的浪费。

很多人可定会说就是因为懒,如果多谢几个sql,每个sql按照需要返回不就好了吗?确实可以这样去做,但是这导致了,我们得不停的写重复的sql,然后写resultMap,最后返回。这种重复的工作,对于一个程序员是不可以容忍的。

所以,引出了今天的主人公——discriminator。

正文

我们应该如何使用鉴别器呢?别着急咱们慢慢看。

如果没有使用鉴别器,返回实体类以及嵌套的实体类的resultMap应该是这样的:

<resultMap extends="BaseResultMap" id="EhmFullExcludeUserResultMap" type="com.test.RoleModel">
        <result column="transaction_id" jdbcType="VARCHAR" property="transactionId" />
              <collection column="role_id" ofType="com.test.model.UserModel" property="userList" select="com.test.mapper.selectUserByRoleId" />
        <collection column="role_id" ofType="com.test.model.GroupModel" property="groupList" select="com.test.mapper.selectGroupByRoleId" />
        <collection column="role_id" ofType="com.test.model.PermissionModel" property="permissionList" select="com.test.mapper.selectPermissionByRoleId" />
    </resultMap>

鉴别器使用后的基本写法是这样的:

<resultMap extends="BaseResultMap" id="ElasticRoleMap" type="com.test.ElasticRoleModel">
  <!--可以在这里使用<result> 标签写所有公用的属性,也就是说这些属性,不会因为指定值的不同而有或无-->
  <discriminator javaType="java.lang.Integer" column="role_profile_flag">
              <case value="1" resultMap="com.test.mapper.ElasticRoleUserMap"/>
              <case value="2" resultMap="com.test.mapper.ElasticRoleGroupMap"/>
              <case value="4" resultMap="com.test.mapper.ElasticRolePermissionMap"/>
              <case value="6" resultMap="com.test.mapper.ElasticRoleGroupAndPermissionMap"/>
  </discriminator>
</resultMap>
  1. column字段是指定我们要根据哪一个数据库查询字段进行判断,这个值可以是真实在数据库中存在的属性,也可以不存在,如果不存在的话,我们可以给实体类添加一个这个标识位属性,或者使用继承,继承父类,然后多加一个标志位属性,放在子类上。细心的读者,肯定看出来,改造前的resultMap的type为RoleModel,改造后的type为ElasticRoleModel。
  2. javaType指定的是column那个字段在实体类中是什么类型的。
  3. value属性就是我们刚刚指定的那个属性值不同的情况,具体返回哪一个resultMap。也就是说如果role_profile_flag属性值为1的情况下,会返回ElasticRoleUserMap 的resultMap
  4. 如果你指定的那个值与所有case中的值都不相同,则会把最外层的resultMap,也就是ElasticRoleMap进行返回,其中就会返回这个resultMap最基本的那些属性(鉴别器之外的值)。

下面给出每个case返回的resultMap的样例:

<!-- Only get the user detail model -->
    <resultMap extends="ElasticRoleMap" id="ElasticRoleUserMap" type="com.test.EhmElasticRoleModel">
        <collection column="role_id" ofType="com.kingland.platform.user_access.common.model.UserModel" property="userList" select="com.kingland.platform.user_access.mapper.RoleModelMapper.selectUserByRoleId" />
    </resultMap>

    <!-- Only get the user group model -->
    <resultMap extends="ElasticRoleMap" id="ElasticRoleGroupMap" type="com.test.EhmElasticRoleModel">
        <collection column="role_id" ofType="com.kingland.platform.user_access.common.model.GroupModel" property="groupList" select="com.kingland.platform.user_access.mapper.RoleModelMapper.selectGroupByRoleId" />
    </resultMap>

    <!-- Only get the user permission model -->
    <resultMap extends="ElasticRoleMap" id="ElasticRolePermissionMap" type="com.test.EhmElasticRoleModel">
        <collection column="role_id" ofType="com.kingland.platform.user_access.common.model.PermissionModel" property="permissionList" select="com.kingland.platform.user_access.mapper.RoleModelMapper.selectPermissionByRoleId" />
    </resultMap>
  1. 我们之所以继承了使用鉴别器的那个resultMap是因为我们希望每个case返回的resultMap会包含所有鉴别器之外公共的变量
  2. resultMap中的collection就是嵌套的那些实体类的具体赋值实现,这里不做过多解释
  3. 上面知识给出了三个例子,不光只有这三种,还可以俩俩的组合,或者是三个的组合形式

最后给出来,我们这个弹性查询的基础sql,他只是负责了最基本的查询,这个sql所查询出来的数据,无论在鉴别器case中,或者不在鉴别器case中,都会进行返回,因为他们不是嵌套的那些实体类。

    <select id="getElasticRoleByRoleIdAndRoleFlag" parameterType="map" resultMap="ElasticRoleMap">
        SELECT
            ro.*,
            out_tran.transaction_id as validated_transaction_id,
            #{roleFlag, jdbcType=INTEGER} as role_profile_flag
        FROM
            platform.role ro
            
        WHERE ro.role_id = #{roleId,jdbcType=BIGINT}
    </select>
</mapper>

  1. 这里的roleFlag就是实体类中标志位,因为我们的这个标志位不是真实在数据库中存在的,所有传入后,直接通过这种形式进行返回。as后的名称一定要与鉴别器中的column字段一致。
  2. resultMap就是刚刚我们定义好的含有鉴别器的那个基础的resultMap

后记

今天就先总结到这里,我也是当时做的时候遇到了不少的坑,如果有什么其他的问题,可以在下方评论给我,咱们可以互相成长。谢谢大家。

目录
相关文章
|
SQL Java 数据库连接
MyBatis的discriminator 鉴别器使用(十一)下
MyBatis的discriminator 鉴别器使用(十一)
528 0
MyBatis的discriminator 鉴别器使用(十一)下
|
SQL Java 数据库连接
MyBatis的discriminator 鉴别器使用(十一)上
MyBatis的discriminator 鉴别器使用(十一)
496 0
MyBatis的discriminator 鉴别器使用(十一)上
|
Java 数据库连接 mybatis
MyBatis从入门到精通(十三):使用discriminator鉴别器映射
MyBatis从入门到精通(十三):使用discriminator鉴别器映射最近在读刘增辉老师所著的《MyBatis从入门到精通》一书,很有收获,于是将自己学习的过程以博客形式输出,如有错误,欢迎指正,如帮助到你,不胜荣幸! 本篇博客主要讲解鉴别器映射discriminator标签的简单用法。
1082 0
|
Java 数据库连接 数据库
Spring boot 使用mybatis generator 自动生成代码插件
本文介绍了在Spring Boot项目中使用MyBatis Generator插件自动生成代码的详细步骤。首先创建一个新的Spring Boot项目,接着引入MyBatis Generator插件并配置`pom.xml`文件。然后删除默认的`application.properties`文件,创建`application.yml`进行相关配置,如设置Mapper路径和实体类包名。重点在于配置`generatorConfig.xml`文件,包括数据库驱动、连接信息、生成模型、映射文件及DAO的包名和位置。最后通过IDE配置运行插件生成代码,并在主类添加`@MapperScan`注解完成整合
1683 1
Spring boot 使用mybatis generator 自动生成代码插件
|
XML Java 数据库连接
微服务——SpringBoot使用归纳——Spring Boot集成MyBatis——基于注解的整合
本文介绍了Spring Boot集成MyBatis的两种方式:基于XML和注解的形式。重点讲解了注解方式,包括@Select、@Insert、@Update、@Delete等常用注解的使用方法,以及多参数时@Param注解的应用。同时,针对字段映射不一致的问题,提供了@Results和@ResultMap的解决方案。文章还提到实际项目中常结合XML与注解的优点,灵活使用两者以提高开发效率,并附带课程源码供下载学习。
1175 0
|
前端开发 Java 数据库连接
Java后端开发-使用springboot进行Mybatis连接数据库步骤
本文介绍了使用Java和IDEA进行数据库操作的详细步骤,涵盖从数据库准备到测试类编写及运行的全过程。主要内容包括: 1. **数据库准备**:创建数据库和表。 2. **查询数据库**:验证数据库是否可用。 3. **IDEA代码配置**:构建实体类并配置数据库连接。 4. **测试类编写**:编写并运行测试类以确保一切正常。
877 2
|
Java 数据库连接 Maven
mybatis使用一:springboot整合mybatis、mybatis generator,使用逆向工程生成java代码。
这篇文章介绍了如何在Spring Boot项目中整合MyBatis和MyBatis Generator,使用逆向工程来自动生成Java代码,包括实体类、Mapper文件和Example文件,以提高开发效率。
850 2
mybatis使用一:springboot整合mybatis、mybatis generator,使用逆向工程生成java代码。
|
SQL JSON Java
mybatis使用三:springboot整合mybatis,使用PageHelper 进行分页操作,并整合swagger2。使用正规的开发模式:定义统一的数据返回格式和请求模块
这篇文章介绍了如何在Spring Boot项目中整合MyBatis和PageHelper进行分页操作,并且集成Swagger2来生成API文档,同时定义了统一的数据返回格式和请求模块。
970 1
mybatis使用三:springboot整合mybatis,使用PageHelper 进行分页操作,并整合swagger2。使用正规的开发模式:定义统一的数据返回格式和请求模块
|
前端开发 Java Apache
Springboot整合shiro,带你学会shiro,入门级别教程,由浅入深,完整代码案例,各位项目想加这个模块的人也可以看这个,又或者不会mybatis-plus的也可以看这个
本文详细讲解了如何整合Apache Shiro与Spring Boot项目,包括数据库准备、项目配置、实体类、Mapper、Service、Controller的创建和配置,以及Shiro的配置和使用。
3538 2
Springboot整合shiro,带你学会shiro,入门级别教程,由浅入深,完整代码案例,各位项目想加这个模块的人也可以看这个,又或者不会mybatis-plus的也可以看这个
|
Java 数据库连接 mybatis
Springboot整合Mybatis,MybatisPlus源码分析,自动装配实现包扫描源码
该文档详细介绍了如何在Springboot Web项目中整合Mybatis,包括添加依赖、使用`@MapperScan`注解配置包扫描路径等步骤。若未使用`@MapperScan`,系统会自动扫描加了`@Mapper`注解的接口;若使用了`@MapperScan`,则按指定路径扫描。文档还深入分析了相关源码,解释了不同情况下的扫描逻辑与优先级,帮助理解Mybatis在Springboot项目中的自动配置机制。
1433 1
Springboot整合Mybatis,MybatisPlus源码分析,自动装配实现包扫描源码