Mybatis全局配置文件

配置properties

可以在全局配置文件中配置properties标签来进行外部配置

设置属性的方式有三种

• 在properties的属性节点resource或url所指定的资源文件中配置
• 在properties的子节点property中配置
• 在构建SqlSessionFactory时通过方法传入参数

外部配置文件引入

jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/test
jdbc.username=root
jdbc.password=123456

<!-- 使用 properties来引入外部配置文件内容-->
<!-- resource  引入类路径下的资源
     url  引入网路或磁盘路径下的资源
 -->
<properties resource="jdbc.properties">
</properties>
<!-- 数据库配置 -->
<environments default="development">
    <environment id="development">
        <transactionManager type="JDBC"/>
        <dataSource type="POOLED">
            <property name="driver" value="${jdbc.driver}"/>
            <property name="url" value="${jdbc.url}"/>
            <property name="username" value="${jdbc.username}"/>
            <property name="password" value="${jdbc.password}"/>
        </dataSource>
    </environment>
</environments>

property子节点配置

<!-- 也可以使用property子节点来进行配置 -->
<properties resource="jdbc.properties">
    <property name="jdbc.password" value="123456"/>
    <!-- 启用默认值特性 -->
    <property name="org.apache.ibatis.parsing.PropertyParser.enable-default-value" value="true"/>
    <!-- 修改默认值的分隔符 -->
    <property name="org.apache.ibatis.parsing.PropertyParser.default-value-separator" value="?:"/>
</properties>
<!-- 数据库配置 -->
<environments default="development">
    <environment id="development">
        <transactionManager type="JDBC"/>
        <dataSource type="POOLED">
            <property name="driver" value="${jdbc.driver}"/>
            <property name="url" value="${jdbc.url}"/>
            <property name="username" value="${jdbc.username}"/>
            <!-- 可以使用:来为占位符设置默认值，如果没有读取到该属性的值，会使用该默认值
             该特性默认关闭，需要配置        <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="password" value="${jdbc.password?:123456}"/>
        </dataSource>
    </environment>
</environments>

实例化时方法传参

public static SqlSessionFactory createFactory(){
    // 获取到mybatis-config.xml配置文件，进而构建SqlSessionFactory
    InputStream is = Thread.currentThread().getContextClassLoader().getResourceAsStream("mybatis-config.xml");
    Properties props = new Properties();
    props.put("jdbc.password","123456");
    return new SqlSessionFactoryBuilder().build(is,props);
}

三种方式的顺序

• 首先读取property子节点中指定的属性
• 再读取使用resources或url引入的外部配置文件中属性，并覆盖之前的同名属性
• 最后读取作为方法传递的参数，并覆盖之前的同名属性

配置settings

进行mybatis的自定义设置

配置typeAliases类型别名

类型别名可以为java类型设置别名，之后使用全类名时可以使用别名

<typeAliases>
    <!-- typeAlias为某个类起别名 -->
    <typeAlias type="com.zhanghe.study.mybatis.model.User" alias="User"/>

    <!-- 为某个包下所有类批量起别名
        默认值为类名首字母小写
     -->
    <package name="com.zhanghe.study.mybatis.model"/>
</typeAliases>

也可以在类上使用@Alias注解来设置该类的别名

配置类型处理器typeHandlers

数据库类型和java类型进行转换

实现 org.apache.ibatis.type.TypeHandler 接口， 或继承 org.apache.ibatis.type.BaseTypeHandler， 并且可以将它映射到一个 JDBC 类型

@MappedJdbcTypes(JdbcType.VARCHAR)
public class ExampleTypeHandler extends BaseTypeHandler<String> {

  @Override
  public void setNonNullParameter(PreparedStatement ps, int i, String parameter, JdbcType jdbcType) throws SQLException {
    ps.setString(i, parameter);
  }

  @Override
  public String getNullableResult(ResultSet rs, String columnName) throws SQLException {
    return rs.getString(columnName);
  }

  @Override
  public String getNullableResult(ResultSet rs, int columnIndex) throws SQLException {
    return rs.getString(columnIndex);
  }

  @Override
  public String getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {
    return cs.getString(columnIndex);
  }
}

<typeHandlers>
  <typeHandler handler="org.mybatis.example.ExampleTypeHandler"/>
</typeHandlers>

配置插件plugins

mybatis可以使用插件来在映射语句执行过程中的某一点进行拦截调用，包括

• Executor (update、query、flushStatements、commit、rollback、getTransaction、close、isClose)
• ParameterHandler (getParameterObject、setParameters)
• ResultSetHandler (handleResultSets、handleOutputParameters)
• StatementHandler (prepare、parameterize、batch、update、query)

需要实现Interceptor接口，并指定想要拦截的方法签名来使用插件

Intercepts({@Signature(
  type= Executor.class,
  method = "update",
  args = {MappedStatement.class,Object.class})})
public class ExamplePlugin implements Interceptor {
  private Properties properties = new Properties();
  public Object intercept(Invocation invocation) throws Throwable {
    // implement pre processing if need
    Object returnObject = invocation.proceed();
    // implement post processing if need
    return returnObject;
  }
  public void setProperties(Properties properties) {
    this.properties = properties;
  }
}

<plugins>
  <plugin interceptor="org.mybatis.example.ExamplePlugin">
    <property name="someProperty" value="100"/>
  </plugin>
</plugins>

注意：如果有多个插件拦截相同方法的时候，会按照配置的先后顺序来进行包装代理，在执行时会执行最外层的插件，也就是逆向执行

配置环境environments

mybatis可以配置多个环境，可以连接多个数据库，但是每个SqlSessionFactory实例只可以选择一种环境

在构建sqlSessionFactory的时候可以指定选择创建哪个环境

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

<!-- 环境 default表示默认使用环境  -->
<environments default="development">
    <environment id="development">
        <!-- 事务管理器有两种类型
            1、JDBC  该配置直接使用了JDBC的提交和回滚，依赖从数据源获得的连接来管理事务作用域
            2、MANAGED 使用容器来管理事务的整个生命周期(spring会使用自带的管理器，不需要配置mybatis的事务管理器)
         -->
        <transactionManager type="JDBC"/>
        <!-- 数据源有三种类型
            1、UNPOOLED  每次请求时打开和关闭连接
                额外属性  - defaultTransactionIsolationLevel  默认的连接事务隔离级别
                         - defaultNetworkTimeout  等待数据库操作完成的默认网络超时时间
            2、POOLED  利用连接池的概念将JDBC连接对象组织起来，避免了创建新的连接实例
                额外属性
                    - poolMaximumActiveConnections 在任意时间可存在的活动连接数，默认10
                    - poolMaximumIdleConnections  任意时间可能存在的空闲连接数
                    - poolMaximumCheckoutTime  在被强制返回之前，池中连接被检出时间，默认20000毫秒
                    - poolTimeToWait  如果获取连接花费了很长的时间，连接池会打印状态日志并重新尝试获取一个连接，默认20000毫秒
                    - poolMaximumLocalBadConnectionTolerance  如果一个线程获取到一个坏的连接，数据源允许这个线程尝试重新获取一个新的连接，
                                                              尝试次数不应该超过poolMaximumIdleConnections与poolMaximumLocalBadConnectionTolerance之和，默认为3
                    - poolPingQuery  发送到数据库的侦测查询，用来检验连接是否正常工作   默认 NO PING QUERY SET
                    - poolPingEnabled  是否启用侦测查询  默认false
                    - poolPingConnectionsNotUsedFor  配置poolPingQuery的频率(可以设置为和数据库连接超时时间一样，避免不必要的侦测)  默认0
            3、JNDI  在外部配置数据源，然后一个JNDI上下文数据源引用
                额外属性
                    - initial_context  用来在InitialContext中寻找上下文
                    - data_source  引用数据源实例的上下文路径
         -->
        <dataSource type="POOLED">
            <property name="driver" value="${jdbc.driver}"/>
            <property name="url" value="${jdbc.url}"/>
            <property name="username" value="${jdbc.username}"/>
            <!-- 可以使用:来为占位符设置默认值，如果没有读取到该属性的值，会使用该默认值
             该特性默认关闭，需要配置        <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="password" value="${jdbc.password?:123456}"/>
        </dataSource>
    </environment>

也可以实现org.apache.ibatis.datasource.DataSourceFactory接口来自定义数据源实现，然后进行配置

配置数据库厂商标识 databaseIdProvider

mybatis可以根据不同的数据库厂商执行不同的语句，基于映射语句中的databaseId属性。mybatis会加载带有匹配当前数据库databaseId属性个所有不带databaseId属性的语句。如果同时找到带有databaseId的不带databaseId的相同语句，后者会被舍弃

<!-- 数据库厂商标识 -->
<databaseIdProvider type="DB_VENDOR">
  <!-- name为使用DatabaseMetaData#getDatabaseProductName()返回的厂商名称
             value为所设置的别名,使用databaseId时使用别名即可 -->
  <property name="MySQL" value="mysql"/>
  <property name="Oracle" value="oracle"/>
</databaseIdProvider>

在mapper.xml中可以配置不同数据库的sql语句

<!-- 查询数据的方法 -->
<!-- mysql -->
<select id="selectUser" resultType="User" databaseId="mysql">
    select * from users where id = #{id}
</select>
<!-- oracle -->
<select id="selectUser" resultType="User" databaseId="oracle">
    select * from users where id = #{id}
</select>

可以实现org.apache.ibatis.mapping.DatabaseIdProvider接口自定义DatabaseIdProvider

配置映射器mappers

将写好的sql映射文件(mapper.xml)注册到全局配置文件中

<!-- mapper配置 -->
<mappers>
    <!-- resource  引入类路径下的资源  -->
    <mapper resource="mapper/UserMapper.xml"/>
    <!-- url  引入网络或者磁盘路径下的sql映射文件 -->
    <mapper url=""/>
    <!-- class  基于注解的方式，注册类文件 -->
    <mapper class="com.zhanghe.study.mybatis.mapper.UserMapper"/>
    <!-- 批量注册 注册整个包下的-->
    <package name="com.zhanghe.study.mybatis.mapper"/>
</mappers>