Mybatis核心配置文件SqlMapConfig.xml详解

一、Mybatis核心配置文件各标签层级关系

image.png

二、properties标签

properties标签是用来加载Mybatis外部属性的标签，该标签用来将内部的配置外在化，即通过外部的配置来动态为内部定义的属性赋值。具体方式如下：

1、使用配置文件加载属性的三种方式

• 使用resource加载相对路径下配置文件中的属性

• 使用url加载绝对路径下配置文件的属性

• 使用property加载属性

2、在配置文件中使用属性

3、在JAVA代码中使用属性

@Test
public void getProperty() throws IOException {
    InputStream resourceAsStream = Resources.getResourceAsStream("SqlConfiguration.xml");
    SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(resourceAsStream);
    Configuration configuration = sqlSessionFactory.getConfiguration();
    Properties properties = configuration.getVariables();
    String property = properties.getProperty("jdbc.driver");
    System.out.printf("jdbc.driver:" + property);
}

4、使用时的注意事项

• resource和url不能同时使用，但是resource和property或者url和property能同时使用。
• 如果同时使用了resource和property或者是url和property，并且两者存在重复的属性，那么以resource或url中的属性为准，因为mybatis在加载配置的属性时，先加载property中的属性，后加载resource或url中的属性，所以在加载后者时，前者的属性就会被覆盖。
• 除了上述在xml文件中配置属性之外，还可以在JAVA代码中为mybatis配置属性，并且这种方式配置的属性优先级最高，也就是说如果配置文件中配置的属性和下面JAVA代码中配置的属性重复了，那么以JAVA代码中配置的属性为准。具体使用如下所示：

@Test
public void getProperty() throws IOException {
    // 创建Properties对象，用来存放属性
    Properties properties = new Properties();
    properties.setProperty("yinyw.mybatisDemo.port","9888");
    // 在mybatis构建SqlSessionFactory时将Properties对象作为参数传入进去
    InputStream resourceAsStream = Resources.getResourceAsStream("SqlConfiguration.xml");
    SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(resourceAsStream,properties);
}

• 属性命名建议：项目名.模块名.属性名。这样做的好处在于易识别。

三、settings标签

settings标签主要用于改变MyBatis运行时的行为。例如开启二级缓存、开启延迟加载等。

1、配置参数如下表所示：

设置名	描述	有效值	默认值
cacheEnabled	全局性地开启或关闭所有映射器配置文件中已配置的任何缓存。	true/false	true
lazyLoadingEnabled	延迟加载的全局开关。当开启时，所有关联对象都会延迟加载。 特定关联关系中可通过设置 fetchType 属性来覆盖该项的开关状态。	true/false	false
aggressiveLazyLoading	开启时，任一方法的调用都会加载该对象的所有延迟加载属性。 否则，每个延迟加载属性会按需加载（参考 lazyLoadTriggerMethods)。	true/false	false （在 3.4.1 及之前的版本中默认为 true）
multipleResultSetsEnabled	是否允许单个语句返回多结果集（需要数据库驱动支持）。	true/false	true
useColumnLabel	使用列标签代替列名。实际表现依赖于数据库驱动，具体可参考数据库驱动的相关文档，或通过对比测试来观察。	true/false	true
useGeneratedKeys	允许 JDBC 支持自动生成主键，需要数据库驱动支持。如果设置为 true，将强制使用自动生成主键。尽管一些数据库驱动不支持此特性，但仍可正常工作（如 Derby）。	true/false	False
autoMappingBehavior	指定 MyBatis 应如何自动映射列到字段或属性。NONE 表示关闭自动映射；PARTIAL 只会自动映射没有定义嵌套结果映射的字段。 FULL 会自动映射任何复杂的结果集（无论是否嵌套）。	NONE/PARTIAL/FULL	PARTIAL
autoMappingUnknownColumnBehavior	指定发现自动映射目标未知列（或未知属性类型）的行为。NONE: 不做任何反应WARNING: 输出警告日志（'org.apache.ibatis.session.AutoMappingUnknownColumnBehavior' 的日志等级必须设置为 WARN）FAILING: 映射失败 (抛出 SqlSessionException)	NONE/WARNING/FAILING	NONE
defaultExecutorType	配置默认的执行器。SIMPLE 就是普通的执行器；REUSE 执行器会重用预处理语句（PreparedStatement）； BATCH 执行器不仅重用语句还会执行批量更新。	SIMPLE/REUSE/BATCH	SIMPLE
defaultStatementTimeout	设置超时时间，它决定数据库驱动等待数据库响应的秒数。	任意正整数	未设置 (null)
defaultFetchSize	为驱动的结果集获取数量（fetchSize）设置一个建议值。此参数只可以在查询设置中被覆盖。	任意正整数	未设置 (null)
defaultResultSetType	指定语句默认的滚动策略。（新增于 3.5.2）	FORWARD_ONLY/SCROLL_SENSITIVE/SCROLL_INSENSITIVE/DEFAULT（等同于未设置）	未设置 (null)
safeRowBoundsEnabled	是否允许在嵌套语句中使用分（RowBounds）。如果允许使用则设置为 false。	true/false	False
safeResultHandlerEnabled	是否允许在嵌套语句中使用结果处理（ResultHandler）。如果允许使用则设置为 false。	true/false	True
mapUnderscoreToCamelCase	是否开启驼峰命名自动映射，即从经典数据库列名 A_COLUMN 映射到经典 Java 属性名 aColumn。	true/false	False
localCacheScope	MyBatis 利用本地缓存机制（Local Cache）防止循环引用和加速重复的嵌套查询。 默认值为 SESSION，会缓存一个会话中执行的所有查询。 若设置值为 STATEMENT，本地缓存将仅用于执行语句，对相同 SqlSession 的不同查询将不会进行缓存。	SESSION/STATEMENT	SESSION
jdbcTypeForNull	当没有为参数指定特定的 JDBC 类型时，空值的默认 JDBC 类型。 某些数据库驱动需要指定列的 JDBC 类型，多数情况直接用一般类型即可，比如 NULL、VARCHAR 或 OTHER。	JdbcType 常量，常用值：NULL、VARCHAR 或 OTHER。	OTHER
lazyLoadTriggerMethods	指定对象的哪些方法触发一次延迟加载。用逗号分隔的方法列表。	equals,clone,hashCode,toString
defaultScriptingLanguage	指定动态 SQL 生成使用的默认脚本语言。 一个类型别名或全限定类名。org.apache.ibatis.scripting.xmltags.XMLLanguageDriver。defaultEnumTypeHandler指定 Enum 使用的默认 TypeHandler 。（新增于 3.4.5）	一个类型别名或全限定类名。	org.apache.ibatis.type.EnumTypeHandler
callSettersOnNulls	指定当结果集中值为 null 的时候是否调用映射对象的 setter（map 对象时为 put）方法，这在依赖于 Map.keySet() 或 null 值进行初始化时比较有用。注意基本类型（int、boolean 等）是不能设置成 null 的。	true/false	false
returnInstanceForEmptyRow	当返回行的所有列都是空时，MyBatis默认返回 null。 当开启这个设置时，MyBatis会返回一个空实例。 请注意，它也适用于嵌套的结果集（如集合或关联）。（新增于 3.4.2）	true/false	false
logPrefix	指定 MyBatis 增加到日志名称的前缀。	任何字符串	未设置
logImpl	指定 MyBatis 所用日志的具体实现，未指定时将自动查找。	SLF4J/LOG4J/LOG4J2/JDK_LOGGING/COMMONS_LOGGING/STDOUT_LOGGING/NO_LOGGING	未设置
proxyFactory	指定 Mybatis 创建可延迟加载对象所用到的代理工具。	CGLIB/JAVASSIST	JAVASSIST （MyBatis 3.3 以上）
vfsImpl	指定 VFS 的实现	自定义 VFS 的实现的类全限定名，以逗号分隔。	未设置
useActualParamName	允许使用方法签名中的名称作为语句参数名称。 为了使用该特性，你的项目必须采用 Java 8 编译，并且加上 -parameters 选项。（新增于 3.4.1）	true/false	true
configurationFactory	指定一个提供 Configuration 实例的类。 这个被返回的 Configuration 实例用来加载被反序列化对象的延迟加载属性值。 这个类必须包含一个签名为static Configuration getConfiguration() 的方法。（新增于 3.2.3）	一个类型别名或完全限定类名。	未设置
shrinkWhitespacesInSql	从SQL中删除多余的空格字符。请注意，这也会影响SQL中的文字字符串。 (新增于 3.5.5)	true/false	false
defaultSqlProviderType	Specifies an sql provider class that holds provider method (Since 3.5.6). This class apply to the type(or value) attribute on sql provider annotation(e.g. @SelectProvider), when these attribute was omitted.	A type alias or fully qualified class name	Not set

2、一份完整的settings配置如下

四、typeAliases标签

typeAliases标签用于为映射配置文件中Java类型的参数和返回值设置一个简短的名字，即设置别名。别名的设置与XML配置相关，其使用的意义在于减少全限定类名的冗余。

1、mybatis默认支持的别名

别名	映射的类型
_byte	byte
_long	long
_short	short
_int	int
_integer	int
_double	double
_float	float
_boolean	boolean
string	String
byte	Byte
long	Long
short	Short
int	Integer
integer	Integer
double	Double
float	Float
boolean	Boolean
date	Date
decimal	BigDecimal
bigdecimal	BigDecimal
object	Object
map	Map
hashmap	HashMap
list	List
arraylist	ArrayList
collection	Collection
iterator	Iterator

2、自定义别名的两种方式

• 使用typeAlias为单个的JAVA实体类定义别名，type属性为JAVA实体类的全路径，alias为该实体类的别名。如果不写alias属性则默认为首字母小写的JAVA实体类名。

• 使用package批量为某个路径下的JAVA实体类定义别名，该路径下所有JAVA实体类的别名为首字母小写的JAVA实体类名。

3、在映射文件中使用别名

    
    
        INSERT INTO member (account,password,username) VALUES(#{account},#{password},#{username})
    
    
    
        DELETE FROM member WHERE ID = #{id}
    

    
        UPDATE member SET account = #{account} , password = #{password} , username = #{username}
    

    
        SELECT id,account,password,username FROM member WHERE id = #{id}
    
    

五、typeHandlers标签

六、objectFactory标签

七、plugins标签

八、environments标签

environments标签用于对Mybatis使用的环境进行配置，环境配置实际上就是数据源的配置。MyBatis支持配置多个环境。例如，开发、测试和生产环境需要有不同的配置；或者想在具有相同 Schema 的多个生产数据库中使用相同的 SQL 映射。还有许多类似的使用场景在此就不一一例数了。虽然mybatis支持配置多个环境，但是在使用时还是需要我们为mybatis指明使用哪个环境，如果没有指明使用哪个环境，mybatis就会使用我们配置的默认环境。

1、配置environments

2、使用environments，下面是mybatis源码中SqlSessionFactoryBuilder创建SqlSessionFactory提供的方法，我们通过调用下面的方法可以使用指定的环境或者是使用默认的环境

public class SqlSessionFactoryBuilder {
    public SqlSessionFactoryBuilder() {
    }

    // 使用默认的环境
    public SqlSessionFactory build(Reader reader) {
        return this.build((Reader)reader, (String)null, (Properties)null);
    }

    // 使用参数environment指定的环境
    public SqlSessionFactory build(Reader reader, String environment) {
        return this.build((Reader)reader, environment, (Properties)null);
    }

    // 使用默认的环境
    public SqlSessionFactory build(Reader reader, Properties properties) {
        return this.build((Reader)reader, (String)null, properties);
    }

    // 使用参数environment指定的环境
    public SqlSessionFactory build(Reader reader, String environment, Properties properties) {
        SqlSessionFactory var5;
        try {
            XMLConfigBuilder parser = new XMLConfigBuilder(reader, environment, properties);
            var5 = this.build(parser.parse());
        } catch (Exception var14) {
            throw ExceptionFactory.wrapException("Error building SqlSession.", var14);
        } finally {
            ErrorContext.instance().reset();

            try {
                reader.close();
            } catch (IOException var13) {
            }

        }

        return var5;
    }

    // 使用默认的环境
    public SqlSessionFactory build(InputStream inputStream) {
        return this.build((InputStream)inputStream, (String)null, (Properties)null);
    }

    // 使用参数environment指定的环境
    public SqlSessionFactory build(InputStream inputStream, String environment) {
        return this.build((InputStream)inputStream, environment, (Properties)null);
    }

    // 使用默认的环境
    public SqlSessionFactory build(InputStream inputStream, Properties properties) {
        return this.build((InputStream)inputStream, (String)null, properties);
    }

    // 使用参数environment指定的环境
    public SqlSessionFactory build(InputStream inputStream, String environment, Properties properties) {
        SqlSessionFactory var5;
        try {
            XMLConfigBuilder parser = new XMLConfigBuilder(inputStream, environment, properties);
            var5 = this.build(parser.parse());
        } catch (Exception var14) {
            throw ExceptionFactory.wrapException("Error building SqlSession.", var14);
        } finally {
            ErrorContext.instance().reset();

            try {
                inputStream.close();
            } catch (IOException var13) {
            }

        }

        return var5;
    }

    public SqlSessionFactory build(Configuration config) {
        return new DefaultSqlSessionFactory(config);
    }
}

3、transactionManager

transactionManager标签通过type属性来配置使用哪种事务管理器来管理Mybatis事务。type属性支持如下两种属性值：

• JDBC：这个配置就是直接使用了JDBC 的提交和回滚设置，它依赖于从数据源得到的连接来管理事务作用域。配置方式如下：

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

4、dataSource

dataSource标签通过type属性来配置Mybatis如何连接数据库。type属性支持如下三种属性值：

• UNPOOLED：这个数据源的实现只是每次被请求时打开和关闭连接。配置方式如下：

• POOLED：这种数据源的实现利用“池”的概念将 JDBC 连接对象组织起来。配置方式如下：

• JNDI：这个数据源的实现是为了能在如 EJB 或应用服务器这类容器中使用，容器可以集中或在外部配置数据源，然后放置一个 JNDI 上下文的引用。配置方式如下:

九、databaseIdProvider标签

databaseIdProvider标签为MyBatis支持多厂商SQL语句的执行提供支持。MyBatis 可以根据不同的数据库厂商执行不同的语句，这种多厂商的支持是基于映射语句中的 databaseId 属性。 MyBatis 会加载不带 databaseId 属性和带有匹配当前数据库 databaseId 属性的所有语句。如果同时找到带有 databaseId 和不带 databaseId 的相同语句，则后者会被舍弃。 配置方式如下：

• 在核心配置文件中配置数据库厂商标志

• 在映射语句中添加数据库厂商标志

    
        SELECT id,account,password,username FROM member WHERE id = #{id}
    

    
        SELECT id,account,password,username FROM member WHERE id = #{id}
    
    

十、mappers标签

mappers标签用于指定MyBatis映射文件的位置。mappers有如下四种配置方式：

• 如果使用xml方式配置的映射，可以使用相对路径来一个一个的指定映射文件的位置

• 如果使用xml方式配置的映射，也可以使用绝对路径来一个一个的指定映射文件的位置

• 如果使用注解方式配置的映射，则可以使用接口类的全路径来一个一个的指定映射文件的位置

• 不论使用xml还是注解的方式，都可以使用package来批量指定映射文件的路径