526互联

MyBatis 核心组件 —— Configuration

发布时间 2023-08-01 16:01:52作者: 低吟不作语

概述

Mybatis 的核心组件如下所示：

  • Configuration：用于描述 MyBatis 的主配置信息，其他组件需要获取配置信息时，直接通过 Configuration 对象获取。除此之外，MyBatis 在应用启动时，将 Mapper 配置信息、类型别名、TypeHandler 等注册到 Configuration 组件中，其他组件需要这些信息时，也可以从 Configuration 对象中获取
  • MappedStatement：用于描述 Mapper 中的 SQL 配置信息，是对 Mapper XML 配置文件中 <select|update|delete|insert> 等标签或者 @Select/@Update 等注解配置信息的封装
  • SqlSession：是 MyBatis 提供的面向用户的 API，表示和数据库交互时的会话对象，用于完成数据库的增删改查功能。SqlSession 是 Executor 组件的外观，目的是对外提供易于理解和使用的数据库操作接口
  • Executor：MyBatis 的 SQL 执行器，MyBatis 对数据库所有的增删改查操作都是由 Executor 组件完成的
  • StatementHandler：封装了对 JDBC Statement 对象的操作，比如为 Statement 对象设置参数，调用 Statement 接口提供的方法与数据库交互等等
  • ParameterHandler：当 MyBatis 框架使用的 Statement 类型为 CallableStatcment 和 PreparedStatement 时，ParamelerHandler 用于为 Statement 对象参数占位符设置值
  • ResultSetHandler：ResultSetHandler 封装了对 JDBC 的 ResultSet 对象操作，当执行 SQL 类型为 SELECT 语句时，ResultSetHandler 用于将查询结果转换成 Java 对象
  • TypeHandler：TypeHandler 是 MyBatis 中的类型处理器，用于处理 Java 类型与 JDBC 类型之间的映射，它的作用主要体现在能够根据 Java 类型调用 PreparedStatement 或 CallableStatement 对象对应的 set 方法为 Statement 对象设置值，而且能够根据 Java 类型调用 ResultSet 对象对应的 get 获取SQL执行结果

在使用 MyBatis 时，我们使用到 SqlSession 组件，它是用户层面的 API。实际上 SqlSession 是Executor 组件的外观，目的是为用户提供更友好的数据库操作接口，这是设计模式中外观模式的典型应用。真正执行 SQL 操作的是 Executor 组件，Executor 可以理解为 SQL 执行器，它会使用 StatementHandler 组件对 JDBC 的 Statement 对象进行操作。当 Statement 类型为 CallableStatement 和 PreparedStatement 时，会通过 ParameterHandler 组件为参数占位符赋值。ParameterHandler 组件中会根据 Java 类型找到对应的 TypeHandler 对象，TypeHandler 会通过 Statement 对象提供的set 方法为 Statement 对象中的参数占位符设置值。StatementHandler 组件使用 JDBC 中的 Statement 对象与数据库完成交互后，当 SQL 语句类型为 SELECT 时，MyBatis 通过 ResultSetHandler 组件从 Statement 对象中获取 ResultSet 对象，然后将 ResultSet 对象转换为 Java 对象


Configuration

MyBatis 框架的配置信息有两种，一种是配置 MyBatis 框架属性的主配置文件；另一种是配置执行 SQL 语句的 Mapper 配置文件。Configuration 的作用是描述 MyBatis 主配置文件的信息。Configuration 类中定义了一系列的属性用来控制MyBatis 运行时的行为，这些属性代码如下：

public class Configuration {
	protected boolean safeRowBoundsEnabled;
	protected boolean safeResultHandlerEnabled = true;
	protected boolean mapUnderscoreToCamelCase;
	protected boolean aggressivelazyLoading;
	protected boolean multipleResultSetsEnabled = true;
	protected boolean useGeneratedKeys;
	protected boolean useColumnLabel = true;
	.......
}

这些属性的值可以在MyBatis主配置文件中通过 <setting> 标签指定，例如：

<settings>
	<setting name="cacheEnabled" value="true"/>
	<setting name="lazyLoadingEnabled" value="true"/>
</settings>

所有属性的作用及配置说明参考如下：

  • cacheEnabled：是否开启 Mapper 缓存，即二级缓存，默认 true
  • lazyLoadingEnabled：延迟加载的全局开关。当开启时，所有关联对象都会延迟加载。特定关联关系中可通过设置 fetchType 属性来覆盖该项的开关状态，默认 false
  • aggressiveLazyLoading：当开启时，任何方法的调用都会加载该对象的所有属性。否则，每个属性会按需加载，默认 false，3.4.1 之前默认为 true
  • multipleResultSetsEnabled：是否允许单一语句返回多结果集，默认 true
  • useColumnLabel：使用列标签代替列名，不同的驱动在这方面会有不同的表现，默认 true
  • useGeneratedKeys：允许 JDBC 支持自动生成主键，需要驱动兼容。如果设置为 true，则这个设置强制使用自动生成主键，尽管一些驱动不能兼容，但仍可正常工作，默认 false
  • autoMappingBehavior：指定 MyBatis 应该如何自动映射列到 Java 实体属性。NONE 表示取消自动映射，PARTIAL 只会自动映射没有定义嵌套结果集映射的结果集。FULL 会自动映射任意复杂的结果集（无论是否嵌套），默认 PARTIAL
  • autoMappingUnknownColumnBehavior：指定发现自动映射目标未知列（或者未知属性）的行为。NONE：不做任何反应，WARNING：输出提醒日志，FAILING：映射失败，抛出异常，默认 NONE
  • defaultExecutorType：配置默认的 Executor 类型，SIMPLE 就是普通的 Executor；REUSE 会复用 Statement 对象；BATCH 会批量执行所有更新语句，默认 SIMPLE
  • defaultStatementTimeout：设置超时时间，它决定驱动等待数据库响应的秒数，可以说任意正整数，默认为 null 未设置
  • defaultFetchSize：默认的 FetchSize，用于设置 Statement 对象的 fetchSize 属性，用于限制从数据库中获取数据的最大行数，默认为 null 未设置
  • SafeRowBoundsEnabled：允许在嵌套语句中使用分页（RowBounds），如果允许使用，则设置为 false，默认 false
  • safeResultHandlerEnabled：允许在嵌套语句中使用分页（ResultHandler），如果允许使用，则设置为 false，默认 false
  • mapUnderscoreToCamelCase：是否开启自动驼峰命名规则映射，即从经典数据库列名 A_COLUMN 到经典 Java 属性名 aColumn 的映射
  • localCacheScope：MyBatis 利用本地缓存机制防止循环引用和加速重复查询。默认值为 SESSION，这种情况下会缓存个会话中执行的所有查询。若设置值为 STATEMENT，本地会话仅用在语句执行上，对相同 SqlSession 的不同调用将不会共享数据
  • jdbcTypeForNuIl：当没有为参数指定 JDBC 类型时，指定 JDBC 类型的值为null。一些驱动需要指定 JDBC 类型，多数情况下直接用一般类型即可，比如 NULL、VARCHAR 或 OTHER，默认 OTHER
  • lazyLoadTriggerMethods：指定哪个对象的方法会触发一次延迟加载，参数是用逗号分割的方法列表
  • defaultScriptingLanguage：指定动态 SQL 生成的默认语言，参数值为一个类型别名或完全限定类名，默认值：org.apache.ibatis.XMLLanguageDriver
  • defaultEnumTypeHandler：指定 Java 枚举类型使用的默认 TypeHandler，默认值：org.apache.ibatis.type.EnumTypeHandler
  • callSettersOnNulls：指定当结果集中的值为 null 的时候是否调用映射对象的Setter方法，这对于有 Map.keySet() 依赖或 null 值初始化的时候是有用的。注意基本类型（int、boolean 等）是不能设置成 null 的，默认 false
  • returnInstanceForEmptyRow：当返回行的所有列都是空时，MyBatis 默认返回null。当开启这个设置时，MyBatis 会返回一个空实例。请注意，也适用于嵌套的结果集（collection、association），默认 false
  • logPrefix：指定 MyBatis 增加到日志名称的前缀，默认未设置
  • loglmpl：指定MyBatis 所用日志的具体实现，未指定时将自动查找，可设置 SLF4J、LOG4J等，默认未设置
  • proxyFactory：指定MyBatis 创建具有延迟加载能力的对象所用到的代理工具，可选值有 JAVASSIST、CGLIB，默认 JAVASSIST
  • vfsImpl：指定 VFS 的实现，参数我 VFS 的实现类的全限定名，以逗号分隔，默认未设置

Configuration 除了提供上面的属性控制 MyBatis 的行为外，还作为容器存放 TypeHandler（类型处理器）、TypeAlias（类型别名）、Mapper 接口及 MapperSQL 配置信息。这些信息在 MyBatis 框架启动时注册到 Configuration 组件中。Configuration 类通过下面的属性保存 TypeHandler、TypeAlias 等信息：

protected final MapperRegistry mapperRegistry = new MapperRegistry(this);
protected final InterceptorChain interceptorChain = new InterceptorChain();
protected final TypeHandlerRegistry typeHandlerRegistry = new TypeHandlerRegistry();
protected final TypeAliasRegistry typeAliasRegistry= new TypeAliasRegistry();
protected final LanguageDriverRegistry languageRegistry = new LanguageDriverRegistry();
protected final Map<String, MappedStatement> mappedStatements = new StrictMap<MappedStatement>("Mapped Statements collection");
protected final Map<String, Cache> caches = new StrictMap<Cache>("Caches collection");
protected final Map<String, ResultMap> resultMaps = new StrictMap<ResultMap>("Result Maps collection");
protected final Map<String, ParameterMap> parameterMaps = new StrictMap<ParameterMap>("Parameter Maps collection");
protected final Map<String, KeyGenerator> keyGenerators = new StrictMap<KeyGenerator>("Key Generators collection");
protected final Set<String> loadedResources = new HashSet<String>();
protected final Map<String, XNode> sqlFragments = new StrictMap<XNode>("XML fragments parsed from previous mappers");
protected final Collection<XMLStatementBuilder> incompleteStatements = new LinkedList<XMLStatementBuilder>();
protected final Collection<CacheRefResolver> incompletecacheRefs = new LinkedList<CacheRefResolver>()
protected final Collection<ResultMapResolver> incompleteResultMaps = new LinkedList<ResultMapResolver>();
protected final Collection<MethodResolver> incompleteMethods = new LinkedList<MethodResolver>();
protected final Map<String, String> cacheRefMap = new HashMap<String, String>();

这些属性的含义如下：

  • mapperRegistry：用于注册 Mapper 接口信息，建立 Mapper 接口的 Class 对象和 MapperProxyFactory 对象之间的关系，其中 MapperProxyFactory 对象用于创建 Mapper 动态代理对象
  • interceptorChain：用于注册 MyBatis 插件信息，MyBatis 插件实际上就是一个拦截器
  • typeHandlerRegistry：用于注册所有的 TypeHandler，并建立 Jdbc 类型、JDBC 类型与 TypeHandler 之间的对应关系
  • typeAliasRegistry：用于注册所有的类型别名
  • languageRegistry：用于注册 LanguageDriver，LanguageDriver 用于解析 SQL 配置，将配置信息转换为 SqlSource 对象
  • mappedStatements：MappedStatement 对象描述 <insert|selectlupdateldelete> 等标签或者通过 @Select|@Delete|@Update|@Insert 等注解配置的 SQL 信息。MyBatis 将所有的 MappedStatement 对象注册到该属性中，其中 Key 为 Mapper 的 Id， Value 为 MappedStatement 对象
  • caches：用于注册 Mapper 中配置的所有缓存信息，其中 Key 为 Cache 的 id，也就是 Mapper 的命名空间，Value 为 Cache 对象
  • resultMaps：用于注册 Mapper 配置文件中通过 标签配置的 ResultMap 信息，ResultMap 用于建立 Java 实体属性与数据库字段之间的映射关系，其中 Key 为 ResultMap 的 id，该 id 是由 Mapper 命名空间和 标签的 id 属性组成的，Value 为解析 标签后得到的 ResultMap 对象
  • parameterMaps：用于注册 Mapper 中通过 标签注册的参数映射信息。Key 为 ParameterMap 的 id，由 Mapper 命名空间和 标签的 id 属性构成，Value 为解析 标签后得到的 ParameterMap 对象
  • keyGenerators：用于注册 KeyGenerator，KeyGenerator 是 MyBatis 的主键生成器，MyBatis 提供了三种KeyGenerator，即 Jdbc3KeyGenerator(数据库自增主键）、NoKeyGenerator（无自增主键)、SelectKeyGenerator（通过 select 语句查询自增主键，例如 oracle 的 sequence）
  • loadedResources：用于注册所有 Mapper XML 配置文件路径
  • sqlFragments：用于注册 Mapper 中通过 标签配置的 SQL 片段，Key 为 SQL 片段的 id，Value 为 MyBatis 封装的表示 XML 节点的 XNode 对象
  • incompleteStatements：用于注册解析出现异常的 XMLStatementBuilder 对象
  • incompleteCacheRefs：用于注册解析出现异常的 CacheRefResolver 对象
  • incompleteResultMaps：用于注册解析出现异常的 ResultMapResolver 对象
  • incompleteMethods：用于注册解析出现异常的 MethodResolver 对象

MyBatis 框架启动时，会对所有的配置信息进行解析，然后将解析后的内容注册到 Configuration 对象的这些属性中。除此之外，Configuration 组件还作为 Executor、StatementHandler、ResultSetHandler、ParameterHandler 组件的工厂类，用于创建这些组件的实例。