MyBatis XML属性配置

一、MyBatis 的配置文件结构

配置文件的结构以下：

<configuration>
    <!-- 属性 -->
    <properties></properties />
    <!-- 设置 -->
    <settings></settings />
    <!-- 类型别名 -->
    <typeAliases></typeAliases />
    <!-- 类型处理器 -->
    <typeHandlers></typeHandlers />
    <!-- 对象工厂 -->
    <objectFactory></objectFactory />
    <!-- 插件 -->
    <plugins> </plugins>
    <!-- 环境 -->
    <environment></environment>
    <!-- 数据库厂商标识 -->
    <databaseIdProvider></databaseIdProvider>
    <!-- 映射器 -->
    <mappers></mappers>
</configuration>

 properties

　　属性配置，能够经过几个不一样方式进行配置，Java 属性文件中配置，亦可经过 properties 元素的子元素来传递。

若是属性在不仅一个地方进行了配置，那么 MyBatis 将按照下面的顺序来加载：

• 在 properties 元素体内指定的属性首先被读取。
• 而后根据 properties 元素中的 resource 属性读取类路径下属性文件或根据 url 属性指定的路径读取属性文件，并覆盖已读取的同名属性。
• 最后读取做为方法参数传递的属性，并覆盖已读取的同名属性。 

例如如下的配置中：

<properties resource="org/mybatis/example/config.properties">
  <property name="username" value="dev_user"/>
  <property name="password" value="F2Fa3!33TYyg"/>
</properties>

 其中的属性就能够在整个配置文件中被用来替换须要动态配置的属性值。

<dataSource type="POOLED">
  <property name="driver" value="${driver}"/>
  <property name="url" value="${url}"/>
  <property name="username" value="${username}"/>
  <property name="password" value="${password}"/>
</dataSource>

‘uername’和‘password’ 这两个值最开始经过property属性值进行传入，接下来由配置文件 config.properties 中若是也有这两值，那么‘uername’和‘password’ 的值将会被配置文件中的值覆盖，再接下来的配置中‘uername’和‘password’ 的值会经过变量值传入进来，因此最终使用的会是传入的变量值。

settings

　　settings中的参数及相关说明：

设置参数	描述	有效值	默认值
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

经常使用配置以下：

<settings>
        <!-- 这个配置使全局的映射器启用或禁用 缓存 -->
        <setting name="cacheEnabled" value="true" />
        <!-- 全局启用或禁用延迟加载。当禁用时, 全部关联对象都会即时加载 -->
        <setting name="lazyLoadingEnabled" value="true" />
        <!-- 容许或不容许多种结果集从一个单独 的语句中返回(须要适合的驱动) -->
        <setting name="multipleResultSetsEnabled" value="true" />
        <!-- 使用列标签代替列名。 不一样的驱动在这 方便表现不一样。 参考驱动文档或充分测 试两种方法来决定所使用的驱动 -->
        <setting name="useColumnLabel" value="true" />
        <!-- 容许 JDBC 支持生成的键。 须要适合的 驱动。 若是设置为 true 则这个设置强制 生成的键被使用, 尽管一些驱动拒绝兼 容但仍然有效(好比 
            Derby) -->
        <setting name="useGeneratedKeys" value="false" />
        <!-- 配置默认的执行器。SIMPLE 执行器没 有什么特别之处。REUSE 执行器重用 预处理语句。BATCH 执行器重用语句 和批量更新 -->
        <setting name="defaultExecutorType" value="SIMPLE" />
        <!-- 设置超时时间, 它决定驱动等待一个数 据库响应的时间 -->
        <setting name="defaultStatementTimeout" value="100" />
        <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>

typeAliases

　　类型别名是为 Java 类型设置一个短的名字。它只和 XML 配置有关，存在的意义仅在于用来减小类彻底限定名的冗余。有两种方法来指定：

<typeAliases>
  <typeAlias alias="Author" type="domain.blog.Author"/>
  <typeAlias alias="Blog" type="domain.blog.Blog"/>
  <typeAlias alias="Comment" type="domain.blog.Comment"/>
</typeAliases>

　　也能够指定一个包名，MyBatis 会在包名下面搜索须要的 Java Bean对象。

<typeAliases>
    <!--扫描指定包下的全部实体类-->
    <package name="com.gw.facade.account.entity"/>
    <package name="com.gw.facade.account.vo"/>
</typeAliases>

　　通常在没有注解的状况下，会使用 Bean 的首字母小写的非限定类名来做为它的别名。 好比 com.gw.facade.account.entity.Account 的别名为 account；如有注解，则别名为其注解。下面是由注解的状况

@Alias("account")
public class Account {
    ...
}

typeHandlers

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

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

　　能够重写类型处理器或建立你本身的类型处理器来处理不支持的或非标准的类型。 具体作法为：实现 org.apache.ibatis.type.TypeHandler 接口， 或继承一个很便利的类 org.apache.ibatis.type.BaseTypeHandler， 而后能够选择性地将它映射到一个 JDBC 类型。

@MappedTypes(Boolean.class)
@MappedJdbcTypes(JdbcType.SMALLINT)
public class BooleanTypeHandler implements TypeHandler<Boolean>{
    public Object getResult(ResultSet arg0, int arg1) throws SQLException {
        int num = arg0.getInt(arg1);
        Boolean rt = Boolean.FALSE;
        if (num == 1){
            rt = Boolean.TRUE;
        }
        return rt; 
    }
    public Object getResult(ResultSet arg0, String arg1) throws SQLException {
        int num = arg0.getInt(arg1);
        Boolean rt = Boolean.FALSE;
        if (num == 1){
            rt = Boolean.TRUE;
        }
        return rt;
    }
    public Object getResult(CallableStatement arg0, int arg1)
            throws SQLException {
        Boolean b = arg0.getBoolean(arg1);
        return b == true ? 1 : 0;
    }
    public void setParameter(PreparedStatement arg0, int arg1, Boolean arg2,JdbcType arg3) throws SQLException {
        Boolean b = (Boolean) arg2;
        int value = (Boolean) b == true ? 1 : 0;
        arg0.setInt(arg1, value);
    }
}

　　上面代码中能够按照咱们的要求将java的Boolean和jdbc的SMALLINT进行转换，对于这两种数据类型的声明有两种方式：一种是如上在类加上注解进行声明；另外也能够在typeHandler类声明中说明，以下图。

    <typeHandlers>
        <typeHandler javaType="Boolean" jdbcType="SMALLINT" handler="com.gw.common.core.mybatis.BooleanTypeHandler" />
    </typeHandlers>

 插件（plugins）

　　MyBatis 容许你在已映射语句执行过程当中的某一点进行拦截调用。默认状况下，MyBatis 容许使用插件来拦截的方法调用包括：

• Executor (update, query, flushStatements, commit, rollback, getTransaction, close, isClosed)
• ParameterHandler (getParameterObject, setParameters)
• ResultSetHandler (handleResultSets, handleOutputParameters)
• StatementHandler (prepare, parameterize, batch, update, query) 

　　只需实现Interceptor接口同时指明须要拦截的方法签名，并在mybatis的配置文件中声明该签名：

@Intercepts({ @Signature
        (type = Executor.class,
        method = "query",
        args = { MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class }
        )
})
public class ExecutorInterceptor extends AbstractInterceptor {

    public Object intercept(Invocation invocation) throws Throwable {
        return invocation.proceed();
    }
    
    public Object plugin(Object target) {
        return Plugin.wrap(target, this);
    }

    public void setProperties(Properties properties) {
        
    }
}

<!-- mybatis-config.xml配置 -->
<plugins>  
        <plugin interceptor="com.gw.common.core.mybatis.interceptor.ExecutorInterceptor">  
        </plugin>  
</plugins> 

上面的插件将会拦截在Executor实例中全部的‘query’方法。

映射器（mapper）

配置真正执行的SQL语句文件地址，经过<mappers>标签指定路径

<mappers>
        <mapper resource="mybatis/mapper/PaymentRecord.Mapper.xml" />
        <mapper resource="mybatis/mapper/TradeImportRecord.Mapper.xml" />
        <mapper resource="mybatis/mapper/RefundImportRecord.Mapper.xml" />
</mappers>