少年阿賓

那些青春的歲月

BlogJava :: 首頁(yè) :: 聯(lián)系 :: 聚合

:: 管理

500 Posts :: 0 Stories :: 135 Comments :: 0 Trackbacks

MyBatis的動(dòng)態(tài)SQL詳解

MyBatis的動(dòng)態(tài)SQL是基于OGNL表達(dá)式的，它可以幫助我們方便的在SQL語(yǔ)句中實(shí)現(xiàn)某些邏輯。

MyBatis中用于實(shí)現(xiàn)動(dòng)態(tài)SQL的元素主要有：

if
choose（when，otherwise）
trim
where
set
foreach

if就是簡(jiǎn)單的條件判斷，利用if語(yǔ)句我們可以實(shí)現(xiàn)某些簡(jiǎn)單的條件選擇。先來(lái)看如下一個(gè)例子：

Xml代碼

<select id="dynamicIfTest" parameterType="Blog" resultType="Blog">
select * from t_blog where 11 = 1
<if test="title != null">
and title = #{title}
</if>
<if test="content != null">
and content = #{content}
</if>
<if test="owner != null">
and owner = #{owner}
</if>
</select>

	<select id="dynamicIfTest" parameterType="Blog" resultType="Blog">
		select * from t_blog where 1 = 1
		<if test="title != null">
			and title = #{title}
		</if>
		<if test="content != null">
			and content = #{content}
		</if>
		<if test="owner != null">
			and owner = #{owner}
		</if>
	</select>

這條語(yǔ)句的意思非常簡(jiǎn)單，如果你提供了title參數(shù)，那么就要滿足title=#{title}，同樣如果你提供了Content和Owner的時(shí)候，它們也需要滿足相應(yīng)的條件，之后就是返回滿足這些條件的所有Blog，這是非常有用的一個(gè)功能，以往我們使用其他類型框架或者直接使用JDBC的時(shí)候，如果我們要達(dá)到同樣的選擇效果的時(shí)候，我們就需要拼SQL語(yǔ)句，這是極其麻煩的，比起來(lái)，上述的動(dòng)態(tài)SQL就要簡(jiǎn)單多了。

choose元素的作用就相當(dāng)于JAVA中的switch語(yǔ)句，基本上跟JSTL中的choose的作用和用法是一樣的，通常都是與when和otherwise搭配的。看如下一個(gè)例子：

Xml代碼

<select id="dynamicChooseTest" parameterType="Blog" resultType="Blog">
select * from t_blog where 11 = 1
<choose>
<when test="title != null">
and title = #{title}
</when>
<when test="content != null">
and content = #{content}
</when>
<otherwise>
and owner = "owner1"
</otherwise>
</choose>
</select>

	<select id="dynamicChooseTest" parameterType="Blog" resultType="Blog">
		select * from t_blog where 1 = 1 
		<choose>
			<when test="title != null">
				and title = #{title}
			</when>
			<when test="content != null">
				and content = #{content}
			</when>
			<otherwise>
				and owner = "owner1"
			</otherwise>
		</choose>
	</select>

when元素表示當(dāng)when中的條件滿足的時(shí)候就輸出其中的內(nèi)容，跟JAVA中的switch效果差不多的是按照條件的順序，當(dāng)when中有條件滿足的時(shí)候，就會(huì)跳出choose，即所有的when和otherwise條件中，只有一個(gè)會(huì)輸出，當(dāng)所有的我很條件都不滿足的時(shí)候就輸出otherwise中的內(nèi)容。所以上述語(yǔ)句的意思非常簡(jiǎn)單，當(dāng)title!=null的時(shí)候就輸出and titlte = #{title}，不再往下判斷條件，當(dāng)title為空且content!=null的時(shí)候就輸出and content = #{content}，當(dāng)所有條件都不滿足的時(shí)候就輸出otherwise中的內(nèi)容。

where語(yǔ)句的作用主要是簡(jiǎn)化SQL語(yǔ)句中where中的條件判斷的，先看一個(gè)例子，再解釋一下where的好處。

Xml代碼

<select id="dynamicWhereTest" parameterType="Blog" resultType="Blog">
select * from t_blog
<where>
<if test="title != null">
title = #{title}
</if>
<if test="content != null">
and content = #{content}
</if>
<if test="owner != null">
and owner = #{owner}
</if>
</where>
</select>

	<select id="dynamicWhereTest" parameterType="Blog" resultType="Blog">
		select * from t_blog 
		<where>
			<if test="title != null">
				title = #{title}
			</if>
			<if test="content != null">
				and content = #{content}
			</if>
			<if test="owner != null">
				and owner = #{owner}
			</if>
		</where>
	</select>

where元素的作用是會(huì)在寫(xiě)入where元素的地方輸出一個(gè)where，另外一個(gè)好處是你不需要考慮where元素里面的條件輸出是什么樣子的，MyBatis會(huì)智能的幫你處理，如果所有的條件都不滿足那么MyBatis就會(huì)查出所有的記錄，如果輸出后是and 開(kāi)頭的，MyBatis會(huì)把第一個(gè)and忽略，當(dāng)然如果是or開(kāi)頭的，MyBatis也會(huì)把它忽略；此外，在where元素中你不需要考慮空格的問(wèn)題，MyBatis會(huì)智能的幫你加上。像上述例子中，如果title=null，而content != null，那么輸出的整個(gè)語(yǔ)句會(huì)是select * from t_blog where content = #{content}，而不是select * from t_blog where and content = #{content}，因?yàn)镸yBatis會(huì)智能的把首個(gè)and 或 or 給忽略。

trim元素的主要功能是可以在自己包含的內(nèi)容前加上某些前綴，也可以在其后加上某些后綴，與之對(duì)應(yīng)的屬性是prefix和suffix；可以把包含內(nèi)容的首部某些內(nèi)容覆蓋，即忽略，也可以把尾部的某些內(nèi)容覆蓋，對(duì)應(yīng)的屬性是prefixOverrides和suffixOverrides；正因?yàn)閠rim有這樣的功能，所以我們也可以非常簡(jiǎn)單的利用trim來(lái)代替where元素的功能，示例代碼如下：

Xml代碼

<select id="dynamicTrimTest" parameterType="Blog" resultType="Blog">
select * from t_blog
<trim prefix="where" prefixOverrides="and |or">
<if test="title != null">
title = #{title}
</if>
<if test="content != null">
and content = #{content}
</if>
<if test="owner != null">
or owner = #{owner}
</if>
</trim>
</select>

	<select id="dynamicTrimTest" parameterType="Blog" resultType="Blog">
		select * from t_blog 
		<trim prefix="where" prefixOverrides="and |or">
			<if test="title != null">
				title = #{title}
			</if>
			<if test="content != null">
				and content = #{content}
			</if>
			<if test="owner != null">
				or owner = #{owner}
			</if>
		</trim>
	</select>

set元素主要是用在更新操作的時(shí)候，它的主要功能和where元素其實(shí)是差不多的，主要是在包含的語(yǔ)句前輸出一個(gè)set，然后如果包含的語(yǔ)句是以逗號(hào)結(jié)束的話將會(huì)把該逗號(hào)忽略，如果set包含的內(nèi)容為空的話則會(huì)出錯(cuò)。有了set元素我們就可以動(dòng)態(tài)的更新那些修改了的字段。下面是一段示例代碼：

Xml代碼

<update id="dynamicSetTest" parameterType="Blog">
update t_blog
<set>
<if test="title != null">
title = #{title},
</if>
<if test="content != null">
content = #{content},
</if>
<if test="owner != null">
owner = #{owner}
</if>
</set>
where id = #{id}
</update>

	<update id="dynamicSetTest" parameterType="Blog">
		update t_blog
		<set>
			<if test="title != null">
				title = #{title},
			</if>
			<if test="content != null">
				content = #{content},
			</if>
			<if test="owner != null">
				owner = #{owner}
			</if>
		</set>
		where id = #{id}
	</update>

上述示例代碼中，如果set中一個(gè)條件都不滿足，即set中包含的內(nèi)容為空的時(shí)候就會(huì)報(bào)錯(cuò)。

foreach的主要用在構(gòu)建in條件中，它可以在SQL語(yǔ)句中進(jìn)行迭代一個(gè)集合。foreach元素的屬性主要有item，index，collection，open，separator，close。item表示集合中每一個(gè)元素進(jìn)行迭代時(shí)的別名，index指定一個(gè)名字，用于表示在迭代過(guò)程中，每次迭代到的位置，open表示該語(yǔ)句以什么開(kāi)始，separator表示在每次進(jìn)行迭代之間以什么符號(hào)作為分隔符，close表示以什么結(jié)束，在使用foreach的時(shí)候最關(guān)鍵的也是最容易出錯(cuò)的就是collection屬性，該屬性是必須指定的，但是在不同情況下，該屬性的值是不一樣的，主要有一下3種情況：

如果傳入的是單參數(shù)且參數(shù)類型是一個(gè)List的時(shí)候，collection屬性值為list
如果傳入的是單參數(shù)且參數(shù)類型是一個(gè)array數(shù)組的時(shí)候，collection的屬性值為array
如果傳入的參數(shù)是多個(gè)的時(shí)候，我們就需要把它們封裝成一個(gè)Map了，當(dāng)然單參數(shù)也可以封裝成map，實(shí)際上如果你在傳入?yún)?shù)的時(shí)候，在MyBatis里面也是會(huì)把它封裝成一個(gè)Map的，map的key就是參數(shù)名，所以這個(gè)時(shí)候collection屬性值就是傳入的List或array對(duì)象在自己封裝的map里面的key

下面分別來(lái)看看上述三種情況的示例代碼：

1.單參數(shù)List的類型：

Xml代碼

<select id="dynamicForeachTest" resultType="Blog">
select * from t_blog where id in
<foreach collection="list" index="index" item="item" open="(" separator="," close=")">
#{item}
</foreach>
</select>

	<select id="dynamicForeachTest" resultType="Blog">
		select * from t_blog where id in
		<foreach collection="list" index="index" item="item" open="(" separator="," close=")">
			#{item}
		</foreach>
	</select>

上述collection的值為list，對(duì)應(yīng)的Mapper是這樣的

Java代碼

public List<Blog> dynamicForeachTest(List<Integer> ids);

public List<Blog> dynamicForeachTest(List<Integer> ids);

測(cè)試代碼：

Java代碼

@Test
public void dynamicForeachTest() {
SqlSession session = Util.getSqlSessionFactory().openSession();
BlogMapper blogMapper = session.getMapper(BlogMapper.class);
List<Integer> ids = new ArrayList<Integer>();
ids.add(1);
ids.add(3);
ids.add(6);
List<Blog> blogs = blogMapper.dynamicForeachTest(ids);
for (Blog blog : blogs)
System.out.println(blog);
session.close();
}

	@Test
	public void dynamicForeachTest() {
		SqlSession session = Util.getSqlSessionFactory().openSession();
		BlogMapper blogMapper = session.getMapper(BlogMapper.class);
		List<Integer> ids = new ArrayList<Integer>();
		ids.add(1);
		ids.add(3);
		ids.add(6);
		List<Blog> blogs = blogMapper.dynamicForeachTest(ids);
		for (Blog blog : blogs)
			System.out.println(blog);
		session.close();
	}

2.單參數(shù)array數(shù)組的類型：

Xml代碼

<select id="dynamicForeach2Test" resultType="Blog">
select * from t_blog where id in
<foreach collection="array" index="index" item="item" open="(" separator="," close=")">
#{item}
</foreach>
</select>

	<select id="dynamicForeach2Test" resultType="Blog">
		select * from t_blog where id in
		<foreach collection="array" index="index" item="item" open="(" separator="," close=")">
			#{item}
		</foreach>
	</select>

上述collection為array，對(duì)應(yīng)的Mapper代碼：

Java代碼

public List<Blog> dynamicForeach2Test(int[] ids);

public List<Blog> dynamicForeach2Test(int[] ids);

對(duì)應(yīng)的測(cè)試代碼：

Java代碼

@Test
public void dynamicForeach2Test() {
SqlSession session = Util.getSqlSessionFactory().openSession();
BlogMapper blogMapper = session.getMapper(BlogMapper.class);
int[] ids = new int[] {1,3,6,9};
List<Blog> blogs = blogMapper.dynamicForeach2Test(ids);
for (Blog blog : blogs)
System.out.println(blog);
session.close();
}

	@Test
	public void dynamicForeach2Test() {
		SqlSession session = Util.getSqlSessionFactory().openSession();
		BlogMapper blogMapper = session.getMapper(BlogMapper.class);
		int[] ids = new int[] {1,3,6,9};
		List<Blog> blogs = blogMapper.dynamicForeach2Test(ids);
		for (Blog blog : blogs)
			System.out.println(blog);
		session.close();
	}

3.自己把參數(shù)封裝成Map的類型

Xml代碼

<select id="dynamicForeach3Test" resultType="Blog">
select * from t_blog where title like "%"#{title}"%" and id in
<foreach collection="ids" index="index" item="item" open="(" separator="," close=")">
#{item}
</foreach>
</select>

	<select id="dynamicForeach3Test" resultType="Blog">
		select * from t_blog where title like "%"#{title}"%" and id in
		<foreach collection="ids" index="index" item="item" open="(" separator="," close=")">
			#{item}
		</foreach>
	</select>

上述collection的值為ids，是傳入的參數(shù)Map的key，對(duì)應(yīng)的Mapper代碼：

Java代碼

public List<Blog> dynamicForeach3Test(Map<String, Object> params);

public List<Blog> dynamicForeach3Test(Map<String, Object> params);

對(duì)應(yīng)測(cè)試代碼：

Java代碼

@Test
public void dynamicForeach3Test() {
SqlSession session = Util.getSqlSessionFactory().openSession();
BlogMapper blogMapper = session.getMapper(BlogMapper.class);
final List<Integer> ids = new ArrayList<Integer>();
ids.add(1);
ids.add(2);
ids.add(3);
ids.add(6);
ids.add(7);
ids.add(9);
Map<String, Object> params = new HashMap<String, Object>();
params.put("ids", ids);
params.put("title", "中國(guó)");
List<Blog> blogs = blogMapper.dynamicForeach3Test(params);
for (Blog blog : blogs)
System.out.println(blog);
session.close();
}

	@Test
	public void dynamicForeach3Test() {
		SqlSession session = Util.getSqlSessionFactory().openSession();
		BlogMapper blogMapper = session.getMapper(BlogMapper.class);
		final List<Integer> ids = new ArrayList<Integer>();
		ids.add(1);
		ids.add(2);
		ids.add(3);
		ids.add(6);
		ids.add(7);
		ids.add(9);
		Map<String, Object> params = new HashMap<String, Object>();
		params.put("ids", ids);
		params.put("title", "中國(guó)");
		List<Blog> blogs = blogMapper.dynamicForeach3Test(params);
		for (Blog blog : blogs)
			System.out.println(blog);
		session.close();
	}

基礎(chǔ)部分可以查看我的另一篇博客：http://haohaoxuexi.iteye.com/blog/1333271

posted on 2012-12-25 13:10 abin 閱讀(18038) 評(píng)論(2) 編輯收藏所屬分類: Mybatis

Feedback

# d[未登錄](méi) 2013-09-03 15:00 ds

# re: MyBatis的動(dòng)態(tài)SQL詳解 2016-06-28 18:12 hd

<insert id="insertSelective" parameterType="com.*">
<selectKey resultType="java.lang.long" Keyproperty="id" order="AFTER">
select last_INSERT_ID()
</selectKey>
insert into last_TABLE
<trim prefix="("suffix=")" suffixOverrides=",">
<if test="createTime!=null">
update_time,
</if>
</trim>
</insert> 回復(fù) 更多評(píng)論

新用戶注冊(cè) 刷新評(píng)論列表


只有注冊(cè)用戶登錄后才能發(fā)表評(píng)論。




網(wǎng)站導(dǎo)航: 博客園 IT新聞 Chat2DB C++博客博問(wèn) 管理
相關(guān)文章: MyBatis的動(dòng)態(tài)SQL詳解 Mybatis 自動(dòng)生成代碼工具

少年阿賓

常用鏈接

留言簿(22)

我參與的團(tuán)隊(duì)

隨筆分類

隨筆檔案

新聞分類

相冊(cè)

搜索

最新評(píng)論

閱讀排行榜

評(píng)論排行榜

Feedback