【3】Mapper代理方法开发dao

MyBatis

上一篇总结了mybatis使用 原始dao的方法存在的一些弊端，我们肯定不会去用它，那么mybatis中该如何开发dao呢？
使用mapper代理的方法来开发dao的步骤。

使用mapper代理的方法来开发dao时，程序员只需要干两件事即可：
1.需要编写mapper.xml映射文件
2.需要编写mapper接口（相当于dao接口）

从做的工作来看，使用mybatis中使用mapper代理来开发dao会很方便，完全不需要我们去写具体的实现类，只需要写出接口即可，但是接口不能直接拿来用啊，那么该如何产生它的实现类对象呢？这在下文会给出答案

1.UserMapper.xml

mapper.xml映射文件，内容其实是跟前面的User.xml文件是一样的，主要是跟定义一些跟User这个pojo之间的映射相关的东西，唯一不同的地方就在于namespace的赋值。在前面的User.xml文件中，我们设定了namespace为"test"，然后在java方法调用的时候，我们会调用类似于sqlSession.insert("test.insertUser", user);的方法，来定位需要执行的sql语句。但是在mapper.xml映射文件中，namespace要设定为我们接下来写的mapper接口的地址，即完全限定名。假设我们新建一个mapper包，在里面新建一个UserMapper.xml，如下：

<mapper namespace="com.mapper.UserMapper">
    <select id="findUserById" parameterType="int" resultType="com.vo.User">
    select * from user where id = #{id}
    </select>
    <select id="findUserByName" parameterType="java.lang.String" resultType="com.vo.User">
        select * from user where username like '%${value}%'
    </select>
    <insert id="insertUser" parameterType="mybatis.po.User">
        insert into user(username,birthday,sex,address) values(#{username},#{birthday},#{sex},#{address})
        <!-- 将插入数据的主键返回，返回到user对象中 -->
        <selectKey keyProperty="id" order="AFTER" resultType="java.lang.Integer">
            select last_insert_id()
        </selectKey>
        <!-- 
        <selectKey keyProperty="id" order="BEFORE" resultType="java.lang.String">
            select uuid()
        </selectKey>
         -->
    </insert>
</mapper>

2.UserMapper.java（接口）

定义好了mapper.xml映射文件后，接下来就要编写mapper接口了，编写mapper接口要遵循以下四个开发规范：

1.在mapper.xml中，使namespace等于mapper接口的地址（完全限定名）
2.mapper.java接口中的方法名和mapper.xml中statement的id一致
3.mapper.java接口中方法的输入参数类型和mapper.xml中statement的parameterType指定的类型一致
4.mapper.java接口中方法返回值类型和mapper.xml中statement的resultType指定的类型一致

根据这四条开发规范，我们来完成mapper接口：UserMapper.java

import com.vo.User;
import java.util.List;
//mapper接口，相当于dao接口
public interface UserMapper {
    //根据id查询用户信息
    public User findUserById(int id) throws Exception;
    //根据用户名模糊查询
    public List<User> findUserByName(String name) throws Exception;
    //添加用户信息
    public void insertUser(User user) throws Exception;
    //删除用户信息
    public void deleteUser(int id) throws Exception;
    //更新用户信息
    public void updateUser(User user) throws Exception;
}   

这里要注意一点就是findUserByName的方法，返回的是一个装有User的List，但是UserMapper.xml中对应的resultType类型是User，这里要注意，在前面的博文中也提到了，resultType指定的是单个返回结果的类型，也就是一条记录的类型，即User，但是这个findUserByName是返回很多User，所以返回值是List。mybatis会自动根据返回值类型去调用不同的方法，如下：

如果mapper方法返回单个pojo对象（非集合对象），代理对象内部通过selectOne来查询数据库
如果mapper方法返回一个集合对象，代理对象内部通过selectList来查询数据库

所以完全不用担心上面这个问题，mybatis已经帮我们解决好了。到这里还没完，还有一步就是别忘了在全局配置文件SqlMapConfig.xml中配置刚刚的UserMapper.xml，如下

<mappers>
    <mapper resource="sqlmap/User.xml" />
    <mapper resource="mapper/UserMapper.xml" />
</mappers>

3.测试程序

如何产生实现类的对象呢？我们在测试程序中来看:

private SqlSessionFactory sqlSessionFactory;
    @Before //创建sqlSessionFactory
    public void setUp() throws Exception {
        String resource = "SqlMapConfig.xml"; //mybatis配置文件 
        //得到配置文件的流
        InputStream inputStream = Resources.getResourceAsStream(resource);
        //创建会话工厂SqlSessionFactory,要传入mybaits的配置文件的流
        sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);      
    }
    @Test
    public void testFindUserById() throws Exception {
        SqlSession sqlSession = sqlSessionFactory.openSession();
        //创建UserMapper对象，mybatis自动生成mapper代理对象
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
        User user = userMapper.findUserById(1);
        System.out.println(user);
    }
    @Test
    public void testFindUserByName() throws Exception {
        SqlSession sqlSession = sqlSessionFactory.openSession();
        //创建UserMapper对象，mybatis自动生成mapper代理对象
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
        List<User> list = userMapper.findUserByName("倪升武");
        sqlSession.close();
        System.out.println(list);
    }
}

原来这个sqlSession可以自动创建一个mapper接口的代理对象！我们只需要把刚刚写好的mapper接口类的字节码对象传给getMapper方法，即可得到一个该接口对应的代理对象，然后我们就可以使用这个代理对象来操作接口中具体的方法了。
到这里，使用mapper代理的方式开发dao就总结完了，但是有个小细节，由于mapper接口中方法的参数要根据映射文件中的parameterType来指定，而parameterType只有一个，所以mapper接口中所有方法的参数都只有一个！那如果我们要传入两个或多个参数该咋整？这没办法，想要传多个参数还是死了这条心了吧，但是可以解决这个问题，就是对传入的对象进行增强，让传进去的对象包含我们需要的参数即可。这算是个小弊端吧，但是不会影响我们开发

• 作者：倪升武（联系作者）
• 发表时间：2017-06-09 13:40
• 版权声明：自由转载-非商用-非衍生-保持署名，转载请注明出处