【MyBatis框架】mapper配置文件-关于动态sql

逃离我推掉我的手 2021-09-25 23:00 354阅读 0赞

动态sql  
  
1.什么是动态sql  
mybatis核心 对sql语句进行灵活操作，通过表达式进行判断，对sql进行灵活拼接、组装。  
  
2.需求  
  
用户信息综合查询列表和用户信息查询列表总数这两个statement的定义使用动态sql。  
  
对查询条件进行判断，如果输入参数不为空才进行查询条件拼接。  
  
3.mapper.xml  
原查询语句配置：

**\[html\]**  [view plain][]   [copy][view plain]

1.  **<****mapper** namespace="cn.edu.hpu.mybatis.mapper.UserMapper"**>**  
2.        
3.        
13.     **<****select** id="findUserCount" parameterType="cn.edu.hpu.mybatis.PO.UserQueryVo" resultType="int"**>**  
14.         select count(\*) from user where user.sex=\#\{userCustom.sex\} and user.username like '%$\{userCustom.username\}%'  
15.     **</****select****>**  
16.     ......  
17. **</****mapper****>**

修改后的查询语句配置：

**\[html\]**  [view plain][]   [copy][view plain]

1.      
10.         **<****where****>**  
11.         **<****if** test="userCustom!=null"**>**  
12.             **<****if** test="userCustom.sex!=null and userCustom.sex!=''"**>**  
13.                 and user.sex=\#\{userCustom.sex\}  
14.             **</****if****>**  
15.             **<****if** test="userCustom.username!=null and userCustom.username!=''"**>**  
16.                 and user.username like '%$\{userCustom.username\}%'  
17.             **</****if****>**  
18.         **</****if****>**  
19.         **</****where****>**  
20.     **</****select****>**  
21.       
22.       
23.     **<****select** id="findUserCount" parameterType="cn.edu.hpu.mybatis.PO.UserQueryVo" resultType="int"**>**  
24.         select count(\*) from user   
25.   
26.   
27.             
28.         **<****where****>**  
29.         **<****if** test="userCustom!=null"**>**  
30.             **<****if** test="userCustom.sex!=null and userCustom.sex!=''"**>**  
31.                 and user.sex=\#\{userCustom.sex\}  
32.             **</****if****>**  
33.             **<****if** test="userCustom.username!=null and userCustom.username!=''"**>**  
34.                 and user.username like '%$\{userCustom.username\}%'  
35.             **</****if****>**  
36.         **</****if****>**  
37.         **</****where****>**  
38.     **</****select****>**

4.测试代码

**\[java\]**  [view plain][]   [copy][view plain]

1.  //用户信息综合查询  
2.      @Test  
3.      **public** **void** testFindUserList() **throws** Exception\{  
4.            
5.          SqlSession sqlSession=sqlSessionFactory.openSession();  
6.            
7.          //创建UserMapper代理对象  
8.          UserMapper userMapper=sqlSession.getMapper(UserMapper.**class**);  
9.            
10.         //创建包装对象，设置查询条件  
11.         UserQueryVo userQueryVo=**new** UserQueryVo();  
12.         UserCustom userCustom=**new** UserCustom();  
13.         //由于这里使用动态sql，如果这里不设置某个值，条件不会拼接在sql中  
14.         //userCustom.setSex("男");  
15.         userCustom.setUsername("张三");  
16.         userQueryVo.setUserCustom(userCustom);  
17.           
18.         //调用userMapper的方法  
19.         List<UserCustom> users=userMapper.findUserList(userQueryVo);  
20.           
21.         **for** (**int** i = 0; i < users.size(); i++) \{  
22.             UserCustom user=(UserCustom)users.get(i);  
23.             System.out.println(user.getId()+":"\+user.getUsername());  
24.         \}  
25.     \}

测试结果:  
1:张三  
4:张三丰  
  
输出日志：

**\[plain\]**  [view plain][]   [copy][view plain]

1.  DEBUG \[main\] - Opening JDBC Connection  
2.  DEBUG \[main\] - Created connection 31761534.  
3.  DEBUG \[main\] - Setting autocommit to false on JDBC Connection \[com.mysql.jdbc.Connection@1e4a47e\]  
4.  DEBUG \[main\] - ==>  Preparing: select \* from user WHERE user.username like '%张三%'   
5.  DEBUG \[main\] - ==> Parameters:   
6.  DEBUG \[main\] - <==      Total: 2

发现sql语句为select \* from user WHERE user.username like '%张三%' ，并没有将sex拼接进去，说明我们的动态sql设置成功  
  
相应的，把userCustom.setUsername("张三");也注释掉，发现输出日志：

**\[plain\]**  [view plain][]   [copy][view plain]

1.  DEBUG \[main\] - Opening JDBC Connection  
2.  DEBUG \[main\] - Created connection 24027753.  
3.  DEBUG \[main\] - Setting autocommit to false on JDBC Connection \[com.mysql.jdbc.Connection@16ea269\]  
4.  DEBUG \[main\] - ==>  Preparing: select \* from user   
5.  DEBUG \[main\] - ==> Parameters:   
6.  DEBUG \[main\] - <==      Total: 5

发现sql语句为select \* from user，并没有将sex和username拼接进去，说明我们的动态sql设置成功  
  
5.sql片段  
  
5.1需求  
将上边实现的动态sql判断代码块抽取出来，组成一个sql片段。其它的statement中就可以引用sql片段。  
方便程序员进行开发。  
  
5.2定义sql片段

**\[html\]**  [view plain][]   [copy][view plain]

1.  **<****mapper** namespace="cn.edu.hpu.mybatis.mapper.UserMapper"**>**  
2.    
3.      <!-- 定义sql片段   
4.      id:sql片段的唯一标识   
5.      在sql片段中不要加入where  
6.      经验:一般我们定义sql片段是为了可重用性，是基于单表来定义sql片段，  
7.      这样的话这个sql片段可重用性才高--**>**  
8.      **<****sql** id="query\_user\_where"**>**  
9.          **<****if** test="userCustom!=null"**>**  
10.             **<****if** test="userCustom.sex!=null and userCustom.sex!=''"**>**  
11.                 and user.sex=\#\{userCustom.sex\}  
12.             **</****if****>**  
13.             **<****if** test="userCustom.username!=null and userCustom.username!=''"**>**  
14.                 and user.username like '%$\{userCustom.username\}%'  
15.             **</****if****>**  
16.         **</****if****>**  
17.     **</****sql****>**  
18.     ......  
19. **</****mapper****>**

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

**\[html\]**  [view plain][]   [copy][view plain]

1.      
10.         **<****where****>**  
11.               
12.             **<****include** refid="query\_user\_where"**>****</****include****>**  
13.               
14.         **</****where****>**  
15.     **</****select****>**  
16.       
17.       
18.     **<****select** id="findUserCount" parameterType="cn.edu.hpu.mybatis.PO.UserQueryVo" resultType="int"**>**  
19.         select count(\*) from user   
20.   
21.   
22.             
23.         **<****where****>**  
24.               
25.             **<****include** refid="query\_user\_where"**>****</****include****>**  
26.               
27.         **</****where****>**  
28.     **</****select****>**

测试:

**\[java\]**  [view plain][]   [copy][view plain]

1.  //用户信息综合查询  
2.  @Test  
3.  **public** **void** testFindUserList() **throws** Exception\{  
4.        
5.      SqlSession sqlSession=sqlSessionFactory.openSession();  
6.        
7.      //创建UserMapper代理对象  
8.      UserMapper userMapper=sqlSession.getMapper(UserMapper.**class**);  
9.        
10.     //创建包装对象，设置查询条件  
11.     UserQueryVo userQueryVo=**new** UserQueryVo();  
12.     UserCustom userCustom=**new** UserCustom();  
13.     //由于这里使用动态sql，如果这里不设置某个值，条件不会拼接在sql中  
14.     userCustom.setSex("男");  
15.     userCustom.setUsername("张三");  
16.     userQueryVo.setUserCustom(userCustom);  
17.       
18.     //调用userMapper的方法  
19.     List<UserCustom> users=userMapper.findUserList(userQueryVo);  
20.       
21.     **for** (**int** i = 0; i < users.size(); i++) \{  
22.         UserCustom user=(UserCustom)users.get(i);  
23.         System.out.println(user.getId()+":"\+user.getUsername());  
24.     \}  
25. \}

测试结果:  
1:张三  
4:张三丰  
  
输出日志:

**\[plain\]**  [view plain][]   [copy][view plain]

1.  DEBUG \[main\] - Opening JDBC Connection  
2.  DEBUG \[main\] - Created connection 17689439.  
3.  DEBUG \[main\] - Setting autocommit to false on JDBC Connection \[com.mysql.jdbc.Connection@10deb5f\]  
4.  DEBUG \[main\] - ==>  Preparing: select \* from user   
5.  DEBUG \[main\] - ==> Parameters:   
6.  DEBUG \[main\] - <==      Total: 5

说明sql片段引用成功  
  
小结：

sql片段方便程序员进行开发

[view plain]: http://blog.csdn.net/acmman/article/details/46581349#