XML映射配置

╰半橙微兮° 2022-09-27 15:19 175阅读 0赞

configuration  配置

1.properties属性

2.settings属性

3.typeAliases类型命名

4.typeHandler类型处理器

5.objectFactory对象工厂

6.plugins 插件

7.environments环境

7.1environment环境变量

7.1.1transactionManager事务管理器

7.1.2dataSource数据源

8.映射器mappers

# 1.properties #

这些是外部化的，可替代的属性，这些属性也可以配置在典型的 Java 属性配置文件中，或者通过  properties 元素的子元素来传递。

这个例子中的 username 和 password  将会由 properties 元素中设置的值来替换。 driver  和url 属性将会从包含进来的配置文件中的值来替换。

SqlSessionFactory factory =sqlSessionFactoryBuilder.build(reader, props);
    
    SqlSessionFactory factory =sqlSessionFactoryBuilder.build(reader, environment, props);

上面这种方式， MyBatis  按照如下的顺序加载它们：  
1.在 properties 元素体内指定的属性首先被读取。  
2.从类路径下资源或  properties 元素的  url 属性中加载的属性第二被读取，它会覆盖已经存在的完全一样的属性。  
3.作为方法参数传递的属性最后被读取，它也会覆盖任一已经存在的完全一样的属性，这些属性可能是从 properties  元素体内和资源/url  属性中加载的。  
  因此，最高优先级的属性是那些作为方法参数的，然后是资源/url  属性，最后是 properties元素中指定的属性

# 2.settings #

这些是极其重要的调整，它们会修改 MyBatis 在运行时的行为方式。

![Center][]

# 3.typeAliases #

类型别名是为 Java 类型命名一个短的名字。它只和  XML  配置有关，只用来减少类完全限定名的多余部分。

# 4.typeHandler #

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

![Center 1][]

你可以重写类型处理器或创建你自己的类型处理器来处理不支持的或非标准的类型。要这样做的话，简单实现 TypeHandler  接口（ org.mybatis.type），然后映射新的类型处理器类到Java 类型，还有可选的一个  JDBC 类型。

public class ExampleTypeHandler implements TypeHandler {
       public void setParameter(PreparedStatement ps, int i, Objectparameter,JdbcType jdbcType) throws SQLException {
            ps.setString(i, (String) parameter);
       }
       public Object getResult(ResultSet rs, String columnName)throws SQLException {
            return rs.getString(columnName);
       }
       public Object getResult(CallableStatement cs, int columnIndex)throws SQLException {
            return cs.getString(columnIndex);
       }
    }
    // MapperConfig.xml
    <typeHandlers>
       <typeHandler javaType="String" jdbcType="VARCHAR" handler="org.mybatis.example.ExampleTypeHandler"/>
    </typeHandlers>

# 5.objectFactory #

MyBatis 每次创建结果对象新的实例时，它使用一个  ObjectFactory 实例来完成。如果参数映射存在，默认的  ObjectFactory 不比使用默认构造方法或带参数的构造方法实例化目标类做的工作多。

// 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);
       }
    }
    // MapperConfig.xml
    <objectFactory type="org.mybatis.example.ExampleObjectFactory">
          <property name="someProperty" value="100"/>
    </objectFactory>

ObjectFactory 接口非常简单。它包含两个用于创建的方法，一个是默认构造方法，另外一个是处理带参数的构造方法。最终setProperties 方法可以被用来配置  ObjectFactory。在初始化你的  ObjectFactory实例后，objectFactory元素体中定义的属性会被传递给 setProperties方法。

# 6.plugins #

MyBatis 允许你在某一点拦截已映射语句执行的调用。

// ExamplePlugin.java
    @Intercepts({@Signature(type= Executor.class,method = "update",args = {MappedStatement.class,Object.class})})
    public class ExamplePlugin implements Interceptor {
       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) {
       }
    }
    // MapperConfig.xml
    <plugins>
       <plugin interceptor="org.mybatis.example.ExamplePlugin">
          <property name="someProperty" value="100"/>
       </plugin>
    </plugins>

# 7.environments #

MyBatis 可以配置多种环境。这会帮助你将  SQL  映射应用于多种数据库之中。

## 7.1transactionManager ##

**JDBC** – 这个配置直接简单使用了  JDBC  的提交和回滚设置。它依赖于从数据源得到的连接来管理事务范围。

**MANAGED** –  这个配置几乎没做什么。它从来不提交或回滚一个连接。而它会让容器来管理事务的整个生命周期（比如  Spring 或  JEE 应用服务器的上下文）。默认情况下它会关闭连接。然而一些容器并不希望这样，因此如果你需要从连接中停止它，将 closeConnection  属性设置为 false。

# 7.2dataSource #

type有三种属性：

1.**UNPOOLED** – 这个数据源的实现是每次被请求时简单打开和关闭连接。它只有一下类型：

**driver** –  这是 JDBC  驱动的 Java  类的完全限定名  
**url** –  这是数据库的 JDBC URL  地址。  
**username** –  登录数据库的用户名。  
**password** –  登录数据库的密码。  
**defaultTransactionIsolationLevel** – 默认的连接事务隔离级别。

2.**POOLED** –  这是 JDBC  连接对象的数据源连接池的实现，用来避免创建新的连接实例时必要的初始连接和认证时间。它除了上面的一些属性还有一些配置连接池的属性。

**poolMaximumActiveConnections –** 在任意时间存在的活动（也就是正在使用）连接的数量。默认值：  10  
**poolMaximumIdleConnections –** 任意时间存在的空闲连接数。  
**poolMaximumCheckoutTime –** 在被强制返回之前， 池中连接被检查的时间。默认值：  20000 毫秒（也就是  20 秒）  
**poolTimeToWait –** 这是给连接池一个打印日志状态机会的低层次设置，还有重新尝试获得连接，这些情况下往往需要很长时间（为了避免连接池没有配置时静默失败）。默认值： 20000 毫秒（也就是 20 秒）

**poolPingQuery –** 发送到数据的侦测查询，用来验证连接是否正常工作，并且准备接受请求。默认是“  NO PING QUERY SET”，这会引起许多数据库驱动连接由一个错误信息而导致失败。

**poolPingEnabled** –  这是开启或禁用侦测查询。如果开启，你必须用一个合法的SQL  语句（最好是很快速的）设置 poolPingQuery  属性。默认值： false。  
**poolPingConnectionsNotUsedFor** –  这是用来配置 poolPingQuery  多次时间被用一次。这可以被设置匹配标准的数据库连接超时时间，来避免不必要的侦测。默认值：0  
  
3.**JNDI** – 这个数据源的实现是为了使用如  Spring 或应用服务器这类的容器，容器可以集中或在外部配置数据源，然后放置一个  JNDI 上下文的引用。只有两种属性：

**initial\_context –** 这个属性用来从初始上下文中寻找环境（也就是initialContext.lookup（ initial——context））。这是个可选属性，如果被忽略，那么data\_source 属性将会直接以  initialContext 为背景再次寻找。

**data\_source –** 这是引用数据源实例位置的上下文的路径。它会以由  initial\_context查询返回的环境为背景来查找，如果  initial\_context 没有返回结果时，直接以初始上下文为环境来查找。  
  
8.mappers

// 使用相对于类路径的资源
    <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/sqlmaps/AuthorMapper.xml"/>
       <mapper url="file:///var/sqlmaps/BlogMapper.xml"/>
       <mapper url="file:///var/sqlmaps/PostMapper.xml"/>
    </mappers>

[Center]: /images/20220708/c9eb33c78f2c452782df66314e2f647c.png
[Center 1]: /images/20220708/b92cfc82c7ab4dc3baa822f6c9f3e8df.png