Mybaits的10种通用的写法

用来循环容器的标签forEach,查看例子

foreach元素的属性主要有item，index，collection，open，separator，close。

item：集合中元素迭代时的别名，

index：集合中元素迭代时的索引

open：常用语where语句中，表示以什么开始，比如以'('开始

separator：表示在每次进行迭代时的分隔符，

close 常用语where语句中，表示以什么结束，

在使用foreach的时候最关键的也是最容易出错的就是collection属性，该属性是必须指定的，但是在不同情况下，该属性的值是不一样的，主要有一下3种情况：

如果传入的是单参数且参数类型是一个List的时候，collection属性值为list .

如果传入的是单参数且参数类型是一个array数组的时候，collection的属性值为array .

如果传入的参数是多个的时候，我们就需要把它们封装成一个Map了，当然单参数也可以封装成map，实际上如果你在传入参数的时候，在MyBatis里面也是会把它封装成一个Map的，map的key就是参数名，所以这个时候collection属性值就是传入的List或array对象在自己封装的map里面的key.

针对最后一条，我们来看一下官方说法：

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

所以，不管是多参数还是单参数的list,array类型，都可以封装为map进行传递。如果传递的是一个List，则mybatis会封装为一个list为key，list值为object的map，如果是array，则封装成一个array为key，array的值为object的map，如果自己封装呢，则colloection里放的是自己封装的map里的key值

//mapper中我们要为这个方法传递的是一个容器,将容器中的元素一个一个的

//拼接到xml的方法中就要使用这个forEach这个标签了

publicListqueryById(List<String> userids);

//对应的xml中如下

select* FROM entity

whereidin

#{userid}

concat模糊查询

//比如说我们想要进行条件查询,但是几个条件不是每次都要使用,那么我们就可以

//通过判断是否拼接到sql中

SELECT *fromentity

name likeconcat('%',concat(#{name},'%'))

choose (when, otherwise)标签

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

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

<!--  choose(判断参数) - 按顺序将实体类 User 第一个不为空的属性作为：where条件 -->

SELECT *

FROM User u

u.username LIKE CONCAT(CONCAT('%', #{username, jdbcType=VARCHAR}),'%')

AND u.sex = #{sex, jdbcType=INTEGER}

AND u.birthday = #{birthday, jdbcType=DATE}

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 =newStudentEntity();

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());

if标签

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

<!-- 查询学生list，like姓名 -->

SELECT * from STUDENT_TBL ST

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

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

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


SELECTST.STUDENT_ID,

ST.STUDENT_NAME,

ST.STUDENT_SEX,

ST.STUDENT_BIRTHDAY,

ST.STUDENT_PHOTO,

ST.CLASS_ID,

ST.PLACE_ID

FROMSTUDENT_TBL ST

WHERE

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

ANDST.STUDENT_SEX =#{studentSex, jdbcType=INTEGER}  

ANDST.STUDENT_BIRTHDAY =#{studentBirthday, jdbcType=DATE}  

ANDST.CLASS_ID =#{classId, jdbcType=VARCHAR}  

ANDST.CLASS_ID =#{classEntity.classId, jdbcType=VARCHAR}  

ANDST.PLACE_ID =#{placeId, jdbcType=VARCHAR}  

ANDST.PLACE_ID =#{placeEntity.placeId, jdbcType=VARCHAR}  

ANDST.STUDENT_ID =#{studentId, jdbcType=VARCHAR}  

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

publicvoidselect_test_2_1(){

StudentEntity entity =newStudentEntity();

entity.setStudentName("");

entity.setStudentSex(1);

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

entity.setClassId("20000001");

//entity.setPlaceId("70000001");  

Listlist=this.dynamicSqlMapper.getStudentList_if(entity);

for(StudentEntity e :list) {

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

}

}

if + where 的条件判断

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

@Test

publicvoidselect_test_2_1()

{

StudentEntity entity =newStudentEntity();

entity.setStudentName(null);

entity.setStudentSex(1);

Listlist=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 开头的，则它会剔除掉。 

上面例子修改为：


SELECTST.STUDENT_ID,

ST.STUDENT_NAME,

ST.STUDENT_SEX,

ST.STUDENT_BIRTHDAY,

ST.STUDENT_PHOTO,

ST.CLASS_ID,

ST.PLACE_ID

FROMSTUDENT_TBL ST

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

ANDST.STUDENT_SEX =#{studentSex, jdbcType=INTEGER}  

ANDST.STUDENT_BIRTHDAY =#{studentBirthday, jdbcType=DATE}  

ANDST.CLASS_ID =#{classId, jdbcType=VARCHAR}  

ANDST.CLASS_ID =#{classEntity.classId, jdbcType=VARCHAR}  

ANDST.PLACE_ID =#{placeId, jdbcType=VARCHAR}  

ANDST.PLACE_ID =#{placeEntity.placeId, jdbcType=VARCHAR}  

ANDST.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


SELECTST.STUDENT_ID,

ST.STUDENT_NAME,

ST.STUDENT_SEX,

ST.STUDENT_BIRTHDAY,

ST.STUDENT_PHOTO,

ST.CLASS_ID,

ST.PLACE_ID

FROMSTUDENT_TBL ST

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

ANDST.STUDENT_SEX =#{studentSex, jdbcType=INTEGER}  

ANDST.STUDENT_BIRTHDAY =#{studentBirthday, jdbcType=DATE}  

ANDST.CLASS_ID =#{classId, jdbcType=VARCHAR}  

ANDST.CLASS_ID =#{classEntity.classId, jdbcType=VARCHAR}  

ANDST.PLACE_ID =#{placeId, jdbcType=VARCHAR}  

ANDST.PLACE_ID =#{placeEntity.placeId, jdbcType=VARCHAR}  

ANDST.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}  

foreach

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

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

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

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

参数为array示例的写法

接口的方法声明：

publicListgetStudentListByClassIds_foreach_array(String[] classIds);

动态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

#{classIds}

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

@Test

publicvoidtest7_foreach()

{

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

Listlist=this.dynamicSqlMapper.getStudentListByClassIds_foreach_array(classIds);

for(StudentEntity e :list) {

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

}

}

2参数为list示例的写法 

接口的方法声明：

publicList getStudentListByClassIds_foreach_list(List classIdList);

动态SQL语句：

<!-- 7.2 foreach(循环List<String>参数) - 作为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

#{classIdList}

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

@Test

publicvoidtest7_2_foreach()

{

ArrayList classIdList =newArrayList();

classIdList.add("20000001");

classIdList.add("20000002");

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

for(StudentEntity e : list) {

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

}

sql片段标签：通过该标签可定义能复用的sql语句片段，在执行sql语句标签中直接引用即可。这样既可以提高编码效率，还能有效简化代码，提高可读性

需要配置的属性：id="" >>>表示需要改sql语句片段的唯一标识

引用：通过标签引用，refid="" 中的值指向需要引用的中的id=“”属性

<!--定义sql片段-->

o.order_id,o.cid,o.address,o.create_date,o.orderitem_id,i.orderitem_id,i.product_id,i.count

select

<!--引用sql片段-->

from ordertable o

join orderitem i on o.orderitem_id = i.orderitem_id

where o.order_id = #{orderId}

​

©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 204,590评论 6赞 478
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 86,808评论 2赞 381
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 151,151评论 0赞 337
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 54,779评论 1赞 277
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 63,773评论 5赞 367
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 48,656评论 1赞 281
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 38,022评论 3赞 398
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 36,678评论 0赞 258
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 41,038评论 1赞 299
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,659评论 2赞 321
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,756评论 1赞 330
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 33,411评论 4赞 321
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 39,005评论 3赞 307
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,973评论 0赞 19
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,203评论 1赞 260
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 45,053评论 2赞 350
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 42,495评论 2赞 343

推荐阅读更多精彩内容

  • Java初级面试题
    1. Java基础部分 基础部分的顺序：基本语法，类相关的语法，内部类的语法，继承相关的语法，异常的语法，线程的语...
    子非鱼_t_阅读 31,571评论 18赞 399
  • MYSQL基础
    MYSQL 基础知识 1 MySQL数据库概要 2 简单MySQL环境 3 数据的存储和获取 4 MySQL基本操...
    Kingtester阅读 7,777评论 5赞 116
  • Java面试
    一. Java基础部分.................................................
    wy_sure阅读 3,788评论 0赞 11
  • WinRun4J 创建服务端，并注册为window服务-教程。
    先创建服务端的APP 1.官网下载Winrun4j。http://winrun4j.sourceforge.net...
    Alex_1799阅读 1,681评论 1赞 2
  • 红安骑行旅途之骑友情
    我们不是亲人，胜似亲人，是这次骑行最大的感受。 原本是一起环过青海湖骑友的小聚，因我实在想感受长途骑行的快乐，厚着...
    appleye阅读 488评论 0赞 1