[置顶] mybatis(三)-mybatis-config详解

Mybatis(三)-详解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">
<property name="username" value="db_user" />
<property name="password" value="verysecurepwd" />
</properties>
<settings>
<setting name="cacheEnabled" value="true" />
</settings>
<typeAliases>
<typeAlias alias="Tutor" type="com.mybatis3.domain.Tutor" />
<package name="com.mybatis3.domain" />
</typeAliases>
<typeHandlers>
<typeHandler handler="com.mybatis3.typehandlers. PhoneTypeHandler" />
<package name="com.mybatis3.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/mybatis3/mappers/StudentMapper.xml" />
<mapper url="file:///D:/mybatisdemo/mappers/TutorMapper.xml" />
<mapper class="com.mybatis3.mappers.TutorMapper" />
</mappers>
</configuration>

enviroment(环境)

　　MyBatis支持多个dataSource环境，可以将应用该部署到不同的环境上,如DEV(开发环境)，TEST(测试环境)，可以设置成我们所想要的环境。

　　在上述的配置中，默认的环境encironment被设置成development。当需要将程序部署到生产服务器上时，你不需要修改配置，只需要将默认环境

　　有时候，我们可能需要要在相同的应用下使用多个数据库。比如我们可能有SHOPPTING-CART数据库来存储所有的订单明细;使用REOIRTS数据库存储订单明细的合计，用作报告。

如果你的应用需要连接多个数据库，你需要将每个数据库配置成独立的环境，并且为每一个数据库创建一个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">
<transactionManager type="MANAGED" />
<dataSource type="JNDI">
<property name="data_source" value="java:comp/jdbc/ReportsDS" />
</dataSource>
</environment>
</environments>

我们可以如下为每个环境创建一个SqlSessionFactory:

inputStream = Resources.getResourceAsStream("mybatis-config.xml");
defaultSqlSessionFactory = new SqlSessionFactoryBuilder().
build(inputStream);
cartSqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStre
am, "shoppingcart");
reportSqlSessionFactory = new SqlSessionFactoryBuilder().
build(inputStream, "reports");

　　创建 SqlSessionFactory 时，如果没有明确指定环境 environment id，则会使用默认的环境 environment 来创建。在上述的源码中，默认的 SqlSessionFactory 便是使用 shoppingcart 环境设置创建的。

对于每个环境 environment,我们需要配置 dataSource 和 transactionManager 元素。

数据源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 的类型可以配置成其内置类型之一，如 UNPOOLED，POOLED，JNDI。

1.如果将类型设置UNPOOLED，Mybatis会为每一个数据库操作创建一个新的连接，并关闭它。该方式适用于只有小规模数量并发用户的简单应用程序上。

2.如果将属性设置成POOLED，MyBatis会创建一个数据库连接池，连接池中的一个连接将会被用作数据库操作。一旦数据库操作完成，MyBatis会将此连接返回给连接池。在开发或测试环境中，经常使用此种方式。

3.如果将类型设置成JNDI，MyBatis从在应用服务器向配置好的JNDI数据源dataSource获取数据库连接。在生产环境中，优先考虑这种方式。

事务管理器TransactionManager(两种)

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

　　1.JDBC 事务管理器被用作当应用程序负责管理数据库连接的生命周期（提交、回退等等）的时候。当你将
TransactionManager 属性设置成 JDBC，MyBatis 内部将使用 JdbcTransactionFactory 类创建
TransactionManager。例如，部署到 Apache Tomcat 的应用程序，需要应用程序自己管理事务。

　　2.MANAGED事务管理器是当由应用服务器负责管理数据库连接生命周期的时候使用。当你将TransactionManager属性设置为MANAGED时，MyBatis内部使用ManagedTransactionFactory类创建事务管理器TransactionManager。Managed是托管的意思，即应用本身不去管理事务，而是把事务管理交给应用所在的服务器进行管理。例如在JBoss,GlassFush用用服务器，会使用EJB进行应用服务器的事务管理。

属性Properties

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

　　1.在applications.properties文件中配置数据库连接参数，如下所示:

jdbc.driverClassName=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/mybatisdemo
jdbc.username=root
jdbc.password=admin

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

<properties resource="application.properties">
<property name="jdbc.username" value="db_user" />
<property name="jdbc.password" value="verysecurepwd" />
</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>

类型别名typeAliases(简化我们的操作)

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

<update id="updateStudent" parameterType="com.mybatis3.domain.Student">
UPDATE STUDENTS
SET NAME=#{name}, EMAIL=#{email}, DOB=#{dob}
WHERE STUD_ID=#{id}
</update>

在这里我们使用了一长串的限定名com.mybatis3.domain.Student，为了方便我们可以为其取别名：

<typeAliases>
<typeAlias alias="Student" type="com.mybatis3.domain.Student" />
</typeAliases>

我们在SQL Mapper映射文件中，就可以使用Student的别名：

<update id="updateStudent" parameterType="Student">
UPDATE STUDENTS
SET NAME=#{name}, EMAIL=#{email}, DOB=#{dob}
WHERE STUD_ID=#{id}
</update>

这里如果你觉得为每一个javaBean定义有点麻烦，你可以为提供需要取别名的javaBean所在的包，MyBatis会自动扫描包内定义的所有的JavaBean,会自动为JavaBean注册一个小写字母开头的非完全限定类名形式的别名。

<typeAliases>
<package name="com.mybatis3.domain" />
</typeAliases>

如果还觉得麻烦可以使用注解@Alias,@Alias 注解将会覆盖配置文件中的定义。

@Alias("StudentAlias")
public class Student
{
}

类型处理器typeHandlers

　　Mybatis通过抽象JDBC来简化了数据持久化逻辑的实现。MyBatis在其内部使用JDBC，提供了更简洁的方式实现了数据库操作。

　　当 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.对于Date类型转换为java.sql.Timestamp并设置：

pstmt.setTimestamp(4, new Timestamp((student.getDob()).getTime()));

Mybatis是怎么知道对于不同类型使用不同setXXX来的呢，其实是通过我们类型处理器来决定。Mybatis对于以下的类型使用内奸的类型处理器:所有的基本数据类型,基本类型的包裹类型、byte[]、java.util.Date、 java.sql.Date、 java,sql.Time、 java.sql.Timestamp、 java 枚举类型等。所以当 MyBatis 发现属性的类型属于上述类型，他会使用对应的类型处理器将值设置到 PreparedStatement 中，同样地，当从 SQL 结果集构建 JavaBean 时，也有类似的过程。

　　问题来了要是有我们自定义类型该怎么办？比如在我们Student中有一个PHONE字段，如下：

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 string)
{
if(string != null)
{
String[] parts = string.split("-");
if(parts.length > 0) this.countryCode = parts[0];
if(parts.length > 1) this.stateCode = parts[1];
if(parts.length > 2) this.number = parts[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
}

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

在这里phone参数需要传递给#{phone};而phone对象是一个我们自定义的类。然而MyBatis并不知道该怎样来处理这个类型的对象。

　　所以我们这里会使用我们定义的TypeHandler,我们可以继承MyBatis提供的抽象类创建自定义类型处理器。

importjava.sql.CallableStatement;
importjava.sql.PreparedStatement;
importjava.sql.ResultSet;
importjava.sql.SQLException;
importorg.apache.ibatis.type.BaseTypeHandler;
importorg.apache.ibatis.type.JdbcType;
importcom.mybatis3.domain.PhoneNumber;
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));
}
}

定义好了之后我们会在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.mybatis3.typehandlers. PhoneTypeHandler" />
</typeHandlers>
</configuration>

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

SQL映射定义Mappers

　　Mapper XML文件中包含的SQL映射语句将会被应用通过使用其statement id来执行。

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

以上每一个 标签的属性有助于从不同类型的资源中加载映射 mapper：

resource 属性用来指定在 classpath 中的 mapper 文件。

url 属性用来通过完全文件系统路径或者 web URL 地址来指向 mapper 文件

class 属性用来指向一个 mapper 接口

package 属性用来指向可以找到 Mapper 接口的

具体代码参见github地址：https://github.com/lzggsimida123/MyBatisStuding