動態sql

1.什麼是動態sql
mybatis核心 對sql語句進行靈活操作，通過表示式進行判斷，對sql進行靈活拼接、組裝。

2.需求

使用者資訊綜合查詢列表和使用者資訊查詢列表總數這兩個statement的定義使用動態sql。

對查詢條件進行判斷，如果輸入引數不為空才進行查詢條件拼接。

3.mapper.xml
原查詢語句配置：

<mapper namespace="cn.edu.hpu.mybatis.mapper.UserMapper">
	
	<!-- 使用者資訊綜合查詢 
	#{UserCustom.sex}取出包裝物件中性別值
	${UserCustom.username}取得pojo包裝物件中使用者名稱稱
	-->
	<select id="findUserList" parameterType="cn.edu.hpu.mybatis.PO.UserQueryVo" 
								resultType="cn.edu.hpu.mybatis.PO.UserCustom">
		select * from user where user.sex=#{userCustom.sex} and user.username like '%${userCustom.username}%'
	</select>
	
	<!-- 使用者資訊綜合查詢總數 -->
	<select id="findUserCount" parameterType="cn.edu.hpu.mybatis.PO.UserQueryVo" resultType="int">
		select count(*) from user where user.sex=#{userCustom.sex} and user.username like '%${userCustom.username}%'
	</select>
	......
</mapper>
 

修改後的查詢語句配置：

<!-- 使用者資訊綜合查詢 
	#{UserCustom.sex}取出包裝物件中性別值
	${UserCustom.username}取得pojo包裝物件中使用者名稱稱
	-->
	<select id="findUserList" parameterType="cn.edu.hpu.mybatis.PO.UserQueryVo" 
								resultType="cn.edu.hpu.mybatis.PO.UserCustom">
		select * from user 
		
		<!-- where標籤可以自動去掉第一個and -->  
		<where>
		<if test="userCustom!=null">
			<if test="userCustom.sex!=null and userCustom.sex!=''">
				and user.sex=#{userCustom.sex}
			</if>
			<if test="userCustom.username!=null and userCustom.username!=''">
				and user.username like '%${userCustom.username}%'
			</if>
		</if>
		</where>
	</select>
	
	<!-- 使用者資訊綜合查詢總數 -->
	<select id="findUserCount" parameterType="cn.edu.hpu.mybatis.PO.UserQueryVo" resultType="int">
		select count(*) from user 


		<!-- where標籤可以自動去掉第一個and -->  
		<where>
		<if test="userCustom!=null">
			<if test="userCustom.sex!=null and userCustom.sex!=''">
				and user.sex=#{userCustom.sex}
			</if>
			<if test="userCustom.username!=null and userCustom.username!=''">
				and user.username like '%${userCustom.username}%'
			</if>
		</if>
		</where>
	</select>
 

 
4.測試程式碼

//使用者資訊綜合查詢
	@Test
	public void testFindUserList() throws Exception{
		
		SqlSession sqlSession=sqlSessionFactory.openSession();
		
		//建立UserMapper代理物件
		UserMapper userMapper=sqlSession.getMapper(UserMapper.class);
		
		//建立包裝物件，設定查詢條件
		UserQueryVo userQueryVo=new UserQueryVo();
		UserCustom userCustom=new UserCustom();
		//由於這裡使用動態sql，如果這裡不設定某個值，條件不會拼接在sql中
		//userCustom.setSex("男");
		userCustom.setUsername("張三");
		userQueryVo.setUserCustom(userCustom);
		
		//呼叫userMapper的方法
		List<UserCustom> users=userMapper.findUserList(userQueryVo);
		
		for (int i = 0; i < users.size(); i++) {
			UserCustom user=(UserCustom)users.get(i);
			System.out.println(user.getId()+":"+user.getUsername());
		}
	}
 

測試結果:
1:張三
4:張三丰

輸出日誌：

DEBUG [main] - Opening JDBC Connection
DEBUG [main] - Created connection 31761534.
DEBUG [main] - Setting autocommit to false on JDBC Connection [[email protected]]
DEBUG [main] - ==>  Preparing: select * from user WHERE user.username like '%張三%' 
DEBUG [main] - ==> Parameters: 
DEBUG [main] - <==      Total: 2

發現sql語句為select * from user WHERE user.username like '%張三%' ，並沒有將sex拼接進去，說明我們的動態sql設定成功

相應的，把userCustom.setUsername("張三");也註釋掉，發現輸出日誌：

DEBUG [main] - Opening JDBC Connection
DEBUG [main] - Created connection 24027753.
DEBUG [main] - Setting autocommit to false on JDBC Connection [[email protected]]
DEBUG [main] - ==>  Preparing: select * from user 
DEBUG [main] - ==> Parameters: 
DEBUG [main] - <==      Total: 5

發現sql語句為select * from user，並沒有將sex和username拼接進去，說明我們的動態sql設定成功

5.sql片段

5.1需求
將上邊實現的動態sql判斷程式碼塊抽取出來，組成一個sql片段。其它的statement中就可以引用sql片段。
方便程式設計師進行開發。

5.2定義sql片段

<mapper namespace="cn.edu.hpu.mybatis.mapper.UserMapper">

	<!-- 定義sql片段 
	id:sql片段的唯一標識 
	在sql片段中不要加入where
	經驗:一般我們定義sql片段是為了可重用性，是基於單表來定義sql片段，
	這樣的話這個sql片段可重用性才高-->
	<sql id="query_user_where">
		<if test="userCustom!=null">
			<if test="userCustom.sex!=null and userCustom.sex!=''">
				and user.sex=#{userCustom.sex}
			</if>
			<if test="userCustom.username!=null and userCustom.username!=''">
				and user.username like '%${userCustom.username}%'
			</if>
		</if>
	</sql>
	......
</mapper>

5.3引用sql片段
在mapper.xml中定義的statement中引用sql片段：

<!-- 使用者資訊綜合查詢 
	#{UserCustom.sex}取出包裝物件中性別值
	${UserCustom.username}取得pojo包裝物件中使用者名稱稱
	-->
	<select id="findUserList" parameterType="cn.edu.hpu.mybatis.PO.UserQueryVo" 
								resultType="cn.edu.hpu.mybatis.PO.UserCustom">
		select * from user 
		
		<!-- where標籤可以自動去掉第一個and -->  
		<where>
			<!-- 應用sql片段的id，如果refid指定的id不再本mapper檔案中，需要前邊加namespace -->
			<include refid="query_user_where"></include>
			<!-- 在這裡還可能要引用其他的sql片段 -->
		</where>
	</select>
	
	<!-- 使用者資訊綜合查詢總數 -->
	<select id="findUserCount" parameterType="cn.edu.hpu.mybatis.PO.UserQueryVo" resultType="int">
		select count(*) from user 


		<!-- where標籤可以自動去掉第一個and -->  
		<where>
			<!-- 應用sql片段的id，如果refid指定的id不再本mapper檔案中，需要前邊加namespace -->
			<include refid="query_user_where"></include>
			<!-- 在這裡還可能要引用其他的sql片段 -->
		</where>
	</select>

測試:

//使用者資訊綜合查詢
@Test
public void testFindUserList() throws Exception{
	
	SqlSession sqlSession=sqlSessionFactory.openSession();
	
	//建立UserMapper代理物件
	UserMapper userMapper=sqlSession.getMapper(UserMapper.class);
	
	//建立包裝物件，設定查詢條件
	UserQueryVo userQueryVo=new UserQueryVo();
	UserCustom userCustom=new UserCustom();
	//由於這裡使用動態sql，如果這裡不設定某個值，條件不會拼接在sql中
	userCustom.setSex("男");
	userCustom.setUsername("張三");
	userQueryVo.setUserCustom(userCustom);
	
	//呼叫userMapper的方法
	List<UserCustom> users=userMapper.findUserList(userQueryVo);
	
	for (int i = 0; i < users.size(); i++) {
		UserCustom user=(UserCustom)users.get(i);
		System.out.println(user.getId()+":"+user.getUsername());
	}
}

測試結果:
1:張三
4:張三丰


輸出日誌:

DEBUG [main] - Opening JDBC Connection
DEBUG [main] - Created connection 17689439.
DEBUG [main] - Setting autocommit to false on JDBC Connection [[email protected]]
DEBUG [main] - ==>  Preparing: select * from user 
DEBUG [main] - ==> Parameters: 
DEBUG [main] - <==      Total: 5

說明sql片段引用成功

小結：

sql片段方便程式設計師進行開發