Mybatis配置详解

Mybatis配置详解

MyBatis最关键的组成部分是SqlSessionFactory，我们可以从中获取SqlSession， 并执行映射的SQL语句。SqlSessionFactory对象可以通过基于XML的配置信息或者JavaAPI创建。

使用xml配置Mybatis

构建SqlSessionFactory最常见的方式是基于XML配置。
下面的 mybatis-config.xml展示了一个典型的MyBatis配置文件的样子：

		<?xml version="1.0" encoding="utf-8"?> 
		<!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN" 
		"http://mybatis.org/dtd/mybatis-3-config.dtd"> 
		<configuration> 
		  <properties resource="application.properties"> 
			<property name="username" value="db_user" /> 
			<property name="password" value="verysecurepwd" /> 
		  </properties> 
		  <settings> 
			<setting name="cacheEnabled" value="true" /> 
		  </settings> 
		  <typeAliases> 
			<typeAlias alias="Student" type="com.briup.pojo.Student" /> 
			<package name="com.briup.pojo" /> 
		  </typeAliases> 
		  <typeHandlers> 
			<typeHandler handler="com.mybatis3.typehandlers.PhoneTypeHandler" /> 
			<package name="com.briup.typehandlers" /> 
		  </typeHandlers> 
		  <environments default="development"> 
			<environment id="development"> 
			  <transactionManager type="JDBC" /> 
			  <dataSource type="POOLED"> 
				<property name="driver" value="${jdbc.driverClassName}" /> 
				<property name="url" value="${jdbc.url}" /> 
				<property name="username" value="${jdbc.username}" /> 
				<property name="password" value="${jdbc.password}" /> 
			  </dataSource> 
			</environment> 
			<environment id="production"> 
			  <transactionManager type="MANAGED" /> 
			  <dataSource type="JNDI"> 
				<property name="data_source" value="java:comp/jdbc/MyBatisDemoDS" /> 
			  </dataSource> 
			</environment> 
		  </environments> 
		  <mappers> 
			<mapper resource="com/briup/mappers/StudentMapper.xml" /> 
			<mapper url="file:///D:/mybatisdemo/mappers/StudentMapper.xml" /> 
			<mapper class="com.briup.mappers.StudentMapper" /> 
		  </mappers> 
		</configuration> 

1. environments元素

environments是配置mybatis当前工作的数据库环境的地方
MyBatis支持配置多个dataSource环境，可以将应用部署到不同的环境上，如DEV(开发环境)，TEST（测试换将），QA（质量评估环境）,UAT(用户验收环境),PRODUCTION（生产环境），可以通过将默认environments值设置成想要的environment的id值。

---

有时候，我们可能需要在相同的应用下使用多个数据库,比如我们可能有shoppingcart数据库来存储所有的订单明细；使用reports数据库存储订单明细的合计，用作报告。(也就是如果系统在运行期间如果有切换数据库环境的需求,mybatis中也可以很轻松的实现).
如果你的应用需要连接多个数据库，你需要将每个数据库配置成独立的环境，并且为每一个数据库创建一个SqlSessionFactory
例如:

		<environments default="shoppingcart"> 
		  <environment id="shoppingcart"> 
			<transactionManager type="MANAGED" /> 
			<dataSource type="JNDI"> 
			  <property name="data_source" value="java:comp/jdbc/ShoppingcartDS" /> 
			</dataSource> 
		  </environment> 
		  <environment id="reports"> 
			<transaction Managertype="MANAGED" /> 
			<dataSource type="JNDI"> 
			  <property name="data_source" value="java:comp/jdbc/ReportsDS" /> 
			</dataSource> 
		  </environment> 
		</environments> 

我们可以为以上每个环境创建一个SqlSessionFactory
java代码:

		inputStream = Resources.getResourceAsStream("mybatis-config.xml"); 
		//默认的环境
		defaultSqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);

		//统计明细的环境
		cartSqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream, "shoppingcart"); 

		//统计报表的环境
		reportSqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream, "reports");

注意:对于environments,我们可以在其中配置多个environment子元素,同时还需要在environment中配置dataSource和transactionManager元素。

2. dataSource元素

dataSource表示的是数据源:至少会包括该连接数据库的各种信息

		<dataSource type="POOLED"> 
		  <property name="driver" value="${jdbc.driverClassName}" /> 
		  <property name="url" value="${jdbc.url}" /> 
		  <property name="username" value="${jdbc.username}" /> 
		  <property name="password" value="${jdbc.password}" /> 
		</dataSource> 

dataSource的类型type属性可以配置成其内置类型之一，如UNPOOLED，POOLED，JNDI。
如果将类型设置成UNPOOLED，MyBatis会为每一个数据库操作创建一个新的连接，使用完了并关闭它，该方式适用于只有小规模数量并发用户的简单应用程序上。

---

如果将属性设置成POOLED，MyBatis会创建一个数据库连接池，连接池中的一个连接将会被用作数据库操作。一旦数据库操作完成，MyBatis会将此连接返回给连接池。

如果将类型设置成JNDI(Java Naming and Directory Interface , Java命名和目录接口, 是SUN公司提供的一种标准的Java命名系统接口)，MyBatis从在应用服务器向配置好的JNDI数据源dataSource获取数据库连接。

3. transactionManager元素 :事务管理器

MyBatis支持两种类型的事务管理器：JDBC 和 MANAGED.

JDBC事务管理器，是在【jdbc程序】负责管理数据库连接的生命周期（提交、回退等等）的时候。如果将TransactionManager 属性设置成JDBC，MyBatis内部将使用JdbcTransactionFactory类创建TransactionManager。例如，部署到ApacheTomcat的应用程序，需要应用程序自己管理事务。因为ApacheTomcat不会帮我们管理事务。

---

MANAGED 事务管理器，是在【应用服务器】负责管理数据库连接生命周期的时候。如果将TransactionManager属性设置成MANAGED时，MyBatis内部使用ManagedTransactionFactory 类创建事务管理器TransactionManager。例如，当一个Java EE的应用程序部署在类似JBoss，WebLogic，GlassFish应用服务器上时，它们会使用EJB进行应用服务器的事务管理能力。在这些管理环境中，你可以使用MANAGED事务管理器。
注：Managed 是托管的意思，即我们编写的应用程序本身不去管理事务，而是把事务管理交给应用所在的服务器进行管理。

4. properties元素

属性配置元素properties可以将配置值写死到mybatis-config.xml中,也可以具体到一个属性文件中,并且使用属性文件的key名作为占位符.
在上述的配置中，我们将数据库连接属性配置到了application.properties文件中，并且为driver，URL等属性使用了占位符.

---

在applications.properties文件中配置数据库连接参数，如下所示：
jdbc.driverClassName=oracle.jdbc.driver.OracleDriver
jdbc.url=jdbc:oracle:thin:@127.0.0.1:1521:XE
jdbc.username=briup
jdbc.password=briup

---

在mybatis-config.xml文件中，为属性使用application.properties文件中定义的占位符：

		<!-- 读取application.properties文件中的数据key-value的形式 -->
		<properties resource="application.properties">
		  <!-- 注意:是applications.properties文件中的值优先级高 -->
		  <property name="jdbc.username" value="briup" /> 
		  <property name="jdbc.password" value="briup" /> 
		</properties> 
		<environments default="development"> 
			<environment id="development"> 
			  <transactionManager type="JDBC" /> 
			  <dataSource type="POOLED"> 
				<property name="driver" value="${jdbc.driverClassName}" /> 
				<property name="url" value="${jdbc.url}" /> 
				<property name="username" value="${jdbc.username}" /> 
				<property name="password" value="${jdbc.password}" /> 
			  </dataSource> 
			</environment> 
		</environments>  

5. typeAliases元素: 类型别名

在SQLMapper配置文件中，对于resultType和parameterType属性值，我们需要使用JavaBean 的完全限定名。
例如:

		<select id="findStudentById" parameterType="int"  
			resultType="com.briup.pojo.Student"> 
				SELECT STUD_ID AS ID, NAME, EMAIL, DOB  
				FROM STUDENTS WHERE STUD_ID=#{Id} 
		</select> 
		<update id="updateStudent" parameterType="com.briup.pojo.Student"> 
			UPDATE STUDENTS  
				SET NAME=#{name}, EMAIL=#{email}, DOB=#{dob}  
				WHERE STUD_ID=#{id} 
		</update> 

注:parameterType表示将来调用这个sql语句的时候所传的参数的类型(参数值或者参数对象里面的属性值 用来替换sql语句中的占位符)
resultType表示将来调用这个sql语句的时候所返回的结果的类型(方便mybatis给我们自动封装结果集)

这里我们为resultType和parameterType属性值设置为Student类型的完全限定名：com.briup.com.Student

我们可以为完全限定名取一个别名（alias），然后就可以在需要使用完全限定名的地方使用别名，而不是到处使用完全限定名。如下例子所示，为完全限定名起一个别名：

		<typeAliases> 
		  <typeAlias alias="Student" type="com.briup.pojo.Student" /> 
		  <typeAlias alias="Teacher" type="com.briup.pojo.Teacher" /> 
		</typeAliases> 

然后在SQLMapper映射文件中, 如下使用Student的别名：

		<select id="findStudentById" parameterType="int" resultType="Student"> 
			SELECT STUD_ID AS ID, NAME, EMAIL, DOB  
			FROM STUDENTS WHERE STUD_ID=#{id} 
		</select> 
		<update id="updateStudent" parameterType="Student"> 
			UPDATE STUDENTS  
				SET NAME=#{name}, EMAIL=#{email}, DOB=#{dob}  
			WHERE STUD_ID=#{id} 
		</update> 

你可以不用为每一个JavaBean单独定义别名,你可以为配置出需要取别名的类的所在的包(package)，MyBatis会自动扫描包内定义的类，然后分别为每个类注册一个小写字母开头的简单类名形式的别名。如下所示：

		<type Aliases> 
		  <package name="com.briup.pojo" /> 
		</type Aliases> 

如果Student.java和 Teacher.java 定义在com.briup.pojo包中，则 com.briup.pojo.Student的别名会被注册为student。而com.briup.pojo.Teacher别名将会被注册为teacher

---

还有另外一种方式为JavaBeans起别名，使用注解 @Alias:
@Alias(“stu”)
public class Student{
…
}
@Alias注解将会覆盖配置文件中的定义。

6. typeHandlers元素: 类型处理器

当MyBatis将一个Java对象作为输入参数执行INSERT语句操作时，它会创建一个PreparedStatement对象，并且使用setXXX()方法对占位符设置相应的参数值 。这里，XXX可以是Int，String，Date 等 Java对象属性类型的任意一个。示例如下：

		<insert id="insert Student" parameter Type="Student"> 
			INSERT INTO STUDENTS(STUD_ID,NAME,EMAIL,DOB)  
			VALUES(#{stud Id},#{name},#{email},#{dob}) 
		</insert> 

---

为执行这个语句，MyBatis将采取以下一系列动作：
创建一个有占位符的PreparedStatement接口，如下：
Prepared Statement ps = connection.prepare Statement
(“INSERT INTO STUDENTS(STUD_ID,NAME,EMAIL,DOB) VALUES(?,?,?,?)”);
检查Student对象的属性studId的类型，然后使用合适setXXX方法去设置参数值。这里studId是integer类型，所以会使用setInt()方法：ps.setInt(1,student.getStudId());

---

类似地，对于name和email属性都是String类型MyBatis使用setString()方法设置参数。
至于dob属性, MyBatis会使用setDate()方法设置dob处占位符位置的值。
MyBaits会将java.util.Date类型转换为java.sql.Timestamp并设值：
ps.setTimestamp(4, new Timestamp((student.getDob()).getTime()));

---

但MyBatis是怎么知道对于Integer类型属性使用setInt()和String类型属性使用setString()方法呢？其实MyBatis是通过使用类型处理器typeHandlers来决定这么做的。

---

MyBatis对于以下的类型使用内建的类型处理器：所有的基本数据类型、基本类型的包裹类型、 byte[]、java.util.Date、java.sql.Date、java,sql.Time、java.sql.Timestamp、java枚举类型等。所以当MyBatis发现属性的类型属于上述类型，他会使用对应的类型处理器将值设置到PreparedStatement中，同样地，当SQL结果集封装成java类对象的时候，也有类似的过程。

---

那如果有一个自定义的类型，怎么存储存储到数据库呢？示例如下：假设表STUDENTS 有一个 PHONE 字段，类型为 VARCHAR2(15)，而 Student类有一个自定义类型属性
alter table students add phone varchar2(15);
alter table students drop column phone;

---

java代码:
PhoneNumber 类定义类型的 phoneNumber 属性。

		public class PhoneNumber{ 
			private String countryCode; 
			private String stateCode; 
			private String number; 
			public PhoneNumber(){} 

			public PhoneNumber(String countryCode, String stateCode, String number) { 
				this.countryCode = countryCode; 
				this.stateCode = stateCode; 
				this.number = number; 
			} 

			public PhoneNumber(String str){ 
				if(str!=null){
					String[] args = str.split("-");
					this.countryCode = 	args[0];
					this.stateCode = 	args[1];
					this.number = 		args[2];
				}
			}
			public String getAsString() { 
				return countryCode + "-" + stateCode + "-" + number; 
			} 
			// Setters and getters 
		} 
		 
		public class Student{ 
			private Integer id; 
			private String name; 
			private String email; 
			private PhoneNumber phone; 
			// Setters and getters 
		} 

xml配置:

		<insert id="insertStudent" parameter Type="Student"> 
			insert into students(name,email,phone) 
			values(#{name},#{email},#{phone}) 
		</insert> 

这里，参数对象中的属性phone的值需要传递给#{phone}；而参数对象的属性phone是 PhoneNumber类型。但是，MyBatis 并不知道该怎样来处理这个类型的对象。
为了让MyBatis明白怎样处理这个自定义的Java对象类型，如PhoneNumber，我们可以创建一个自定义的类型处理器,MyBatis提供了抽象类BaseTypeHandler ，我们可以继承此类创建自定义类型处理器。

代码如下所示:

			package com.briup.typehandlers;

			import java.sql.CallableStatement;
			import java.sql.PreparedStatement;
			import java.sql.ResultSet;
			import java.sql.SQLException;

			import org.apache.ibatis.type.BaseTypeHandler;
			import org.apache.ibatis.type.JdbcType;

			import com.briup.pojo.PhoneNumber;

			public class PhoneTypeHandler extends BaseTypeHandler<PhoneNumber>{

				//遇到PhoneNumber参数的时候应该如何在ps中设置值
				@Override
				public void setNonNullParameter(PreparedStatement ps, int i, PhoneNumber parameter, JdbcType jdbcType)
						throws SQLException {
					ps.setString(i, parameter.getAsString());
				}

				//查询中遇到PhoneNumber类型的应该如何封装(使用列名封装)
				@Override
				public PhoneNumber getNullableResult(ResultSet rs, String columnName) throws SQLException {
					return new PhoneNumber(rs.getString(columnName));
				}

				//查询中遇到PhoneNumber类型的应该如何封装(使用列的下标)
				@Override
				public PhoneNumber getNullableResult(ResultSet rs, int columnIndex) throws SQLException {
					return new PhoneNumber(rs.getString(columnIndex));
				}

				//CallableStatement使用中遇到了PhoneNumber类型的应该如何封装
				@Override
				public PhoneNumber getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {
					return new PhoneNumber(cs.getString(columnIndex));
				}

			}

注意:使用ps.setString()和rs.getString()方法是 :因为在数据库的表中phone列是VARCHAR类型。

最后一旦我们实现了自定义的类型处理器，我们需要在mybatis-config.xml中注册它：

		<?xml version="1.0" encoding="utf-8"?> 
		<!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN" 
		"http://mybatis.org/dtd/mybatis-3-config.dtd"> 
		<configuration> 
		  <properties resource="application.properties" /> 
		  <typeHandlers> 
			<type Handler handler="com.briup.typehandlers.PhoneTypeHandler" /> 
		  </typeHandlers> 
		</configuration> 

	注册PhoneTypeHandler后, MyBatis就能够将Phone类型的对象值存储到VARCHAR类型的列上。

7. settings元素: 全局参数设置

注意:大多数情况下，【这些参数使用它们的默认值即可】
为满足应用特定的需求，MyBatis默认的全局参数设置可以被覆盖掉，如下所示：

		<settings>
		  <setting name="cacheEnabled" value="true" /> 
		  <setting name="lazyLoadingEnabled" value="true" /> 
		  <setting name="multipleResultSetsEnabled" value="true" /> 
		  <setting name="useColumnLabel" value="true" /> 
		  <setting name="useGeneratedKeys" value="false" /> 
		  <setting name="autoMappingBehavior" value="PARTIAL" /> 
		  <setting name="defaultExecutorType" value="SIMPLE" /> 
		  <setting name="defaultStatementTimeout" value="25000" /> 
		  <setting name="safeRowBoundsEnabled" value="false" /> 
		  <setting name="mapUnderscoreToCamelCase" value="false" /> 
		  <setting name="localCacheScope" value="SESSION" /> 
		  <setting name="jdbcTypeForNull" value="OTHER" /> 
		  <setting name="lazyLoadTriggerMethods" value="equals,clone,hash Code ,to String" /> 
		  <setting name="proxyFactory" value="JAVASSIST" /> 
		  <setting name="aggressiveLazyLoading" value="true" /> 
		  <setting name="logImpl" value="LOG4J " /> 
		  <setting name="logPrefix" value="LOG4J " /> 
		  <setting name="callSettersOnNulls" value="false " /> 
		</settings> 

		<settings>
		  <!-- 这个配置使全局的映射文件启用或禁用缓存 -->
		  <setting name="cacheEnabled" value="true" />

		  <!-- 全局启用或禁用延迟加载。当禁用时，所有关联对象都会即时加载 -->
		  <setting name="lazyLoadingEnabled" value="true" />

		  <!-- 允许或不允许多种结果集从一个单独的语句中返回（需要适合的驱动） -->
		  <setting name="multipleResultSetsEnabled" value="true" /> 

		  <!-- 使用列标签代替列名。不同的驱动在这方便表现不同。参考驱动文档或充分测试两种方法来决定所使用的驱动 -->
		  <setting name="useColumnLabel" value="true" /> 

		  <!-- 允许JDBC支持生成的键。需要适合的驱动。 -->
		  <setting name="useGeneratedKeys" value="false" /> 

		  <!-- 指定MyBatis如何自动映射列到字段/属性。PARTIAL只会自动映射简单、没有嵌套的结果。FULL会自动映射任意复杂的结果（嵌套的或其他情况） -->
		  <setting name="autoMappingBehavior" value="PARTIAL" />
		  
		  <!-- 配置默认的执行器。SIMPLE执行器没有什么特别之处。REUSE执行器重用预处理语句。BATCH执行器重用语句和批量更新 -->
		  <setting name="defaultExecutorType" value="SIMPLE" /> 

		  !-- 设置超时时间，它决定驱动等待一个数据库响应的时间 -->
		  <setting name="defaultStatementTimeout" value="25000" /> 
		  
		  <!-- 允许在嵌套语句中使用分页（RowBounds）默认false -->
		  <setting name="safeRowBoundsEnabled" value="false" /> 

		  <!-- 是否开启自动驼峰命名规则（camel case）映射，即从经典数据库列名 A_COLUMN 到经典 Java 属性名 aColumn 的类似映射。默认false -->
		  <setting name="mapUnderscoreToCamelCase" value="false" /> 

		  <!-- MyBatis 利用本地缓存机制（Local Cache）防止循环引用（circular references）和加速重复嵌套查询。 默认值为 SESSION，这种情况下会缓存一个会话中执行的所有查询。 若设置值为 STATEMENT，本地会话仅用在语句执行上，对相同 SqlSession 的不同调用将不会共享数据。 -->
		  <setting name="localCacheScope" value="SESSION" /> 

		  <!-- 当没有为参数提供特定的 JDBC 类型时，为空值指定 JDBC 类型。 某些驱动需要指定列的 JDBC 类型，多数情况直接用一般类型即可，比如 NULL、VARCHAR 或 OTHER。 -->
		  <setting name="jdbcTypeForNull" value="OTHER" />

		  <!-- 指定对象的哪个方法触发一次延迟加载。 -->
		  <setting name="lazyLoadTriggerMethods" value="equals,clone,hashCode ,toString" /> 

		  <!-- CGLIB | JAVASSIST 默认JAVASSIST(MyBatis 3.3 or above)  -->
		  <!-- 指定 Mybatis 创建具有延迟加载能力的对象所用到的代理工具。 -->
		  <setting name="proxyFactory" value="JAVASSIST" /> 
		  <!-- 当启用时，对任意延迟属性的调用会使带有延迟加载属性的对象完整加载；反之，每种属性将会按需加载。 -->
		  <setting name="aggressiveLazyLoading" value="true" /> 
			
		  <!-- 指定 MyBatis 所用日志的具体实现，未指定时将自动查找。 -->
		  <setting name="logImpl" value="LOG4J " /> 

		  <!-- 指定 MyBatis 增加到日志名称的前缀。值可以是任意字符串 -->
		  <setting name="logPrefix" value="LOG4J " /> 

		  <!-- 指定当结果集中值为 null 的时候是否调用映射对象的 setter（map 对象时为 put）方法，这对于有 Map.keySet() 依赖或 null 值初始化的时候是有用的。注意基本类型（int、boolean等）是不能设置成 null 的。 默认false-->
		  <setting name="callSettersOnNulls" value="false " /> 
		</settings> 

8. mappers元素: SQL映射

SQLMapper文件中主要是对SQL语句的映射，表明这个sql语句对应哪个方法的调用。我们需要在mybatis-config.xml文件中配置SQLMapper文件的位置。

		<mappers> 
		  <mapper resource="com/briup/mappers/StudentMapper.xml" /> 
		  <mapper url="file:///D:/mybatisdemo/app/mappers/StudentMapper.xml" /> 
		  <mapper class="com.briup.mappers.StudentMapper" /> 
		  <package name="com.briup.mappers" /> 
		</mappers> 

以上每一个 标签都可以从不同类型的资源中加载映射mapper：
resource属性用来指定在classpath中的mapper文件。
url属性用来通过完全文件系统路径或者web URL地址来指向mapper文件
class属性用来指向一个mapper接口
package属性用来指向可以找到Mapper接口的包名