MyBatis XML 映射配置文件

配置文件的基本结构

• configuration —— 根元素
  • properties —— 定义配置外在化
  • settings —— 一些全局性的配置
  • typeAliases —— 为一些类定义别名
  • typeHandlers —— 定义类型处理，也就是定义java类型与数据库中的数据类型之间的转换关系
  • objectFactory
  • plugins —— Mybatis的插件，插件能够修改Mybatis内部的运行规则
  • environments —— 配置Mybatis的环境
    • environment
      • transactionManager —— 事务管理器
      • dataSource —— 数据源
  • databaseIdProvider ——数据库厂商标识
  • mappers —— 指定映射文件或映射类

 

 

主要的几点:

---

 

settings

调整 settings 中的设置是很是关键的，它们会改变 MyBatis 的运行时行为。下表描述了设置中各项的意图、默认值等。

设置参数	描述	有效值	默认值
cacheEnabled	该配置影响的全部映射器中配置的缓存的全局开关。	true | false	true
lazyLoadingEnabled	延迟加载的全局开关。当开启时，全部关联对象都会延迟加载。特定关联关系中可经过设置fetchType属性来覆盖该项的开关状态。	true | false	false
aggressiveLazyLoading	当启用时，带有延迟加载属性的对象的加载与否彻底取决于对任意延迟属性的调用；反之，每种属性将会按需加载。	true | false	true
multipleResultSetsEnabled	是否容许单一语句返回多结果集（须要兼容驱动）。	true | false	true
useColumnLabel	使用列标签代替列名。不一样的驱动在这方面会有不一样的表现，具体可参考相关驱动文档或经过测试这两种不一样的模式来观察所用驱动的结果。	true | false	true
useGeneratedKeys	容许 JDBC 支持自动生成主键，须要驱动兼容。若是设置为 true 则这个设置强制使用自动生成主键，尽管一些驱动不能兼容但仍可正常工做（好比 Derby）。	true | false	False
autoMappingBehavior	指定 MyBatis 是否以及如何自动映射指定的列到字段或属性。NONE 表示取消自动映射；PARTIAL 只会自动映射没有定义嵌套结果集映射的结果集。FULL 会自动映射任意复杂的结果集（包括嵌套和其余状况）。	NONE, PARTIAL, FULL	PARTIAL
defaultExecutorType	配置默认的执行器。SIMPLE 就是普通的执行器；REUSE 执行器会重用预处理语句（prepared statements）；BATCH 执行器将重用语句并执行批量更新。	SIMPLE REUSE BATCH	SIMPLE
defaultStatementTimeout	设置超时时间，它决定驱动等待数据库响应的秒数。	Any positive integer	Not Set (null)
safeRowBoundsEnabled	容许在嵌套语句中使用行分界（RowBounds）。	true | false	False
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 enumeration. Most common are: NULL, VARCHAR and OTHER	OTHER
lazyLoadTriggerMethods	指定哪一个对象的方法触发一次延迟加载。	A method name list separated by commas	equals,clone,hashCode,toString
defaultScriptingLanguage	指定动态 SQL 生成的默认语言。	A type alias or fully qualified class name.	org.apache.ibatis.scripting.xmltags.XMLDynamicLanguageDriver
callSettersOnNulls	指定当结果集中值为 null 的时候是否调用映射对象的 setter（map 对象时为 put）方法，这对于有 Map.keySet() 依赖或 null 值初始化的时候是有用的。注意原始类型（int、boolean等）是不能设置成 null 的。	true | false	false
logPrefix	指定 MyBatis 增长到日志名称的前缀。	Any String	Not set
logImpl	指定 MyBatis 所用日志的具体实现，未指定时将自动查找。	SLF4J | LOG4J | LOG4J2 | JDK_LOGGING | COMMONS_LOGGING | STDOUT_LOGGING | NO_LOGGING	Not set
proxyFactory	为 Mybatis 用来建立具备延迟加载能力的对象设置代理工具。	CGLIB | JAVASSIST	CGLIB

一个配置完整的 settings 元素的示例以下：

<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="25"/>
  <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,hashCode,toString"/>
</settings>

配置环境（environments）

MyBatis 能够配置成适应多种环境，这种机制有助于将 SQL 映射应用于多种数据库之中，现实状况下有多种理由须要这么作。例如，开发、测试和生产环境须要有不一样的配置；或者共享相同 Schema 的多个生产数据库，想使用相同的 SQL 映射。许多相似的用例。

不过要记住：尽管能够配置多个环境，每一个 SqlSessionFactory 实例只能选择其一。

因此，若是你想链接两个数据库，就须要建立两个 SqlSessionFactory 实例，每一个数据库对应一个。而若是是三个数据库，就须要三个实例，依此类推，记起来很简单：

• 每一个数据库对应一个 SqlSessionFactory 实例

为了指定建立哪一种环境，只要将它做为可选的参数传递给 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);

Environments配置示例

<environments default="development">
  <environment id="development">
    <transactionManager type="JDBC">
      <property name="..." value="..."/>
    </transactionManager>
    <dataSource type="POOLED">
      <property name="driver" value="${driver}"/>
      <property name="url" value="${url}"/>
      <property name="username" value="${username}"/>
      <property name="password" value="${password}"/>
    </dataSource>
  </environment>
</environments>

<environments default="development">  
        <environment id="development">  
            <transactionManager type="JDBC" />  
            <dataSource type="POOLED">
                <property name="driver" value="com.mysql.jdbc.Driver" />
                <property name="url" value="jdbc:mysql://localhost:3306/wifi?useUnicode=true&amp;characterEncoding=UTF-8&amp;zeroDateTimeBehavior=convertToNull" />
                <property name="username" value="root" />
                <property name="password" value="123456" />
            </dataSource> 
        </environment>  
    </environments> 

 

注意这里的关键点:

• 默认的环境 ID（好比:default=”development”）。
• 每一个 environment 元素定义的环境 ID（好比:id=”development”）。
• 事务管理器的配置（好比:type=”JDBC”）。
• 数据源的配置（好比:type=”POOLED”）。

默认的环境和环境 ID 是自我解释的。你能够使用你喜欢的名称来命名，只要肯定默认的要匹配其中之一。

映射器（mappers）

既然 MyBatis 的行为已经由上述元素配置完了，咱们如今就要定义 SQL 映射语句了。可是首先咱们须要告诉 MyBatis 到哪里去找到这些语句。Java 在自动查找这方面没有提供一个很好的方法，因此最佳的方式是告诉 MyBatis 到哪里去找映射文件。你能够使用相对于类路径的资源引用，或彻底限定资源定位符（包括 file:/// 的 URL），或类名和包名等。例如：

<!-- Using classpath relative resources -->
<mappers>
  <mapper resource="org/mybatis/builder/AuthorMapper.xml"/>
  <mapper resource="org/mybatis/builder/BlogMapper.xml"/>
  <mapper resource="org/mybatis/builder/PostMapper.xml"/>
</mappers>

<!-- Using url fully qualified paths -->
<mappers>
  <mapper url="file:///var/mappers/AuthorMapper.xml"/>
  <mapper url="file:///var/mappers/BlogMapper.xml"/>
  <mapper url="file:///var/mappers/PostMapper.xml"/>
</mappers>

<!-- Using mapper interface classes -->
<mappers>
  <mapper class="org.mybatis.builder.AuthorMapper"/>
  <mapper class="org.mybatis.builder.BlogMapper"/>
  <mapper class="org.mybatis.builder.PostMapper"/>
</mappers>

<!-- Register all interfaces in a package as mappers -->
<mappers>
  <package name="org.mybatis.builder"/>
</mappers>