【Mybatis】MyBatis配置文件的使用（二）

　　本例在【Mybatis】MyBatis快速入门（一）基础上继续学习XML映射配置文件

　　MyBatis 的配置文件包含了会深深影响 MyBatis 行为的设置（settings）和属性（properties）信息。文档的顶层结构如下：

configuration 配置
- properties 属性
- settings 设置
- typeAliases 类型别名
- typeHandlers 类型处理器
- objectFactory 对象工厂
- plugins 插件
- environments 环境
  - environment 环境变量
    - transactionManager 事务管理器
    - dataSource 数据源
- databaseIdProvider 数据库厂商标识
- mappers 映射器

properties 属性

　　属性都是可外部配置且可动态替换的，既可以在典型的 Java 属性文件中配置，亦可通过 properties 元素的子元素来传递。

　可以将数据库的连接配置信息写在一个properties文件中，然后在mybatis-config.xml文件中引用properties文件

　　1、新建一个dbconfig.properties属性文件放在类路径下

　　　内容如下：

 jdbc.driver = com.mysql.jdbc.Driver

 jdbc.url = jdbc:mysql://localhost:3306/test_mybatis

 jdbc.username = admin

 jdbc.password = 123456

　　2、在MyBatis的mybatis-config.xml文件中引用db.properties文件，如下：

 <!--

     mybatis可以使用properties来引入外部properties配置文件的内容

         resource：引入类路径下的资源

         url：引入网络路径或磁盘路径下的资源

  -->

 <properties resource="dbconfig.properties"></properties>

 <environments default="development">

     <environment id="development">

         <transactionManager type="JDBC" />

         <!-- 配置数据库连接信息 -->

         <dataSource type="POOLED">

             <property name="driver" value="${jdbc.driver}" />

             <property name="url" value="${jdbc.url}" />

             <property name="username" value="${jdbc.username}" />

             <property name="password" value="${jdbc.password}" />

         </dataSource>

     </environment>

 </environments>

settings 设置

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

设置参数	描述	有效值	默认值
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 版本开始)

　　例子：假如数据库中表某个字段是带下划线的，如last_name，而JavaBean中字段名称是lastName，通常查询时通过设置sql别名来解决，当Mybatis可以通过设置mapUnderscoreToCamelCase=true，也能实现同样的效果

　　数据库表内容，字段名称是lastName

　　　　【Mybatis】MyBatis配置文件的使用（二）

　　解决方法1：通常查询时通过设置sql别名来解决，在sql映射中

 <select id="getEmployeeById" resultType="com.hd.test.pojo.Employee">

     select id, last_name lastName, gender, email from employee where id = #{id}

 </select>

　　解决方法2：

　　　　1）Mybatis中，可以通过设置配置文件，mapUnderscoreToCamelCase=true

<!--

    settings包含含多重要的设置项

        setting：用来设置每一个设置项

            name：设置项名字

            values：设置项取值

 -->

<settings>

    <setting name="mapUnderscoreToCamelCase" value="true"/>

</settings>

　　　2）sql映射如下：

 <select id="getEmployeeById" resultType="com.hd.test.pojo.Employee">

     select id, last_name lastName, gender, email from employee where id = #{id}

 </select>

typeAliases 类型别名

　　类型别名是为 Java 类型设置一个短的名字。它只和 XML 配置有关，存在的意义仅在于用来减少类完全限定名的冗余。例如:

　　1、设置Employee的别名为emp

  <!--

      typeAliases：别名处理器，可以为Java类取别名

          1）typeAlias：为某个Java类型取别名

              type：指定起别名的类型全限定名，默认别名就是类名小写（别名大小写不敏感）

              alias：指定新的别名

          2）package：为某个包下的所有类批量取别名

              name：指定包名（为当前包以及下面所有的后代包的每一个类起一个默认别名（类名小写））

          3) 批量起别名的情况下，使用@Alias注解为某个类型指定新的别名

          不推荐使用别名：无法从xml中关联查看类

   -->

 <typeAliases>

     <typeAlias type="com.hd.test.pojo.Employee" alias="emp"/>

 </typeAliases>

　　2、在sql映射文件中可以使用别名

 <select id="getEmployeeById" resultType="emp" >

     select id, last_name lastName, gender, email from employee where id = #{id}

 </select>

　　注意：常见的 Java 类型Mybatis内建的相应的类型别名。它们都是大小写不敏感的，需要注意的是由基本类型名称重复导致的特殊处理

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

typeHandlers 类型处理器

　　无论是 MyBatis 在预处理语句（PreparedStatement）中设置一个参数时，还是从结果集中取出一个值时，都会用类型处理器将获取的值以合适的方式转换成 Java 类型。

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 的核心模块。这些都是更低层的类和方法，所以使用插件的时候要特别当心

environments 环境

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

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

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

 <!--

     environments：环境们，mybatis可以配置多种环境，dafault指定某中环境。可以达到快速切换环境的目的

         environment：配置一个具体的环境信息，必须有两个标签：id代表当前环境的唯一标识

             transactionManager：事物管理器

                 type：事物管理器的类型；JDBC（JdbcTransactionFactory）|MANAGED（ManagedTransactionFactory）

                         自定义事物管理器：实现TransactionFactory接口，type指定为全限定名

             dataSource：数据源；

                 type：数据源类型；UNPOOLED|POOLED|JNDI

                 自定义数据源 实现DateSourceFactory接口 type是全限定名

  -->

 <environments default="development">

     <environment id="development">

         <transactionManager type="JDBC" />

         <!-- 配置数据库连接信息 -->

         <dataSource type="POOLED">

             <property name="driver" value="${jdbc.driver}" />

             <property name="url" value="${jdbc.url}" />

             <property name="username" value="${jdbc.username}" />

             <property name="password" value="${jdbc.password}" />

         </dataSource>

     </environment>

     <environment id="test">

         <transactionManager type="JDBC" />

         <!-- 配置数据库连接信息 -->

         <dataSource type="POOLED">

             <property name="driver" value="${jdbc.driver}" />

             <property name="url" value="${jdbc.url}" />

             <property name="username" value="test" />

             <property name="password" value="123456" />

         </dataSource>

     </environment>

 </environments>

databaseIdProvider 数据库厂商标识

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

　　例：

　　　1、为不同的数据库厂商起别名

 <!--

     databaseIdProvider：支持多数据库厂商的；

      type="DB_VENDOR"：VendorDatabaseIdProvider

          作用就是得到数据库厂商的标识(驱动getDatabaseProductName())，mybatis就能根据数据库厂商标识来执行不同的sql;

          MySQL，Oracle，SQL Server,xxxx

   -->

 <databaseIdProvider type="DB_VENDOR">

     <!-- 为不同的数据库厂商起别名 -->

     <property name="MySQL" value="mysql"/>

     <property name="Oracle" value="oracle"/>

     <property name="SQL Server" value="sqlserver"/>

 </databaseIdProvider>

　　2、sql映射如下，

 <select id="getEmpById" resultType="com.hd.test.pojo.Employee">

     select * from employee where id = #{id}

 </select>

 <select id="getEmpById" resultType="com.hd.test.pojo.Employee"

     databaseId="mysql">

     select * from employee where id = #{id}

 </select>

 <select id="getEmpById" resultType="com.hd.test.pojo.Employee"

     databaseId="oracle">

     select EMPLOYEE_ID id,LAST_NAME    lastName,EMAIL email

     from employees where EMPLOYEE_ID=#{id}

 </select>

　　3、测试

　　　　1、使用mysql环境进行测试，可以看到使用是带mysql标识的sql语句

　　　　　　　　select * from employee where id = #{id}
　　　　　　</select>　

　　　　2、使用oracle环境进行测试，可以看到使用是带oracle标识的sql语句

　　　　　　<select id="getEmpById" resultType="com.hd.test.pojo.Employee" databaseId="oracle">
　　　　　　　　select EMPLOYEE_ID id,LAST_NAME lastName,EMAIL email from employees where EMPLOYEE_ID=#{id}

　　　　　　</select>　

　　　　注意：在sql映射文件中有同样id的sql语句时，mybatis先会加载没带厂商标识的sql语句，然后加载带厂商标识的sql语句，后面的会覆盖前面加载的sql

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>

 <!-- 使用完全限定资源定位符（URL） -->

 <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】MyBatis配置文件的使用（二）

properties 属性

settings 设置

typeAliases 类型别名

typeHandlers 类型处理器

objectFactory 对象工厂

plugins 插件

environments 环境

databaseIdProvider 数据库厂商标识

mappers 映射器

相关文章