Mybatis实战之 Settings

桃扇骨 2022-06-04 08:24 227阅读 0赞

## **Mybatis实战 之 Settings** ##

本章节我们将详细学习Mybatis 的全局配置文件。

--------------------

## **实例** ##

*  Mybatis 配置文件模板参考地址(中文版的)：[MybatisConfig.xml][]
 *  配置结构：
    
     *  configuration：全局配置标签
        
         *  properties(属性配置，连接数据库的配置)  
            连接数据库的配置可以使静态的也可以是动态的。
            
             *  static Connection
                
                    <properties resource="org/mybatis/example/config.properties">
                      <property name="username" value="dev_user"/>
                      <property name="password" value="F2Fa3!33TYyg"/>
                    </properties>
             *  dynamic Connnection(一般结合连接池使用，且配置了基本的dbConfig.properties)  
                
                
                    <properties resource="org/mybatis/example/config.properties">
                      <property name="username" value="${username}"/>
                      <property name="password" value="${password}"/>
                    </properties>
         *  settings(常规设置)
            
            这是 MyBatis 中极为重要的调整设置，它们会改变 MyBatis 的运行时行为。下表描述了设置中各项的意图、默认值等。
            
                <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="autoMappingUnknownColumnBehavior" value="WARNING"/>
                  <setting name="defaultExecutorType" value="SIMPLE"/>
                  <setting name="defaultStatementTimeout" value="25"/>
                  <setting name="defaultFetchSize" 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(POJO 类型别名设置)
            
            类型别名是为 Java 类型设置一个短的名字。它只和 XML 配置有关，存在的意义仅在于用来减少类完全限定名的冗余。
            
             *  常规设置(为每一个POJO 设置一个别名以便Mapper.xml 文件引用)
                
                    <typeAliases>
                      <typeAlias alias="Author" type="domain.blog.Author"/>
                      <typeAlias alias="Blog" type="domain.blog.Blog"/>
                      <typeAlias alias="Comment" type="domain.blog.Comment"/>
                      <typeAlias alias="Post" type="domain.blog.Post"/>
                      <typeAlias alias="Section" type="domain.blog.Section"/>
                      <typeAlias alias="Tag" type="domain.blog.Tag"/>
                    </typeAliases>
             *  也可以指定一个包名，MyBatis 会在包名下面搜索需要的 Java Bean
                
                    <typeAliases>
                      <package name="com.sstps.vo"/>
                    </typeAliases>
                
                此时com.sstps.vo包下的每一个实体类都将获得一个属于各自的实体别名即各自类名(第一个字母小写的规则)
             *  在JAVA 代码中知名实体别名(**需要使用@Alias注解**)
                
                    @Alias("author")
                    public class Author {
                        ...
                    }
         *  typeHandlers(类型处理器设置)  
            无论是 MyBatis 在预处理语句（PreparedStatement）中设置一个参数时，还是从结果集中取出一个值时， 都会用类型处理器将获取的值以合适的方式转换成 Java 类型。
            
            通过类型处理器的泛型，MyBatis 可以得知该类型处理器处理的 Java 类型，不过这种行为可以通过两种方法改变。
            
             *  在类型处理器的配置元素（typeHandler element）上增加一个 javaType 属性（比如：javaType=”String”）
             *  在类型处理器的类上（TypeHandler class）增加一个 @MappedTypes 注解来指定与其关联的 Java 类型列表。 如果在 javaType 属性中也同时指定，则注解方式将被忽略
            
            可以通过两种方式来指定被关联的 JDBC 类型：
            
             *  在类型处理器的配置元素上增加一个 jdbcType 属性（比如：jdbcType=”VARCHAR”）
             *  在类型处理器的类上（TypeHandler class）增加一个 @MappedJdbcTypes 注解来指定与其关联的 JDBC 类型列表。 如果在 jdbcType 属性中也同时指定，则注解方式将被忽略。
         *  objectFactory(对象工厂设置)
            
            MyBatis 每次创建结果对象的新实例时，它都会使用一个对象工厂（ObjectFactory）实例来完成。 默认的对象工厂需要做的仅仅是实例化目标类，要么通过默认构造方法，要么在参数映射存在的时候通过参数构造方法来实例化。 如果想覆盖对象工厂的默认行为，则可以通过创建自己的对象工厂来实现
            
             *  JAVA 代码
                
                    // ExampleObjectFactory.java
                    public class ExampleObjectFactory extends DefaultObjectFactory { 
                      public Object create(Class type) {
                        return super.create(type);
                      }
                      public Object create(Class type, List<Class> constructorArgTypes, List<Object> constructorArgs) {
                        return super.create(type, constructorArgTypes, constructorArgs);
                      }
                      public void setProperties(Properties properties) {
                        super.setProperties(properties);
                      }
                      public <T> boolean isCollection(Class<T> type) {
                        return Collection.class.isAssignableFrom(type);
                      }}
             *  配置信息
                
                    
                    <objectFactory type="org.mybatis.example.ExampleObjectFactory">
                      <property name="someProperty" value="100"/>
                    </objectFactory>
                
                ObjectFactory 接口很简单，它包含两个创建用的方法，一个是处理默认构造方法的，另外一个是处理带参数的构造方法的。 最后，setProperties 方法可以被用来配置 ObjectFactory，在初始化你的 ObjectFactory 实例后， objectFactory 元素体中定义的属性会被传递给 setProperties 方法。
         *  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 的核心模块。 这些都是更低层的类和方法，所以使用插件的时候要特别当心。
             *  例子使用PageHelper 分页插件的设置
                
                    <plugins>
                        <plugin interceptor="com.github.pagehelper.PageInterceptor">
                            
                            <property name="reasonable" value="true"/>
                        </plugin>
                    </plugins>
         *  environments(自定义环境设置)
            
                <environments default="Intergration_ENV">
                    <environment id="Intergration_ENV">
                        <transactionManager type="JDBC"></transactionManager>
                        <dataSource type="UNPOOLED">
                            <property name="driver" value="${driver}" />
                            <property name="url" value="${url}" />
                            <property name="username" value="${username}" />
                            <property name="password" value="${password}" />
                        </dataSource>
                    </environment>
                
                    <environment id="UAT_ENV">
                        <transactionManager type="JDBC"></transactionManager>
                        <dataSource type="POOLED">
                            <property name="driver" value="${driver}" />
                            <property name="url" value="${url}" />
                            <property name="username" value="${username}" />
                            <property name="password" value="${password}" />
                            <property name="poolMaximumActiveConnections " value="${poolMaximumActiveConnections }"/>
                            <property name="poolMaximumIdleConnections" value="${poolMaximumIdleConnections}"/>
                            <property name="poolMaximumCheckoutTime" value="${poolMaximumCheckoutTime}"/>
                            <property name="poolPingEnabled" value="${poolPingEnabled }"/>
                        </dataSource>
                    </environment>
                
                    <environment id="Trunk_ENV">
                        <transactionManager type="JDBC"></transactionManager>
                        <dataSource type="JNDI">
                            <property name="initial_context" value="${initial_context}" />
                            <property name="data_source" value="data_source" />
                        </dataSource>
                    </environment>
                </environments>
            
             *  environment(环境)
                
                Mybatis 支持多数据库连接的设置，但是用的时候只能使用一个。例如我们在environments中配置了Mysql和Oracle两种数据库的连接配置，使用时通过使用 **default=”development”** 属性来设置指定使用那一个数据库连接配置。
                
                 *  transactionManager (事务处理器)  
                    在 MyBatis 中有两种类型的事务管理器:
                    
                     *  JDBC – 这个配置就是直接使用了 JDBC 的提交和回滚设置，它依赖于从数据源得到的连接来管理事务作用域。
                     *  MANAGED – 这个配置几乎没做什么。它从来不提交或回滚一个连接，而是让容器来管理事务的整个生命周期（比如 JEE 应用服务器的上下文）。 默认情况下它会关闭连接，然而一些容器并不希望这样，因此需要将 closeConnection 属性设置为 false 来阻止它默认的关闭行为
                    
                    如果你正在使用 Spring + MyBatis，则没有必要配置事务管理器， 因为Spring已高度封装了事务(比如基于代码的事务、基于注解的事务、基于配置的事务，它们会自动地切入数据源以达到事务控制的目的)
                 *  dataSource(数据源设置)
                    
                    dataSource 元素使用标准的 JDBC 数据源接口来配置 JDBC 连接对象的资源，Mybatis 提供并支持一下三种内建的数据源类型：
                    
                     *  UNPOOLED  
                        这个数据源的实现只是每次被请求时打开和关闭连接。虽然一点慢，它对在及时可用连接方面没有性能要求的简单应用程序是一个很好的选择。 不同的数据库在这方面表现也是不一样的，所以对某些数据库来说使用连接池并不重要，这个配置也是理想的。UNPOOLED 类型的数据源仅仅需要配置以下 5 种属性：
                        
                         *  driver: 这是 JDBC 驱动的 Java 类的完全限定名（并不是JDBC驱动中可能包含的数据源类）如com.mysql.jdbc.Driver
                         *  url: 这是数据库的 JDBC URL 地址
                         *  username: 登录数据库的用户名
                         *  password: 登录数据库的密码
                         *  defaultTransactionIsolationLevel:默认的连接事务隔离级别
                     *  POOLED: 这种数据源的实现利用“池”的概念将 JDBC 连接对象组织起来，避免了创建新的连接实例时所必需的初始化和认证时间。 这是一种使得并发 Web 应用快速响应请求的流行处理方式。除了上述提到 UNPOOLED 下的属性外，会有更多属性用来配置 POOLED 的数据源。
                        
                         *  poolMaximumActiveConnections – 在任意时间可以存在的活动（也就是正在使用）连接数量，默认值：10
                         *  poolMaximumIdleConnections – 任意时间可能存在的空闲连接数。
                         *  poolMaximumCheckoutTime – 在被强制返回之前，池中连接被检出（checked out）时间，默认值：20000 毫秒（即 20 秒）
                         *  poolTimeToWait – 这是一个底层设置，如果获取连接花费的相当长的时间，它会给连接池打印状态日志并重新尝试获取一个连接（避免在误配置的情况下一直安静的失败），默认值：20000 毫秒（即 20 秒）。
                         *  poolMaximumLocalBadConnectionTolerance – 这是一个关于坏连接容忍度的底层设置， 作用于每一个尝试从缓存池获取连接的线程. 如果这个线程获取到的是一个坏的连接，那么这个数据源允许这 个线程尝试重新获取一个新的连接，但是这个重新尝试的次数不应该超过
                         *  poolMaximumIdleConnections 与 poolMaximumLocalBadConnectionTolerance 之和。 默认值：3 (Since: 3.4.5)
                         *  poolPingQuery – 发送到数据库的侦测查询，用来检验连接是否处在正常工作秩序中并准备接受请求。默认是“NO PING QUERY SET”，这会导致多数数据库驱动失败时带有一个恰当的错误消息。
                         *  poolPingEnabled – 是否启用侦测查询。若开启，也必须使用一个可执行的 SQL 语句设置 poolPingQuery 属性（最好是一个非常快的 SQL），默认值：false。
                         *  poolPingConnectionsNotUsedFor – 配置 poolPingQuery 的使用频度。这可以被设置成匹配具体的数据库连接超时时间，来避免不必要的侦测，默认值：0（即所有连接每一时刻都被侦测 — 当然仅当 poolPingEnabled 为 true 时适用）。
                     *  JNDI：这个数据源的实现是为了能在如 EJB 或应用服务器这类容器中使用，容器可以集中或在外部配置数据源，然后放置一个 JNDI 上下文的引用。这种数据源配置只需要两个属性：
                        
                         *  initial\_context – 这个属性用来在 InitialContext 中寻找上下文（即，initialContext.lookup(initial\_context)）。这是个可选属性，如果忽略，那么 data\_source 属性将会直接从 InitialContext 中寻找。
                         *  data\_source – 这是引用数据源实例位置的上下文的路径。提供了 initial\_context 配置时会在其返回的上下文中进行查找，没有提供时则直接在 InitialContext 中查找。
         *  databaseIdProvider(数据库厂商标识)
            
            MyBatis 可以根据不同的数据库厂商执行不同的语句，这种多厂商的支持是基于映射语句中的 databaseId 属性。 MyBatis 会加载不带 databaseId 属性和带有匹配当前数据库 databaseId 属性的所有语句。 如果同时找到带有 databaseId 和不带 databaseId 的相同语句，则后者会被舍弃。 为支持多厂商特性只要像下面这样在 mybatis-config.xml 文件中加入 databaseIdProvider 即可：
            
                <databaseIdProvider type="DB_VENDOR">
                  <property name="SQL Server" value="sqlserver"/>
                  <property name="DB2" value="db2"/>        
                  <property name="Oracle" value="oracle" />
                </databaseIdProvider>
            
            指明或者配置了数据库厂商之后，我们在执行SQL的时候可以选择性的执行，比如如果当前使用的是Mysql，则执行Mysql sql,如果是Oracle则执行 Oracle SQL。
            
                <insert id="addEmps" databaseId="oracle">
                        insert into employees(
                            
                            <include refid="insertColumn">
                                <property name="testColomn" value="abc"/>
                            </include>
                        )
                                <foreach collection="emps" item="emp" separator="union" open="select employees_seq.nextval,lastName,email from(" close=")">
                                    select #{emp.lastName} lastName,#{emp.email} email from dual
                                </foreach>
                     </insert>
                       <sql id="insertColumn">
                            <if test="_databaseId=='oracle'">
                                employee_id,last_name,email
                            </if>
                            <if test="_databaseId=='mysql'">
                                last_name,email,gender,d_id
                            </if>
                      </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>
             *  完全限定资源定位符
                
                    <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>
             *  使用接口包(把所有的Mapper接口放在一个包下面)
                
                    <mappers>
                      <package name="org.mybatis.builder"/>
                    </mappers>
                
                **当然如果你的项目中使用可Spring的话，Mapper文件的查找会有更加优雅的配置方式，后续会详解。**

--------------------

## **小结** ##

*  如果使用的时Spring 作为Framework，我们可以将以上设置交由Spring管理，因而很多配置都将不必要配置。
 *  如果不使用管理那么请参照官方文档配置。
 *  各个配置项之间是由先后顺序的，如果顺序不符将会Mybatis报错。

[MybatisConfig.xml]: http://www.mybatis.org/mybatis-3/zh/configuration.html