mybatis学习：二、 Mybatis的Dao开发、mybatis-config.xml文件的详情

3. Mybatis的Dao开发

​ 使用Mybatis开发Dao，通常有两个方法，即原始Dao开发方法和Mapper接口开发方法。

3.1 Mybatis的核心对象

• SqlSessionFactoryBuilder

  ​ SqlSessionFactoryBuilder用于创建SqlSessionFacoty，SqlSessionFacoty一旦创建完成就不需要SqlSessionFactoryBuilder了，因为SqlSession是通过SqlSessionFactory生产，所以可以将SqlSessionFactoryBuilder当成一个工具类使用，最佳使用范围是静态代码块中的局部变量

• SqlSessionFactory

  ​ SqlSessionFactory是一个接口，接口中定义了openSession的不同重载方法，SqlSessionFactory的最佳使用范围是整个应用运行期间，一旦创建后可以重复使用，通常以单例模式管理SqlSessionFactory。

• SqlSession

1. SqlSession是一个面向用户的接口， sqlSession中定义了数据库操作，默认使用DefaultSqlSession实现类。

2. SqlSession的实现类即DefaultSqlSession，此对象中对操作数据库实质上用的是Executor

3. 每个线程都应该有它自己的SqlSession实例。SqlSession的实例不能共享使用，它也是线程不安全的。因此最佳的范围是请求或方法范围。绝对不能将SqlSession实例的引用放在一个类的静态字段或实例字段中。
   4. 打开一个 SqlSession；使用完毕就要关闭它。通常把这个关闭操作放到 finally 块中以确保每次都能执行关闭。

3.2 传统的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;
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

---

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();
	}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51

2. 编写SQL映射文件

   
   <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>
   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   13
   14
   15
   16

总结:

原始Dao开发中存在以下问题：

• Dao方法体存在重复代码：通过SqlSessionFactory创建SqlSession，调用SqlSession的数据库操作方法

• 调用sqlSession的数据库操作方法需要指定statement的id，这里存在硬编码，不得于开发维护。

3.3 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);
	}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37

总结:

• selectOne和selectList

动态代理对象调用sqlSession.selectOne()和sqlSession.selectList()是根据mapper接口方法的返回值决定，如果返回list则调用selectList方法，如果返回单个对象则调用selectOne方法。

• namespace

mybatis官方推荐使用mapper代理方法开发mapper接口，程序员不用编写mapper接口实现类，使用mapper代理方法时，输入参数可以使用包装类或map对象，保证dao的通用性。

4. mybatis-config.xml文件的详情

mybatis的全局配置文件SqlMapConfig.xml，配置内容如下：

properties（属性） 加载properties文件

settings（全局配置参数） 缓存

typeAliases（类型别名） 类型别名

typeHandlers（类型处理器）

objectFactory（对象工厂）

plugins（插件） 通用Mapper 分页插件

environments（环境集合属性对象）

​ environment（环境子属性对象）

​ transactionManager（事务管理）

​ dataSource（数据源）

mappers（映射器）

4.1 properties属性

​ 在实际开发中,我们通常会将数据库连接参数单独配置在db.properties中，只需要在mybatis-config.xml中加载db.properties的属性值。这样我们在mybatis-config.xml中就不需要对数据库连接参数硬编码。

​ 将数据库连接参数只配置在db.properties中，原因：方便对参数进行统一管理，其它xml可以引用该db.properties。

db.properties文件:

jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/mybatis?characterEncoding=utf-8
jdbc.username=root
jdbc.password=root
1
2
3
4

mybatis-config.xml引用properties文件:

	
	<properties resource="db.properties">properties>
	
	<environments default="development">
		
		<environment id="development">
			
			<transactionManager type="JDBC" />
			
			<dataSource type="POOLED">
				<property name="driver" value="${jdbc.driver}" />
				<property name="url" value="${jdbc.url}" />
				<property name="username" value="${jdbc.username}" />
				<property name="password" value="${jdbc.password}" />
			dataSource>
		environment>
	environments>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

4.2 settings全局参数配置

​ mybatis框架在运行时可以调整一些运行参数。

​ 比如：开启二级缓存、开启延迟加载。

全局参数将会影响mybatis的运行行为。

4.3 typeAliases(类型别名)

4.3.1 mybatis支持别名：

4.3.2 自定义别名：

在mybatis-config.xml中配置：

<typeAliases>
	
	<typeAlias alias="user" type="org.csmf.mybatis.entity.User"/>
	
	<package name=" org.csmf.mybatis.entity "/>
	<package name="其它包"/>
typeAliases>
1
2
3
4
5
6
7

使用别名:

4.4 mappers（映射器）

Mapper配置的几种方法：

使用相对于类路径的资源

如：

使用完全限定路径

如：

使用mapper接口类路径

如：

注意：此种方法要求mapper接口名称和mapper映射文件名称相同，且放在同一个目录中。

注册指定包下的所有mapper接口

如：

注意：此种方法要求mapper接口名称和mapper映射文件名称相同，且放在同一个目录中。