Mybatis-Dao层开发之Mapper接口

相关链接：

相关配置文件：详见 http://blog.csdn.net/qq_28796345/article/details/53427020

基本配置：详见 http://blog.csdn.net/qq_28796345/article/details/53402808

dao接口开发实现：详见 http://blog.csdn.net/qq_28796345/article/details/53427087

Mapper接口开发方法只需要程序员编写Mapper接口（相当于Dao接口），由Mybatis框架根据接口定义创建接口的动态代理对象，代理对象的方法体同上边Dao接口实现类方法。

Mapper接口开发需要遵循以下规范：

1、  Mapper.xml文件中的namespace与mapper接口的类路径相同。

2、  Mapper接口方法名和Mapper.xml中定义的每个statement的id相同

3、  Mapper接口方法的输入参数类型和mapper.xml中定义的每个sql 的parameterType的类型相同

4、  Mapper接口方法的输出参数类型和mapper.xml中定义的每个sql的resultType的类型相同

1、Mapper映射文件

定义mapper映射文件UserMapper.xml（内容同Users.xml），需要修改namespace的值为UserMapper接口路径。将UserMapper.xml放在classpath 下mapper目录下。

[html]  view plain  copy

1. <?xml version="1.0" encoding="UTF-8" ?>  
2. <!DOCTYPE mapper  
3. PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"  
4. "http://mybatis.org/dtd/mybatis-3-mapper.dtd">  
5.   
6. <!-- 命名空间，对sql进行分类化管理（sql隔离） -->  
7. <mapper namespace="com.sw.mapper.UserMapper">  
8.     <!-- 在映射文件中配置sql语句 -->  
9.     <!-- 通过select执行查询，id用于标识映射文件中的sql(Statement-id)  
10.     将sql语句封装到mappedstatement中  
11.     #{}表示占位符  
12.     parameterType-指定输入参数的类型  
13.     #{id}-id表示输入的参数，参数名称就是id,如如果输入参数是简单类型，#{}中的参数可以任意  
14.     resultType-指定sql输出结果所映射的java对象类型  
15.     -->  
16.     <!-- 通过id查询用户表的记录 -->  
17.     <select id="findUserById" parameterType="int" resultType="com.sw.po.User">  
18.         select *from user where id=#{id}  
19.     </select>  
20.       
21.     <!-- 根据用户名称模糊查询用户信息 -->  
22.     <!-- resultType-指定单条记录所映射的对象类型   
23.     ${}拼接sql串，接收参数的内容，不加任何修饰，拼接在sql中(存在sql漏洞)  
24.     ${}接收输入参数的内容，如果传入的类型是简单类型，${}中只能使用value  
25.     -->  
26.     <select id="findUserByName" parameterType="java.lang.String" resultType="com.sw.po.User">  
27.         SELECT *FROM USER WHERE username LIKE '%${value}%'  
28.     </select>  
29.       
30.     <!-- 添加用户 -->  
31.     <!-- 指定输入参数类型是pojo(包括用户信息)  
32.         #{}中指定pojo（User）属性名,接收到pojo的属性值  
33.         Mybatis通过OGNL获取对象的属性值  
34.      -->  
35.     <insert id="insertUser" parameterType="com.sw.po.User">  
36.         <!-- 获取刚增加的记录主键   
37.             返回id到poio对象（User）  
38.             SELECT LAST_INSERT_ID():得到刚插入金进去记录的主键值，只适用于自增逐主键  
39.             keyProperty：将查询到的主键值设置到parameterType指定的对象的id属性  
40.             order:指SELECT LAST_INSERT_ID()的执行顺序，相对于insert来说（before/after）  
41.             resultType:指定SELECT LAST_INSERT_ID()的结果类型  
42.         -->  
43.         <selectKey keyProperty="id" order="AFTER" resultType="java.lang.Integer">  
44.             SELECT LAST_INSERT_ID()  
45.         </selectKey>  
46.         INSERT INTO USER (username,birthday,sex,address) VALUES(#{username},#{birthday},#{sex},#{address})  
47.          
48.         <!-- 使用mysql的uuid生成主键返回  
49.             执行过程：  
50.                 首先通过uuid得到主键，然后将主键设置到id属性中  
51.                 其次在Inster执行的时候从User对象中取出id的属性值  
52.          -->  
53.        <!--   <selectKey keyProperty="id" order="BEFORE" resultType="java.lang.String">  
54.              SELECT UUID()  
55.          </selectKey>  
56.        INSERT INTO USER (id,username,birthday,sex,address) VALUES(#{id},#{username},#{birthday},#{sex},#{address})  -->  
57.     </insert>  
58.       
59.     <!-- 根据id删除用户 -->  
60.     <delete id="deleteUser" parameterType="java.lang.Integer">  
61.         DELETE FROM USER WHERE id=#{id}  
62.     </delete>  
63.       
64.     <!-- 根据id更新用户   
65.         传入用户id以及相关更新信息  
66.         #{id}:从输入的user对象中获取user的属性值  
67.     -->  
68.     <update id="updateUser" parameterType="com.sw.po.User">  
69.         UPDATE USER SET username=#{username},birthday=#{birthday},sex=#{sex},address=#{address} WHERE id=#{id}  
70.     </update>  
71. </mapper>  

2、Mapper.java-接口文件

Mapper接口定义有如下特点：

1、Mapper接口方法名与Mapper.xml(UserMapper.xml)中定义的statement的id相同

2、Mapper接口方法的输入参数类型和mapper.xml（User.xml）中定义的statement的parameterType的类型相同

3、 Mapper接口方法的输出参数类型和mapper.xml中定义的statement的resultType的类型相同

代码如下;

[java]  view plain  copy

1. package com.sw.mapper;  
2.   
3. import java.util.List;  
4.   
5. import com.sw.po.User;  
6.   
7. /* 
8.  *@Author swxctx 
9.  *@time 2016年12月1日 
10.  *@Explain:使用mapper接口（用户管理）,相当于dao接口 
11.  */  
12. public interface UserMapper {  
13.     //根据id查询用户的信息  
14.     public  User findUserById(int id)throws Exception;  
15.     //根据用户名查看用户列表  
16.     public List<User> findUserByName(String username)throws Exception;  
17.     //添加用户  
18.     public void insertUser(User user)throws Exception;  
19.     //删除用户  
20.     public void deleteUser(int id)throws Exception;  
21. }  

3、测试类

[java]  view plain  copy

1. package com.sw.mapper.test;  
2.   
3. import java.io.InputStream;  
4. import java.util.Date;  
5. import java.util.List;  
6.   
7. import org.apache.ibatis.io.Resources;  
8. import org.apache.ibatis.session.SqlSession;  
9. import org.apache.ibatis.session.SqlSessionFactory;  
10. import org.apache.ibatis.session.SqlSessionFactoryBuilder;  
11. import org.junit.Before;  
12. import org.junit.Test;  
13.   
14. import com.sw.mapper.UserMapper;  
15. import com.sw.po.User;  
16.   
17. /* 
18.  *@Author swxctx 
19.  *@time 2016年12月1日 
20.  *@Explain: 
21.  */  
22. public class UserMapperTest {  
23.   
24.      private SqlSessionFactory sqlSessionFactory;  
25.         @Before  
26.         public void setUpBefore() throws Exception {  
27.             //执行其他方法前需要创建SqlSessionFactory  
28.             // mybatis配置文件  
29.             String resource = "SqlMapConfig.xml";  
30.             // 得到配置文件流  
31.             InputStream inputStream = Resources.getResourceAsStream(resource);  
32.   
33.             // 创建会话工厂，传入mybatis的配置文件信息  
34.             sqlSessionFactory = new SqlSessionFactoryBuilder()  
35.                     .build(inputStream);  
36.         }  
37.       
38.     @Test  
39.     public void testFindUserById() throws Exception{  
40.         SqlSession sqlSession = sqlSessionFactory.openSession();  
41.         //创建UserMapper对象，mybatis自动生成mapper代理对象  
42.         UserMapper userMapper = sqlSession.getMapper(UserMapper.class);  
43.         //调用UserMapper方法  
44.         User user = userMapper.findUserById(27);  
45.         sqlSession.close();  
46.           
47.         System.out.println(user);  
48.     }  
49.       
50.     @Test  
51.     public void testFindUserByName() throws Exception{  
52.         SqlSession sqlSession = sqlSessionFactory.openSession();  
53.         //创建UserMapper对象，mybatis自动生成mapper代理对象  
54.         UserMapper userMapper = sqlSession.getMapper(UserMapper.class);  
55.         //调用UserMapper方法  
56.         List<User> user = userMapper.findUserByName("王");  
57.           
58.         sqlSession.close();  
59.           
60.         System.out.println(user);  
61.     }  
62.   
63.     @Test  
64.     public void testInsertUser()throws Exception{  
65.         SqlSession sqlSession = sqlSessionFactory.openSession();  
66.         //创建UserMapper  
67.         UserMapper userMapper = sqlSession.getMapper(UserMapper.class);  
68.         User user = new User();  
69.         user.setUsername("李小二");  
70.         user.setSex("1");  
71.         user.setBirthday(new Date());  
72.         user.setAddress("广州");  
73.           
74.         //调用方法  
75.         userMapper.insertUser(user);  
76.         //提交事务  
77.         sqlSession.commit();  
78.         //释放资源  
79.         sqlSession.close();  
80.     }  
81.       
82.     @Test  
83.     public void testDeleteUser() throws Exception{  
84.         SqlSession sqlSession = sqlSessionFactory.openSession();  
85.         //创建UserMapper对象，mybatis自动生成mapper代理对象  
86.         UserMapper userMapper = sqlSession.getMapper(UserMapper.class);  
87.         //调用UserMapper方法  
88.         userMapper.deleteUser(44);  
89.         sqlSession.commit();  
90.         sqlSession.close();  
91.     }  
92. }  

注：

selectOne和selectList

动态代理对象调用sqlSession.selectOne()和sqlSession.selectList()是根据mapper接口方法的返回值决定，如果返回list则调用selectList方法，如果返回单个对象则调用selectOne方法。

namespace

mybatis官方推荐使用mapper代理方法开发mapper接口，程序员不用编写mapper接口实现类，使用mapper代理方法时，输入参数可以使用pojo包装对象或map对象，保证dao的通用性。