Mybatis的核心对象
SqlSessionFactoryBuilder
SqlSessionFactoryBuilder用于创建SqlSessionFacoty,SqlSessionFacoty一旦创建完成就不需要SqlSessionFactoryBuilder了,因为SqlSession是通过SqlSessionFactory生产,所以可以将SqlSessionFactoryBuilder当成一个工具类使用,最佳使用范围是静态代码块中的局部变量
SqlSessionFactory
SqlSessionFactory是一个接口,接口中定义了openSession的不同重载方法,SqlSessionFactory的最佳使用范围是整个应用运行期间,一旦创建后可以重复使用,通常以单例模式管理SqlSessionFactory。
SqlSession
SqlSession是一个面向用户的接口, sqlSession中定义了数据库操作,默认使用DefaultSqlSession实现类。
SqlSession的实现类即DefaultSqlSession,此对象中对操作数据库实质上用的是Executor
每个线程都应该有它自己的SqlSession实例。SqlSession的实例不能共享使用,它也是线程不安全的。因此最佳的范围是请求或方法范围。绝对不能将SqlSession实例的引用放在一个类的静态字段或实例字段中。
- 打开一个 SqlSession;使用完毕就要关闭它。通常把这个关闭操作放到 finally 块中以确保每次都能执行关闭。
传统的DAO开发模式
程序员需要写dao接口和dao实现类。
需要向dao实现类中注入SqlSessionFactory,在方法体内通过SqlSessionFactory创建SqlSession
步骤:
1.编写到接口以及实现类
import java.util.List;
public interface IUserDao {
/**
* 根据ID查询User
* @param id 用户Id
* @return 用户信息
* @throws Exception
*/
public User findUserById(int id) throws Exception;
/**
* 根据用户的名字模糊查询
* @param name 用户的username
* @return 一组用户
* @throws Exception
*/
public List<User> findUserByName(String name) throws Exception;
/**
* 添加用户
* @param user 用户信息
* @return 包含主键的用户
* @throws Exception
*/
public User addUser(User user) throws Exception;
}
public class UserDaoImpl implements IUserDao {
//需要往UserDaoImpl注入SQLSessionFactory
private SqlSessionFactory sqlSessionFactory;
//通过构造方法注入
public UserDaoImpl(SqlSessionFactory sqlSessionFactory) {
this.sqlSessionFactory = sqlSessionFactory;
}
@Override
public User findUserById(int id) throws Exception {
/**
* 1.得到SqlSession
* 2.调用SqlSession对应的方法(selectOne)来操作数据库
* 3.关闭SqlSession
* 4.返回结果
*/
SqlSession sqlSession = sqlSessionFactory.openSession();
User user = sqlSession.selectOne("test.findUserById", id);
sqlSession.close();
return user;
}
@Override
public List<User> findUserByName(String name) throws Exception {
/**
* 1.得到SqlSession
* 2.调用SqlSession对应的方法(selectList)来操作数据库
* 3.关闭SqlSession
* 4.返回结果
*/
SqlSession sqlSession = sqlSessionFactory.openSession();
List<User> users = sqlSession.selectList("test.findUserByName", "%"+name+"%");
sqlSession.close();
return users;
}
@Override
public void addUser(User user) throws Exception {
/**
* 1.得到SqlSession
* 2.调用SqlSession对应的方法(insert)来操作数据库
* 3.提交事务
* 4.关闭SqlSession
*/
SqlSession sqlSession = sqlSessionFactory.openSession();
sqlSession.insert("test.addUser", user);
sqlSession.commit();
sqlSession.close();
}
}
2.编写SQL映射文件
<!-- 根据ID查询 -->
<select id="findUserById" parameterType="int" resultType="org.csmf.mybatis.entity.User">
select * from t_user where id = #{id}
</select>
<!-- 根据姓名模糊查询 -->
<select id="findUserByName" parameterType="string" resultType="org.csmf.mybatis.entity.User">
select * from t_user where username like #{name}
</select>
<!—添加用户-->
<insert id="addUser" parameterType="org.csmf.mybatis.entity.User">
<selectKey order="AFTER" resultType="int" keyProperty="id">
select last_insert_id()
</selectKey>
insert into t_user(username,password,sex,brithday,address)
values(#{username},#{password},#{sex},#{brithday},#{address})
</insert>
总结:
原始Dao开发中存在以下问题:
-
Dao方法体存在重复代码:通过SqlSessionFactory创建SqlSession,调用SqlSession的数据库操作方法
-
调用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的类型相同
实现:
UserMapper.xml:
UserMapper接口:
测试代码:
import java.io.IOException;
import java.io.InputStream;
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.csmf.mybatis.entity.User;
import org.junit.Before;
import org.junit.Test;
/**
* 测试UserMapper的测试类
* @author pactera
*
*/
public class UserMapperTest {
private SqlSessionFactory sqlSessionFactory;
@Before
public void setUp(){
InputStream inputStream = null;
try {
inputStream = Resources.getResourceAsStream("mybatis-config.xml");
} catch (IOException e) {
e.printStackTrace();
}
sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
}
@Test
public void testFindUserById() throws Exception{
SqlSession sqlSession = sqlSessionFactory.openSession();
//创建UserMapper的休息,Mybatis可以自动生成UserMapper接口的代理对象
UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
User user = userMapper.findUserById(2);
System.out.println(user);
}
}
总结:
selectOne和selectList
动态代理对象调用sqlSession.selectOne()和sqlSession.selectList()是根据mapper接口方法的返回值决定,如果返回list则调用selectList方法,如果返回单个对象则调用selectOne方法。
namespace
mybatis官方推荐使用mapper代理方法开发mapper接口,程序员不用编写mapper接口实现类,使用mapper代理方法时,输入参数可以使用包装类或map对象,保证dao的通用性。