MyBatis学习--mybatis开发dao的方法

• 简介

　　使用Mybatis开发Dao，通常有两个方法，即原始Dao开发方法和Mapper接口开发方法。

• 主要概念介绍：

　　MyBatis中进行Dao开发时候有几个重要的类，它们是SqlSessionFactoryBuilder、SqlSessionFactory、SqlSession。

　　SqlSession中封装了对数据库的操作，如：查询、插入、更新、删除等。通过SqlSessionFactory创建SqlSession，而SqlSessionFactory是通过SqlSessionFactoryBuilder进行创建。

　　1、SqlSessionFactoryBuilder

　　SqlSessionFactoryBuilder用于创建SqlSessionFacoty，SqlSessionFacoty一旦创建完成就不需要SqlSessionFactoryBuilder了，因为SqlSession是通过SqlSessionFactory生产，所以可以将SqlSessionFactoryBuilder当成一个工具类使用，最佳使用范围是方法范围即方法体内局部变量。

　　2、SqlSessionFactory

　　SqlSessionFactory是一个接口，接口中定义了openSession的不同重载方法，SqlSessionFactory的最佳使用范围是整个应用运行期间，一旦创建后可以重复使用，通常以单例模式管理SqlSessionFactory。

　　3、SqlSession

　　SqlSession是一个面向用户的接口， sqlSession中定义了数据库操作，默认使用DefaultSqlSession实现类。

　　SqlSession中提供了很多操作数据库的方法：如：selectOne(返回单个对象)、selectList（返回单个或多个对象），SqlSession是线程不安全的，在SqlSesion实现类中除了有接口中的方法（操作数据库的方法）还有数据域属性，SqlSession最佳应用场合在方法体内，定义成局部变量使用，绝对不能将SqlSession实例的引用放在一个类的静态字段或实例字段中。

　　打开一个 SqlSession；使用完毕就要关闭它。通常把这个关闭操作放到 finally 块中以确保每次都能执行关闭。如下：

SqlSession session = sqlSessionFactory.openSession();
try {
      // do work
} finally {
      session.close();
}

• 原始Dao开发方式

　　原始Dao开发方法需要程序员编写Dao接口和Dao实现类。

　　还是以前文提到的简单的增删改查为例，来简单介绍原始Dao开发方式。

　　1、映射文件

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="user">
    <!-- 根据id获取用户信息 -->
    <select id="findUserById" parameterType="int" resultType="user">
        select * from user where id = #{id}
    </select>
    <!-- 根据username模糊查询用户信息 -->
    <select id="findUserByName" parameterType="java.lang.String" resultType="com.luchao.mybatis.first.po.User">
        select * from user where username like '%${value}%'
    </select>
    <!-- 添加用户信息 -->
    <insert id="insertUser" parameterType="com.luchao.mybatis.first.po.User">
        <selectKey keyProperty="id" order="AFTER" resultType="java.lang.Integer">
            select LAST_INSERT_ID()
        </selectKey>
        insert into user(username,birthday,sex,address) value (#{username},#{birthday},#{sex},#{address});
    </insert>
    <!-- 根据id删除用户信息 -->
    <delete id="deleteUser" parameterType="int">
        delete from user where id=#{id}
    </delete>
    <!-- 修改用户信息 -->
    <update id="updateUser" parameterType="com.luchao.mybatis.first.po.User">
        update user set username=#{username},birthday=#{birthday},sex=#{sex},address=#{address}
        where id=#{id}
    </update>
</mapper>

　　2、Dao接口

public interface UserDao {
    //根据ID查询用户信息
    public User findUserById(int id) throws Exception;
    //添加用户信息
    public void insertUser(User user) throws Exception;
    //删除用户信息
    public void deleteUser(int id) throws Exception;
}

　　3、Dao接口实现类

public class UserDaoImpl implements UserDao{
    
    // 需要向dao实现类中注入SqlSessionFactory
    // 这里通过构造方法注入
    private SqlSessionFactory sqlSessionFactory;
    
    public UserDaoImpl(SqlSessionFactory sqlSessionFactory) {
        super();
        this.sqlSessionFactory = sqlSessionFactory;
    }
    @Override
    public void deleteUser(int id) throws Exception {
        SqlSession sqlSession = sqlSessionFactory.openSession();
        //执行删除操作
        sqlSession.insert("user.deleteUser", id);
        // 提交事务
        sqlSession.commit();
        // 释放资源
        sqlSession.close();
    }
    @Override
    public User findUserById(int id) throws Exception {
        SqlSession sqlSession = sqlSessionFactory.openSession();//获取sqlSession
        User user = sqlSession.selectOne("user.findUserById", id);
        sqlSession.close();//关闭资源
        return user;
    }
    @Override
    public void insertUser(User user) throws Exception {
        SqlSession sqlSession = sqlSessionFactory.openSession();
        //执行插入操作
        sqlSession.insert("user.insertUser", user);
        // 提交事务
        sqlSession.commit();
        // 释放资源
        sqlSession.close();
    }
}

　　4、测试代码：

public class MyBatis_dao_test {
    private SqlSessionFactory sqlSessionFactory;
    @Before
    public void init() throws IOException{
        //创建sqlSessionFactory
        //MyBatis配置文件
        String resource = "SqlMapConfig.xml";
        //得到配置文件流
        InputStream inputStream = Resources.getResourceAsStream(resource);
        //创建会话工厂，传入MyBatis的配置信息
        sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
    }
    @Test
    public void testFindUserById() throws Exception{
        //创建UserDao对象
        UserDao userDao = new UserDaoImpl(sqlSessionFactory);
        //调用UserDao的方法，根据ID查找user
        User user = userDao.findUserById(10);
        //打印客户信息
        System.out.println(user);
    }
}

　　5、原始Dao方法总结：

　　（1）、dao接口实现类方法中存在大量模板方法，如：通过SqlSessionFactory创建SqlSession，调用SqlSession的数据库操作方法。

　　（2）、调用sqlSession的数据库操作方法需要指定statement的id，这里存在硬编码。

　　（3）、调用sqlsession方法时传入的变量，由于sqlsession方法使用泛型，即使变量类型传入错误，在编译阶段也不报错，不利于程序员开发。

• Mapper动态代理方式

　　1、实现原理

　　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的类型相同。

　　2、Mapper.xml(映射文件)

　　映射文件与原始Dao开发的映射文件相似，只需要将namespace定于为mapper接口全路径。

 

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.luchao.mybatis.first.mapper.UserMapper">
    <!-- 根据id获取用户信息 -->
    <select id="findUserById" parameterType="int" resultType="user">
        select * from user where id = #{id}
    </select>
    <!-- 根据username模糊查询用户信息 -->
    <select id="findUserByName" parameterType="java.lang.String" resultType="com.luchao.mybatis.first.po.User">
        select * from user where username like '%${value}%'
    </select>
    <!-- 添加用户信息 -->
    <insert id="insertUser" parameterType="com.luchao.mybatis.first.po.User">
        <selectKey keyProperty="id" order="AFTER" resultType="java.lang.Integer">
            select LAST_INSERT_ID()
        </selectKey>
        insert into user(username,birthday,sex,address) value (#{username},#{birthday},#{sex},#{address});
    </insert>
    <!-- 根据id删除用户信息 -->
    <delete id="deleteUser" parameterType="int">
        delete from user where id=#{id}
    </delete>
    <!-- 修改用户信息 -->
    <update id="updateUser" parameterType="com.luchao.mybatis.first.po.User">
        update user set username=#{username},birthday=#{birthday},sex=#{sex},address=#{address}
        where id=#{id}
    </update>
</mapper>

 

　　3、Mapper.java(接口文件)

public interface UserMapper {
    //根据ID查询用户信息
    public User findUserById(int id) throws Exception;
    //添加用户信息
    public void insertUser(User user) throws Exception;
    //删除用户信息
    public void deleteUser(int id) throws Exception;
    //更新用户信息
    public void updateUser(User user) throws Exception;
    //根据用户名模糊查找
    public List<User> findUserByName(String user) throws Exception;
}

　　接口定义有如下特点：

　　（1）、 Mapper接口方法名和Mapper.xml中定义的statement的id相同。

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

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

　　4、加载UserMapper.xml文件

　　在SqlMapConfig.xml文件中加载UserMapper.xml，如下：

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

　　5、测试代码：

public class MyBatis_mapper_test {
    private SqlSessionFactory sqlSessionFactory;
    @Before
    public void init() throws IOException{
        //创建sqlSessionFactory
        //MyBatis配置文件
        String resource = "SqlMapConfig.xml";
        //得到配置文件流
        InputStream inputStream = Resources.getResourceAsStream(resource);
        //创建会话工厂，传入MyBatis的配置信息
        sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
    }
    @Test
    public void testFindUserById() throws Exception{
        //获取sqlSession对象
        SqlSession sqlSession = sqlSessionFactory.openSession();
        //创建UserMapper对象，MyBatis自动生成mapper代理
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
        //调用userMapper的方法
        User user = userMapper.findUserById(10);
        //关闭资源
        sqlSession.close();
        //打印客户信息
        System.out.println(user);
    }
}

　　5、Mapper动态代理总结：

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

　　（2）、使用mapper代理方法时，输入参数可以使用pojo包装对象或map对象，保证dao的通用性。在系统中，dao层的代码是被业务层公用的。即使mapper接口只有一个参数，可以使用包装类型的pojo满足不同的业务方法的需求。

 　　注意：持久层方法的参数可以包装类型、map等，service方法中建议不要使用包装类型（不利于业务层的可扩展）。

　　mybatis开发dao的方法有两种：原始Dao开发和Mapper动态代理开发，这两种各有优点。原始Dao开发：程序员要写Dao和Dao实现，需要些较多的代码，但是比较好理解。Mapper动态代理：程序员只需要写Mapper接口，然后按照规范进行配置，MyBatis就会自动实现类似Dao实现，减少模板方法。mybatis官方推荐使用mapper代理方法开发mapper接口，程序员不用编写mapper接口实现类，使用mapper代理方法时，输入参数可以使用pojo包装对象或map对象，保证dao的通用性。