六 、MyBean 框架的动态 SQL
动态 SQL: 通过 MyBatis 提供的各种标签对条件作出判断以实现动态拼接 SQL 语句。这里的条件判断使用的表达式为 OGNL 表达式。常用的动态 SQL 标签有<if>、<where>、<choose/>、<foreach>
等。
- MyBatis 的动态 SQL 语句,与 JSTL 中的语句非常相似。
动态 SQL,主要用于解决查询条件不确定的情况:
- 在程序运行期间,根据用户提交的查询条件进行查询。提交的查询条件不同,执行的 SQL 语句不同。若将每种可能的情况均逐一列出,对所有条件进行排列组合,将会出现大量的 SQL 语句。此时,可使用动态 SQL 来解决这样的问题
环境准备
- step1: 创建新的 maven 项目,加入 mybatis , mysql 驱动依赖
- step2: 创建实体类 Student , StudentDao 接口,StudentDao.xml , mybatis.xml , 测试类
使用之前的表 student。 - step3: 在 mapper 的动态 SQL 中若出现大于号(>)、小于号(<)、大于等于号(>=),小于等于号(<=)等符号,最好将其转换为实体符号。否则,XML 可能会出现解析出错问题。
特别是对于小于号(<),在 XML 中是绝不能出现的。否则解析 mapper 文件会出错。
实体符号表:
动态 SQL之 if 语句
对于该标签的执行,当 test 的值为 true 时,会将其包含的 SQL 片断拼接到其所在的 SQL 语句中
语法:<if test=”条件”> sql 语句的部分 </if>
举例
-
接口方法:
List<Student> selectStudentIf(Student student);
-
mapper 文件:
<select id="selectStudentIf" resultType="com.bjpowernode.domain.Student"> select id,name,email,age from student where 1=1 <if test="name != null and name !='' "> and name = #{name} </if> <if test="age > 0 "> and age > #{age} </if> </select>
-
测试方法:
@Test public void testSelect() throws IOException { Student param = new Student(); param.setName("李力"); param.setAge(18); List<Student> studentList = studentDao.selectStudentIf(param); studentList.forEach( stu -> System.out.println(stu)); }
动态 SQL 之 where
<if/>
标签的中存在一个比较麻烦的地方:需要在 where 后手工添加 1=1 的子句。
- 因为,若 where 后的所有条件均为 false,而 where 后若又没有 1=1 子句,则 SQL 中就会只剩下一个空的 where,SQL出错。所以,在 where 后,需要添加永为真子句 1=1,以防止这种情况的发生。但当数据量很大时,会严重影响查询效率。
使用<where/>
标签,在有查询条件时,可以自动添加上 where 子句;
- 没有查询条件时,不会添加 where 子句。
- 需要注意的是,第一个
<if/>
标签中的 SQL 片断,可以不包含 and。不过,写上 and 也不错,
系统会将多出的 and 去掉。但其它中 SQL 片断的 and,必须要求写上。否则 SQL 语句将拼接出错。
语法:<where> 其他动态 sql </where>
例子
-
接口方法:
List<Student> selectStudentWhere(Student student);
-
mapper 文件:
<select id="selectStudentWhere" resultType="com.bjpowernode.domain.Student"> select id,name,email,age from student <where> <if test="name != null and name !='' "> and name = #{name} </if> <if test="age > 0 "> and age > #{age} </if> </where> </select>
-
测试方法:
@Test public void testSelectWhere() throws IOException { Student param = new Student(); param.setName("李力"); param.setAge(18); List<Student> studentList = studentDao.selectStudentWhere(param); studentList.forEach( stu -> System.out.println(stu)); }
动态 SQL 之 foreach
<foreach/>
标签用于实现对于数组与集合的遍历。对其使用,需要注意:
➢ collection 表示要遍历的集合类型, list ,array 等。
➢ open、close、separator 为对遍历内容的 SQL 拼接。
语法:
<foreach collection="集合类型" open="开始的字符" close="结束的字符" item="集合中的成员" separator="集合成员之间的分隔符"> #{item 的值} </foreach>
(1) 遍历 List<简单类型>
表达式中的 List 使用 list 表示,其大小使用 list.size
表示。
需求:查询学生 id 是 1002,1005,1006
-
接口方法:
List<Student> selectStudentForList(List<Integer> idList);
-
mapper 文件:
<select id="selectStudentForList" resultType="com.bjpowernode.domain.Student"> select id,name,email,age from student <if test="list !=null and list.size > 0 "> where id in <foreach collection="list" open="(" close=")" item="stuid" separator=","> #{stuid} </foreach> </if> </select>
-
测试方法:
@Test public void testSelectForList() { List<Integer> list = new ArrayList<>(); list.add(1002); list.add(1005); list.add(1006); List<Student> studentList = studentDao.selectStudentForList(list); studentList.forEach( stu -> System.out.println(stu)); }
(2) 遍历 List<对象类型>
-
接口方法:
List<Student> selectStudentForList2(List<Student> stuList);
-
mapper 文件:
<select id="selectStudentForList2" resultType="com.bjpowernode.domain.Student"> select id,name,email,age from student <if test="list !=null and list.size > 0 "> where id in <foreach collection="list" open="(" close=")" item="stuobject" separator=","> #{stuobject.id} </foreach> </if> </select>
-
测试方法:
@Test public void testSelectForList2() { List<Student> list = new ArrayList<>(); Student s1 = new Student(); s1.setId(1002); list.add(s1); s1 = new Student(); s1.setId(1005); list.add(s1); List<Student> studentList = studentDao.selectStudentForList2(list); studentList.forEach( stu -> System.out.println(stu)); }
动态 SQL 之代码片段
<sql/>
标签用于定义 SQL 片断,以便其它 SQL 标签复用。
- 而其它标签使用该 SQL 片断,需要使用
<include/>子标签
。该<sql/>
标签可以定义 SQL 语句中的任何部分,所以<include/>
子标签可以放在动态 SQL 的任何位置。 - 可以简单的理解为定义函数,将指定的SQL片段提取出来,下次直接include就行了
举例
-
接口方法:
List<Student> selectStudentSqlFragment(List<Student> stuList);
-
mapper 文件:
<!--创建 sql 片段 id:片段的自定义名称--> <sql id="studentSql"> select id,name,email,age from student </sql> <select id="selectStudentSqlFragment" resultType="com.bjpowernode.domain.Student"> <!-- 引用 sql 片段 --> <include refid="studentSql"/> <if test="list !=null and list.size > 0 "> where id in <foreach collection="list" open="(" close=")" item="stuobject" separator=","> #{stuobject.id} </foreach> </if> </select>
-
测试方法:
@Test public void testSelectSqlFragment() { List<Student> list = new ArrayList<>(); Student s1 = new Student(); s1.setId(1002); list.add(s1); s1 = new Student(); s1.setId(1005); list.add(s1); List<Student> studentList = studentDao.selectStudentSqlFragment(list); studentList.forEach( stu -> System.out.println(stu)); }
七、MyBean配合文件
主配置文件
之前项目中使用的 mybatis.xml 是主配置文件。
主配置文件特点:
-
xml 文件,需要在头部使用约束文件=
<?xml version="1.0" encoding="UTF-8" ?> <!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN" "http://mybatis.org/dtd/mybatis-3-config.dtd">
-
根元素,
<configuration>
-
主要包含内容:
➢ 定义别名
➢ 数据源
➢ mapper 文件
dataSource 标签
Mybatis 中访问数据库,可以连接池技术,但它采用的是自己的连接池技术。
- 在 Mybatis 的
mybatis.xml 配置文件
中,通过<dataSource type=”pooled”>
来实现 Mybatis 中连接池的配置。
dataSource 类型
上图看出 Mybatis 将数据源分为三类:
- UNPOOLED: 不使用连接池的数据源
- POOLED: 使用连接池的数据源
- JNDI: 使用 JNDI 实现的数据源(在J2EE服务器上保存着一个数据库的多个连接。每一个连接通过DataSource可以找到。DataSource被绑定在了JNDI树上(为每一个DataSource提供一个名字)客户端通过名称找到在JNDI树上绑定的DataSource,再由DataSource找到一个连接)
dataSource 配置
-
在 MyBatis.xml 主配置文件,配置 dataSource:
<dataSource type="POOLED"> <!--连接数据库的四个要素--> <property name="driver" value="com.mysql.jdbc.Driver"/> <property name="url" value="jdbc:mysql://localhost:3306/ssm?charset=utf-8"/> <property name="username" value="root"/> <property name="password" value="123456"/> </dataSource>
-
MyBatis 在初始化时,根据
<dataSource>
的 type 属性来创建相应类型的的数据源 DataSource,即: -
type=”POOLED”
:MyBatis 会创建 PooledDataSource 实例 -
type=”UNPOOLED”
: MyBatis 会创建 UnpooledDataSource 实例 -
type=”JNDI”
:MyBatis 会从 JNDI 服务上查找 DataSource 实例,然后返回使用
事务的提交
默认使用手动提交事务
-
Mybatis 框架是对 JDBC 的封装,所以 Mybatis 框架的事务控制方式,本身也是用 JDBC 的 Connection 对象的 commit(), rollback().
-
Connection 对象的 setAutoCommit()方法来设置事务提交方式的。自动提交和手工提交、
-
可以使用
<transactionManager type="JDBC"/>
来指定 MyBatis 所使用的事务管理器。MyBatis 支持两种事务管理器类型:JDBC 与 MANAGED。
➢ JDBC:使用 JDBC 的事务管理机制。即,通过 Connection 的commit()
方法提交,通过rollback()
方法回滚。但默认情况下,MyBatis 将自动提交功能关闭了,改为了手动提交。即程序中需要显式的对
事务进行提交或回滚。从日志的输出信息中可以看到。
➢ MANAGED:由容器来管理事务的整个生命周期(如 Spring 容器)。
自动提交事务
设置自动提交的方式,factory 的 openSession()
分为有参数和无参数的。
- 有参数为 true,使用自动提交,可以修改 MyBatisUtil 的 getSqlSession()方法。
此时,再执行 insert 操作,无需执行session = factory.openSession(true);
session.commit()
,因为事务是自动提交的。
使用数据库属性配置文件
为 了方便对数据库连接的管理,DB 连接四要素数据一般都是存放在一个专门的属性文件中的。MyBatis 主配置文件需要从这个属性文件中读取这些数据。
步骤:
-
在
classpath
路径下,创建properties 文件
在 resources 目录创建 jdbc.properties 文件,文件名称自定义。
-
使用 properties 标签
修改主配置文件,文件开始位置加入:
-
主文件读取 property得到的是一个map ,可以直接使用
$
来通过key获取具体值<dataSource type="POOLED"> <!--使用 properties 文件: 语法 ${key}--> <property name="driver" value="${jdbc.driver}"/> <property name="url" value="${jdbc.url}"/> <property name="username" value="${jdbc.username}"/> <property name="password" value="${jdbc.password}"/> </dataSource>
typeAliases(类型别名)
Mybatis 支持默认别名,我们也可以采用自定义别名方式来开发,主要使用 在<select resultType=”别名”>
-
mybatis.xml 主配置文件定义别名:
<typeAliases> <!--定义单个类型的别名 type:类型的全限定名称 alias:自定义别名 --> <typeAlias type="com.bjpowernode.domain.Student" alias="mystudent"/> <!-- 批量定义别名,扫描整个包下的类,别名为类名(首字母大写或小写都可以) name:包名 --> <package name="com.bjpowernode.domain"/> <package name="...其他包"/> </typeAliases>
-
mapper.xml 文件,使用别名表示类型
<select id="selectStudents" resultType="mystudent"> select id,name,email,age from student </select>
mappers(映射器)
-
<mapper resource=" " />
使用相对于类路径的资源,从classpath 路径
查找文件
例如:<mapper resource="com/bjpowernode/dao/StudentDao.xml" />
-
<package name=""/>
指定包下的所有 Dao 接口
如:<package name="com.bjpowernode.dao"/>
注意:此种方法要求 Dao 接口名称和 mapper 映射文件名称相同,且在同一个目录中
八、扩展:PageHelper插件
Mybatis 通用分页插件
网址:https://github.com/pagehelper/Mybatis-PageHelper
PageHelper 支持多种数据库:
- Oracle
- Mysql
- MariaDB
- SQLite
- Hsqldb
- PostgreSQL
- DB2
- SqlServer(2005,2008)
- Informix
- H2
- SqlServer2012
- Derby
- Phoenix
基于 PageHelper 分页:
实现步骤:
-
(1)添加依赖, maven 坐标如下:
<dependency> <groupId>com.github.pagehelper</groupId> <artifactId>pagehelper</artifactId> <version>5.1.10</version> </dependency>
-
(2) 添加 plugin 配置
在<environments>
之前加入<plugins> <plugin interceptor="com.github.pagehelper.PageInterceptor" /> </plugins>
-
(3) PageHelper 对象
查询语句之前调用PageHelper.startPage
静态方法。
除了PageHelper.startPage
方法外,还提供了类似用法的PageHelper.offsetPage
方法。
在你需要进行分页的 MyBatis 查询方法前调用 PageHelper.startPage
静态方法即可,紧跟在这个
方法后的第一个 MyBatis 查询方法会被进行分页。
- ·PageHelper.startPage(1,3); 表示 获取第一页,每页三条内容
具体代码如下:·
@Test
public void testSelect() throws IOException {
//获取第 1 页,3 条内容
PageHelper.startPage(1,3);
List<Student> studentList = studentDao.selectStudents();
studentList.forEach( stu -> System.out.println(stu));
}