标签：总结 false 映射 设置 MyBatis true 属性

MyBatis主配置文件

MyBatis的配置文件包含了会深深影响MyBatis行为的设置和属性信息。

文档类型定义(dtd)：http://mybatis.org/dtd/mybatis-3-config.dtd

配置文档的顶层结构：

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

属性(properties)

可以再三个位置进行属性的配置：

• properties中的字标签properties中的属性name和value进行设置

  <properties>
      <properties name="username" value="root"></properties>
  </properties>
  

• 引入外部的properties的属性文件，通过properties中的属性resource进行配置，后续使用通过"${等号左侧内容}"进行设置

  <properties resource="xxx.properties">
      <properties name="username" value="root"></properties>
  </properties>
  

• 也可以在SqlSessionFactoryBuilder().builder()方法中传入属性值。

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

属性加载顺序：

1. 首先读取在properties标签内部的property标签中的属性值；
2. 然后根据properties元素中的resource属性读取类路径下属性文件，或根据url属性指定的路径读取属性文件，并覆盖之前读取过得同名属性；
3. 最后读取作为方法参数传递的属性，并覆盖之前读取过的同名属性。

可以为占位符指定一个默认值：

<dataSource type="POOLED">
    <property name="username" value="${username:root}"/>
    <!-- 如果属性username没有被配置，username的属性值将为root -->
</dataSource>

这个特性是默认关闭的，要启用这个特性，需要添加一个特定的属性来开启这个特性。

<properties resource="xxx.properties">
	<property name="org.apache.ibatis.parsing.PropertyParser.enable-default-value" value="true"></property>
</properties>

但是当你在属性名中使用:时或者使用三元运算符时，就需要设置特定的属性来修改分割属性名和默认值的字符，以消除两者之间的冲突。

<properties resource="xxx.properties">
	<property name="org.apache.ibatis.parsing.PropertyParse.default-value-separator" value="?:"/>
    <!-- 修改默认值的分隔符 -->
</properties>

<dataSource type="POOLED">
    <property name="username" value="${username?:root}"/>
    <!-- 如果属性username没有被配置，username的属性值将为root -->
</dataSource>

设置(settings)

这是MyBatis中极为重要的调整设置，他们会改变MyBatis的运行时行为。

设置名	描述	有效值	默认值
cacheEnabled	全局性地开启或关闭所有映射器配置文件中已配置的任何缓存。	true | false	true
lazyLoadingEnabled	延迟加载的全局开关。当开启时，所有关联对象都会延迟加载。 特定关联关系中可通过设置 fetchType 属性来覆盖该项的开关状态。	true | false	false
aggressiveLazyLoading	开启时，任一方法的调用都会加载该对象的所有延迟加载属性。 否则，每个延迟加载属性会按需加载（参考 lazyLoadTriggerMethods)。	true | false	false （在 3.4.1 及之前的版本中默认为 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
autoMappingUnknownColumnBehavior	指定发现自动映射目标未知列（或未知属性类型）的行为。NONE: 不做任何反应WARNING: 输出警告日志（'org.apache.ibatis.session.AutoMappingUnknownColumnBehavior' 的日志等级必须设置为 WARN）FAILING: 映射失败 (抛出 SqlSessionException)	NONE, WARNING, FAILING	NONE
defaultExecutorType	配置默认的执行器。SIMPLE 就是普通的执行器；REUSE 执行器会重用预处理语句（PreparedStatement）； BATCH 执行器不仅重用语句还会执行批量更新。	SIMPLE REUSE BATCH	SIMPLE
defaultStatementTimeout	设置超时时间，它决定数据库驱动等待数据库响应的秒数。	任意正整数	未设置 (null)
defaultFetchSize	为驱动的结果集获取数量（fetchSize）设置一个建议值。此参数只可以在查询设置中被覆盖。	任意正整数	未设置 (null)
defaultResultSetType	指定语句默认的滚动策略。（新增于 3.5.2）	FORWARD_ONLY | SCROLL_SENSITIVE | SCROLL_INSENSITIVE | DEFAULT（等同于未设置）	未设置 (null)
safeRowBoundsEnabled	是否允许在嵌套语句中使用分页（RowBounds）。如果允许使用则设置为 false。	true | false	False
safeResultHandlerEnabled	是否允许在嵌套语句中使用结果处理器（ResultHandler）。如果允许使用则设置为 false。	true | false	True
mapUnderscoreToCamelCase	是否开启驼峰命名自动映射，即从经典数据库列名 A_COLUMN 映射到经典 Java 属性名 aColumn。	true | false	False
localCacheScope	MyBatis 利用本地缓存机制（Local Cache）防止循环引用和加速重复的嵌套查询。 默认值为 SESSION，会缓存一个会话中执行的所有查询。 若设置值为 STATEMENT，本地缓存将仅用于执行语句，对相同 SqlSession 的不同查询将不会进行缓存。	SESSION | STATEMENT	SESSION
jdbcTypeForNull	当没有为参数指定特定的 JDBC 类型时，空值的默认 JDBC 类型。 某些数据库驱动需要指定列的 JDBC 类型，多数情况直接用一般类型即可，比如 NULL、VARCHAR 或 OTHER。	JdbcType 常量，常用值：NULL、VARCHAR 或 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会返回一个空实例。 请注意，它也适用于嵌套的结果集（如集合或关联）。（新增于 3.4.2）	true | false	false
logPrefix	指定 MyBatis 增加到日志名称的前缀。	任何字符串	未设置
logImpl	指定 MyBatis 所用日志的具体实现，未指定时将自动查找。	SLF4J | LOG4J(deprecated since 3.5.9) | LOG4J2 | JDK_LOGGING | COMMONS_LOGGING | STDOUT_LOGGING | NO_LOGGING	未设置
proxyFactory	指定 Mybatis 创建可延迟加载对象所用到的代理工具。	CGLIB | JAVASSIST	JAVASSIST （MyBatis 3.3 以上）
vfsImpl	指定 VFS 的实现	自定义 VFS 的实现的类全限定名，以逗号分隔。	未设置
useActualParamName	允许使用方法签名中的名称作为语句参数名称。 为了使用该特性，你的项目必须采用 Java 8 编译，并且加上 -parameters 选项。（新增于 3.4.1）	true | false	true
configurationFactory	指定一个提供 Configuration 实例的类。 这个被返回的 Configuration 实例用来加载被反序列化对象的延迟加载属性值。 这个类必须包含一个签名为static Configuration getConfiguration() 的方法。（新增于 3.2.3）	一个类型别名或完全限定类名。	未设置
shrinkWhitespacesInSql	从SQL中删除多余的空格字符。请注意，这也会影响SQL中的文字字符串。 (新增于 3.5.5)	true | false	false
defaultSqlProviderType	Specifies an sql provider class that holds provider method (Since 3.5.6). This class apply to the type(or value) attribute on sql provider annotation(e.g. @SelectProvider), when these attribute was omitted.	A type alias or fully qualified class name	Not set
nullableOnForEach	Specifies the default value of 'nullable' attribute on 'foreach' tag. (Since 3.5.9)	true | false	false

<settings>
	<setting name="cacheEnabled" value="true"></setting>\
    <!-- …… -->
</settings>

类型别名(typeAliases)

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

<typeAliases>
	<typeAliase alias="Author" type="com.wang.model.Author"></typeAliase>
</typeAliases>

当这样配置时，Author可以用在任何使用com.wang.model.Author的地方。

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

<typeAliases>
	<package name="com.wang.model"></package>
</typeAliases>

每一个在包com.wang.model中的Java Bean，在没有注解的情况下，会使用Bean的首字母小写的非全限定类名来作为它的别名。比如：com.wang.model.TestMyBatis的别名为testMyBatis;若有注解，则别名为其注解值。

@Alias("test")
public class TestMyBatis{
    ...
}

环境配置(environments)

MyBatis可以配置成适应多种环境，该方式有助于将SQL映射应用于多种数据库之中。例如：开发、测试和生产环节需要有不同的配置；或者想在具有相同Schema的多个生产数据库中使用相同的SQL映射。

不过需要注意的是：尽管可以配置多个环境，但每个SqlSessionFactory实例只能选择一种环境。每个数据库对应一个SqlSessionFactory实例。

可以通过传递相关参数给SqlSessionFactoryBuilder来完成环境的指定。

SqlSessionFactory factory = new SqlSessionFactoryBuilder(reader[,environment,properties]);
// 如果忽略了环境变量的配置，那么将会加载默认的环境。

也可以在environments变迁中配置环境

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

一些注意点：

• 默认使用的环境ID(比如：default="development")
• 每一个environment元素定义的环境ID(比如：id="development")
• 事务管理器的配置(transactionManager) (后续介绍)
• 数据源的配置(type="POOLED") (后续介绍)

事务管理器(TransactionManager):

在MyBatis中有两种类型的事务管理器(type="JDBC"或者type="MANAGED")

• JDBC--->这个配置直接使用了JDBC的提交和回滚设施，它依赖从数据源获得的连接来管理事务作用域。

• MANAGED--->这个配置几乎没做什么。它从不提交或回滚一个连接，而是让容器来管理事务的整个生命周期，默认情况下他回关闭连接。然而一些容器并不希望连接被关闭，因此需要将closeConnection属性设置为false来阻止默认的关闭行为。

如果你在使用Spring+MyBatis，则没有必要配置事务管理器，因为SP日那个模块会使用自带的管理器来覆盖前面的配置。

数据源(dataSource):

一共有三种可选UNPOOLED,POOLED,JNDI

1. UNPOOLED

   该数据源的实现会每次请求时打开和关闭连接。虽然有点慢，但对于数据库连接可用性要求不高的简单应用程序来说，是一个很好地选择。

2. POOLED

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

3. JNDI

org.apache.ibatis.datasource.unpooled.UnpooledDataSourceFactory可用作父类来构建新的数据源适配器。下面例子为Druid连接池的配置。

1. 引入Druid连接池的依赖

   <dependency>
       <groupId>com.alibaba</groupId>
       <artifactId>druid</artifactId>
       <version>1.1.10</version>
   </dependency>
   

2. 继承UnpooledDataSourceFactory，无参构造方法中将dataSource改为DruidDataSource

   public class DruidSourceFactory extends UnpooledDataSourceFactory {
       public DruidSourceFactory() {
           this.dataSource = new DruidDataSource();
       }
   
       /**
       @Override
       public DataSource getDataSource() {
   
           try {
               ((DruidDataSource) this.dataSource).init();
           } catch (SQLException e) {
               e.printStackTrace();
           }
   
           return this.dataSource;
       }
       **/
   }
   

   网上有一个方法是重写getDataSource，我想着是它认为new DruidDataSource();后没有将配置文件中的内容写入，所以调用init方法，进行初始化。但是在得到DruidDataSource的对象时，会调用有参构造方法，有参构造方法中又将配置文件中的写入，所以不需要重写。

3. <dataSource type="com.wang.dataSourceFactory.DruidSourceFactory">
       <property name="driverClass" value="${driver}"/>
       <property name="jdbcUrl" value="${url}"/>
       <property name="username" value="${username}"/>
       <property name="password" value="${password}"/>
   </dataSource>
   

映射器(mappers)

告诉MyBatis到哪里去找SQL映射语句。

• 使用相对于类路径的资源引用

  <mappers>
  	<mapper resource="xxxMapper.xml"></mapper>
  </mappers>
  

• 使用完全限定资源定位符

  <mappers>
  	<mapper url="file:///xx/xxxMapper.xml"></mapper>
  </mappers>
  

• 使用映射器接口实现类的完全限定类名

  <mappers>
  	<mapper class="xxxMapper"></mapper>
  </mappers>
  

• 将包内的映射器接口实现全部注册为映射器

  <mappers>
  	<mapper name="com.wang.mappers"></mapper>
  </mappers>
  

XML映射文件

字符串替换(# $)

#{} -> preparedStatement , 安全，快速，首选

${} -> Statement 慢。不安全，不进行转义，容易产生sql注入的问题。

参数

通过@Param("xxx")指定指定某个参数在进行字符串替换时怎么使用，没有@Param("")时，字符串替换可以为arg0,arg1...或者param1,param2...

结果映射（resultMap）

• constructor

  用于在实例化类时，注入结果到构造方法中

  • idArg - ID 参数；标记出作为 ID 的结果可以帮助提高整体性能
  • arg - 将被注入到构造方法的一个普通结果

• id – 一个 ID 结果；标记出作为 ID 的结果可以帮助提高整体性能

• result – 注入到字段或 JavaBean 属性的普通结果

• association一个复杂类型的关联；许多结果将包装成这种类型

  • 嵌套结果映射 – 关联可以是 resultMap 元素，或是对其它结果映射的引用

• collection 一个复杂类型的集合

  • 嵌套结果映射 – 集合可以是 resultMap 元素，或是对其它结果映射的引用

• discriminator 使用结果值来决定使用哪个resultMap

  • case 基于某些值的结果映射
    • 嵌套结果映射 – case 也是一个结果映射，因此具有相同的结构和元素；或者引用其它的结果映射

缓存

MyBatis 一级缓存、二级缓存全详解(一)

MyBatis 二级缓存全详解

标签：总结,false,映射,设置,MyBatis,true,属性
来源： https://www.cnblogs.com/chixinwang/p/15937740.html

本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享；
2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关；
3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关；
4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除；
5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。