半棵树

Spring Mybatis详解

介绍

MyBatis 是支持定制化 SQL、存储过程以及高级映射的优秀的持久层框架，它支持定制化 SQL、存储过程以及高级映射，它避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集，它可以使用简单的 XML 或注解来配置和映射原生信息，将接口和 Java 的 POJOs(Plain Old Java Objects,普通的 Java对象)映射成数据库中的记录。

架构

构造由数据源配置文件、SQL映射配置文件、会话工厂、会话、执行器、底层封装对象组成！

数据源：

负责连接数据库，并对数据进行操作的一套框架，连接数据库是最重要的一步！！！

SQL映射配置文件：

Mapper配置文件，可以配置任何类型的SQL语句，包括select、update、delete、insert。

INSERT
我们在Mapper XML的文件中使用来配置INSERT的语言。如下：

  
INSERT INTO STUDENTS(STUD_ID,NAME,EMAIL, PHONE)  
VALUES(#{studId},#{name},#{email},#{phone})  
  
在这儿，我们给出了inSertStudent作为ID，这个可以关联的独有的命名空间是：com.owen.mybatis.mappers.StuentMapper.insertStudent.

我们定义的parameterType的属性值必须是完整的限定名，或是别名。我们可以执行上面的代码如下：

 int count =  
sqlSession.insert("com.owen.mybatis.mappers.StudentMapper.insertStuden  
t", student);  
这个sqlSession.insert()方法返回的数值就是插入的行数。取代上面通过命名空间和声明的ID，你可以创建一个Mapper的接口和调用的方式如下：

 package com.owen.mybatis.mappers;  
public interface StudentMapper  
{  
int insertStudent(Student student);  
}  
你可以调用的insertStudent映射声明如下：

StudentMapper mapper = sqlSession.getMapper(StudentMapper.class);  
int count = mapper.insertStudent(student);  
这样的方式比Hibernate好用了，不是使用固定的格式，而是通过自己的想法至尊命名，然后去调用。

自动生成Key
在前面的INSERT声明中，我们插入STUDENT的表时，使用了自己手动的STUD_ID作为主键的列值。其实我们可以应用一个useGeneratedKeys和keyProperty属性来生成auto_increment列的值，而将生成的值赋予给STUD_ID.

  
INSERT INTO STUDENTS(NAME, EMAIL, PHONE)  
VALUES(#{name},#{email},#{phone})  
  
这里的STUD_ID值将会由MySQL数据库自动生成，而且生成的值将会给student对象的参数studId。

StudentMapper mapper = sqlSession.getMapper(StudentMapper.class);  
mapper.insertStudent(student);  
现在你可以获取STUD_ID的值：

int studentId = student.getStudId();  
一些数据库，如Oracle不能够提供AUTO_INCREMENT列和运用SEQUENCE去创建主键的值。现在，我们拥有一个SEQUENCE名称为STUD_ID_SEQ去生成STUD_ID的主键值。运用的代码如下：

  
  
SELECT ELEARNING.STUD_ID_SEQ.NEXTVAL FROM DUAL  
  
INSERT INTO STUDENTS(STUD_ID,NAME,EMAIL, PHONE)  
VALUES(#{studId},#{name},#{email},#{phone})  
  
这里我们运用了的子元素去生成一个主键的值，并且储蓄它在Student对象的studId的属性中。我们设置属性order=”BEFORE”,这个说明MyBatis在执行INSERT之前，会先对已有的主键进行排序，然后将主键储蓄到studId中。

当然， 我们也可以用触发器来设置主键值，可以从序列中获得一个主键值，并将其设置为主键的列值插入到查询中。如果你使用这个方法，你可以用下面的代码：

  
INSERT INTO STUDENTS(NAME,EMAIL, PHONE)  
VALUES(#{name},#{email},#{phone})  
  
SELECT ELEARNING.STUD_ID_SEQ.CURRVAL FROM DUAL

声明UPDATE
UPDATE的声明可以使用的元素配置在MapperXML文件中。

  
UPDATE STUDENTS SET NAME=#{name}, EMAIL=#{email}, PHONE=#{phone}  
WHERE STUD_ID=#{studId}  
  
我们可以使用如下的代码来调用声明：

int noOfRowsUpdated =  
sqlSession.update("com.owen.mybatis.mappers.StudentMapper.updateStudent",  
student);  
通过UPDATE的声明，sqlSession().update()方法将会返回受影响的行。

这里我们就不使用声明的命名空间和声明的id来执行，我们使用Mapper的接口和调用 方法如下：

package com.owen.mybatis.mappers;  
public interface StudentMapper  
{  
int updateStudent(Student student);  
}  
  你可发调用updateStudent声明使用Mapper接口。
StudentMapper mapper = sqlSession.getMapper(StudentMapper.class);  
int noOfRowsUpdated = mapper.updateStudent(student);

会话工厂、会话：

SqlSessionFactory类会根据Resource资源信息加载对象，获取开发人员在项目中配置的数据库连接池配置文件SqlMapConfig.xml信息，从而产生一种可与数据库交互的会话实例SqlSession.

      //MyBatis的配置文件  
      Stringresource= "SqlMapConfig.xml";  
      InputStreaminputStream= Resources.getResourceAsStream(resource);  
       //创建会话工厂  
      SqlSessionFactorysqlSessionFactory= newSqlSessionFactoryBuilder().build(inputStream);  
      //从会话工厂中得到会话  
      SqlSessionsqlSession= sqlSessionFactory.openSession();  
      Useruser= sqlSession.selectOne("test.findUserByName","jasber");  
   System.out.println("-------------------------------------result-----------------------------------");  
      System.out.println(user);  
   System.out.println("------------------------------------------------------------------------------");  
      //关闭session  
      sqlSession.close();

执行器：

SimpleExecutor继承BaseExecutor
主要实现：doUpdate、doQuery、doFlushStatements
可以看代码主要是：
1、获取声明处理类：StatementHandler handler
2、获取声明类：stmt = prepareStatement(handler, ms.getStatementLog());
3、处理声明，执行SQL处理

底层封装对象：

public class SmsHouseholdOrderDto {
    private String id;
    private SmsHouseholdOrder smsHouseholdOrder;
    private SmsOrder smsOrder;

    public String getId() {
        return id;
    }
    public void setId(String id) {
        this.id = id;
    }
    public SmsHouseholdOrder getSmsHouseholdOrder() {
        return smsHouseholdOrder;
    }
    public void setSmsHouseholdOrder(SmsHouseholdOrder smsHouseholdOrder) {
        this.smsHouseholdOrder = smsHouseholdOrder;
    }
    public SmsOrder getSmsOrder() {
        return smsOrder;
    }
    public void setSmsOrder(SmsOrder smsOrder) {
        this.smsOrder = smsOrder;
    }
}

自定义字段

    smsOrder.id id_smsOrder, smsOrder.order_time order_time_smsOrder, smsOrder.appointment_time appointment_time_smsOrder, smsOrder.director director_smsOrder, smsOrder.status status_smsOrder, smsOrder.member member_smsOrder
    , smsOrder.address address_smsOrder, smsOrder.individual_needs individual_needs_smsOrder, 
    smsOrder.order_type order_type_smsOrder, smsOrder.member_phone member_phone_smsOrder,smsOrder.member_name member_name_smsOrder


    smsHouseholdOrder.id id_smsHouseholdOrder, smsHouseholdOrder.order_id order_id_smsHouseholdOrder, smsHouseholdOrder.times times_smsHouseholdOrder, smsHouseholdOrder.price price_smsHouseholdOrder
    , smsHouseholdOrder.discount discount_smsHouseholdOrder, smsHouseholdOrder.amount amount_smsHouseholdOrder

层次架构

MyBatis的主要成员

Configuration MyBatis所有的配置信息都保存在Configuration对象之中，配置文件中的大部分配置都会存储到该类中
SqlSession 作为MyBatis工作的主要顶层API，表示和数据库交互时的会话，完成必要数据库增删改查功能
Executor MyBatis执行器，是MyBatis 调度的核心，负责SQL语句的生成和查询缓存的维护
StatementHandler 封装了JDBC Statement操作，负责对JDBC statement 的操作，如设置参数等
ParameterHandler 负责对用户传递的参数转换成JDBC Statement 所对应的数据类型
ResultSetHandler 负责将JDBC返回的ResultSet结果集对象转换成List类型的集合
TypeHandler 负责java数据类型和jdbc数据类型(也可以说是数据表列类型)之间的映射和转换
MappedStatement MappedStatement维护一条节点的封装
SqlSource 负责根据用户传递的parameterObject，动态地生成SQL语句，将信息封装到BoundSql对象中，并返回
BoundSql 表示动态生成的SQL语句以及相应的参数信息

以上主要成员在一次数据库操作中基本都会涉及，在SQL操作中重点需要关注的是SQL参数什么时候被设置和结果集怎么转换为JavaBean对象的，这两个过程正好对应StatementHandler和ResultSetHandler类中的处理逻辑。

运行流程

1 使用连接池
2 统一sql 存取xml
3 参数封装和结果映射
4 sql语句的复用封装

(1)加载配置并初始化:触发条件：加载配置文件.配置来源于两个地方，一处是配置文件，一处是Java代码的注解，将SQL的配置信息加载成为一个个MappedStatement对象（包括了传入参数映射配置、执行的SQL语句、结果映射配置），存储在内存中。
(2)接收调用请求:触发条件：调用Mybatis提供的API。传入参数：为SQL的ID和传入参数对象。处理过程：将请求传递给下层的请求处理层进行处理。
(3)处理操作请求 触发条件：API接口层传递请求过来。传入参数：为SQL的ID和传入参数对象。
(4)返回处理结果将最终的处理结果返回。

配置文件详解

名称	含义	简介
configuration	顶级配置	顶级配置
properties	属性	这些属性都是可外部配置且可动态替换的，既可以在典型的 Java 属性文件中配置，亦可通过 properties 元素的子元素来传递。
settings	设置	这是 MyBatis 中极为重要的调整设置，它们会改变 MyBatis 的运行时行为。下表描述了设置中各项的意图、默认值等。
typeAliases	类型别名	类型别名是为 Java 类型设置一个短的名字。它只和 XML 配置有关，存在的意义仅在于用来减少类完全限定名的冗余。
typeHandlers	类型处理器	无论是 MyBatis 在预处理语句（PreparedStatement）中设置一个参数时，还是从结果集中取出一个值时，都会用类型处理器将获取的值以合适的方式转换成 Java 类型。下表描述了一些默认的类型处理器。
objectFactory	对象工厂	MyBatis 每次创建结果对象的新实例时，它都会使用一个对象工厂（ObjectFactory）实例来完成。默认的对象工厂需要做的仅仅是实例化目标类，要么通过默认构造方法，要么在参数映射存在的时候通过参数构造方法来实例化。如果想覆盖对象工厂的默认行为，则可以通过创建自己的对象工厂来实现。
plugins	插件	MyBatis 允许你在已映射语句执行过程中的某一点进行拦截调用。
environments	环境	MyBatis 可以配置成适应多种环境，这种机制有助于将 SQL 映射应用于多种数据库之中，现实情况下有多种理由需要这么做。
environment	环境变量	同上
transactionManager	事务管理器	这个配置就是直接使用了 JDBC 的提交和回滚设置，它依赖于从数据源得到的连接来管理事务作用域。
dataSource	数据源	dataSource 元素使用标准的 JDBC 数据源接口来配置 JDBC 连接对象的资源。
databaseIdProvider	数据库厂商标识	MyBatis 可以根据不同的数据库厂商执行不同的语句，这种多厂商的支持是基于映射语句中的 databaseId 属性。
mappers	映射器	既然 MyBatis 的行为已经由上述元素配置完了，我们现在就要定义 SQL 映射语句了。

Setting

设置参数	描述	有效值	默认值
cacheEnabled	全局地开启或关闭配置文件中的所有映射器已经配置的任何缓存。	true | false	true
lazyLoadingEnabled	延迟加载的全局开关。当开启时，所有关联对象都会延迟加载。 特定关联关系中可通过设置fetchType属性来覆盖该项的开关状态。	true | false	false
aggressiveLazyLoading	当开启时，任何方法的调用都会加载该对象的所有属性。否则，每个属性会按需加载（参考lazyLoadTriggerMethods).	true | false	false (true in ≤3.4.1)
multipleResultSetsEnabled	是否允许单一语句返回多结果集（需要兼容驱动）。	true | false	true
useColumnLabel	使用列标签代替列名。不同的驱动在这方面会有不同的表现， 具体可参考相关驱动文档或通过测试这两种不同的模式来观察所用驱动的结果。	true | false	true
useGeneratedKeys	允许 JDBC 支持自动生成主键，需要驱动兼容。 如果设置为 true 则这个设置强制使用自动生成主键，尽管一些驱动不能兼容但仍可正常工作（比如 Derby）。	true | false	False
autoMappingBehavior	指定 MyBatis 应如何自动映射列到字段或属性。 NONE 表示取消自动映射；PARTIAL 只会自动映射没有定义嵌套结果集映射的结果集。 FULL 会自动映射任意复杂的结果集（无论是否嵌套）。	NONE, PARTIAL, FULL	PARTIAL
autoMappingUnknownColumnBehavior	指定发现自动映射目标未知列（或者未知属性类型）的行为。
NONE: 不做任何反应
WARNING: 输出提醒日志 ('org.apache.ibatis.session.AutoMappingUnknownColumnBehavior' 的日志等级必须设置为 WARN)
FAILING: 映射失败 (抛出 SqlSessionException)
NONE, WARNING, FAILING	NONE
defaultExecutorType	配置默认的执行器。SIMPLE 就是普通的执行器；REUSE 执行器会重用预处理语句（prepared statements）； BATCH 执行器将重用语句并执行批量更新。	SIMPLE REUSE BATCH	SIMPLE
defaultStatementTimeout	设置超时时间，它决定驱动等待数据库响应的秒数。	任意正整数	Not Set (null)
defaultFetchSize	为驱动的结果集获取数量（fetchSize）设置一个提示值。此参数只可以在查询设置中被覆盖。	任意正整数	Not Set (null)
safeRowBoundsEnabled	允许在嵌套语句中使用分页（RowBounds）。如果允许使用则设置为false。	true | false	False
safeResultHandlerEnabled	允许在嵌套语句中使用分页（ResultHandler）。如果允许使用则设置为false。	true | false	True
mapUnderscoreToCamelCase	是否开启自动驼峰命名规则（camel case）映射，即从经典数据库列名 A_COLUMN 到经典 Java 属性名 aColumn 的类似映射。	true | false	False
localCacheScope	MyBatis 利用本地缓存机制（Local Cache）防止循环引用（circular references）和加速重复嵌套查询。 默认值为 SESSION，这种情况下会缓存一个会话中执行的所有查询。 若设置值为 STATEMENT，本地会话仅用在语句执行上，对相同 SqlSession 的不同调用将不会共享数据。	SESSION | STATEMENT	SESSION
jdbcTypeForNull	当没有为参数提供特定的 JDBC 类型时，为空值指定 JDBC 类型。 某些驱动需要指定列的 JDBC 类型，多数情况直接用一般类型即可，比如 NULL、VARCHAR 或 OTHER。	JdbcType 常量. 大多都为: NULL, VARCHAR and OTHER	OTHER
lazyLoadTriggerMethods	指定哪个对象的方法触发一次延迟加载。	用逗号分隔的方法列表。	equals,clone,hashCode,toString
defaultScriptingLanguage	指定动态 SQL 生成的默认语言。	一个类型别名或完全限定类名。	org.apache.ibatis.scripting.xmltags.XMLLanguageDriver
defaultEnumTypeHandler	指定 Enum 使用的默认 TypeHandler 。 (从3.4.5开始)	一个类型别名或完全限定类名。	org.apache.ibatis.type.EnumTypeHandler
callSettersOnNulls	指定当结果集中值为 null 的时候是否调用映射对象的 setter（map 对象时为 put）方法，这对于有 Map.keySet() 依赖或 null 值初始化的时候是有用的。注意基本类型（int、boolean等）是不能设置成 null 的。	true | false	false
returnInstanceForEmptyRow	当返回行的所有列都是空时，MyBatis默认返回null。 当开启这个设置时，MyBatis会返回一个空实例。 请注意，它也适用于嵌套的结果集 (i.e. collectioin and association)。（从3.4.2开始）	true | false	false
logPrefix	指定 MyBatis 增加到日志名称的前缀。	任何字符串	Not set
logImpl	指定 MyBatis 所用日志的具体实现，未指定时将自动查找。	SLF4J | LOG4J | LOG4J2 | JDK_LOGGING | COMMONS_LOGGING | STDOUT_LOGGING | NO_LOGGING	Not set
proxyFactory	指定 Mybatis 创建具有延迟加载能力的对象所用到的代理工具。	CGLIB | JAVASSIST	JAVASSIST (MyBatis 3.3 or above)
vfsImpl	指定VFS的实现	自定义VFS的实现的类全限定名，以逗号分隔。	Not set
useActualParamName	允许使用方法签名中的名称作为语句参数名称。 为了使用该特性，你的工程必须采用Java 8编译，并且加上-parameters选项。（从3.4.1开始）	true | false	true
configurationFactory	指定一个提供Configuration实例的类。 这个被返回的Configuration实例用来加载被反序列化对象的懒加载属性值。 这个类必须包含一个签名方法static Configuration getConfiguration(). (从 3.2.3 版本开始)	类型别名或者全类名.	Not set

typeAliases


  
  
  
  
  
  

当这样配置时，Blog可以用在任何使用domain.blog.Blog的地方。

也可以指定一个包名，MyBatis 会在包名下面搜索需要的 Java Bean，比如:


  

每一个在包 domain.blog 中的 Java Bean，在没有注解的情况下，会使用 Bean 的首字母小写的非限定类名来作为它的别名。 比如 domain.blog.Author 的别名为 author；若有注解，则别名为其注解值。看下面的例子：

@Alias("author")
public class Author {
    ...
}

typeHandlers：

// ExampleTypeHandler.java
@MappedJdbcTypes(JdbcType.VARCHAR)
public class ExampleTypeHandler extends BaseTypeHandler {

  @Override
  public void setNonNullParameter(PreparedStatement ps, int i, String parameter, JdbcType jdbcType) throws SQLException {
    ps.setString(i, parameter);
  }

  @Override
  public String getNullableResult(ResultSet rs, String columnName) throws SQLException {
    return rs.getString(columnName);
  }

  @Override
  public String getNullableResult(ResultSet rs, int columnIndex) throws SQLException {
    return rs.getString(columnIndex);
  }

  @Override
  public String getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {
    return cs.getString(columnIndex);
  }
}

使用这个的类型处理器将会覆盖已经存在的处理 Java 的 String 类型属性和 VARCHAR 参数及结果的类型处理器。要注意 MyBatis 不会窥探数据库元信息来决定使用哪种类型，所以你必须在参数和结果映射中指明那是 VARCHAR 类型的字段，以使其能够绑定到正确的类型处理器上。这是因为：MyBatis 直到语句被执行才清楚数据类型。
通过类型处理器的泛型，MyBatis 可以得知该类型处理器处理的 Java 类型，不过这种行为可以通过两种方法改变：
在类型处理器的配置元素（typeHandler element）上增加一个 javaType 属性（比如：javaType="String"）；
在类型处理器的类上（TypeHandler class）增加一个 @MappedTypes 注解来指定与其关联的 Java 类型列表。如果在 javaType 属性中也同时指定，则注解方式将被忽略。

可以通过两种方式来指定被关联的 JDBC 类型：

对象工厂（objectFactory）

// ExampleObjectFactory.java
public class ExampleObjectFactory extends DefaultObjectFactory {
  public Object create(Class type) {
    return super.create(type);
  }
  public Object create(Class type, List constructorArgTypes, List