MyBatis的配置方式有两种,一种是XML,一种是代码方式,下面我们都简单介绍下
从XML中创造 SqlSessionFactory
MyBatis 最关键的组成部分是 SqlSessionFactory,每一个 MyBatis 应该都是以一个 SqlSessionFactory 实例为中心,我们可以从中获取 SqlSession,并执行映射的 SQL 语句。
构建 SqlSessionFactory 最常见的方式是基于 XML 配置的构造方式 。推荐使用一个类路径资源来进行配置,你也可以使用一个 Reader 实例,甚至使用 URL 路径。
MyBatis 有一个 Resources 通用类,类中有许多方法可以简单地从类路径和其他地址中加载资源。
String resource = "mybatis-config.xml";
Reader reader = Resources.getResourceAsReader(resource);
SqlSessionFactory sqlSessionFactory= new SqlSessionFactoryBuilder().build(reader);
使用 SqlSessionFactory 获取 SqlSession
假设你有一个 SqlSessionFactory,你就可以来获取一个 SqlSession 实例,SqlSession 包含了针对数据库执行语句的每一个方法。
SqlSession sqlSession = MyBatisSqlSessionFactory.getSqlSession();
try {
StudentMapper studentMapper = sqlSession.getMapper(StudentMapper.class);
return studentMapper.findAllStudents();
} finally {
sqlSession.close();
}
Mapper的XML配置文件
XML 文件包含了许多 MyBatis 的核心设置,包括一个获取数据库连接(Connection)实例的数据源
(DataSource)和一个决定事务作用域和操作的 TransactionManager。文档的深层次结果如下:
configuration
- |--- properties
- |--- settings
- |--- typeAliases
- |--- typeHandlers
- |--- objectFactory
- |--- plugins
- |--- environments
- |--- - |--- environment
- |--- - |--- - |--- transactionManager
- |--- - |--- _ |__ dataSource
_ |__ mappers
下面的 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="mysql.properties"/>
<settings>
<setting name="cacheEnabled" value="true" />
</settings>
<typeAliases>
<typeAlias alias="Student" type="com.neucloud.domain.Student"/>
<package name="com.neucloud.domain"/>
</typeAliases>
<typeHandlers>
<typeHandler handler="com.neucloud.typehandlers.MyTypeHandler" />
<package name="com.neucloud.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>
</environments>
<mappers>
<mapper resource="com/mybatis3/mappers/StudentMapper.xml"/>
</mappers>
</configuration>
下面让我们逐个讨论上述配置文件的组成部分
一、属性 Properties
属性配置元素可以将配置值具体化到一个属性文件中,并且使用属性文件的 key 名作为占位符。在上述的配置中,我们将数据库连接属性具体化到了 mysql.properties 文件中,并且为 driver,URL 等属性使用了占位符。
1. 在 mysql.properties 文件中配置数据库连接参数,如下所示:
jdbc.driverClassName=com.mysql.cj.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/first_db
jdbc.username=root
jdbc.password=9958
2.在 mybatis-config.xml 文件中,为属性使用 mysql.properties 文件中定义的占位符:
JAVA 属性文件就可以配置直观的、可代替的属性,或者是属性项的子项。比如:
<properties resource="mysql.properties">
<property name="jdbc.username" value="root" />
<property name="jdbc.password" value="123456" />
</properties>
通过动态配置,这些属性都可以用替换整个文件的值。例如:
<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>
在<properties>元素中可以配置默认参数的值。 如果<properties>中定义的元素和属性文件定义元素的 key值相同,它们会被属性文件中定义的值覆盖,也就是如果mysql.properties 文件包含值 jdbc.username 和 jdbc.password,则上述定义的 username 和password 的值 root和 9958将会被 mysql.properties 中定义的对应的 jdbc.username 和jdbc.password 值覆盖,这为配置提供了多种选择。
属性值也可以设入到 SqlSessionBuilder.build()方法中,例如:
SqlSessionFactory factory = sqlSessionFactoryBuilder.build(reader, props);
// ... or ...
SqlSessionFactory factory = sqlSessionFactoryBuilder.build(reader, environment, props);
如果一个属性项在多个地方出现,那 MyBatis 将按以下顺序加载:
- 属性文件中的属性项首先被读取
- 在类路径或 URL 资源中读取的属性项第二顺序加载,并且可以覆盖第一顺序加载的值
- 在方法体中给定的参数值最后加载,但是以后覆盖上述两种加载的值。
也就是说,最高级别的属性值是方法体中设定的参数值,接下来是类路径和 URL,最后才是属性文件
二、全局参数设置 Settings
为满足应用特定的需求,MyBatis 默认的全局参数设置可以被覆盖(overridden)掉,下方这个表格描述了这些设置项、含义和默认值
设置项 | 描述 | 允许值 | 默认值 |
cacheEnabled | 对在此配置文件下的所有 cache 进行全局性开/关设置。 | true| false | true |
lazyLoadingEnabled | 全局性设置懒加载。如果设为‘关’,则所有相关联的都会被初始化加载。 | true| false | true |
aggressiveLazyLoading | 当设置为‘开’的时候,懒加载的对象可能被任何懒属性全部加载。否则,每个属性都按需加载。 | true| false | true |
multipleResultSetsEnabled | 允许和不允许单条语句返回多个数据集(取决于驱动需求) | true| false | true |
useColumnLabel | 使用列标签代替列名称。不用的驱动器有不同的作法。参考一下驱动器文档 ,或者用这两个不同的选项进行测试一下。 | true| false | true |
useGeneratedKeys | 允许 JDBC生成主键。需要驱动器支持 。如果设为了 true,这个设置将强制使用被生成的主键,有一些驱动器不兼容不过仍然可以执行。 | true| false | false |
autoMappingBehavior | 指定 MyBatis 是否并且如何来自动映射数据表字段与对象的属性。PARTIAL将只自动映射简单的,没有嵌套的结果。FULL 将自动映射所有复杂的结果。 | NONE PARTIAL FULL | PARTIAL |
defaultExecutorType | 配置和设定执行器,SIMPLE 执行器执行其它语句。REUSE 执行器可能重复使用 prepared statements 语句,BATCH执行器可以重复执行语句和批量更新。 | SIMPLE REUSE BATCH | SIMPLE |
defaultStatementTimeout | 设置一个时限,以决定让驱动器等待数据库回应的多长时间为超时 | 正整数 | NotSet (null) |
下面列出关于设置的完整例子:
<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="enhancementEnabled" value="false"/>
<setting name="defaultExecutorType" value="SIMPLE"/>
<setting name="defaultStatementTimeout" value="25000"/>
</settings>
三、类型别名 typeAliases
类型别名是 Java 类型的简称。在 SQLMapper 配置文件中,对于 resultType 和 parameterType 属性值,我们需要使用 JavaBean 的完全限定名:
<select id="findStudentById" parameterType="int"
resultType="com.mybatis3.domain.Student">
select stud_id as studId, name, email, dob from Students where stud_id=#{studId}
</select>
<update id="updateStudent" parameterType="com.mybatis3.domain.Student">
UPDATE STUDENTS SET NAME=#{name}, EMAIL=#{email}, DOB=#{dob} WHERE STUD_ID=#{studId}
</update>
这里我们为 resultType 和 parameterType 属性值设置为 Student 类型的完全限定名:
com.mybatis3.domain.Student
我们可以为完全限定名取一个别名(alias),然后其需要使用完全限定名的地方使用别名,而不是到处使用完全限定名。如下例子所示,为完全限定名起一个别名:
<typeAliases>
<typeAlias alias="Student" type="com.mybatis3.domain.Student"/>
<package name="com.mybatis3.domain"/>
</typeAliases>
然后在 SQL Mapper 映射文件中, 直接使用 Student就可以了
通过提供需要取别名的 JavaBean 所在的包(package),你可以不用为每一个 JavaBean 单独定义别名, MyBatis会自动扫描包内定义的 JavaBeans,然后分别为 JavaBean 注册一个小写字母开头的非完全限定的类名形式的别名。
还有一些与通用 JAVA 类型建立的别名。它们是大小写敏感的,注意 JAVA 的基本类型,使用了_来命名。
别名 | 映射类型 |
_byte | byte |
_long | long |
_short | short |
_int | int |
_integer | int |
_double | double |
_float | float |
_boolean | boolean |
string | String |
byte | Byte |
long | Long |
short | Short |
int | Integer |
integer | Integer |
double | Double |
float | Float |
boolean | Boolean |
date | Date |
decimal | BigDecimal |
bigdecimal | BigDecimal |
object | Object |
map | Map |
hashmap | HashMap |
list | List |
arraylist | ArrayList |
collection | Collection |
iterator | Iterator |
还有另外一种方式为 JavaBeans 起别名,使用注解@Alias:
@Alias("StudentAlias")
public class Student {
}
@Alias 注解将会覆盖配置文件中的<typeAliases>定义。
四、类型处理器 typeHandlers
MyBatis 通过抽象 JDBC 来简化了数据持久化逻辑的实现。MyBatis 在其内部使用 JDBC,提供了更简洁的方式实现了数据库操作。 当 MyBatis 对 PreparedStatement 设入一个参数或者是从 ResultSet 返回一个值的时候,类型处理器被用来将值转换为相匹配的 JAVA 类型。这方表格描述了默认的类型句柄。
当 MyBatis 将一个 Java 对象作为输入参数执行 INSERT 语句操作时,它会创建一个 PreparedStatement 对象,并且使用 setXXX()方式对占位符设置相应的参数值。
这里,XXX 可以是 Int,String,Date 等 Java 对象属性类型的任意一个。示例如下:
<insert id="insertStudent" parameterType="Student">
INSERT INTO STUDENTS(STUD_ID,NAME,EMAIL,DOB)
VALUES(#{studId},#{name},#{email},#{dob})
</insert>
为执行这个语句,MyBatis 将采取以下一系列动作:
1. 创建一个有占位符的 PreparedStatement 接口,如下:
PreparedStatement pstmt = connection.prepareStatement
("INSERT INTO STUDENTS(STUD_ID,NAME,EMAIL,DOB) VALUES(?,?,?,?)");
2. 检查 Student 对象的属性 studId 的类型, 然后使用合适 setXXX 方法去设置参数值。 这里 studId 是 integer类型,所以会使用 setInt()方法:
pstmt.setInt(1,student.getStudId());
3. 类似地,对于 name 和 email 属性都是 String 类型,MyBatis 使用 setString()方法设置参数:
pstmt.setString(2, student.getName());
pstmt.setString(3, student.getEmail());
4. 至于 dob 属性, MyBatis 会使用 setDate() 方法设置 dob 处占位符位置的值。
5. MyBaits 会将 java.util.Date 类型转换为 into java.sql.Timestamp 并设值:
pstmt.setTimestamp(4, new Timestamp((student.getDob()).getTime()));
其原理就是通过使用类型处理器(type handlers)来决定这么做的。
MyBatis 对于以下的类型使用内建的类型处理器:所有的基本数据类型、基本类型的包裹类型、byte[]、java.util.Date、java.sql.Date、java,sql.Time、java.sql.Timestamp、java 枚举类型等。所以当 MyBatis 发现属性的类型属于上述类型,他会使用对应的类型处理器将值设置到 PreparedStatement 中,同样地,当从 SQL 结果集构建 JavaBean 时,也有类似的过程。
可如果我们有一个自定义的对象类型,来存储存储到数据库呢?
假设表 STUDENTS 有一个 PHONE 字段,类型为 VARCHAR(15),而 JavaBean Student 有一个 PhoneNumber 类定义类型的 phoneNumber 属性。
<insert id="insertStudent" parameterType="Student">
insert into students(name,email,phone)
values(#{name},#{email},#{phone})
</insert>
这里,phone 参数需要传递给#{phone};而 phone 对象是 PhoneNumber 类型。然而,MyBatis 并不知道该怎样来处理这个类型的对象。
为了让 MyBatis 明白怎样处理这个自定义的 Java 对象类型,如 PhoneNumber,我们可以创建一个自定义的类型处理器,如下所示:
1. MyBatis 提供了抽象类 BaseTypeHandler<T> ,我们可以继承此类创建自定义类型处理器。
public class PhoneTypeHandler extends BaseTypeHandler<PhoneNumber> {
@Override
public void setNonNullParameter(PreparedStatement ps, int i,
PhoneNumber parameter, JdbcType jdbcType) throws
SQLException {
ps.setString(i, parameter.getAsString());
}
@Override
public PhoneNumber getNullableResult(ResultSet rs, String columnName)
throws SQLException {
return new PhoneNumber(rs.getString(columnName));
}
@Override
public PhoneNumber getNullableResult(ResultSet rs, int columnIndex)
throws SQLException {
return new PhoneNumber(rs.getString(columnIndex));
}
@Override
public PhoneNumber getNullableResult(CallableStatement cs, int columnIndex)
throws SQLException {
return new PhoneNumber(cs.getString(columnIndex));
}
}
2. 我们使用 ps.setString()和 rs.getString()方法是因为 phone 列是 VARCHAR 类型。
3. 一旦我们实现了自定义的类型处理器,我们需要在 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>
<typeHandler handler="com.neucloud.typehandlers. PhoneTypeHandler" />
</typeHandlers>
</configuration>
注册 PhoneTypeHandler 后, MyBatis 就能够将 Phone 类型的对象值存储到 VARCHAR 类型的列上。
五、对象工厂( ObjectFactory )
每次 MyBatis 为结果对象创建一个新实例,都会用到 ObjectFactory。默认的 ObjectFactory 与使用目标类的构造函数创建一个实例毫无区别,如果有已经映射的参数,那也可能使用带参数的构造函数。
当然也可以重写 ObjectFactory 的默认操作
public class ExampleObjectFactory extends DefaultObjectFactory {
public Object create(Class type) {
return super.create(type);
}
public Object create(Class type,List<Class> constructorArgTypes,
List<Object> constructorArgs) {
return super.create(type, constructorArgTypes, constructorArg
}
public void setProperties(Properties properties) {
super.setProperties(properties);
}
}
// MapperConfig.xml
<objectFactory type="com.mybatis3.xml.config.ExampleObjectFactory">
<property name="someProperty" value="100"/>
</objectFactory>
ObjectFactory 接口非常简单,只包含两个方法,一个是构造函数,一个是带参数的构造函数。最后,setProperties 方法也可以使用 ObjectFactory 来配置。可以在 ObjectFactory 实例化后,通过 setProperties方法,在对象工厂中定义属性。
六、插件( plugins )
MyBatis 允许你在映射语句执行过程中某点上拦截调用。默认的,MyBatis 允许插件拦截以下调用:
- Executor(update, query, flushStatements, commit, rollback, getTransaction, close,isClosed)
- ParameterHandler(getParameterObject, setParameters)
- ResultSetHandler(handleResultSets, handleOutputParameters)
- StatementHandler(prepare, parameterize, batch, update, query)
这些类的细节在每个方法签名中均可以找到,源代码在 MyBatis 每次发布时都可以下载。如果你要做的事不仅仅是调用,而是重写(overriding)方法,那你需要了解你要重写的方法的动作。如果你试图修改或者重写既定方便的动作,你最好深入到 MyBatis 的核心。因为这些方法和类都底层的架构,所以使用插件时要格外小心。
使用插件是非常简单而又有用的。只需要简单地实现这个 Interceptor 接口,确定好你要拦截的标识即可。
@Intercepts({@Signature(type= Executor.class,method = "update",
args = {MappedStatement.class,Object.class})})
public class ExamplePlugin implements Interceptor {
public Object intercept(Invocation invocation) throws Throwable {
return invocation.proceed();
}
public Object plugin(Object o) {
return Plugin.wrap(o, this);
}
public void setProperties(Properties properties) {
}
}
<plugins>
<plugin interceptor="com.mybatis3.util.ExamplePlugin">
<property name="someProperty" value="100"/>
</plugin>
</plugins>
上面的这个插件可以在执行器上拦截所有“update”方法的调用,这里的执行器,是一个映射语句内部
对象的深架构的执行器。
七、环境(environments)
environment 项里包含了事务管理和连接池的环境配置。MyBatis 支持配置多个 dataSource 环境, 这可以帮助你 SQL 映射对应多种数据库等。我们也可以将应用部署到不同的环境上, 如 DEV(开发环境), TEST (测试环境) ,QA(质量评估环境),UAT(用户验收环境),PRODUCTION(生产环境) ,可以通过将默认 environment 值设置成想要的 environment id 值。
在上述的配置中,默认的环境 environment 被设置成 development。当需要将程序部署到生产服务器上时,你不需要修改什么配置,只需要将默认环境 environment 值设置成生产环境的 environment id 属性即可。 有时候,我们可能需要在相同的应用下使用多个数据库。比如我们可能有 SHOPPING-CART 数据库来存储所有的订单明细;使用 REPORTS 数据库存储订单明细的合计,用作报告。
如果你的应用需要连接多个数据库,你需要将每个数据库配置成独立的环境,并且为每一个数据库创建一个SqlSessionFactory。那么配置文件就可以这样写:
<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="development2">
<transactionManager type="MANAGED" />
<dataSource type="JNDI">
<property name="data_source" value="java:comp/jdbc/ReportsDS" />
</dataSource>
</environment>
</environments>
想要指定生成哪个环境,只要简单地把它做了一个可选参数代入 SqlSessionFactoryBuilder。下面两种方式都可以:
SqlSessionFactory factory=sqlSessionFactoryBuilder.build(reader, environment);
SqlSessionFactory factory=sqlSessionFactoryBuilder.build(reader, environment,properties);
如果环境变更省略了,就会载入默认的环境变量。像这样:
SqlSessionFactory factory=sqlSessionFactoryBuilder.build(reader);
SqlSessionFactory factory=sqlSessionFactoryBuilder.build(reader,properties);
对于每个环境 environment,我们都需要配置 dataSource 和 transactionManager 元素
事务管理器 TransactionManager
MyBatis 支持两种类型的事务管理器: JDBC and MANAGED.
- JDBC 事务管理器被用作当应用程序负责管理数据库连接的生命周期(提交、回退等等)的时候。当你将TransactionManager 属性设置成 JDBC,MyBatis 内部将使用 JdbcTransactionFactory 类创建TransactionManager。例如,部署到 Apache Tomcat 的应用程序,需要应用程序自己管理事务。
- MANAGED 事务管理器是当由应用服务器负责管理数据库连接生命周期的时候使用。当你将TransactionManager 属性设置成 MANAGED 时, MyBatis 内部使用ManagedTransactionFactory 类创建事务管理器TransactionManager。 例如, 当一个JavaEE的应用程序部署在类似 JBoss, WebLogic,GlassFish 应用服务器上时,它们会使用 EJB 进行应用服务器的事务管理能力。在这些管理环境中,你可以使用 MANAGED 事务管理器。(Managed 可以理解为托管的意思,即是应用本身不去管理事务,而是把事务管理交给应用所在的服务器进行管理)
数据源DataSource
dataSource 元素被用来配置数据库连接属性,dataSource 的类型可以配置成其内置类型之一,如 UNPOOLED,POOLED,JNDI。
- 如果将类型设置成 UNPOOLED,MyBatis 会为每一个数据库操作创建一个新的连接,并关闭它。该方式适用于只有小规模数量并发用户的简单应用程序上,在多用户并发应用中, 不建议使用。
- 如果将属性设置成 POOLED,MyBatis 会创建一个数据库连接池,对用户的每一个请求,会使用缓冲池中的一个可用的Connection对 象 , 这样可以提高应用的性能。一旦数据库操作完成,MyBatis 会将此连接返回给连接池。在开发或测试环境中,经常使用此种方式。
- 如果将类型设置成 JNDI,MyBatis使用应用服务器的数据库连接池,并且使用JNDI查找来获取数据库连接。在生产环境中,优先考虑这种方式。
八、SQL 映射定义 Mappers
mappers 项中包含了一系列 SQL 语句映射定义的 XML 文件。
<mappers>
<mapper resource="com/neucloud/mappers/StudentMapper.xml"/>
<mapper url="file:///D:/Intellij/MyBatisDemo/src/main/resources/com/neucloud/mappersStudentMapper.xml" />
<mapper class="com.neucloud.mappers.StudentMapper" />
<package name="com.neucloud.mappers" />
</mappers>
以上每一个<mapper> 标签的属性有助于从不同类型的资源中加载映射 mapper:
- resource 属性用来指定在 classpath 中的 mapper 文件。
- url 属性用来通过完全文件系统路径或者 web URL 地址来指向 mapper 文件
- class 属性用来指向一个 mapper 接口
- package 属性用来指向可以找到 Mapper 接口的包名