MyBatis config 文件常用设置

properties

作用 :

引入外部 properties 配置文件的内容

<!-- resource: 引入类路径下的资源文件  -->
<properties resource="db.properties"></properties>

属性:

1. resource: 引入类路径下的资源文件;格式: com/xxx/xxx/xx.properties
2. url: 引入网络路径或者磁盘路径下的资源

官方文档

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>

常用设置:

• mapUnderscoreToCamelCase 是否开启自动驼峰命名规则（camel case）映射
• defaultStatementTimeout 设置超时时间

更多设置项

typeAliases

作用:

类型别名(typeAliases)是为: Java 类型设置一个短的名字。它只和 XML 配置有关，存在的意义仅在于用来减少类完全限定名的冗余。

1. 按类型取别名:

<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>

• 当这样配置时，Blog 可以用在任何使用 domain.blog.Blog 的地方。

1. 按包取别名

<typeAliases>
  <package name="domain.blog"/>
</typeAliases>

说明:

1. 按包取别名的默认名是: 类名小写
2. 当多个包相同类时,可使用 @Alias 注解设置别名来区分

@Alias("author")
public class Author {
    ...
}

注意:

• 别名不区分大小写
• MyBatis 为 Java 类型内建了相应的类型别名. 参考文档

---

environments

<environments default="development">
    <environment id="development">
        <transactionManager type="JDBC"/>
        <dataSource type="POOLED">
            <property name="driver" value="com.mysql.jdbc.Driver"/>
            <property name="url" value="jdbc:mysql:///test"/>
            <property name="username" value="root"/>
            <property name="password" value=""/>
        </dataSource>
    </environment>
</environments>

• environments 可以设置多种环境,例如:开发环境、测试环境、生产环境等
• 每个 SqlSessionFactory 实例只能选择其一.如果想连接两个数据库，就需要创建两个 SqlSessionFactory 实例，每个数据库对应一个。

// environment 获取指定开发环境
SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(reader, environment);

• 如果 environment 省略将加载默认的环境

注意这里的关键点:

• 默认的环境 ID（比如:default=”development”）。
• 每个 environment元素定义的环境ID（比如:id=”development”）。
• 事务管理器的配置（比如:type=”JDBC”）。
• 数据源的配置（比如:type=”POOLED”）。
• Spring + MyBatis，则没有必要配置事务管理器

更多参考

databaseIdProvider

MyBatis 可以根据不同的数据库厂商执行不同的语句，这种多厂商的支持是基于映射语句中的 databaseId 属性。 MyBatis 会加载不带 databaseId 属性和带有匹配当前数据库 databaseId 属性的所有语句。 如果同时找到带有 databaseId 和不带 databaseId 的相同语句，则后者会被舍弃。 为支持多厂商特性只要像下面这样在 mybatis-config.xml 文件中加入 databaseIdProvider 即可：

<databaseIdProvider type="DB_VENDOR" />

这里的 DB_VENDOR 会通过 DatabaseMetaData#getDatabaseProductName() 返回的字符串进行设置。 由于通常情况下这个字符串都非常长而且相同产品的不同版本会返回不同的值，所以最好通过设置属性别名来使其变短，如下：

<databaseIdProvider type="DB_VENDOR">
  <property name="MySQL" value="mysql"/>
  <property name="SQL Server" value="sqlserver"/>
  <property name="DB2" value="db2"/>        
  <property name="Oracle" value="oracle" />
</databaseIdProvider>

在映射文件中使用数据厂商别名

<select id="getEmpById" resultType="com.mybatis.bean.Employee"
        databaseId="mysql">
        select * from employee where id = #{id}
    </select>

---

mappers

• 其用途是注册映射文件

MyBatis 提供以下几种方式配置:
1. resource: 引用类路径下的sql映射文件

<mappers>
  <mapper resource="org/mybatis/builder/AuthorMapper.xml"/>
  <mapper resource="org/mybatis/builder/BlogMapper.xml"/>
  <mapper resource="org/mybatis/builder/PostMapper.xml"/>
</mappers>

• 注意是 / 分割,而不是用 . 分割

---

2.url: 引用网路路径或者磁盘路径下的sql映射文件

<mappers>
  <mapper url="file:///var/mappers/AuthorMapper.xml"/>
  <mapper url="file:///var/mappers/BlogMapper.xml"/>
  <mapper url="file:///var/mappers/PostMapper.xml"/>
</mappers>

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

---

3.使用接口映射

<mappers>
  <mapper class="org.mybatis.builder.AuthorMapper"/>
  <mapper class="org.mybatis.builder.BlogMapper"/>
  <mapper class="org.mybatis.builder.PostMapper"/>
</mappers>

• 注意这里是接口的全类名,用 . 分割
• 映射文件名必须和接口同名,并且放在与接口同一目录下.

也可以在接口上直接写 sql 语句

public interface IStudent {
    @Select("select * from student where id=#{id}")
    Student getStudent(Integer id);
}

• 在接口上直接写 sql 时不需要配置文件

---

4.使用包注册

<mappers>
  <package name="org.mybatis.builder"/>
</mappers>

• 使用包批量注册时,映射文件必须和接口放在一个包中,且名字相同.

---

更多请查阅 MyBatis 中文手册