【mybatis深度历险系列】深入浅出mybatis中原始dao的开发和mapper代理开发

使用Mybatis开发Dao，通常有两个方法，即原始Dao开发方法和Mapper接口开发方法。mybatis在进行dao开发的时候，涉及到三姐妹，分别是SqlSessionFactoryBuilder、SqlSessionFactroy、SqlSession。
小伙伴们都知道，SqlSession中封装了对数据库的操作，如：增删改查，通过SqlSessionFactory创建SqlSession，而SqlSessionFactory是通过SqlSessionFactoryBuilder进行创建的，小编来依次讲解一下各个类。
a、SqlSessionFactoryBuilder
SqlSessionFactoryBuilder用于创建SqlSessionFacoty，SqlSessionFacoty一旦创建完成就不需要SqlSessionFactoryBuilder了，因为SqlSession是通过SqlSessionFactory生产，所以可以将SqlSessionFactoryBuilder当成一个工具类使用，最佳使用范围是方法范围即方法体内局部变量。
b、SqlSessionFactory
SqlSessionFactory是一个接口，接口中定义了openSession的不同重载方法，SqlSessionFactory的最佳使用范围是整个应用运行期间，一旦创建后可以重复使用，通常以单例模式管理SqlSessionFactory。
c、SqlSession
SqlSession是一个面向用户的接口， sqlSession中定义了数据库操作，默认使用DefaultSqlSession实现类。

SqlSession中提供了很多操作数据库的方法：如：selectOne(返回单个对象)、selectList（返回单个或多个对象），SqlSession是线程不安全的，在SqlSesion实现类中除了有接口中的方法（操作数据库的方法）还有数据域属性，SqlSession最佳应用场合在方法体内，定义成局部变量使用，绝对不能将SqlSession实例的引用放在一个类的静态字段或实例字段中。今天的博文中，小编将着重介绍小伙伴们介绍mybatis中开发dao的两种方法，原始dao的开发方式和mapper代理开发。

一、原始Dao开发方法

在前面的博文中，小编介绍 了一个入门程序，接下来的依稀操作都以前面的demo为例，在前面的基础上进一步开发，首先，我们编写dao接口和dao实现类，接着再想dao接口实现类中注入SqlSessionFactory，在方法体内通过SqlSessionFactory创建sqlSession。

第一步、编写Dao接口类UserDao.java，代码如下所示：

package cn.itcast.mybatis.dao;

import java.util.List;

import cn.itcast.mybatis.po.User;

/**
 * @ClassName: UserDAO
 * @Description: 用户管理DAO接口
 * @author Flower
 * @date 2016年8月5日 21:21:59
 */
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实现类UserDaoImpl.java,代码如下所示：

package cn.itcast.mybatis.dao;

import java.util.List;

import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;

import cn.itcast.mybatis.po.User;

/**
 *
 * @ClassName: UserDaoImpl
 * @Description: 用户管理接口的实现类
 * @author Flower
 * @date 2016年8月5日 21:24:24
 *
 */
public class UserDaoImpl implements UserDao {

	//需要向dao实现类中注入SqlSessionFactory
	//这里通过构造方法注入
	private SqlSessionFactory sqlSessionFactory;

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

	@Override
	public User findUserById(int id) throws Exception {
		SqlSession sqlSession = sqlSessionFactory.openSession();
		User user = sqlSession.selectOne("test.findUserById",id);
		//释放资源
		sqlSession.close();
		return user;
	}

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

	}

	@Override
	public void deleteUser(int id) throws Exception {
		SqlSession sqlSession = sqlSessionFactory.openSession();
		//执行删除操作
		sqlSession.delete("test.deleteUser",id);
		//提交事务
		sqlSession.commit();
		//释放资源
		sqlSession.close();

	}

	@Override
	public List<User> findUserByName(String name) throws Exception {

		SqlSession sqlSession = sqlSessionFactory.openSession();

		List<User> list = sqlSession.selectList("test.findUserByName", name);

		// 释放资源
		sqlSession.close();

		return list;
	}

}

第三步、编写JunitTest测试UserDaoImplTest.java，代码如下所示：

package cn.itcast.mybatis.dao;

import java.io.InputStream;

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;

import cn.itcast.mybatis.po.User;

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

}

从上面的代码可以看出，比起之前那个MybatisService.java类里面的内容稍微清晰明了。但依然存在以下几个问题：

a、dao接口中存在大量模板方法，能否把这些代码提出来，减少我们的工作量。

b、调用sqlSession方法时将statement的id硬编码了。

c、调用sqlSeesion传入的变量，由于sqlSession方法使用泛型，即使变量类型传入错误，在编译阶段也不报错，不利于程序开发。

so，我们带着问题看看mapper代理看法，看看能否解决原始dao开发的问题，精彩往下看。

二、mapper代理方法，只需要mapper接口，相当于dao接口

第一步、编写UserMapper.java类代码，代码如下所示：

package cn.itcast.mybatis.mapper;

import java.util.List;

import cn.itcast.mybatis.po.User;
/**
 *
 * @ClassName: UserDAO
 * @Description: 用户管理mapper接口
 * @author Flower
 * @date 2016年8月5日 21:33:35
 *
 */

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;

}

第二步、将原来的User.xml拷贝修改名称为UserMapper.xml,只需修改此行代码即可，如下所示：

<!-- namespace命名空间,作用就是对sql进行分类化的管理,理解为sql隔离
    注意:使用mapper代理开发时，namespace有特殊作用,namespace等于mapper接口地址
 -->
<mapper namespace="com.mybatis.mapper.UserMapper">

第三步、在SqlMapConfing.xml中加载UserMapper.xml，代码如下所示：

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

第四步、编写Junit测试UserMapperTest.java，代码如下所示：

package cn.itcast.mybatis.mapper;

import static org.junit.Assert.*;

import java.io.InputStream;
import java.util.List;

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

import cn.itcast.mybatis.po.User;

public class UserMapperTest {

	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 {
		SqlSession sqlSession = sqlSessionFactory.openSession();

		//创建UserMapper对象，mybatis自动生成mapper代理对象
		UserMapper userMapper = sqlSession.getMapper(UserMapper.class);

		//调用userMapper的方法

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

		//调用userMapper的方法

		List<User> list = userMapper.findUserByName("小明");

		sqlSession.close();

		System.out.println(list);

	}

}

小结：a、代理对象内部调用selectOne()和selectList():如果mapper对象返回单个pojo对象(非集合对象)代理对象内部通过selectOne查询数据库，如果mapper方法返回集合对象，代理对象内部通过selectList查询数据库。

b、mapper接口中的方法参数只能有一个是否影响系统开发：

mapper接口方法参数只能有一个，系统是否不利于维护？

回答：系统框架中，dao层的代码是被业务层公用的。机试mapper接口只有一个参数，可以使用包装类型的pojo满足不同的业务方法的需求。

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