• Mybatis 动态SQL – 使用choose标签动态生成条件语句

    之前我们介绍了if,where标签的使用；本篇我们需要在if,where标签的基础上介绍如何使用Mybatis提供的choose标签动态生成条件语句。

    如果您对if,where标签动态生成条件语句不太了解，建议您先进行了解后再阅读本篇，可以参考：

    Mybatis 动态SQL – 使用if,where标签动态生成条件语句icon-default.png?t=N7T8https://blog.csdn.net/m1729339749/article/details/132627894

    一、数据准备

    这里我们直接使用脚本初始化数据库中的数据

    1. -- 如果数据库不存在则创建数据库
    2. CREATE DATABASE IF NOT EXISTS demo DEFAULT CHARSET utf8;
    3. -- 切换数据库
    4. USE demo;
    5. -- 创建用户表
    6. CREATE TABLE IF NOT EXISTS T_TEACHER(
    7.   ID INT PRIMARY KEY COMMENT '教师编号',
    8.   TEACHER_NAME VARCHAR(64) NOT NULL COMMENT '教师名称',
    9.   DEPARTMENT VARCHAR(16) NOT NULL COMMENT '所属部门',
    10.   BIRTH DATE NOT NULL COMMENT '出生年月',
    11.   DEGREE VARCHAR(16) NOT NULL COMMENT '学历(ZK:专科, BK:本科, YJS:研究生, BS:博士)'
    12. );
    13. -- 插入用户数据
    14. INSERT INTO T_TEACHER(ID, TEACHER_NAME, DEPARTMENT, BIRTH, DEGREE)
    15. VALUES(1, '张三1', '001', '1990-06-12', 'BK'),
    16.       (2, '李四1', '002', '1992-05-10', 'BK'),
    17.       (3, '张三2', '003', '1988-01-15', 'YJS'),
    18.       (4, '李四2', '001', '1979-03-10', 'BK'),
    19.       (5, '李四3', '003', '1995-08-16', 'YJS');

    创建了一个名称为demo的数据库；并在库里创建了名称为T_TEACHER的教师表并向表中插入了数据

    二、环境搭建

    1、创建实体类

    在cn.horse.demo下创建TeacherInfo实体类：

    TeacherInfo类：

    1. package cn.horse.demo;
    2.  
    3. import java.time.LocalDate;
    4.  
    5. public class TeacherInfo {
    6.     private Integer id;
    7.     private String name;
    8.     private String department;
    9.     private LocalDate birth;
    10.     private String degree;
    11.     
    12.     @Override
    13.     public String toString() {
    14.         StringBuilder stringBuilder = new StringBuilder();
    15.         stringBuilder.append("{ ");
    16.         stringBuilder.append("id: ");
    17.         stringBuilder.append(this.id);
    18.         stringBuilder.append(", ");
    19.         stringBuilder.append("name: ");
    20.         stringBuilder.append(this.name);
    21.         stringBuilder.append(", ");
    22.         stringBuilder.append("department: ");
    23.         stringBuilder.append(this.department);
    24.         stringBuilder.append(", ");
    25.         stringBuilder.append("birth: ");
    26.         stringBuilder.append(this.birth);
    27.         stringBuilder.append(", ");
    28.         stringBuilder.append("degree: ");
    29.         stringBuilder.append(this.degree);
    30.         stringBuilder.append(" }");
    31.         return stringBuilder.toString();
    32.     }
    33. }

    2、Mapper配置文件

    在resources的目录下新建TeacherInfoMapper.xml配置文件

    1. "1.0" encoding="UTF-8" ?>
    2. mapper
    3.         PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
    4.         "https://mybatis.org/dtd/mybatis-3-mapper.dtd">
    5. <mapper namespace="cn.horse.demo.TeacherInfoMapper">
    6.  
    7.     <select id="findAll" parameterType="cn.horse.demo.TeacherInfoQuery" resultType="cn.horse.demo.TeacherInfo">
    8.         SELECT
    9.             ID,
    10.             TEACHER_NAME name,
    11.             DEPARTMENT,
    12.             BIRTH,
    13.             DEGREE
    14.         FROM T_TEACHER
    15.         <where>
    16.             <if test="null != id and '' != id">
    17.                 AND ID = #{id}
    18.             if>
    19.             <if test="null != name and '' != name">
    20.                 AND TEACHER_NAME = #{name}
    21.             if>
    22.             <if test="null != department and '' != department">
    23.                 AND DEPARTMENT = #{department}
    24.             if>
    25.             <if test="null != degree and '' != degree">
    26.                 AND DEGREE = #{degree}
    27.             if>
    28.         where>
    29.     select>
    30. mapper>

    3、引入配置文件

    在resources下新建mybatis-config.xml配置文件，并引入TeacherInfoMapper.xml配置文件

    1. "1.0" encoding="UTF-8" ?>
    2. configuration
    3.         PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
    4.         "http://mybatis.org/dtd/mybatis-3-config.dtd">
    5. <configuration>
    6.     <settings>
    7.         <setting name="logImpl" value="JDK_LOGGING"/>
    8.     settings>
    9.  
    10.     <environments default="development">
    11.         <environment id="development">
    12.             <transactionManager type="JDBC"/>
    13.             <dataSource type="POOLED">
    14.                 <property name="driver" value="org.gjt.mm.mysql.Driver"/>
    15.                 <property name="url" value="jdbc:mysql://localhost:3306/demo?useUnicode=true&useSSL=false&characterEncoding=utf8"/>
    16.                 <property name="username" value="root"/>
    17.                 <property name="password" value="horse"/>
    18.             dataSource>
    19.         environment>
    20.     environments>
    21.  
    22.     <mappers>
    23.         <mapper resource="demo/TeacherInfoMapper.xml" />
    24.     mappers>
    25. configuration>

    4、会话工具类

    在cn.horse.demo包下新建SqlSessionUtils工具类

    1. package cn.horse.demo;
    2.  
    3. import org.apache.ibatis.session.SqlSession;
    4. import org.apache.ibatis.session.SqlSessionFactory;
    5. import org.apache.ibatis.session.SqlSessionFactoryBuilder;
    6.  
    7. import java.io.InputStream;
    8. import java.util.Objects;
    9.  
    10. public class SqlSessionUtils {
    11.  
    12.     private static final SqlSessionFactory sqlSessionFactory;
    13.     static {
    14.         // 读取mybatis配置文件
    15.         InputStream inputStream = ClassLoader.getSystemClassLoader().getResourceAsStream("mybatis-config.xml");
    16.         // 根据配置创建SqlSession工厂
    17.         sqlSessionFactory = new SqlSessionFactoryBuilder()
    18.                 .build(inputStream);
    19.     }
    20.  
    21.     /**
    22.      * 开启会话
    23.      * @return
    24.      */
    25.     public static SqlSession openSession() {
    26.         return sqlSessionFactory.openSession();
    27.     }
    28.  
    29.     /**
    30.      * 关闭会话
    31.      * @param sqlSession
    32.      */
    33.     public static void closeSession(SqlSession sqlSession) {
    34.         if(Objects.nonNull(sqlSession)) {
    35.             sqlSession.close();
    36.         }
    37.     }
    38. }

    5、JDK 日志系统配置

    在resources的目录下新建logging.properties配置文件

    1. handlers=java.util.logging.ConsoleHandler
    2. .level=INFO
    3.  
    4. cn.horse.demo.TeacherInfoMapper.level=FINER
    5. java.util.logging.ConsoleHandler.level=ALL
    6. java.util.logging.ConsoleHandler.formatter=java.util.logging.SimpleFormatter
    7. java.util.logging.SimpleFormatter.format=%1$tY-%1$tm-%1$td %1$tT.%1$tL %4$s %3$s - %5$s%6$s%n

    在cn.horse.demo下新建JdkLogConfig类：

    JdkLogConfig类：

    1. package cn.horse.demo;
    2.  
    3. import java.io.IOException;
    4. import java.io.InputStream;
    5. import java.util.logging.LogManager;
    6.  
    7. public class JdkLogConfig {
    8.  
    9.     public JdkLogConfig() {
    10.         try {
    11.             InputStream inputStream = ClassLoader.getSystemClassLoader().getResourceAsStream("logging.properties");
    12.             LogManager.getLogManager().readConfiguration(inputStream);
    13.         } catch (IOException e) {
    14.             throw new RuntimeException(e);
    15.         }
    16.     }
    17. }

    6、启动程序

    1. package cn.horse.demo;
    2.  
    3. import org.apache.ibatis.session.SqlSession;
    4.  
    5. import java.util.List;
    6.  
    7. public class Main {
    8.     public static void main(String[] args) {
    9.         // 引入JDK日志配置
    10.         System.setProperty("java.util.logging.config.class", "cn.horse.demo.JdkLogConfig");
    11.  
    12.         TeacherInfoQuery teacherInfoQuery = new TeacherInfoQuery();
    13.         teacherInfoQuery.setId(1);
    14.         teacherInfoQuery.setName("张三1");
    15.         teacherInfoQuery.setDepartment("001");
    16.         teacherInfoQuery.setDegree("BK");
    17.         findAll("cn.horse.demo.TeacherInfoMapper.findAll", teacherInfoQuery);
    18.     }
    19.  
    20.     private static void findAll(String statement, TeacherInfoQuery teacherInfoQuery) {
    21.         SqlSession sqlSession = null;
    22.         try {
    23.             sqlSession = SqlSessionUtils.openSession();
    24.             List teacherInfoList = sqlSession.selectList(statement, teacherInfoQuery);
    25.             for (TeacherInfo teacherInfo: teacherInfoList) {
    26.                 System.out.println(teacherInfo);
    27.             }
    28.         } finally {
    29.             SqlSessionUtils.closeSession(sqlSession);
    30.         }
    31.     }
    32. }

    执行后的结果如下：

    三、choose标签的使用

    在上面的运行结果中，我们可以看到执行的SQL语句：

    SELECT ID, TEACHER_NAME name, DEPARTMENT, BIRTH, DEGREE FROM T_TEACHER WHERE ID = ? AND TEACHER_NAME = ? AND DEPARTMENT = ? AND DEGREE = ?

    从SQL中我们可以看到条件语句中包含了ID、TEACHER_NAME、DEPARTMENT、DEGREE；而在实际的场景中ID是唯一的，ID作为条件时，其他的条件就显得比较多余，显然上面动态生成的条件语句是存在一些问题的，下面我们使用choose标签来解决此类问题：

    1. <select id="findAll" parameterType="cn.horse.demo.TeacherInfoQuery" resultType="cn.horse.demo.TeacherInfo">
    2.     SELECT
    3.     ID,
    4.     TEACHER_NAME name,
    5.     DEPARTMENT,
    6.     BIRTH,
    7.     DEGREE
    8.     FROM T_TEACHER
    9.     <where>
    10.         <choose>
    11.             <when test="null != id and '' != id">
    12.                 AND ID = #{id}
    13.             when>
    14.             <otherwise>
    15.                 <if test="null != name and '' != name">
    16.                     AND TEACHER_NAME = #{name}
    17.                 if>
    18.                 <if test="null != department and '' != department">
    19.                     AND DEPARTMENT = #{department}
    20.                 if>
    21.                 <if test="null != degree and '' != degree">
    22.                     AND DEGREE = #{degree}
    23.                 if>
    24.             otherwise>
    25.         choose>
    26.     where>
    27. select>

    choose标签：标签中可以包含多个when标签、一个otherwise标签

    when标签：test属性值用作条件判断，与if标签的test属性一样；when标签可以多次使用

    otherwise标签：otherwise标签最多只能使用一次，并且只能作为choose标签内的最后一个标签。

    choose标签类似于Java中的switch语句，会依次判断when标签中的条件是否满足，直到找到满足条件的when标签，并将when标签中的条件语句拼装到SQL语句中并跳出choose标签；如果找不到满足条件的when标签，则将otherwise标签中的条件语句拼装到SQL语句中并跳出choose标签；

    1、示例：使用ID查询教师

    1. // 引入JDK日志配置
    2. System.setProperty("java.util.logging.config.class", "cn.horse.demo.JdkLogConfig");
    3.  
    4. TeacherInfoQuery teacherInfoQuery = new TeacherInfoQuery();
    5. teacherInfoQuery.setId(1);
    6. teacherInfoQuery.setName("张三1");
    7. teacherInfoQuery.setDepartment("001");
    8. teacherInfoQuery.setDegree("BK");
    9. findAll("cn.horse.demo.TeacherInfoMapper.findAll", teacherInfoQuery);

    执行后的结果如下：

    结果分析：

    choose标签中，先判断第一个when标签条件是否满足，因为id为1，第一个条件满足，则将条件AND ID = #{id} 拼装到SQL语句中并跳出choose标签；所以执行的条件语句中只有ID = ? 条件

    2、示例：使用名称查询教师

    1. // 引入JDK日志配置
    2. System.setProperty("java.util.logging.config.class", "cn.horse.demo.JdkLogConfig");
    3.  
    4. TeacherInfoQuery teacherInfoQuery = new TeacherInfoQuery();
    5. teacherInfoQuery.setName("张三1");
    6. findAll("cn.horse.demo.TeacherInfoMapper.findAll", teacherInfoQuery);

    执行后的结果如下：

    结果分析：

    choose标签中，先判断第一个when标签条件是否满足，因为id为null，第一个条件不满足，没有找到满足条件的when标签，则将otherwise标签中的条件语句拼装到SQL语句中并跳出choose标签（由于这里otherwise标签中的条件语句是动态SQL语句，则会执行动态SQL语句，执行后的结果AND TEACHER_NAME = #{name} 作为otherwise标签的内容）；所以执行的条件语句中只有TEACHER_NAME = ? 条件

  • 相关阅读:
    组件化与插件化
    写一个基于C语言的保守垃圾回收器
    程序员的护城河：技术、创新还是沟通？
    我HTTP协议用的好好的，为什么还要用RPC协议？
    MATLAB | 官方举办的动图绘制大赛 | 第一周赛情回顾
    打造工业操作系统开源开放体系
    基于51单片机的简易电梯系统的设计
    Ukey连接虚拟前置机，浦银安盛基金用USB Server解决
    [ITIL]-ITIL4的服务管理关键概念
    VVC中图块划分结果在图像上显示（中间有一段没写完）
  • 原文地址：https://blog.csdn.net/m1729339749/article/details/132638515