详解Java的MyBatis框架中动态SQL的基本用法-eolink官网

详解Java的MyBatis框架中动态SQL的基本用法

有些时候，sql语句where条件中，需要一些安全判断，例如按某一条件查询时如果传入的参数是空，此时查询出的结果很可能是空的，也许我们需要参数为空时，是查出全部的信息。使用Oracle的序列、mysql的函数生成Id。这时我们可以使用动态sql。下文均采用mysql语法和函数（例如字符串链接函数CONCAT）。

selectKey 标签

在insert语句中，在Oracle经常使用序列、在MySQL中使用函数来自动生成插入表的主键，而且需要方法能返回这个生成主键。使用myBatis的selectKey标签可以实现这个效果。下面例子，使用mysql数据库自定义函数nextval('student')，用来生成一个key，并把他设置到传入的实体类中的studentId属性上。所以在执行完此方法后，边可以通过这个实体类获取生成的key。

select nextval('student')

INSERT INTO STUDENT_TBL(STUDENT_ID,

STUDENT_NAME,

STUDENT_SEX,

STUDENT_BIRTHDAY,

STUDENT_PHOTO,

CLASS_ID,

PLACE_ID)

VALUES (#{studentId},

#{studentName},

#{studentSex},

#{studentBirthday},

#{studentPhoto, javaType=byte[], jdbcType=BLOB, typeHandler=org.apache.ibatis.type.BlobTypeHandler},

#{classId},

#{placeId})

调用接口方法，和获取自动生成key

StudentEntity entity = new StudentEntity();

entity.setStudentName("黎明你好");

entity.setStudentSex(1);

entity.setStudentBirthday(DateUtil.parse("1985-05-28"));

entity.setClassId("20000001");

entity.setPlaceId("70000001");

this.dynamicSqlMapper.createStudentAutoKey(entity);

System.out.println("新增学生ID: " + entity.getStudentId());

selectKey语句属性配置细节：

属性

描述

取值

keyProperty

selectKey 语句生成结果需要设置的属性。

resultType

生成结果类型，MyBatis 允许使用基本的数据类型，包括String 、int类型。

order

1：BEFORE，会先选择主键，然后设置keyProperty，再执行insert语句；

2：AFTER，就先运行insert 语句再运行selectKey 语句。

BEFORE

AFTER

statementType

MyBatis 支持STATEMENT，PREPARED和CALLABLE 的语句形式，对应Statement ，PreparedStatement 和CallableStatement 响应

STATEMENT

PREPARED

CALLABLE

if标签

if标签可用在许多类型的sql语句中，我们以查询为例。首先看一个很普通的查询：

SELECT * from STUDENT_TBL ST

WHERE ST.STUDENT_NAME LIKE CONCAT(CONCAT('%', #{studentName}),'%')

但是此时如果studentName或studentSex为null，此语句很可能报错或查询结果为空。此时我们使用if动态sql语句先进行判断，如果值为null或等于空字符串，我们就不进行此条件的判断，增加灵活性。

参数为实体类StudentEntity。将实体类中所有的属性均进行判断，如果不为空则执行判断条件。

SELECT ST.STUDENT_ID,

ST.STUDENT_NAME,

ST.STUDENT_SEX,

ST.STUDENT_BIRTHDAY,

ST.STUDENT_PHOTO,

ST.CLASS_ID,

ST.PLACE_ID

FROM STUDENT_TBL ST

WHERE

ST.STUDENT_NAME LIKE CONCAT(CONCAT('%', #{studentName, jdbcType=VARCHAR}),'%')

AND ST.STUDENT_SEX = #{studentSex, jdbcType=INTEGER}

AND ST.STUDENT_BIRTHDAY = #{studentBirthday, jdbcType=DATE}

AND ST.CLASS_ID = #{classId, jdbcType=VARCHAR}

AND ST.CLASS_ID = #{classEntity.classId, jdbcType=VARCHAR}

AND ST.PLACE_ID = #{placeId, jdbcType=VARCHAR}

AND ST.PLACE_ID = #{placeEntity.placeId, jdbcType=VARCHAR}

AND ST.STUDENT_ID = #{studentId, jdbcType=VARCHAR}

使用时比较灵活， new一个这样的实体类，我们需要限制那个条件，只需要附上相应的值就会where这个条件，相反不去赋值就可以不在where中判断。

public void select_test_2_1() {

StudentEntity entity = new StudentEntity();

entity.setStudentName("");

entity.setStudentSex(1);

entity.setStudentBirthday(DateUtil.parse("1985-05-28"));

entity.setClassId("20000001");

//entity.setPlaceId("70000001");

List list = this.dynamicSqlMapper.getStudentList_if(entity);

for (StudentEntity e : list) {

System.out.println(e.toString());

}

if + where 的条件判断

当where中的条件使用的if标签较多时，这样的组合可能会导致错误。我们以在3.1中的查询语句为例子，当java代码按如下方法调用时：

@Test

public void select_test_2_1() {

StudentEntity entity = new StudentEntity();

entity.setStudentName(null);

entity.setStudentSex(1);

List list = this.dynamicSqlMapper.getStudentList_if(entity);

for (StudentEntity e : list) {

System.out.println(e.toString());

}

如果上面例子，参数studentName为null，将不会进行STUDENT_NAME列的判断，则会直接导“WHERE AND”关键字多余的错误SQL。

这时我们可以使用where动态语句来解决。这个“where”标签会知道如果它包含的标签中有返回值的话，它就插入一个‘where'。此外，如果标签返回的内容是以AND 或OR 开头的，则它会剔除掉。

上面例子修改为：

SELECT ST.STUDENT_ID,

ST.STUDENT_NAME,

ST.STUDENT_SEX,

ST.STUDENT_BIRTHDAY,

ST.STUDENT_PHOTO,

ST.CLASS_ID,

ST.PLACE_ID

FROM STUDENT_TBL ST

ST.STUDENT_NAME LIKE CONCAT(CONCAT('%', #{studentName, jdbcType=VARCHAR}),'%')

AND ST.STUDENT_SEX = #{studentSex, jdbcType=INTEGER}

AND ST.STUDENT_BIRTHDAY = #{studentBirthday, jdbcType=DATE}

AND ST.CLASS_ID = #{classId, jdbcType=VARCHAR}

AND ST.CLASS_ID = #{classEntity.classId, jdbcType=VARCHAR}

AND ST.PLACE_ID = #{placeId, jdbcType=VARCHAR}

AND ST.PLACE_ID = #{placeEntity.placeId, jdbcType=VARCHAR}

AND ST.STUDENT_ID = #{studentId, jdbcType=VARCHAR}

if + set 的更新语句

当update语句中没有使用if标签时，如果有一个参数为null，都会导致错误。

当在update语句中使用if标签时，如果前面的if没有执行，则或导致逗号多余错误。使用set标签可以将动态的配置SET 关键字，和剔除追加到条件末尾的任何不相关的逗号。

使用if+set标签修改后，如果某项为null则不进行更新，而是保持数据库原值。如下示例：

UPDATE STUDENT_TBL

STUDENT_TBL.STUDENT_NAME = #{studentName},

STUDENT_TBL.STUDENT_SEX = #{studentSex},

STUDENT_TBL.STUDENT_BIRTHDAY = #{studentBirthday},

STUDENT_TBL.STUDENT_PHOTO = #{studentPhoto, javaType=byte[], jdbcType=BLOB, typeHandler=org.apache.ibatis.type.BlobTypeHandler},

STUDENT_TBL.CLASS_ID = #{classId}

STUDENT_TBL.PLACE_ID = #{placeId}

WHERE STUDENT_TBL.STUDENT_ID = #{studentId};

if + trim代替where/set标签

trim是更灵活的去处多余关键字的标签，他可以实践where和set的效果。

trim代替where

SELECT ST.STUDENT_ID,

ST.STUDENT_NAME,

ST.STUDENT_SEX,

ST.STUDENT_BIRTHDAY,

ST.STUDENT_PHOTO,

ST.CLASS_ID,

ST.PLACE_ID

FROM STUDENT_TBL ST

ST.STUDENT_NAME LIKE CONCAT(CONCAT('%', #{studentName, jdbcType=VARCHAR}),'%')

AND ST.STUDENT_SEX = #{studentSex, jdbcType=INTEGER}

AND ST.STUDENT_BIRTHDAY = #{studentBirthday, jdbcType=DATE}

AND ST.CLASS_ID = #{classId, jdbcType=VARCHAR}

AND ST.CLASS_ID = #{classEntity.classId, jdbcType=VARCHAR}

AND ST.PLACE_ID = #{placeId, jdbcType=VARCHAR}

AND ST.PLACE_ID = #{placeEntity.placeId, jdbcType=VARCHAR}

AND ST.STUDENT_ID = #{studentId, jdbcType=VARCHAR}

trim代替set

UPDATE STUDENT_TBL

STUDENT_TBL.STUDENT_NAME = #{studentName},

STUDENT_TBL.STUDENT_SEX = #{studentSex},

STUDENT_TBL.STUDENT_BIRTHDAY = #{studentBirthday},

STUDENT_TBL.STUDENT_PHOTO = #{studentPhoto, javaType=byte[], jdbcType=BLOB, typeHandler=org.apache.ibatis.type.BlobTypeHandler},

STUDENT_TBL.CLASS_ID = #{classId},

STUDENT_TBL.PLACE_ID = #{placeId}

WHERE STUDENT_TBL.STUDENT_ID = #{studentId}

choose (when, otherwise)

有时候我们并不想应用所有的条件，而只是想从多个选项中选择一个。而使用if标签时，只要test中的表达式为true，就会执行if标签中的条件。MyBatis提供了choose 元素。if标签是与(and)的关系，而choose比傲天是或（or）的关系。

choose标签是按顺序判断其内部when标签中的test条件出否成立，如果有一个成立，则choose结束。当choose中所有when的条件都不满则时，则执行otherwise中的sql。类似于Java 的switch 语句，choose为switch，when为case，otherwise则为default。

例如下面例子，同样把所有可以限制的条件都写上，方面使用。choose会从上到下选择一个when标签的test为true的sql执行。安全考虑，我们使用where将choose包起来，放置关键字多于错误。

SELECT ST.STUDENT_ID,

ST.STUDENT_NAME,

ST.STUDENT_SEX,

ST.STUDENT_BIRTHDAY,

ST.STUDENT_PHOTO,

ST.CLASS_ID,

ST.PLACE_ID

FROM STUDENT_TBL ST

ST.STUDENT_NAME LIKE CONCAT(CONCAT('%', #{studentName, jdbcType=VARCHAR}),'%')

AND ST.STUDENT_SEX = #{studentSex, jdbcType=INTEGER}

AND ST.STUDENT_BIRTHDAY = #{studentBirthday, jdbcType=DATE}

AND ST.CPWjlEoTCDLASS_ID = #{classId, jdbcType=VARCHAR}

AND ST.CLASS_ID = #{classEntity.classId, jdbcType=VARCHAR}

AND ST.PLACE_ID = #{placeId, jdbcType=VARCHAR}

AND ST.PLACE_ID = #{placeEntity.placeId, jdbcType=VARCHAR}

AND ST.STUDENT_ID = #{studentId, jdbcType=VARCHAR}

foreach

对于动态SQL 非常必须的，主是要迭代一个集合，通常是用于IN 条件。List 实例将使用“list”做为键，数组实例以“array” 做为键。

foreach元素是非常强大的，它允许你指定一个集合，声明集合项和索引变量，它们可以用在元素体内。它也允许你指定开放和关闭的字符串，在迭代之间放置分隔符。这个元素是很智能的，它不会偶然地附加多余的分隔符。

注意：你可以传递一个List实例或者数组作为参数对象传给MyBatis。当你这么做的时候，MyBatis会自动将它包装在一个Map中，用名称在作为键。List实例将会以“list”作为键，而数组实例将会以“array”作为键。

这个部分是对关于XML配置文件和XML映射文件的而讨论的。下一部分将详细讨论Java API，所以你可以得到你已经创建的最有效的映射。

1.参数为array示例的写法

接口的方法声明：

public List getStudentListByClassIds_foreach_array(String[] classIds);

动态SQL语句：

<!— 7.1 foreach(循环array参数) - 作为where中in的条件 -->

SELECT ST.STUDENT_ID,

ST.STUDENT_NAME,

ST.STUDENT_SEX,

ST.STUDENT_BIRTHDAY,

ST.STUDENT_PHOTO,

ST.CLASS_ID,

ST.PLACE_ID

FROM STUDENT_TBL ST

WHERE ST.CLASS_ID IN

#{classIds}

测试代码，查询学生中，在20000001、20000002这两个班级的学生：

@Test

public void test7_foreach() {

String[] classIds = { "20000001", "20000002" };

List list = this.dynamicSqlMapper.getStudentListByClassIds_foreach_array(classIds);

for (StudentEntity e : list) {

System.out.println(e.toString());

}

2.参数为list示例的写法

接口的方法声明：

public List getStudentListByClassIds_foreach_list(List classIdList);

动态SQL语句：

SELECT ST.STUDENT_ID,

ST.STUDENT_NAME,

ST.STUDENT_SEX,

ST.STUDENT_BIRTHDAY,

ST.STUDENT_PHOTO,

ST.CLASS_ID,

ST.PLACE_ID

FROM STUDENT_TBL ST

WHERE ST.CLASS_ID IN

#{classIdList}

测试代码，查询学生中，在20000001、20000002这两个班级的学生：

@Test

public void test7_2_foreach() {

ArrayList classIdList = new ArrayList();

classIdList.add("20000001");

classIdList.add("20000002");

List list = this.dynamicSqlMapper.getStudentListByClassIds_foreach_list(classIdList);

for (StudentEntity e : list) {

System.out.println(e.toString());

}

3.自己把参数封装成Map的类型

select * from t_blog where title like "%"#{title}"%" and id in

#{item}

上述collection的值为ids，是传入的参数Map的key，对应的Mapper代码：

public List dynamicForeach3Test(Map params);

对应测试代码：

@Test

public void dynamicForeach3Test() {

SqlSession session = Util.getSqlSessionFactory().openSession();

BlogMapper blogMapper = session.getMapper(BlogMapper.class);

final List ids = new ArrayList();

ids.add(1);

ids.add(2);

ids.add(3);

ids.add(6);

ids.add(7);

ids.add(9);

Map params = new HashMap();

params.put("ids", ids);

params.put("title", "中国");

List blogs = blogMapper.dynamicForeach3Test(params);

for (Blog blog : blogs)

System.out.println(blog);

session.close();

}

Iterator与LIstIterator接口在java中的区别有哪些

270 2023-07-19

详解Java的MyBatis框架中动态SQL的基本用法

Iterator与LIstIterator接口在java中的区别有哪些

java 单机接口限流处理方案

Spring中的aware接口详情

推荐文章

接口调用是什么意思？几种常用接口调用方式

接口设计原则

8款在线 API 接口文档管理工具

api管理系统是什么？

什么是接口调试？接口调试的步骤有哪些？

api 接口管理系统有哪些？

接口测试有几种测试方法

API文档生成工具有哪些？

微服务和api网关区别

交换机配置步骤

最近发表

热评文章

在线接口文档管理工具推荐，支持在线测试，HTTP接口

开源的在线接口文档wiki工具Mindoc的介绍与使

如何优雅的进行接口设计？接口设计的六大原则是什么？

什么是API测试,api检测公司

软件接口设计怎么做？前后端分离软件接口设计思路

接口管理平台推荐，几大接口管理平台总有一款适合你！