MyBatis学习之DAO开发

SqlSession使用范围

• SqlSessionFactoryBuilder
  通过 SqlSessionFactoryBuilder 创建会话工厂 SqlSessionFactory，将 SqlSessionFactoryBuilder 当成一个工具类使用，不需要使用单例管理 SqlSessionFactoryBuilder。在需要创建 SqlSessionFactory 时候，只需要 new 一次 SqlSessionFactoryBuilder 即可。

• SqlSessionFactory
  SqlSessionFactory 是一个接口，接口中定义了 openSession 的不同重载方法。通过 SqlSessionFactory 创建 SqlSession，使用单例模式管理 SqlSessionFactory（工厂一旦创建，使用一个实例）。

• SqlSession
  SqlSession 是一个面向用户的接口，封装了对数据库的操作，如：查询、插入、更新、删除等。
  SqlSession 是线程不安全的，在 SqlSesion 实现类中除了有接口中的方法（操作数据库的方法）还有数据域属性。

---

原始DAO开发方法

需要写 dao 接口和 dao 实现类

需要向 dao 实现类中注入 SqlSessionFactory，在方法体内通过 SqlSessionFactory 创建 SqlSession

DAO接口

public interface UserDao {
    //根据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;
}

（为减少篇幅，后面只写与添加操作相关的内容）

DAO接口实现类

import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import java.util.List;

public class UserDaoImpl implements UserDao{
    // 需要向dao实现类中注入SqlSessionFactory
    // 这里通过构造方法注入
    private SqlSessionFactory sqlSessionFactory;

    public UserDaoImpl(SqlSessionFactory sqlSessionFactory){
        this.sqlSessionFactory = sqlSessionFactory;
    }
	...
	@Override
    public void insertUser(User user) throws Exception {
        SqlSession sqlSession = sqlSessionFactory.openSession();
        //执行插入操作
        sqlSession.insert("test.insertUser", user);
        // 提交事务
        sqlSession.commit();
        // 释放资源
        sqlSession.close();
    }
    
}

测试代码

import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import org.junit.Before;
import org.junit.Test;

public class UserDaoImplTest {

	private SqlSessionFactory sqlSessionFactory;

	// 在执行testFindUserById之前执行
	@Before
	public void setUp() throws Exception {
		// 创建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的方法
		User user = userDao.findUserById(1);
		System.out.println(user);
	}

}

原始DAO开发方法存在的问题

1. DAO 接口实现类方法中存在大量模板方法，如果将这些代码提取出来，可以大大减轻工作量。
2. 调用 sqlsession 方法时将 statement 的 id 硬编码了
3. 调用 sqlsession 方法时传入的变量，由于 sqlsession 方法使用泛型，即使变量类型传入错误，在编译阶段也不报错，不利于开发

---

Mapper代理方法

实现原理

1. 只需要mapper接口（相当 于dao接口）
2. 需要编写mapper.xml映射文件
3. 编写mapper接口需要遵循一些开发规范，mybatis可以自动生成mapper接口实现类代理对象

开发规范

• 在mapper.xml中namespace等于mapper接口地址
• mapper.java接口中的方法名和mapper.xml中statement的id一致
• mapper.java接口中的方法输入参数类型和mapper.xml中statement的parameterType指定的类型一致
• mapper.java接口中的方法返回值类型和mapper.xml中statement的resultType指定的类型一致

UserMapper.java

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;
}

（为减少篇幅，后面只写与添加操作相关的内容）

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进行分类化管理,理解为sql隔离
 namespace 等于mapper接口地址
 -->
<mapper namespace="com.ste.mapper.UserMapper">
	...
	<insert id="insertUser" parameterType="com.ste.po.User">
		INSERT INTO user (username,birthday,sex,address)values (#{username},#{birthday},#{sex},#{address})
    </insert>
    ...
</mapper>

测试代码

public class UserMapperTest {  

    private SqlSessionFactory sqlSessionFactory;  
      
    //注解Before是在执行本类所有测试方法之前先调用这个方法  
    @Before  
    public void setup() throws Exception{  
        //创建SqlSessionFactory  
        String resource="SqlMapConfig.xml";  
        //将配置文件加载成流  
        InputStream inputStream = Resources.getResourceAsStream(resource);  
        //创建会话工厂，传入mybatis配置文件的信息  
        sqlSessionFactory=new SqlSessionFactoryBuilder().build(inputStream);  
    }  
      
    @Test  
    public void testFindUserById() throws Exception{  
        SqlSession sqlSession=sqlSessionFactory.openSession();  
        //创建UserMapper代理对象  
        UserMapper userMapper=sqlSession.getMapper(UserMapper.class);  
        //调用userMapper的方法  
        User user=userMapper.findUserById(1);  
        System.out.println(user.getUsername());  
    }
    
} 

总结

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

• mybatis官方推荐使用 mapper 代理方法开发 mapper 接口，不用编写 mapper 接口实现类