Mybatis 开发 Dao

作者: 林皮皮s | 来源:发表于2018-11-06 17:51 被阅读0次

前言 | 使用Mybatis 开发 dao，通常有两个方法，即原始 dao 开发方法和 Mapper 动态代理开发方法。

一、需求

使用MyBatis开发DAO实现以下的功能：
1)、根据用户id查询一个用户信息
2)、根据用户名称模糊查询用户信息列表
3)、添加用户信息

二、SqlSession的使用范围

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

SqlSessionFactoryBuilder
SqlSessionFactoryBuilder用于创建SqlSessionFacoty，SqlSessionFacoty一旦创建完成就不需要SqlSessionFactoryBuilder了，因为SqlSession是通过SqlSessionFactory创建的。所以可以将SqlSessionFactoryBuilder当成一个工具类使用，最佳使用范围是方法范围即方法体内局部变量。
SqlSessionFactory
SqlSessionFactory是一个接口，接口中定义了openSession的不同重载方法，SqlSessionFactory的最佳使用范围是整个应用运行期间，一旦创建后可以重复使用，通常以单例模式管理SqlSessionFactory。
SqlSession
SqlSession是一个面向用户的接口，sqlSession中定义了数据库操作方法。
每个线程都应该有它自己的SqlSession实例。SqlSession的实例不能共享使用，它也是线程不安全的。因此最佳的范围是请求或方法范围。绝对不能将SqlSession实例的引用放在一个类的静态字段或实例字段中。
打开一个 SqlSession；使用完毕就要关闭它。通常把这个关闭操作放到 finally 块中以确保每次都能执行关闭。如下：

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

三、原始 Dao 开发方式

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

sql 映射文件

<?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">
<!-- namespace：命名空间，用于隔离sql，
    使用动态代理开发DAO，namespace必须和Mapper接口类路径一致 -->
<mapper namespace="test">
    <!-- 根据id查询用户 -->
    <select id="queryUserById" parameterType="int"
       resultType="cn.itcast.mybatis.pojo.User">
       select * from user where id = #{id}
    </select>
    <!-- 根据username模糊查询用户 -->
    <select id="queryUserByUsername" parameterType="string"
       resultType="cn.itcast.mybatis.pojo.User">
       select * from user where username like '%${value}%'
    </select>

    <!-- 保存用户 -->
    <insert id="saveUser" parameterType="cn.itcast.mybatis.pojo.User">
       <selectKey keyProperty="id" keyColumn="id" order="AFTER" resultType="int">
           SELECT LAST_INSERT_ID()
       </selectKey>
       insert into user(username,birthday,sex,address)
       values(#{username},#{birthday},#{sex},#{address})
    </insert>
</mapper>

dao 接口

public interface UserDao {
    /**
     * 根据id查询用户
     * @param id
     * @return
     */
    User queryUserById(int id);

    /**
     * 根据用户名模糊查询用户
     * @param username
     * @return
     */
    List<User> queryUserByUsername(String username);

    /**
     * 保存用户
     * @param user
     */
    void saveUser(User user);
}

dao 实现类

public class UserDaoImpl implements UserDao {

    private SqlSessionFactory sqlSessionFactory;
    public UserDaoImpl(SqlSessionFactory sqlSessionFactory) {
       super();
       this.sqlSessionFactory = sqlSessionFactory;
    }

    @Override
    public User queryUserById(int id) {
       // 创建SqlSession
       SqlSession sqlSession = this.sqlSessionFactory.openSession();
       // 执行查询逻辑
       User user = sqlSession.selectOne("queryUserById", id);
       // 释放资源
       sqlSession.close();
       return user;
    }

    @Override
    public List<User> queryUserByUsername(String username) {
       // 创建SqlSession
       SqlSession sqlSession = this.sqlSessionFactory.openSession();
       // 执行查询逻辑
       List<User> list = sqlSession.selectList("queryUserByUsername", username);
       // 释放资源
       sqlSession.close();
       return list;
    }

    @Override
    public void saveUser(User user) {
       // 创建SqlSession
       SqlSession sqlSession = this.sqlSessionFactory.openSession();
       // 执行保存逻辑
       sqlSession.insert("saveUser", user);
       // 提交事务
       sqlSession.commit();
       // 释放资源
       sqlSession.close();
    }
}

dao 测试

public class UserDaoTest {

    private SqlSessionFactory sqlSessionFactory;
    @Before
    public void init() throws Exception {
       // 创建SqlSessionFactoryBuilder
       SqlSessionFactoryBuilder sqlSessionFactoryBuilder = new SqlSessionFactoryBuilder();
       // 加载SqlMapConfig.xml配置文件
       InputStream inputStream = Resources.getResourceAsStream("SqlMapConfig.xml");
       // 创建SqlsessionFactory
       this.sqlSessionFactory = sqlSessionFactoryBuilder.build(inputStream);
    }

    @Test
    public void testQueryUserById() {
       // 创建DAO
       UserDao userDao = new UserDaoImpl(this.sqlSessionFactory);
       // 执行查询
       User user = userDao.queryUserById(1);
       System.out.println(user);
    }

    @Test
    public void testQueryUserByUsername() {
       // 创建DAO
       UserDao userDao = new UserDaoImpl(this.sqlSessionFactory);
       // 执行查询
       List<User> list = userDao.queryUserByUsername("张");
       for (User user : list) {
           System.out.println(user);
       }
    }

    @Test
    public void testSaveUser() {
       // 创建DAO
       UserDao userDao = new UserDaoImpl(this.sqlSessionFactory);
       // 创建保存对象
       User user = new User();
       user.setUsername("刘备");
       user.setBirthday(new Date());
       user.setSex("1");
       user.setAddress("蜀国");
       // 执行保存
       userDao.saveUser(user);
       System.out.println(user);
    }
}

问题

原始Dao开发中存在以下问题：
1)、Dao方法体存在重复代码：通过SqlSessionFactory创建SqlSession，调用SqlSession的数据库操作方法；
2)、调用sqlSession的数据库操作方法需要指定statement的id，这里存在硬编码，不利于开发维护。

四、Mapper 动态代理开发方式

开发规范
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的类型相同。

Mapper.xml （映射文件）
栗子

 <?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">
<!-- namespace：命名空间，用于隔离sql -->
<!-- 还有一个很重要的作用，使用动态代理开发DAO，1\. namespace必须和Mapper接口类路径一致 -->
<mapper namespace="cn.itcast.mybatis.mapper.UserMapper">
    <!-- 根据用户id查询用户 -->
    <!-- 2\. id必须和Mapper接口方法名一致 -->
    <!-- 3\. parameterType必须和接口方法参数类型一致 -->
    <!-- 4\. resultType必须和接口方法返回值类型一致 -->
    <select id="queryUserById" parameterType="int" resultType="cn.itcast.mybatis.pojo.User">
       select * from user where id = #{id}
    </select>

    <!-- 根据用户名查询用户 -->
    <select id="queryUserByUsername" parameterType="string" resultType="cn.itcast.mybatis.pojo.User">
       select * from user where username like '%${value}%'
    </select>

    <!-- 保存用户 -->
    <insert id="saveUser" parameterType="cn.itcast.mybatis.pojo.User">
       <selectKey keyProperty="id" keyColumn="id" order="AFTER" resultType="int">
           select last_insert_id()
       </selectKey>
       insert into user(username,birthday,sex,address) values
       (#{username},#{birthday},#{sex},#{address});
    </insert>
</mapper>

UserMapper(接口文件)

public interface UserMapper {
    /**
     * 根据id查询
     * @param id
     * @return
     */
    User queryUserById(int id);

    /**
     * 根据用户名查询用户
     * @param username
     * @return
     */
    List<User> queryUserByUsername(String username);

    /**
     * 保存用户
     * @param user
     */
    void saveUser(User user);
}

加载UserMapper.xml文件

    <!-- 加载映射文件 -->
    <mappers>
       <mapper resource="sqlmap/User.xml" />
       <mapper resource="mapper/UserMapper.xml" />
    </mappers>

测试

public class UserMapperTest {
    private SqlSessionFactory sqlSessionFactory;
    @Before
    public void init() throws Exception {
       // 创建SqlSessionFactoryBuilder
       SqlSessionFactoryBuilder sqlSessionFactoryBuilder = new SqlSessionFactoryBuilder();
       // 加载SqlMapConfig.xml配置文件
       InputStream inputStream = Resources.getResourceAsStream("SqlMapConfig.xml");
       // 创建SqlsessionFactory
       this.sqlSessionFactory = sqlSessionFactoryBuilder.build(inputStream);
    }

    @Test
    public void testQueryUserById() {
       // 获取sqlSession，和spring整合后由spring管理
       SqlSession sqlSession = this.sqlSessionFactory.openSession();
       // 从sqlSession中获取Mapper接口的代理对象
       UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
       // 执行查询方法
       User user = userMapper.queryUserById(1);
       System.out.println(user);
       // 和spring整合后由spring管理
       sqlSession.close();
    }

    @Test
    public void testQueryUserByUsername() {
       // 获取sqlSession，和spring整合后由spring管理
       SqlSession sqlSession = this.sqlSessionFactory.openSession();
       // 从sqlSession中获取Mapper接口的代理对象
       UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
       // 执行查询方法
       List<User> list = userMapper.queryUserByUsername("张");
       for (User user : list) {
           System.out.println(user);
       }
       // 和spring整合后由spring管理
       sqlSession.close();
    }

    @Test
    public void testSaveUser() {
       // 获取sqlSession，和spring整合后由spring管理
       SqlSession sqlSession = this.sqlSessionFactory.openSession();
       // 从sqlSession中获取Mapper接口的代理对象
       UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
       // 创建保存对象
       User user = new User();
       user.setUsername("刘备");
       user.setBirthday(new Date());
       user.setSex("1");
       user.setAddress("蜀国");
       // 执行查询方法
       userMapper.saveUser(user);
       System.out.println(user);
       // 和spring整合后由spring管理
       sqlSession.commit();
       sqlSession.close();
    }
}

小结

selectOne 和 selectList
动态代理对象调用sqlSession.selectOne()和sqlSession.selectList()是根据mapper接口方法的返回值决定，如果返回list则调用selectList方法，如果返回单个对象则调用selectOne方法。
namespace
mybatis官方推荐使用mapper代理方法开发mapper接口，程序员不用编写mapper接口实现类，使用mapper代理方法时，输入参数可以使用pojo包装对象或map对象，保证dao的通用性。

Mybatis 开发 Dao

一、需求

二、SqlSession的使用范围

三、原始 Dao 开发方式

四、Mapper 动态代理开发方式

相关文章

网友评论

延伸阅读

深度阅读

栏目导航

热点阅读