教你学会SSM框架第七步，详解MyBatis核心配置

7.1 MyBatis的核心对象

MyBatis框架主要涉及两个核心对象

• SqlSessionFactory
• SqlSession

7.1.1 SqlSessionFactory

SqlSessionFactory是单个数据库映射关系经过编译后的内存镜像，用于创建SqlSession。SqlSessionFactory对象的实例通过SqlSessionFactoryBuilder对象来构建，通过XML配置文件或一个预先定义好的Configuration实例构建出SqlSessionFactory的实例。通过XML配置文件构建出SqlSessionFactory实例的实现代码如下：

//读取配置文件
InputStream inputStream=Resource.getResourceAsStream(配置文件位置);
//构建SqlSessionFactory
SqlSessionFactory factory=new SqlSessionFactoryBuilder().build(inputstream);

SqlSessionFactory对象是线程安全的，一旦被创建，在整个应用执行期间都会存在。如果多次创建同一个数据库的SqlSessionFactory，那么此数据库的资源将很容易被耗尽。所以在构建SqlSessionFactory实例时，建议使用单列模式。

7.1.2 SqlSession

SqlSession是应用程序与持久层之间执行交互操作的一个单线程对象，其主要作用是执行持久化操作。SqlSession对象包含数据库中所有执行SQL操作的方法，底层封装了JDBC连接，所以可以直接使用其实例来执行已映射的SQL语句。SqlSession实例是不能被共享的，也是线程不安全的，因此其使用范围最好限定在一次请求或一个方法中，绝不能将其放在一个类的静态字段、实例字段或任何类型的管理范围中使用。使用完SqlSession对象之后，要及时将它关闭，通常可以将其放在finally块中关闭。
SqlSession对象常用方法

• < T> T selectOne(String statement);
  查询方法。参数statement是在配置文件中定义的< select>元素的id。该方法返回执行SQL语句查询结果的一个泛型对象。
• < T>I selectOne(String statement, Object parameter);
  查询方法。参数statement是在配置文件中定义的< select>元素的id，parameter是查询所需的参数。该方法返回执行SQL语句查询结果的一个泛型对象。
• < E> List< E> selectList( String statement);
  查询方法。参数statement是在配置文件中定义的< select>元素的id。该方法返回执行SQL语句查询结果的泛型对象的集合。
• < E> List< E> selectList( String statement, Object parameter);
  查询方法。参数statement是在配置文件中定义的< select>元素的id，parameter是查询所需的参数。该方法返回执行SQL语句查询结果的泛型对象的集合。
• e < E> List< E> selectList(String statement, Object parameter, RowBounds rowBounds);
  查询方法。参数statement是在配置文件中定义的< select>元素的id，parameter是查询所需的参数，rowBounds是用于分页的参数对象。该方法返回执行SQL语句查询结果的泛型对象的集合。
• void select(String statement, Object parameter, ResultHandler handler);
  查询方法。参数statement是在配置文件中定义的< select>元素的id，parameter是查询所需的参数，ResultHandler对象用于处理查询返回的复杂结果集，通常用于多表查询。
• int insert( String statement);
  插入方法。参数statement是在配置文件中定义的< insert>元素的id。该方法返回执行SQL语句所影响的行数。
• int insert(String statement, Object parameter);
  插入方法。参数statement是在配置文件中定义的< insert>元素的id，parameter是插入所需的参数。该方法返回执行SQL语句所影响的行数。
• int update(String statement);
  更新方法。参数statement是在配置文件中定义的< update>元素的id。该方法返回执行SQL语句所影响的行数。
• int update(String statement, Object parameter);
  更新方法。参数statement是在配置文件中定义的< update>元素的id，parameter是更新所需的参数。该方法返回执行SQL语句所影响的行数。
• int delete(String statement);
  删除方法。参数statement是在配置文件中定义的< delete>元素的id。该方法返回执行SQL语句所影响的行数。
• int delete(String statement, Object parameter );
  删除方法。参数statement是在配置文件中定义的< delete>元素的id，parameter是删除所需的参数。该方法返回执行SQL语句所影响的行数。
• void commit();
  提交事务的方法。
• void rollback();
  回滚事务的方法。
• void close();
  关闭SqlSession对象。
• < T>T getMapper(Class type)
  返回 Mapper接口的代理对象，该对象关联了Sqlsession对象，开发人员可以使用该对象直接调用方法操作数据库。参数type是Mapper的接口类型。
• Connection getConnection();
  获取JDBC数据库连接对象的方法。

为了简化开发，可以将构建SqlSessionFactory对象、创建SqlSession对象等重复性代码封装到一个工具类中，然后通过工具类来创建SqlSession。

7.2 MyBatis配置文件元素

使用MyBatis框架进行开发，需要创建MyBatis的核心配置文件，该配置文件包含重要的元素，熟悉配置文件中各个元素的功能十分重要。

在MyBatis框架的核心配置文件中，< configuration>元素是配置文件的根元素，其他元素都要在< contiguration>元素内配置。
MyBatis配置文件中的主要元素如图

< contiguration>元素的子元素必须按照由上到下的顺序配置。

7.2.1 < properties>元素

< properties>是一个配置属性的元素，通过外部配置来动态替换内部定义的属性。

示例1

配置数据库的连接属性

步骤01

在项目的src目录下创建一个名称为db.properties的配置文件，代码

jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql: //localhost: 3306/db_mybatis
jdbc.username=root
jdbc.password=root

步骤02

在MyBatis配置文件mybatis-config.xml中配置属性，具体如下。
< properties resource=“db.properties”/>

步骤03

修改配置文件中数据库连接的信息，具体如下。

完成上述配置，dataSource中连接数据库的4个属性（driver、url、username和password）值将会由db.properties文件中对应的值来动态替换。另外，还可以通过配置< properties>元素的子元素< property>以及通过方法参数传递的方式来获取属性值。
由于使用properties配置文件来配置属性值可以方便地在多个配置文件中使用这些属性值，并且方便维护和修改，因此在实际开发中常用。

7.2.2 < settings>元素

< settings>元素主要用于改变MyBatis运行时的行为，例如开启二级缓存、开启延迟加载等。元素中的常见配置及其描述如图

图中介绍了< settings>元素中的常见配置，这些配置在配置文件中的使用方式

上面所介绍的配置内容通常在需要时只配置少数几项。

7.2.3 < typeAliases>元素

< typeAliases>元素用于为配置文件中的Java类型设置一个简短的名字，即设置别名。别名的设置与XML配置相关，其使用的意义在于减少全限定类名的冗余。
使用< typeAliases>元素配置别名的方法如下：

在上述示例中，< typeAliases>元素的子元素< typeAlias>中的type属性用于指定需要被定义别名的类的全限定名；alias属性的属性值“user”就是自定义的别名，可以代替“com.ssm.po.User”使用在MyBatis文件的任何位置。如果省略alias属性，MyBatis会默认将类名首字母小写后的名称作为别名。
当POJO类过多时，还可以通过自动扫描包的形式自定义别名，具体示例如下。

在上述示例中，< typeAliases>元素的子元素< package>中的name属性用于指定要被定义别名的包，MyBatis会将所有com.ssm.po包中的POJO类以首字母小写的非限定类名作为它的别名。

需要注意的是上述方式的别名只适用于没有使用注解的情况，如果使用了注解，那么别名就是其注解的名字

除了可以使用元素自定义别名外，MyBatis框架还默认为许多常见的Java类型（如数值、字符串、日期和集合等）提供相应的类型别名，如图
　MyBatis默认别名

所列举的别名可以在MyBatis中直接使用，但由于别名不区分大小写，因此在使用时要注意重复定义的覆盖问题。

7.2.4 < typeHandle>元素

MyBatis在预处理语句（Prepared Statement）中设置一个参数或者从结果集（Resultset）中取出一个值时，都会用其框架内部注册了的typeHandler（类型处理器）进行相关处理。typeHandler的作用就是将预处理语句中传入的参数从javaType（Java类型）转换为jdbcType（JDBC类型），或者从数据库取出结果时将jdbcType转换为javaType。
为了方便转换，MyBatis框架提供了一些默认的类型处理器
常用的类型处理器
　
当MyBatis框架所提供的这些类型处理器不能够满足需求时，还可以通过自定义的方式对类型处理器进行扩展。自定义类型处理器可以通过实现TypeHandler接口或者继承BaseTypeHandle类来定义。元素就是用于在配置文件中注册自定义的类型处理器的。它的使用方式有两种，具体如下。

• 注册一个类的类型处理器
  上述代码中，子元素< typeHandler>的handler属性用于指定在程序中自定义的类型处理器类。
  
• 注册一个包中所有的类型处理器
  在上述代码中，子元素< package>的name属性用于指定类型处理器所在的包名，使用这种方式后，系统会在启动时自动扫描com.ssm.type包下所有的文件，并把它们作为类型处理器。
  
  typeHandler的作用就是将预处理语句中传入的参数从javaType（Java类型）转换为jdbcType（JDBC类型），或者从数据库取出结果时将jdbcType转换为javaType

7.2.5 < objectFactory>元素

MyBatis框架每次创建结果对象的新实例时，都会使用一个对象工厂（ObjectFactory）的实例来完成。MyBatis中默认的ObjectFactory的作用就是实例化目标类，既可以通过默认构造方法实例化，也可以在参数映射存在的时候通过参数构造方法来实例化。
在通常情况下，我们使用默认的ObjectFactory即可。MyBatis中默认的ObjectFactory是由org.apache.ibatis.reflection.factory.DefaultObjectFactory来提供服务的，大部分场景下都不用配置和修改。如果想覆盖ObjectFactory的默认行为，那么可以通过自定义ObjectFactory实现。

7.2.6 < plugins>元素

该元素的作用就是配置用户开发所需的插件

7.2.7 < environments>元素

< environments>元素用于在配置文件中对环境进行配置。MyBatis的环境配置实际上就是数据源的配置，可以通过< environments>元素配置多种数据源，即配置多种数据库。
示例1
使用< environments>元素进行环境配置的示例如下。

在上述示例代码中，< environments>元素是环境配置的根元素，它包含一个default属性，该属性用于指定默认的环境ID。< environment>是< environments>元素的子元素，它可以被定义多个，其id属性用于表示所定义环境的ID值。在< environment>元素内，包含事务管理和数据源的配置信息，其中< transactionManager>元素用于配置事务管理，它的type属性用于指定事务管理的方式，即使用哪种事务管理器；< dataSource>元素用于配置数据源，它的type属性用于指定使用哪种数据源。
在MyBatis中，可以配置两种类型的事务管理器

1. JDBC：此配置直接使用JDBC的提交和回滚设置，依赖从数据源得到的连接来管理事务的作用域。
2. MANAGED：此配置从来不提交或回滚一个连接，而是让容器来管理事务的整个生命周期。在默认情况下，它会关闭连接，但一些容器并不希望这样，为此可以将closeConnection属性设置为false来阻止它默认的关闭行为。

注意
如果项目中使用Spring+MyBatis，就没有必要在MyBatis中配置事务管理器，因为实际开发中会使用Spring自带的管理器来实现事务管理。
对于数据源的配置，MyBatis框架提供了三种数据源类型。

• UNPOOLED：配置此数据源类型后，在每次被请求时会打开和关闭连接。它对没有性能要求的简单应用程序是一个很好的选择。
• POOLED：此数据源利用“池”的概念将JDBC连接对象组织起来，避免在创建新的连接实例时需要初始化和认证的时间。这种方式使得并发Web应用可以快速地响应请求，是当前流行的处理方式。
• JNDI：此数据源可以在EJB或应用服务器等容器中使用。容器可以集中或在外部配置数据源，然后放置一个JNDI上下文的引用。

7.2.8 < mappers>元素

在配置文件中，< mappers>元素用于指定MyBatis映射文件的位置，一般可以使用以下4种方法引入映射器文件

• 使用类路径引入
  < mappers>
  < mapper resource=“com/ssm/mapper/UserMapper.xmI”/>
  </ mappers>
• 使用本地文件路径引入
  < mappers>
  <mapper url=file: ///D:/com/ssm/mapper/UserMapper.xml"/>
  </ mappers>
• 使用接口类引入
  < mappers>
  < mapper class=“com.ssm.mapper.UserMapper”/>
  </ mappers>
• 使用包名引入
  < mappers>
  < package name="“com.ssm.mapper”/>
  </ mappers>

7.3 映射文件

映射文件是MyBatis框架中十分重要的文件。在映射文件中，< mapper>元素是映射文件的根元素，其他元素都是它的子元素。映射文件中的主要元素如下所示。

7.3.1 < select>元素

< select>元素用于映射查询语句，从数据库中读取数据，并组装数据给业务开发人员。示例如下：

< select id="findUserById" parameterType="Integer" resultType="com.ssm.po.User">
select * from t_user where id=#{id}
</ select>

上述语句中的唯一标识为findUserById，它接收一个Integer类型的参数，并返回一个User类型的对象。
在< select>元素中，除了上述示例代码中的几个属性外，还有其他可以配置的属性，如图

7.3.2 < insert>元素

< insert>元素用于映射插入语句，在执行完元素中定义的SQL语句后，会返回一个表示插入记录数的整数。< insert>元素的配置示例如下：

< insert id="addUser" parameterType="com.ssm.po.User" flushCache="true"
    statementType="PREPARED"  keyProperty="id" keyColumn=""
    useGeneratedKeys="" timeout="20">
       insert into    t_user(username,jobs,phone)values(#{username},#{jobs},#{phone})
</ insert>

从上述示例代码中可以看出，< insert>元素的属性与< select>元素的属性大部分相同，但还包含3个特有属性（仅对insert和update有用），如图< insert>元素的常用属性

执行插入操作后，很多时候我们会需要返回插入成功的数据生成的主键值，此时就可以通过上面所讲解的3个属性来实现。

示例1

如果使用的数据库支持主键自动增长（如MySQL），那么可以通过keyProperty属性指定PO类的某个属性（新增id属性变量）接收主键返回值（通常会设置到id属性上），然后将==useGeneratedKeys的属性值设置为true。==使用上述配置执行插入后，会返回插入成功的行数以及插入行的主键值。可以通过如下代码测试。

如果使用的数据库不支持主键自动增长（如Oracle），或者支持增长的数据库取消了主键自增的规则，就可以使用MyBatis提供的另一种方式来自定义生成主键，具体配置示例如下。

在执行上述示例代码时，< selectKey>元素会首先运行，它会通过自定义的语句来设置数据表中的主键（如果t_user表中没有记录，就将id设置为1，否则将id的最大值加1作为新的主键），然后调用插入语句。
< selectKey>元素在使用时可以设置以下几种属性。

< selectKey
   keyProperty="id"
   resultType="Integer"
   order="BEFORE"
   statement="PREPARED">

在上述< selectKey>元素的几个属性中，keyProperty、resultType和statement的作用与前面讲解的相同。order属性可以被设置为BEFORE或AFTER。如果设置为BEFORE，那么它会先执行< selectKey>元素中的配置来设置主键，再执行插入语句；如果设置为AFTER，那么它会先执行插入语句，再执行< selectKey>元素中的配置内容。

7.3.3 < update>元素和< delete>元素

< update>元素和< delete>元素的使用比较简单，它们的属性配置也基本相同，其常用属性如下

< update
    id="updateUser"
    parameterType="com.ssm.po.User"
    flushCache="true"
    statementType="PREPARED"
    timeout="20">
< delete
    id="deleteUser"
    parameterType="com.ssm.po.User"
    flushCache="true"
    statementType="PREPARED"
    timeout="20">

从上述配置代码中可以看出，< update>元素和< delete>元素的属性基本与< select>元素中的属性一致。与< insert>元素一样，< update>元素和< delete>元素在执行完之后，也会返回一个表示影响记录条数的整数，其使用示例如下。

7.3.4 < sql>元素

在一个映射文件中，通常需要定义多条SQL语句，这些SQL语句的组成可能有一部分是相同的（如多条select语句中都查询相同的id、username、jobs字段），如果每一个SQL语句都重写一遍相同的部分，势必会增加代码量，导致映射文件过于臃肿。那么有没有什么办法将这些SQL语句中相同的组成部分抽取出来，然后在需要的地方引用呢？答案是肯定的，我们可以在映射文件中使用MyBatis提供的< sql>元素来解决上述问题。
< sql>元素的作用是定义可重用的SQL代码片段，然后在其他语句中引用这一代码片段。
例如，定义一个包含id、username、jobs和phone字段的代码片段：

< sql id="user Columns">id,username,jobs, phone</ sql>
这一代码片段可以包含在其他语句中使用，具体如下：
< select id="findUserById" parameterType="Integer" resultType="com.ssm.po.User">
    select < include refid="user Columns">
    from t_user
    where id=#{id}
</ select>

在上述代码中，使用< include>元素的refid属性引用了自定义的代码片段，refid属性值为自定义代码片段的id。

在实际开发中，可以更加灵活地定义SQL片段。

7.3.5 < resultMap>元素

< resultMap>元素表示结果映射集，主要作用是定义映射规则、级联更新以及定义类型转化器等。
< resultMap>元素中包含一些子元素，元素结构如下所图

< resultMap>元素的type属性表示需要映射的POJO，id属性是这个resultMap的唯一标识。它的子元素< constructor>用于配置构造方法（当一个POJO中未定义无参的构造方法时，就可以使用< constructor>元素进行配置）。子元素< id>用于表示哪个列是主键，而< result>用于表示POJO和数据表中普通列的映射关系。< association>和< collection>用于处理多表时的关联关系，而< discriminator>元素主要用于处理一个单独的数据库查询返回很多不同数据类型结果集的情况。
在默认情况下，MyBatis程序在运行时会自动地将查询到的数据与需要返回的对象的属性进行匹配赋值（需要表中的列名与对象的属性名称完全一致）。然而实际开发时，数据表中的列和需要返回的对象的属性可能不会完全一致，这种情况下MyBatis是不会自动赋值的。此时，就可以使用< resultMap>元素进行处理，示例代码UserMapper.xml如图

在上述代码中，< resultMap>的子元素< id>和< result>的property属性表示User类的属性名，column属性表示数据表t_user的列名。< select>元素的resultMap属性表示引用上面定义的resultMap。接下来可以在配置文件mybatis-config.xml中引入UserMapper.xml。
除此之外，还可以通过< resultMap>元素中的< association>和< collection>处理多表时的关联关系。

多表时的关联关系