首页 > 代码库 > MyBatis基本配置和实践(二)
MyBatis基本配置和实践(二)
一、前言
从上一篇文章的junit单元测试环节可以看到,每一次调用MyBatis需要先加载SqlMapConfig.xml文件,再通过SqlSessionFactoryBuilder创建SqlSessionFactory,然后从SqlSessionFactory获取SqlSession,最后调用SqlSession的selectOne、selectList、insert、delete方法完成数据库操作,编码效率低下。
二、若干概念的解释
1、SqlSession的使用范围 SqlSession中封装了对数据库的操作,如:查询、插入、更新、删除等。通过SqlSessionFactory创建SqlSession,而SqlSessionFactory是通过SqlSessionFactoryBuilder进行创建。 2、SqlSessionFactoryBuilder SqlSessionFactoryBuilder用于创建SqlSessionFacoty,SqlSessionFacoty一旦创建完成就不需要SqlSessionFactoryBuilder了,因为SqlSession是通过SqlSessionFactory生产,所以可以将SqlSessionFactoryBuilder当成一个工具类使用,最佳使用范围是方法范围即方法体内局部变量。 3、SqlSessionFactory SqlSessionFactory是一个接口,接口中定义了openSession的不同重载方法,SqlSessionFactory的最佳使用范围是整个应用运行期间,一旦创建后可以重复使用,通常以单例模式管理SqlSessionFactory。 4、SqlSession SqlSession是一个面向用户的接口, sqlSession中定义了数据库操作方法。每个线程都应该有它自己的SqlSession实例。SqlSession的实例不能共享使用,它也是线程不安全的。因此最佳的范围是请求或方法范围。绝对不能将SqlSession实例的引用放在一个类的静态字段或实例字段中。打开一个 SqlSession;使用完毕就要关闭它。通常把这个关闭操作放到 finally 块中以确保每次都能执行关闭。如下: SqlSession session = sqlSessionFactory.openSession(); try { // do work } finally { session.close(); }
三、使用MyBatis开发DAO的第一种方式:原始DAO开发方法
第一步:复用上一个实验中的文件(步骤1~步骤7)
第二步:创建Dao接口UserDao.java(在接口中定义操作数据库的Dao方法)
package cn.itheima.dao; import cn.itheima.pojo.User; import java.util.List; /** * Created by Eric on 3/11/17. */ public interface UserDao { User findUserById(int id) throws Exception; List<User> findUserByUserName(String username) throws Exception; }
第三步:创建Dao接口的实现类UserDaoImpl.java
package cn.itheima.dao; import cn.itheima.pojo.User; import org.apache.ibatis.session.SqlSession; import org.apache.ibatis.session.SqlSessionFactory; import java.util.List; /** * Created by Eric on 3/11/17. */ public class UserDaoImpl implements UserDao { private SqlSessionFactory sqlSessionFactory; public UserDaoImpl(SqlSessionFactory sqlSessionFactory) { this.sqlSessionFactory = sqlSessionFactory; } public User findUserById(int id) throws Exception { // SqlSession 是线程不安全的, 所以必须用完销毁 SqlSession openSession = sqlSessionFactory.openSession(); return (User) openSession.selectOne("test.findUserById", id); } public List<User> findUserByUserName(String userName) throws Exception { SqlSession openSession = sqlSessionFactory.openSession(); return openSession.selectList("test.findUserByUsername", userName); } }
第四步:单元测试(模拟日常使用)
package cn.itheima.test; import cn.itheima.dao.UserDaoImpl; import cn.itheima.pojo.User; 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 java.io.InputStream; import java.util.List; /** * Created by Eric on 3/11/17. */ public class UserDaoTest { private SqlSessionFactory sqlSessionFactory; /** * 通过@Before完成sqlSessionFactory的创建 */ @Before public void setUp() throws Exception { InputStream resourceAsStream = Resources.getResourceAsStream("SqlMapConfig.xml"); sqlSessionFactory = new SqlSessionFactoryBuilder().build(resourceAsStream); } /** * 每次使用DaoImpl时, 以构造函数传参的方式将sqlSessionFactory注入给DaoImpl, 然后调用DaoImpl的方法完成数据库操作 */ @Test public void testSelectById() throws Exception { System.out.println(new UserDaoImpl(sqlSessionFactory).findUserById(10)); } @Test public void testSelectByUsername() throws Exception { List<User> userByUserName = new UserDaoImpl(sqlSessionFactory).findUserByUserName("王%"); for (User user : userByUserName) { System.out.println(user); } } }
问题:
原始Dao开发中存在以下问题: 1、Dao方法体存在重复代码:通过SqlSessionFactory创建SqlSession,调用SqlSession的数据库操作方法 2、调用sqlSession的数据库操作方法需要指定statement的id,这里存在硬编码,不得于开发维护。
四、使用MyBatis开发DAO的第二种方式:Mapper动态代理方式
开发规范:
Mapper接口开发方法只需要程序员编写Mapper接口(相当于Dao接口),由Mybatis框架根据接口定义创建接口的动态代理对象,代理对象的方法体同上边Dao接口实现类方法。Mapper接口开发需要遵循以下规范: 1、mapper接口的类路径与Mapper.xml文件中的namespace相同。 2、Mapper接口方法名和Mapper.xml中定义的每个statement的id相同 3、Mapper接口方法的输入参数类型和mapper.xml中定义的每个sql 的parameterType的类型相同 4、Mapper接口方法的输出参数类型和mapper.xml中定义的每个sql的resultType的类型相同
第一步:复用上一个实验中的文件(步骤1~步骤5,不再需要第六步的sql映射文件Users.xml;第七步的加载Users.xml自然也不需要)
第二步:创建UserMapper.xml映射文件
定义mapper映射文件UserMapper.xml(内容同Users.xml),需要修改namespace的值为 UserMapper接口路径(规范一)。将UserMapper.xml放在cn.itheima.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"> <!-- 1、Mapper接口的全路径名称和Mapper.xml中的namespace相同 2、Mapper接口方法名和Mapper.xml中定义的每个statement的id相同 3、Mapper接口方法的输入参数类型和mapper.xml中定义的每个sql 的parameterType的类型相同 4、Mapper接口方法的输出参数类型和mapper.xml中定义的每个sql的resultType的类型相同 --> <mapper namespace="cn.itheima.mapper.UserMapper"> <select id="findUserById" parameterType="int" resultType="cn.itheima.pojo.User"> select * from user where id = #{id} </select> <select id="findUserByUsername" parameterType="java.lang.String" resultType="cn.itheima.pojo.User"> SELECT * FROM user WHERE username LIKE ‘${value}‘ </select> <insert id="insertUser" parameterType="cn.itheima.pojo.User"> <selectKey order="AFTER" resultType="java.lang.Integer" keyProperty="id"> SELECT LAST_INSERT_ID() </selectKey> INSERT INTO user(username,birthday,sex,address)VALUES (#{username},#{birthday},#{sex},#{address}) </insert> </mapper>
第三步:创建UserMapper.java接口文件
package cn.itheima.mapper; import cn.itheima.pojo.User; import java.util.List; /** * A. 原生DAO实现 (需要写DAO接口和DAO实现类) * B. 动态代理方式 (只需要写接口) * 1、Mapper接口的全路径名称和Mapper.xml中的namespace相同 * 2、Mapper接口中的方法名和Mapper.xml中定义的statement的id相同 * 3、Mapper接口中的方法的输入参数类型和mapper.xml中定义的statement的parameterType的类型相同 * 4、Mapper接口中方法的输出参数类型和mapper.xml中定义的statement的resultType的类型相同 */ public interface UserMapper { User findUserById(int id); List<User> findUserByUsername(String username); void insertUser(User user); }
第四步:在SqlMapConfig.xml文件中配置sql映射文件,保证可以被读取
<mappers> <mapper resource="Users.xml"/> <!--接口文件和映射文件都放在cn.itheima.mapper目录下,这是采用package标签所必须的--> <package name="cn.itheima.mapper"/> <!--使用包扫描的方式批量引入Mapper接口: 1、接口名称和映射文件名称除扩展名外要完全相同; 2、接口和映射文件必须放在同一个目录中--> </mappers>
第五步:单元测试(Dao接口 + sql映射文件,MyBatis会自动生成DaoImpl)
package cn.itheima.test; import cn.itheima.mapper.UserMapper; import cn.itheima.pojo.User; 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 java.io.InputStream; import java.util.List; /** * Created by Eric on 3/11/17. */ public class UserMapperTest { private SqlSessionFactory sqlSessionFactory; @Before public void setUp() throws Exception { InputStream resourceAsStream = Resources.getResourceAsStream("SqlMapConfig.xml"); sqlSessionFactory = new SqlSessionFactoryBuilder().build(resourceAsStream); } /** * 依然需要通过@Before生成sqlSessionFactory, 但不再需要注入给DaoImpl, 因为DaoImpl由MyBatis自动生成. * 只需要在方法中生成线程安全的SqlSession, 然后获取我们需要的Mapper, 即可调用Dao接口中定义的方法 */ @Test public void testFindUserById() throws Exception { SqlSession openSession = sqlSessionFactory.openSession(); UserMapper userMapper = openSession.getMapper(UserMapper.class); System.out.println(userMapper.findUserById(10)); } @Test public void testFineUserByUserame() throws Exception { SqlSession openSession = sqlSessionFactory.openSession(); UserMapper userMapper = openSession.getMapper(UserMapper.class); List<User> userList = userMapper.findUserByUsername("王%"); for (User user : userList) { System.out.println(user); } } @Test public void insertUserTestUnit() throws Exception { SqlSession openSession = sqlSessionFactory.openSession(); UserMapper userMapper = openSession.getMapper(UserMapper.class); User user = new User(); user.setUsername("阿拉蕾"); userMapper.insertUser(user); System.out.println(user.getId()); openSession.commit(); } }
小结:
1、selectOne和selectList 动态代理对象调用sqlSession.selectOne()和sqlSession.selectList()是根据mapper接口方法的返回值决定,如果返回list则调用selectList方法,如果返回单个对象则调用selectOne方法。 2、namespace mybatis官方推荐使用mapper代理方法开发mapper接口,程序员不用编写mapper接口实现类,使用mapper代理方法时,输入参数可以使用pojo包装对象或map对象,保证dao的通用性。
SqlMapConfigxml中<Mapper>配置的几种方法: <mapper resource="" /> 使用相对于classpath的资源,如:<mapper resource="sqlmap/User.xml" /> <mapper class="" /> 使用mapper接口类路径,如:<mapper class="cn.itcast.mybatis.mapper.UserMapper"/> 注意:此种方法要求mapper接口名称和mapper映射文件名称相同,且放在同一个目录中。 <package name=""/> 注册指定包下的所有mapper接口,如:<package name="cn.itcast.mybatis.mapper"/> 注意:此种方法要求mapper接口名称和mapper映射文件名称相同,且放在同一个目录中。
MyBatis基本配置和实践(二)
声明:以上内容来自用户投稿及互联网公开渠道收集整理发布,本网站不拥有所有权,未作人工编辑处理,也不承担相关法律责任,若内容有误或涉及侵权可进行投诉: 投诉/举报 工作人员会在5个工作日内联系你,一经查实,本站将立刻删除涉嫌侵权内容。