XML配置

川长思鸟来 2022-11-26 09:41 176阅读 0赞

Mybatis的配置文件包含了众多能够影响Mybatis行为的设置和属性信息。通常Mybatis的配置文件位于项目路径下的resources文件夹下，通常命名为mybatis-config.xml。我们观察一下我们之前写过的mybatis-config.xml，发现Mybatis配置文档的顶层结构大致是这样的：

**属性（properties）**

有些属性我们可以在外部进行配置，并可以进行动态替换。也就是说，对于某些属性，我们既可以在典型的 Java 属性文件中配置，也可以在 properties 元素的子元素中设置。例如：

如果一个属性在不只一个地方进行了配置，那么，MyBatis 将按照一定的的顺序来加载：首先读取在 properties 元素体内指定的属性；然后根据 properties 元素中的 resource 属性读取类路径下属性文件，或根据 url 属性指定的路径读取属性文件，并覆盖之前读取过的同名属性；最后读取作为方法参数传递的属性，并覆盖之前读取过的同名属性。

因此，通过方法参数传递的属性具有最高优先级，resource/url 属性中指定的配置文件次之，最低优先级的则是 properties 元素中指定的属性。

**设置（settigns）**

这是 MyBatis 中极为重要的调整设置，它们会改变 MyBatis 的运行时行为。 下表描述了设置中各项设置的含义、默认值等。

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

一个完整的settings应该是这样设置的。

**类型别名（typeAliases）**

类型别名可为 Java 类型设置一个缩写名字。 它仅用于 XML 配置，意在降低冗余的全限定类名书写。例如：

当这样配置时，Blog 可以用在任何使用 domain.blog.Blog 的地方，减少代码书写量，也能降低错误率。

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

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

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

下面是一些为常见的 Java 类型内建的类型别名。它们都是不区分大小写的，注意，为了应对原始类型的命名重复，采取了特殊的命名风格。

<table> 
 <thead> 
 <tr> 
 <th> 别名 </th> 
 <th> 映射的类型 </th> 
 </tr> 
 </thead> 
 <tbody> 
 <tr> 
 <td> _byte </td> 
 <td> byte </td> 
 </tr> 
 <tr> 
 <td> _long </td> 
 <td> long </td> 
 </tr> 
 <tr> 
 <td> _short </td> 
 <td> short </td> 
 </tr> 
 <tr> 
 <td> _int </td> 
 <td> int </td> 
 </tr> 
 <tr> 
 <td> _integer </td> 
 <td> int </td> 
 </tr> 
 <tr> 
 <td> _double </td> 
 <td> double </td> 
 </tr> 
 <tr> 
 <td> _float </td> 
 <td> float </td> 
 </tr> 
 <tr> 
 <td> _boolean </td> 
 <td> boolean </td> 
 </tr> 
 <tr> 
 <td> string </td> 
 <td> String </td> 
 </tr> 
 <tr> 
 <td> byte </td> 
 <td> Byte </td> 
 </tr> 
 <tr> 
 <td> long </td> 
 <td> Long </td> 
 </tr> 
 <tr> 
 <td> short </td> 
 <td> Short </td> 
 </tr> 
 <tr> 
 <td> int </td> 
 <td> Integer </td> 
 </tr> 
 <tr> 
 <td> integer </td> 
 <td> Integer </td> 
 </tr> 
 <tr> 
 <td> double </td> 
 <td> Double </td> 
 </tr> 
 <tr> 
 <td> float </td> 
 <td> Float </td> 
 </tr> 
 <tr> 
 <td> boolean </td> 
 <td> Boolean </td> 
 </tr> 
 <tr> 
 <td> date </td> 
 <td> Date </td> 
 </tr> 
 <tr> 
 <td> decimal </td> 
 <td> BigDecimal </td> 
 </tr> 
 <tr> 
 <td> bigdecimal </td> 
 <td> BigDecimal </td> 
 </tr> 
 <tr> 
 <td> object </td> 
 <td> Object </td> 
 </tr> 
 <tr> 
 <td> map </td> 
 <td> Map </td> 
 </tr> 
 <tr> 
 <td> hashmap </td> 
 <td> HashMap </td> 
 </tr> 
 <tr> 
 <td> list </td> 
 <td> List </td> 
 </tr> 
 <tr> 
 <td> arraylist </td> 
 <td> ArrayList </td> 
 </tr> 
 <tr> 
 <td> collection </td> 
 <td> Collection </td> 
 </tr> 
 <tr> 
 <td> iterator </td> 
 <td> Iterator </td> 
 </tr> 
 </tbody> 
</table>

类型处理器（typeHandlers）

MyBatis 在设置预处理语句（PreparedStatement）中的参数或从结果集中取出一个值时， 都会用类型处理器将获取到的值以合适的方式转换成 Java 类型。下表描述了一些默认的类型处理器。

<table> 
 <thead> 
 <tr> 
 <th> 类型处理器 </th> 
 <th> Java 类型 </th> 
 <th> JDBC 类型 </th> 
 </tr> 
 </thead> 
 <tbody> 
 <tr> 
 <td> BooleanTypeHandler </td> 
 <td> java.lang.Boolean,&nbsp;boolean </td> 
 <td> 数据库兼容的&nbsp;BOOLEAN </td> 
 </tr> 
 <tr> 
 <td> ByteTypeHandler </td> 
 <td> java.lang.Byte,&nbsp;byte </td> 
 <td> 数据库兼容的&nbsp;NUMERIC&nbsp;或&nbsp;BYTE </td> 
 </tr> 
 <tr> 
 <td> ShortTypeHandler </td> 
 <td> java.lang.Short,&nbsp;short </td> 
 <td> 数据库兼容的&nbsp;NUMERIC&nbsp;或&nbsp;SMALLINT </td> 
 </tr> 
 <tr> 
 <td> IntegerTypeHandler </td> 
 <td> java.lang.Integer,&nbsp;int </td> 
 <td> 数据库兼容的&nbsp;NUMERIC&nbsp;或&nbsp;INTEGER </td> 
 </tr> 
 <tr> 
 <td> LongTypeHandler </td> 
 <td> java.lang.Long,&nbsp;long </td> 
 <td> 数据库兼容的&nbsp;NUMERIC&nbsp;或&nbsp;BIGINT </td> 
 </tr> 
 <tr> 
 <td> FloatTypeHandler </td> 
 <td> java.lang.Float,&nbsp;float </td> 
 <td> 数据库兼容的&nbsp;NUMERIC&nbsp;或&nbsp;FLOAT </td> 
 </tr> 
 <tr> 
 <td> DoubleTypeHandler </td> 
 <td> java.lang.Double,&nbsp;double </td> 
 <td> 数据库兼容的&nbsp;NUMERIC&nbsp;或&nbsp;DOUBLE </td> 
 </tr> 
 <tr> 
 <td> BigDecimalTypeHandler </td> 
 <td> java.math.BigDecimal </td> 
 <td> 数据库兼容的&nbsp;NUMERIC&nbsp;或&nbsp;DECIMAL </td> 
 </tr> 
 <tr> 
 <td> StringTypeHandler </td> 
 <td> java.lang.String </td> 
 <td> CHAR,&nbsp;VARCHAR </td> 
 </tr> 
 <tr> 
 <td> ClobReaderTypeHandler </td> 
 <td> java.io.Reader </td> 
 <td> - </td> 
 </tr> 
 <tr> 
 <td> ClobTypeHandler </td> 
 <td> java.lang.String </td> 
 <td> CLOB,&nbsp;LONGVARCHAR </td> 
 </tr> 
 <tr> 
 <td> NStringTypeHandler </td> 
 <td> java.lang.String </td> 
 <td> NVARCHAR,&nbsp;NCHAR </td> 
 </tr> 
 <tr> 
 <td> NClobTypeHandler </td> 
 <td> java.lang.String </td> 
 <td> NCLOB </td> 
 </tr> 
 <tr> 
 <td> BlobInputStreamTypeHandler </td> 
 <td> java.io.InputStream </td> 
 <td> - </td> 
 </tr> 
 <tr> 
 <td> ByteArrayTypeHandler </td> 
 <td> byte[] </td> 
 <td> 数据库兼容的字节流类型 </td> 
 </tr> 
 <tr> 
 <td> BlobTypeHandler </td> 
 <td> byte[] </td> 
 <td> BLOB,&nbsp;LONGVARBINARY </td> 
 </tr> 
 <tr> 
 <td> DateTypeHandler </td> 
 <td> java.util.Date </td> 
 <td> TIMESTAMP </td> 
 </tr> 
 <tr> 
 <td> DateOnlyTypeHandler </td> 
 <td> java.util.Date </td> 
 <td> DATE </td> 
 </tr> 
 <tr> 
 <td> TimeOnlyTypeHandler </td> 
 <td> java.util.Date </td> 
 <td> TIME </td> 
 </tr> 
 <tr> 
 <td> SqlTimestampTypeHandler </td> 
 <td> java.sql.Timestamp </td> 
 <td> TIMESTAMP </td> 
 </tr> 
 <tr> 
 <td> SqlDateTypeHandler </td> 
 <td> java.sql.Date </td> 
 <td> DATE </td> 
 </tr> 
 <tr> 
 <td> SqlTimeTypeHandler </td> 
 <td> java.sql.Time </td> 
 <td> TIME </td> 
 </tr> 
 <tr> 
 <td> ObjectTypeHandler </td> 
 <td> Any </td> 
 <td> OTHER&nbsp;或未指定类型 </td> 
 </tr> 
 <tr> 
 <td> EnumTypeHandler </td> 
 <td> Enumeration Type </td> 
 <td> VARCHAR 或任何兼容的字符串类型，用来存储枚举的名称（而不是索引序数值） </td> 
 </tr> 
 <tr> 
 <td> EnumOrdinalTypeHandler </td> 
 <td> Enumeration Type </td> 
 <td> 任何兼容的&nbsp;NUMERIC&nbsp;或&nbsp;DOUBLE&nbsp;类型，用来存储枚举的序数值（而不是名称）。 </td> 
 </tr> 
 <tr> 
 <td> SqlxmlTypeHandler </td> 
 <td> java.lang.String </td> 
 <td> SQLXML </td> 
 </tr> 
 <tr> 
 <td> InstantTypeHandler </td> 
 <td> java.time.Instant </td> 
 <td> TIMESTAMP </td> 
 </tr> 
 <tr> 
 <td> LocalDateTimeTypeHandler </td> 
 <td> java.time.LocalDateTime </td> 
 <td> TIMESTAMP </td> 
 </tr> 
 <tr> 
 <td> LocalDateTypeHandler </td> 
 <td> java.time.LocalDate </td> 
 <td> DATE </td> 
 </tr> 
 <tr> 
 <td> LocalTimeTypeHandler </td> 
 <td> java.time.LocalTime </td> 
 <td> TIME </td> 
 </tr> 
 <tr> 
 <td> OffsetDateTimeTypeHandler </td> 
 <td> java.time.OffsetDateTime </td> 
 <td> TIMESTAMP </td> 
 </tr> 
 <tr> 
 <td> OffsetTimeTypeHandler </td> 
 <td> java.time.OffsetTime </td> 
 <td> TIME </td> 
 </tr> 
 <tr> 
 <td> ZonedDateTimeTypeHandler </td> 
 <td> java.time.ZonedDateTime </td> 
 <td> TIMESTAMP </td> 
 </tr> 
 <tr> 
 <td> YearTypeHandler </td> 
 <td> java.time.Year </td> 
 <td> INTEGER </td> 
 </tr> 
 <tr> 
 <td> MonthTypeHandler </td> 
 <td> java.time.Month </td> 
 <td> INTEGER </td> 
 </tr> 
 <tr> 
 <td> YearMonthTypeHandler </td> 
 <td> java.time.YearMonth </td> 
 <td> VARCHAR&nbsp;或&nbsp;LONGVARCHAR </td> 
 </tr> 
 <tr> 
 <td> JapaneseDateTypeHandler </td> 
 <td> java.time.chrono.JapaneseDate </td> 
 <td> DATE </td> 
 </tr> 
 </tbody> 
</table>

**对象工厂（objectFactory）**

每次 MyBatis 创建结果对象的新实例时，它都会使用一个对象工厂（ObjectFactory）实例来完成实例化工作。 默认的对象工厂需要做的仅仅是实例化目标类，要么通过默认无参构造方法，要么通过存在的参数映射来调用带有参数的构造方法。 如果想覆盖对象工厂的默认行为，可以通过创建自己的对象工厂来实现。

插件（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 发行包中的源代码。 如果你想做的不仅仅是监控方法的调用，那么你最好相当了解要重写的方法的行为。 因为在试图修改或重写已有方法的行为时，很可能会破坏 MyBatis 的核心模块。 这些都是更底层的类和方法，所以使用插件的时候要特别当心。

通过 MyBatis 提供的强大机制，使用插件是非常简单的，只需实现 Interceptor 接口，并指定想要拦截的方法签名即可。

环境配置（environments）

MyBatis 可以配置成适应多种环境，这种机制有助于将 SQL 映射应用于多种数据库之中， 现实情况下有多种理由需要这么做。例如，开发、测试和生产环境需要有不同的配置；或者想在具有相同 Schema 的多个生产数据库中使用相同的 SQL 映射。还有许多类似的使用场景。

**不过要记住：尽管可以配置多个环境，但每个 SqlSessionFactory 实例只能选择一种环境。**

所以，如果你想连接两个数据库，就需要创建两个 SqlSessionFactory 实例，每个数据库对应一个。而如果是三个数据库，就需要三个实例，依此类推，记起来很简单：

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

为了指定创建哪种环境，只要将它作为可选的参数传递给 SqlSessionFactoryBuilder 即可。可以接受环境配置的两个方法签名是：

SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(reader, environment);
    SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(reader, environment, properties);

如果忽略了环境参数，那么将会加载默认环境，如下所示：

SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(reader);
    SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(reader, properties);

经常使用的environments大致是这样配置的：

我们发现，我们其实在配置environment的时候会将transactionManager（事务管理器）和dataSource（数据源）也一起配置了。

注意一些关键点:

*  默认使用的环境 ID（比如：default="development"）。
 *  每个 environment 元素定义的环境 ID（比如：id="development"）。
 *  事务管理器的配置（比如：type="JDBC"）。
 *  数据源的配置（比如：type="POOLED"）。

**默认环境和环境 ID**

顾名思义。 环境可以随意命名，但务必保证默认的环境 ID 要匹配其中一个环境 ID。

**事务管理器（transactionManager）**

在 MyBatis 中有两种类型的事务管理器（也就是 type="\[JDBC|MANAGED\]"）：

* JDBC – 这个配置直接使用了 JDBC 的提交和回滚设施，它依赖从数据源获得的连接来管理事务作用域。
 * MANAGED – 这个配置几乎没做什么。它从不提交或回滚一个连接，而是让容器来管理事务的整个生命周期（比如 JEE 应用服务器的上下文）。 默认情况下它会关闭连接。然而一些容器并不希望连接被关闭，因此需要将 closeConnection 属性设置为 false 来阻止默认的关闭行为。例如:
 
 <transactionManager type="MANAGED">
 <property name="closeConnection" value="false"/>
 </transactionManager>

**数据源（dataSource）**

dataSource 元素使用标准的 JDBC 数据源接口来配置 JDBC 连接对象的资源。

有三种内建的数据源类型（也就是 type="\[UNPOOLED|POOLED|JNDI\]"）：

**UNPOOLED**– 这个数据源的实现会每次请求时打开和关闭连接。虽然有点慢，但对那些数据库连接可用性要求不高的简单应用程序来说，是一个很好的选择。 性能表现则依赖于使用的数据库，对某些数据库来说，使用连接池并不重要，这个配置就很适合这种情形。UNPOOLED 类型的数据源仅仅需要配置以下 5 种属性：

*  driver – 这是 JDBC 驱动的 Java 类全限定名（并不是 JDBC 驱动中可能包含的数据源类）。
 *  url – 这是数据库的 JDBC URL 地址。
 *  username – 登录数据库的用户名。
 *  password – 登录数据库的密码。
 *  defaultTransactionIsolationLevel – 默认的连接事务隔离级别。
 *  defaultNetworkTimeout – 等待数据库操作完成的默认网络超时时间（单位：毫秒）。查看 java.sql.Connection\#setNetworkTimeout() 的 API 文档以获取更多信息。

作为可选项，你也可以传递属性给数据库驱动。只需在属性名加上“driver.”前缀即可，例如：

*  driver.encoding=UTF8

这将通过 DriverManager.getConnection(url, driverProperties) 方法传递值为 UTF8 的 encoding 属性给数据库驱动。

**POOLED**– 这种数据源的实现利用“池”的概念将 JDBC 连接对象组织起来，避免了创建新的连接实例时所必需的初始化和认证时间。 这种处理方式很流行，能使并发 Web 应用快速响应请求。

除了上述提到 UNPOOLED 下的属性外，还有更多属性用来配置 POOLED 的数据源：

*  poolMaximumActiveConnections – 在任意时间可存在的活动（正在使用）连接数量，默认值：10
 *  poolMaximumIdleConnections – 任意时间可能存在的空闲连接数。
 *  poolMaximumCheckoutTime – 在被强制返回之前，池中连接被检出（checked out）时间，默认值：20000 毫秒（即 20 秒）
 *  poolTimeToWait – 这是一个底层设置，如果获取连接花费了相当长的时间，连接池会打印状态日志并重新尝试获取一个连接（避免在误配置的情况下一直失败且不打印日志），默认值：20000 毫秒（即 20 秒）。
 *  poolMaximumLocalBadConnectionTolerance – 这是一个关于坏连接容忍度的底层设置， 作用于每一个尝试从缓存池获取连接的线程。 如果这个线程获取到的是一个坏的连接，那么这个数据源允许这个线程尝试重新获取一个新的连接，但是这个重新尝试的次数不应该超过 poolMaximumIdleConnections 与 poolMaximumLocalBadConnectionTolerance 之和。 默认值：3（新增于 3.4.5）
 *  poolPingQuery – 发送到数据库的侦测查询，用来检验连接是否正常工作并准备接受请求。默认是“NO PING QUERY SET”，这会导致多数数据库驱动出错时返回恰当的错误消息。
 *  poolPingEnabled – 是否启用侦测查询。若开启，需要设置 poolPingQuery 属性为一个可执行的 SQL 语句（最好是一个速度非常快的 SQL 语句），默认值：false。
 *  poolPingConnectionsNotUsedFor – 配置 poolPingQuery 的频率。可以被设置为和数据库连接超时时间一样，来避免不必要的侦测，默认值：0（即所有连接每一时刻都被侦测 — 当然仅当 poolPingEnabled 为 true 时适用）。

**JNDI** – 这个数据源实现是为了能在如 EJB 或应用服务器这类容器中使用，容器可以集中或在外部配置数据源，然后放置一个 JNDI 上下文的数据源引用。这种数据源配置只需要两个属性：

*  initial\_context – 这个属性用来在 InitialContext 中寻找上下文（即，initialContext.lookup(initial\_context)）。这是个可选属性，如果忽略，那么将会直接从 InitialContext 中寻找 data\_source 属性。
 *  data\_source – 这是引用数据源实例位置的上下文路径。提供了 initial\_context 配置时会在其返回的上下文中进行查找，没有提供时则直接在 InitialContext 中查找。

和其他数据源配置类似，可以通过添加前缀“env.”直接把属性传递给 InitialContext。比如：

*  env.encoding=UTF8

这就会在 InitialContext 实例化时往它的构造方法传递值为 UTF8 的 encoding 属性。

数据库厂商标识（databaseIdProvider）

MyBatis 可以根据不同的数据库厂商执行不同的语句，这种多厂商的支持是基于映射语句中的databaseId属性。MyBatis会加载带有匹配当前数据库 databaseId 属性和所有不带 databaseId 属性的语句。 如果同时找到带有databaseId不带databaseId的相同语句，则后者会被舍弃。 为支持多厂商特性，只要像下面这样在 mybatis-config.xml 文件中加入 databaseIdProvider 即可：

databaseIdProvider 对应的 DB\_VENDOR 实现会将 databaseId 设置为 DatabaseMetaData\#getDatabaseProductName() 返回的字符串。 由于通常情况下这些字符串都非常长，而且相同产品的不同版本会返回不同的值，你可能想通过设置属性别名来使其变短：

在提供了属性别名时，databaseIdProvider 的 DB\_VENDOR 实现会将 databaseId 设置为数据库产品名与属性中的名称第一个相匹配的值，如果没有匹配的属性，将会设置为 “null”。 在这个例子中，如果 getDatabaseProductName() 返回“Oracle (DataDirect)”，databaseId 将被设置为“oracle”。

映射器（mappers）

既然 MyBatis 的行为已经由上述元素配置完了，我们现在就要来定义 SQL 映射语句了。 但首先，我们需要告诉 MyBatis 到哪里去找到这些语句。 在自动查找资源方面，Java 并没有提供一个很好的解决方案，所以最好的办法是直接告诉 MyBatis 到哪里去找映射文件。 你可以使用相对于类路径的资源引用，或完全限定资源定位符（包括 file:/// 形式的 URL），或类名和包名等。例如：

<mappers>
 <mapper resource="org/mybatis/builder/AuthorMapper.xml"/>
 <mapper resource="org/mybatis/builder/BlogMapper.xml"/>
 <mapper resource="org/mybatis/builder/PostMapper.xml"/>
 </mappers>
 
 
 <mappers>
 <mapper url="file:///var/mappers/AuthorMapper.xml"/>
 <mapper url="file:///var/mappers/BlogMapper.xml"/>
 <mapper url="file:///var/mappers/PostMapper.xml"/>
 </mappers>
 
 
 <mappers>
 <mapper class="org.mybatis.builder.AuthorMapper"/>
 <mapper class="org.mybatis.builder.BlogMapper"/>
 <mapper class="org.mybatis.builder.PostMapper"/>
 </mappers>
 
 
 <mappers>
 <package name="org.mybatis.builder"/>
 </mappers>

这些配置会告诉 MyBatis 去哪里找映射文件，剩下的细节就应该是每个 SQL 映射文件了，也就是接下来我们要讨论的。

参考自MyBatis的官方文档： [https://mybatis.org/mybatis-3/zh/configuration.html\#][https_mybatis.org_mybatis-3_zh_configuration.html]

[https_mybatis.org_mybatis-3_zh_configuration.html]: https://mybatis.org/mybatis-3/zh/configuration.html#