MyBatis XML 配置

XML 配置

xml 核心配置文件中设置了 MyBatis 的各种核心配置，对 MyBatis 的行为有很大影响，本节为常用的一些配置项

properties（属性）

就像字面意思一样，properties 包含很多属性信息，这些属性可以在整个配置文件中替代相应的值，设置属性有三种方法：

1. 导入 Java 配置文件

   • config.properties

     driver = com.mysql.jdbc.Driver
     url = jdbc:mysql://localhost:3306/mybatis_study?useSSL=false&useUnicode=true&characterEncoding=UTF-8
     name = root
     password = 123456
     

   • XML 配置

     <properties resource="config.properties"/>
     

2. 在子元素中设置

   <properties resource="config.properties">
       <property name="name" value="root"/>
   </properties>
   

3. 通过 SqlSessionFactoryBuilder 设置

   Properties properties = new Properties();
   properties.setProperty("password", "123456");
   sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream,properties);
   

这些方法可以相互补充，为配置增加了多种选择

加载顺序

Mybatis 在加载属性时按照 子元素 --> 配置文件 --> 方法 的顺序加载，后加载的属性值会覆盖前面的同名属性，也就是说当出现同名元素时，三种加载方式的优先级如下：

1. 通过方法加载的属性有最高的优先级
2. 通过 resource 导入的配置文件次之
3. 子元素的优先级最低

使用属性

加载的属性可以通过${}的方式调用，例如

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

还可以在调用时设置一个默认值，如果没有设置对应的属性就使用默认值

<property name="username" value="${name:root}"/> <!--如果没有name属性就使用root-->

默认值功能默认关闭，想要开启需要添加一个特定的属性

<property name="org.apache.ibatis.parsing.PropertyParser.enable-default-value" value="true"/> <!-- 启用默认值特性 -->

开启默认值功能后:就被视为属性值和默认值的分隔符，如果属性名中含有:字符，就会出现问题，此时就需要修改默认的分隔符：

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

此时调用默认值的写法就是：

<property name="username" value="${name?:root}"/> 

typeAliases（类型别名）

在前面的 XML 映射配置中，使用到实体类时都需要写出它的全限定名，如resultType="com.kk.pojo.User"，而通过 typeAliases 可以为这些 Java 类设置缩写，降低 XML 文件的冗余

<typeAliases>
    <typeAlias type="com.kk.pojo.User" alias="user"/>
</typeAliases>

UserMapper：

<mapper namespace="com.kk.mapper.UserMapper">
    <select id="selectById" resultType="user">
        select * from user where id = #{id}
    </select>
</mapper>

需要注意 typeAliases 不区分大小写，也就是说 resultType="uSEr" 这样的写法一样可以，当然不建议这么做，通常使用类名首字母小写的形式作为别名

除了单独设置类的别名，还可以通过指定一个包来设置别名：

<typeAliases>
    <package name="com.kk.pojo"/>
</typeAliases>

Mybatis 将会搜索这个包下的 Java Bean，并默认使用这个 Bean 首字母小写的形式作为别名，如果需要手动设置，可以在 Bean 上增加注解，如：

@Alias("usr")
public class User {
    private int id;
    private String name;
    private String password;
    .....
}

Java 内置类型的别名

Java 中内置的引用类型别名与自身相同，同样，不区分大小写，如List的别名是list，Double的别名是double。因为几个包装类的别名和基本类型的名字一样，为了避免重复，基本数据类型的别名是它们的名字前面加上一个下划线(_)，如 byte 的别名是 _byte。

其中比较特别的是别名 int 和 integer 都对应 Integer 类型，而 _int 和_integer 都对应 int 类型，以及 decimal 和 bigdecimal 都对应 BigDecimal 类型

environments（环境配置）

环境配置可以设置多套环境，通过 default 指定默认环境，通过 id 确定唯一的环境，如

<environments default="development"> <!--指定当前默认环境为development-->
    <environment id="development">   <!--指定环境id为development-->
        ......
    </environment>
</environments>

一套环境包括事务管理器（transactionManager）和数据源（dataSource）

事务管理器

MyBatis 有两种事务管理器，JDBC 和 MANAGED，通常使用 JDBC

• JDBC：使用 JDBC 的提交和回滚机制，依赖从数据源获得的连接来管理事务作用域。

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

  <transactionManager type="MANAGED">
    <property name="closeConnection" value="false"/>
  </transactionManager>
  

数据源（dataSource）

dataSource 元素使用标准的 JDBC 数据源接口来配置 JDBC 连接对象的资源。

MyBatis 包含三种内置的数据源

• UNPOOLED
• POOLED
• JNDI

通常使用 POOLED 即可，一个简单的数据源配置需要包含：

• driver：数据库驱动的全限定名
• url：数据库 JDBC 的 url 地址
• username：登录数据库的用户名
• password：登录数据库的密码

更多配置见官网mybatis – MyBatis 3 | 配置

映射器（mapper）

为了告诉 MyBatis 映射文件的位置，所有的映射文件都应该在 mapper 中注册，注册的方式很多

1. 相对于配置类的路径

   <mappers>
       <mapper resource="com/kk/mapper/UserMapper.xml"/>
   </mappers>
   

2. 统一资源定位

   <mappers>
       <mapper url="file:///D:\MyBatis-Study\code\mybatis-02\src\main\resources\com\kk\mapper\UserMapper.xml"/>
   </mappers>
   

3. 映射接口的全类名

   <mappers>
       <mapper class="com.kk.mapper.UserMapper"/>
   </mappers>
   

   注意： 如果使用这种方法，编译后接口的 class 文件和对应的 xml 映射文件一定要在同一个文件夹，否则 MyBatis 无法找到对应的资源

4. 通过包名

   <mappers>
       <package name="com.kk.mapper"/>
   </mappers>
   

   将整个包中的所有映射器接口实现全部注册为映射器，和第 3 种方式一样，接口的 class 文件和对应的 xml 映射文件一定要在同一个文件夹