大家都知道,利用 Spring 整合 MyBatis,我们可以直接利用 @MapperScan 注解或者 @Mapper 注解,让 Spring 可以扫描全部的 Mapper 接口,解析然后加载。那么如果抛开 Spring,你们可知道 MyBatis 是如何解析和加载 Mapper 接口的?
如果不知道的话,可以跟着我这篇文章,一步一步地深入和解读源码,带你从底层来看通 MyBatis 解析加载 Mapper 的实现原理。
在解读源码之前,我们很有必要先了解 MyBatis 几大核心组件,知道他们都是做什么用的。
核心组件有:Configuration、SqlSession、Executor、StatementHandler、ParameterHandler、ResultSethandler。
下面简单介绍一下他们:
SqlSession组件,它是用户层面的API。用户可利用 SqlSession 获取想要的 Mapper 对象(MapperProxy 代理对象);当执行 Mapper 的方法,MapperProxy 会创建对应的 MapperMetohd,然后 MapperMethod 底层其实是利用 SqlSession 来执行 SQL。
但是真正执行 SQL 操作的应该是 Executor组 件,Executor 可以理解为 SQL 执行器,它会使用 StatementHandler 组件对 JDBC 的 Statement 对象进行操作。当 Statement 类型为 CallableStatement 和 PreparedStatement 时,会通过 ParameterHandler 组件为参数占位符赋值。
ParameterHandler 组件中会根据 Java 类型找到对应的 TypeHandler 对象,TypeHandler 中会通过 Statement 对象提供的 setXXX() 方法(例如setString()方法)为 Statement 对象中的参数占位符设置值。
StatementHandler 组件使用 JDBC 中的 Statement 对象与数据库完成交互后,当 SQL 语句类型为 SELECT 时,MyBatis 通过 ResultSetHandler 组件从 Statement 对象中获取 ResultSet 对象,然后将 ResultSet 对象转换为 Java 对象。
我们可以用一幅图来描述上面各个核心组件之间的关系:
下面我将带着一个非常简单的 Mapper 使用例子来讲解底层的流程和原理。
例子很简单,首先是获取 MyBatis 的主配置文件的文件输入流,然后创建 SqlSessinoFactory,接着利用 SqlSessionFactory 创建 SqlSessin;然后利用 SqlSession 获取要使用的 Mapper 代理对象,最后执行 Mapper 的方法获取结果。
@Test
public void testMybatis () throws IOException {
// 获取配置文件输入流
InputStream inputStream = Resources.getResourceAsStream("mybatis-config.xml");
// 通过SqlSessionFactoryBuilder的build()方法创建SqlSessionFactory实例
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
// 调用openSession()方法创建SqlSession实例
SqlSession sqlSession = sqlSessionFactory.openSession();
// 获取UserMapper代理对象
UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
// 执行Mapper方法,获取执行结果
List<UserEntity> userList = userMapper.listAllUser();
System.out.println(JSON.toJSONString(userList));
}
第一行代码,非常的明显,就是读取 MyBatis 的主配置文件。正常来说,这个主配置文件应该用来创建 Configuration ,但是这里却是传给 SqlSessionFactoryBuilder 来创建 SqlSessionFactory,然后就利用工厂模式来创建 SqlSession 了;上面我们也提及到, SqlSession 是提供给用户友好的数据库操作接口,那么岂不是说不需要 Configuratin 也可以直接获取 Mapper 然后操作数据库了?
那当然不是了,Configuration 是 MyBatis 的主配置类,它里面会包含 MyBatis 的所有信息(不管是主配置信息,还是所有 Mapper 配置信息),所以肯定是需要创建的。
所以其实在创建 SqlSessionFactory 时就已经初始化 Configuration 了,因为 SqlSession 需要利用 Executor、ParameterHandler 和 ResultSetHandler 等等各大组件互相配合来执行 Mapper,而 Configuration 就是这些组件的工厂类。
我们可以在 SqlSessionFactoryBuilder#build() 方法中看到 Configuration 是如何被初始化的:
public SqlSessionFactory build(Reader reader, String environment, Properties properties) {
try {
XMLConfigBuilder parser = new XMLConfigBuilder(reader, environment, properties);
return build(parser.parse());
//......
}
从上面的代码能看到,就是根据主配置文件的文件输入流创建 XMLConfigBuilder 对象,然后利用 XMLConfigBuilder#parse() 方法来创建 Configuration 对象。
当然了,虽然只是简单的调用了 XMLConfigBuilder#parse() 方法,可是里面包含的东西是非常的多的。例如: MyBatis 主配置文件的解析;如何根据
当然了,这篇文章我们只会着重于关于 Mapper 配置的解析和加载,根据底层源码一步一步的去分析弄明白,至于其他的知识点就不过多讲解了。
上面讲到 XMLConfigBuilder 会调用 parse() 方法去解析 MyBatis 的主配置文件,底层主要是利用 XPATH 来解析 XML 文件。代码如下:
public class XMLConfigBuilder extends BaseBuilder {
// .....
private final XPathParser parser;
// .....
public Configuration parse() {
// 防止parse()方法被同一个实例多次调用
if (parsed) {
throw new BuilderException("Each XMLConfigBuilder can only be used once.");
}
parsed = true;
// 调用XPathParser.evalNode()方法,创建表示configuration节点的XNode对象。
// 调用parseConfiguration()方法对XNode进行处理
parseConfiguration(parser.evalNode("/configuration"));
return configuration;
}
private void parseConfiguration(XNode root) {
try {
propertiesElement(root.evalNode("properties"));
Properties settings = settingsAsProperties(root.evalNode("settings"));
loadCustomVfs(settings);
typeAliasesElement(root.evalNode("typeAliases"));
pluginElement(root.evalNode("plugins"));
objectFactoryElement(root.evalNode("objectFactory"));
objectWrapperFactoryElement(root.evalNode("objectWrapperFactory"));
reflectorFactoryElement(root.evalNode("reflectorFactory"));
settingsElement(settings);
environmentsElement(root.evalNode("environments"));
databaseIdProviderElement(root.evalNode("databaseIdProvider"));
typeHandlerElement(root.evalNode("typeHandlers"));
// 最重要的关注点
mapperElement(root.evalNode("mappers"));
} catch (Exception e) {
throw new BuilderException("Error parsing SQL Mapper Configuration. Cause: " + e, e);
}
}
// ....
}
在 XMLConfigBuilder#parseConfiguration() 方法里面,会对主配置文件里的所有标签进行解析;当然了,由于我们这篇文章的主题是分析 Mapper 的解析和加载过程,所以接下来将直接关注 parseConfiguration() 方法里面的 mapperElement() 方法,其他部分大家可以直接去阅读 MyBatis 的源码。
备注:MyBatis 里面的所有 xxxBuilder 类都是继承于 BaseBuilder,而 BaseBuilder 要注意的点就是它持有着 Configuration 实例的引用。
在 XMLConfigBuilder#mapperElement() 方法里面,主要是解析
代码如下:
private void mapperElement(XNode parent) throws Exception {
if (parent != null) {
for (XNode child : parent.getChildren()) {
// 通过<package>标签指定包名
if ("package".equals(child.getName())) {
String mapperPackage = child.getStringAttribute("name");
configuration.addMappers(mapperPackage);
} else {
String resource = child.getStringAttribute("resource");
String url = child.getStringAttribute("url");
String mapperClass = child.getStringAttribute("class");
// 通过resource属性指定XML文件路径
if (resource != null && url == null && mapperClass == null) {
ErrorContext.instance().resource(resource);
InputStream inputStream = Resources.getResourceAsStream(resource);
XMLMapperBuilder mapperParser = new XMLMapperBuilder(inputStream, configuration, resource, configuration.getSqlFragments());
mapperParser.parse();
} else if (resource == null && url != null && mapperClass == null) {
// 通过url属性指定XML文件路径
ErrorContext.instance().resource(url);
InputStream inputStream = Resources.getUrlAsStream(url);
XMLMapperBuilder mapperParser = new XMLMapperBuilder(inputStream, configuration, url, configuration.getSqlFragments());
mapperParser.parse();
} else if (resource == null && url == null && mapperClass != null) {
// 通过class属性指定接口的完全限定名
Class<?> mapperInterface = Resources.classForName(mapperClass);
configuration.addMapper(mapperInterface);
} else {
throw new BuilderException("A mapper element may only specify a url, resource or class, but not more than one.");
}
}
}
}
}
从上面的代码来看,主要是将标签分为
那么我们可以先看看指定 XML 文件是如何解析与加载 Mapper 的。
Mapper 接口的 XML 文件的解析当然也是利用 XPath,但此时不再是 XMLConfigBuilder 来负责了,而是需要创建一个 XMLMapperBuilder 对象,而 XMLMapperBuilder 需要传入 XML 文件的文件输入流。
我们可以看看 XMLMapperBuilder#parse() 方法,XML 文件的解析流程就是在这里面:
public void parse() {
if (!configuration.isResourceLoaded(resource)) {
// 调用XPathParser的evalNode()方法获取根节点对应的XNode对象
configurationElement(parser.evalNode("/mapper"));
// 將资源路径添加到Configuration对象中
configuration.addLoadedResource(resource);
bindMapperForNamespace();
}
// 继续解析之前解析出现异常的ResultMap对象
parsePendingResultMaps();
// 继续解析之前解析出现异常的CacheRef对象
parsePendingCacheRefs();
// 继续解析之前解析出现异常<select|update|delete|insert>标签配置
parsePendingStatements();
}
解析前,会先判断 Configuratin 是否已经加载这个 XML 资源,如果不存在,则调用 configurationElement() 方法;在方法里面会解析所有的
下面我们先看一下 XMLMapperBuilder#configuratinElement() 方法的代码:
private void configurationElement(XNode context) {
try {
// 获取命名空间
String namespace = context.getStringAttribute("namespace");
if (namespace == null || namespace.equals("")) {
throw new BuilderException("Mapper's namespace cannot be empty");
}
// 设置当前正在解析的Mapper配置的命名空间
builderAssistant.setCurrentNamespace(namespace);
// 解析<cache-ref>标签
cacheRefElement(context.evalNode("cache-ref"));
// 解析<cache>标签
cacheElement(context.evalNode("cache"));
// 解析所有的<parameterMap>标签
parameterMapElement(context.evalNodes("/mapper/parameterMap"));
// 解析所有的<resultMap>标签
resultMapElements(context.evalNodes("/mapper/resultMap"));
// 解析所有的<sql>标签
sqlElement(context.evalNodes("/mapper/sql"));
// 解析所有的<select|insert|update|delete>标签
buildStatementFromContext(context.evalNodes("select|insert|update|delete"));
} catch (Exception e) {
throw new BuilderException("Error parsing Mapper XML. The XML location is '" + resource + "'. Cause: " + e, e);
}
}
当然了,我们此时将所有注意力集中在 buildStatementFromContext 方法即可。
在这个方法里面,会调用重载的 buildStatementFromContext 方法;但是这里还不是真正解析的地方,而是遍历所有标签,然后创建一个 XMLStatementBuilder 对象,对标签进行解析。代码如下:
private void buildStatementFromContext(List<XNode> list, String requiredDatabaseId) {
for (XNode context : list) {
// 通过XMLStatementBuilder对象,对<select|update|insert|delete>标签进行解析
final XMLStatementBuilder statementParser = new XMLStatementBuilder(configuration, builderAssistant, context, requiredDatabaseId);
try {
// 调用parseStatementNode()方法解析
statementParser.parseStatementNode();
} catch (IncompleteElementException e) {
configuration.addIncompleteStatement(statementParser);
}
}
}
那么我们接着看看 XMLStatementBuilder#parseStatementNode 方法:
public void parseStatementNode() {
String id = context.getStringAttribute("id");
String databaseId = context.getStringAttribute("databaseId");
if (!databaseIdMatchesCurrent(id, databaseId, this.requiredDatabaseId)) {
return;
}
// 解析<select|update|delete|insert>标签属性
Integer fetchSize = context.getIntAttribute("fetchSize");
Integer timeout = context.getIntAttribute("timeout");
String parameterMap = context.getStringAttribute("parameterMap");
String parameterType = context.getStringAttribute("parameterType");
Class<?> parameterTypeClass = resolveClass(parameterType);
String resultMap = context.getStringAttribute("resultMap");
String resultType = context.getStringAttribute("resultType");
// 获取LanguageDriver对象
String lang = context.getStringAttribute("lang");
LanguageDriver langDriver = getLanguageDriver(lang);
// 获取Mapper返回结果类型Class对象
Class<?> resultTypeClass = resolveClass(resultType);
String resultSetType = context.getStringAttribute("resultSetType");
// 默认Statement类型为PREPARED
StatementType statementType = StatementType.valueOf(context.getStringAttribute("statementType",
StatementType.PREPARED.toString()));
ResultSetType resultSetTypeEnum = resolveResultSetType(resultSetType);
String nodeName = context.getNode().getNodeName();
SqlCommandType sqlCommandType = SqlCommandType.valueOf(nodeName.toUpperCase(Locale.ENGLISH));
boolean isSelect = sqlCommandType == SqlCommandType.SELECT;
boolean flushCache = context.getBooleanAttribute("flushCache", !isSelect);
boolean useCache = context.getBooleanAttribute("useCache", isSelect);
boolean resultOrdered = context.getBooleanAttribute("resultOrdered", false);
// 將<include>标签内容,替换为<sql>标签定义的SQL片段
XMLIncludeTransformer includeParser = new XMLIncludeTransformer(configuration, builderAssistant);
includeParser.applyIncludes(context.getNode());
// 解析<selectKey>标签
processSelectKeyNodes(id, parameterTypeClass, langDriver);
// 通过LanguageDriver解析SQL内容,生成SqlSource对象
SqlSource sqlSource = langDriver.createSqlSource(configuration, context, parameterTypeClass);
String resultSets = context.getStringAttribute("resultSets");
String keyProperty = context.getStringAttribute("keyProperty");
String keyColumn = context.getStringAttribute("keyColumn");
KeyGenerator keyGenerator;
String keyStatementId = id + SelectKeyGenerator.SELECT_KEY_SUFFIX;
keyStatementId = builderAssistant.applyCurrentNamespace(keyStatementId, true);
// 获取主键生成策略
if (configuration.hasKeyGenerator(keyStatementId)) {
keyGenerator = configuration.getKeyGenerator(keyStatementId);
} else {
keyGenerator = context.getBooleanAttribute("useGeneratedKeys",
configuration.isUseGeneratedKeys() && SqlCommandType.INSERT.equals(sqlCommandType))
? Jdbc3KeyGenerator.INSTANCE : NoKeyGenerator.INSTANCE;
}
builderAssistant.addMappedStatement(id, sqlSource, statementType, sqlCommandType,
fetchSize, timeout, parameterMap, parameterTypeClass, resultMap, resultTypeClass,
resultSetTypeEnum, flushCache, useCache, resultOrdered,
keyGenerator, keyProperty, keyColumn, databaseId, langDriver, resultSets);
}
从上面的代码可得,首先会解析标签里的所有属性;然后创建 LanguageDriver 来解析标签里面的 SQL 配置,并生成对应的 SqlSource 对象;最后,利用工具类 MapperBuilderAssistant 来将上面解析的内容组装成 MappedStatement 对象,并且注册到 Configuration 中。
上面我们说到,解析的 SQL 内容会生成对应的 SqlSource 对象,那么我们先看看 SqlSource 接口,代码如下:
public interface SqlSource {
BoundSql getBoundSql(Object parameterObject);
}
SqlSource 接口的定义非常简单,只有一个 getBoundSql() 方法,该方法返回一个 BoundSql 实例。
所以说 BoundSql 才是对 SQL 语句及参数信息的封装,它是 SqlSource 解析后的结果,BoundSql 的代码如下:
public class BoundSql {
// Mapper配置解析后的sql语句
private final String sql;
// Mapper参数映射信息
private final List<ParameterMapping> parameterMappings;
// Mapper参数对象
private final Object parameterObject;
// 额外参数信息,包括<bind>标签绑定的参数,内置参数
private final Map<String, Object> additionalParameters;
// 参数对象对应的MetaObject对象
private final MetaObject metaParameters;
// ... 省略 get/set 和 构造函数
}
因为 SQL 的解析是利用 LanguageDriver 组件完成的,所以我们再接着看看 LanguageDriver 接口,代码如下:
public interface LanguageDriver {
ParameterHandler createParameterHandler(MappedStatement mappedStatement, Object parameterObject, BoundSql boundSql);
SqlSource createSqlSource(Configuration configuration, XNode script, Class<?> parameterType);
SqlSource createSqlSource(Configuration configuration, String script, Class<?> parameterType);
}
如上面的代码所示,LanguageDriver 接口中一共有3个方法,其中 createParameterHandler() 方法用于创建 ParameterHandler 对象,另外还有两个重载的 createSqlSource() 方法,这两个重载的方法用于创建 SqlSource 对象。
MyBatis 中为 LanguageDriver 接口提供了两个实现类,分别为 XMLLanguageDriver 和 RawLanguageDriver。
接下来我们重点了解一下 XMLLanguageDriver 实现类的内容,代码如下:
public class XMLLanguageDriver implements LanguageDriver {
@Override
public ParameterHandler createParameterHandler(MappedStatement mappedStatement, Object parameterObject, BoundSql boundSql) {
return new DefaultParameterHandler(mappedStatement, parameterObject, boundSql);
}
@Override
public SqlSource createSqlSource(Configuration configuration, XNode script, Class<?> parameterType) {
// 该方法用于解析XML文件中配置的SQL信息
// 创建XMLScriptBuilder对象
XMLScriptBuilder builder = new XMLScriptBuilder(configuration, script, parameterType);
// 调用 XMLScriptBuilder对象parseScriptNode()方法解析SQL资源
return builder.parseScriptNode();
}
@Override
public SqlSource createSqlSource(Configuration configuration, String script, Class<?> parameterType) {
// 该方法用于解析Java注解中配置的SQL信息
// 字符串以<script>标签开头,则以XML方式解析
if (script.startsWith("<script>")) {
XPathParser parser = new XPathParser(script, false, configuration.getVariables(), new XMLMapperEntityResolver());
return createSqlSource(configuration, parser.evalNode("/script"), parameterType);
} else {
// 解析SQL配置中的全局变量
script = PropertyParser.parse(script, configuration.getVariables());
TextSqlNode textSqlNode = new TextSqlNode(script);
// 如果SQL中是否仍包含${}参数占位符,则返回DynamicSqlSource实例,否则返回RawSqlSource
if (textSqlNode.isDynamic()) {
return new DynamicSqlSource(configuration, textSqlNode);
} else {
return new RawSqlSource(configuration, script, parameterType);
}
}
}
}
如上面的代码所示,XMLLanguageDriver 类实现了 LanguageDriver 接口中两个重载的 createSqlSource() 方法,分别用于处理 XML 文件和 Java 注解中配置的 SQL 信息,将 SQL 配置转换为 SqlSource 对象。
第一个重载的 createSqlSource() 方法用于处理 XML 文件中配置的 SQL 信息,该方法中创建了一个 XMLScriptBuilder 对象,然后调用 XMLScriptBuilder 对象的 parseScriptNode() 方法将 SQL 资源转换为 SqlSource 对象。
第二个重载的 createSqlSource() 方法用于处理 Java 注解中配置的 SQL 信息,该方法中首先判断 SQL 配置是否以
京东创始人刘强东和其妻子章泽天最近成为了互联网舆论关注的焦点。有关他们“移民美国”和在美国购买豪宅的传言在互联网上广泛传播。然而,京东官方通过微博发言人发布的消息澄清了这些传言,称这些言论纯属虚假信息和蓄意捏造。
日前,据博主“@超能数码君老周”爆料,国内三大运营商中国移动、中国电信和中国联通预计将集体采购百万台规模的华为Mate60系列手机。
据报道,荷兰半导体设备公司ASML正看到美国对华遏制政策的负面影响。阿斯麦(ASML)CEO彼得·温宁克在一档电视节目中分享了他对中国大陆问题以及该公司面临的出口管制和保护主义的看法。彼得曾在多个场合表达了他对出口管制以及中荷经济关系的担忧。
今年早些时候,抖音悄然上线了一款名为“青桃”的 App,Slogan 为“看见你的热爱”,根据应用介绍可知,“青桃”是一个属于年轻人的兴趣知识视频平台,由抖音官方出品的中长视频关联版本,整体风格有些类似B站。
日前,威马汽车首席数据官梅松林转发了一份“世界各国地区拥车率排行榜”,同时,他发文表示:中国汽车普及率低于非洲国家尼日利亚,每百户家庭仅17户有车。意大利世界排名第一,每十户中九户有车。
近日,一项新的研究发现,维生素 C 和 E 等抗氧化剂会激活一种机制,刺激癌症肿瘤中新血管的生长,帮助它们生长和扩散。
据媒体援引消息人士报道,苹果公司正在测试使用3D打印技术来生产其智能手表的钢质底盘。消息传出后,3D系统一度大涨超10%,不过截至周三收盘,该股涨幅回落至2%以内。
9月2日,坐拥千万粉丝的网红主播“秀才”账号被封禁,在社交媒体平台上引发热议。平台相关负责人表示,“秀才”账号违反平台相关规定,已封禁。据知情人士透露,秀才近期被举报存在违法行为,这可能是他被封禁的部分原因。据悉,“秀才”年龄39岁,是安徽省亳州市蒙城县人,抖音网红,粉丝数量超1200万。他曾被称为“中老年...
9月3日消息,亚马逊的一些股东,包括持有该公司股票的一家养老基金,日前对亚马逊、其创始人贝索斯和其董事会提起诉讼,指控他们在为 Project Kuiper 卫星星座项目购买发射服务时“违反了信义义务”。
据消息,为推广自家应用,苹果现推出了一个名为“Apps by Apple”的网站,展示了苹果为旗下产品(如 iPhone、iPad、Apple Watch、Mac 和 Apple TV)开发的各种应用程序。
特斯拉本周在美国大幅下调Model S和X售价,引发了该公司一些最坚定支持者的不满。知名特斯拉多头、未来基金(Future Fund)管理合伙人加里·布莱克发帖称,降价是一种“短期麻醉剂”,会让潜在客户等待进一步降价。
据外媒9月2日报道,荷兰半导体设备制造商阿斯麦称,尽管荷兰政府颁布的半导体设备出口管制新规9月正式生效,但该公司已获得在2023年底以前向中国运送受限制芯片制造机器的许可。
近日,根据美国证券交易委员会的文件显示,苹果卫星服务提供商 Globalstar 近期向马斯克旗下的 SpaceX 支付 6400 万美元(约 4.65 亿元人民币)。用于在 2023-2025 年期间,发射卫星,进一步扩展苹果 iPhone 系列的 SOS 卫星服务。
据报道,马斯克旗下社交平台𝕏(推特)日前调整了隐私政策,允许 𝕏 使用用户发布的信息来训练其人工智能(AI)模型。新的隐私政策将于 9 月 29 日生效。新政策规定,𝕏可能会使用所收集到的平台信息和公开可用的信息,来帮助训练 𝕏 的机器学习或人工智能模型。
9月2日,荣耀CEO赵明在采访中谈及华为手机回归时表示,替老同事们高兴,觉得手机行业,由于华为的回归,让竞争充满了更多的可能性和更多的魅力,对行业来说也是件好事。
《自然》30日发表的一篇论文报道了一个名为Swift的人工智能(AI)系统,该系统驾驶无人机的能力可在真实世界中一对一冠军赛里战胜人类对手。
近日,非营利组织纽约真菌学会(NYMS)发出警告,表示亚马逊为代表的电商平台上,充斥着各种AI生成的蘑菇觅食科普书籍,其中存在诸多错误。
社交媒体平台𝕏(原推特)新隐私政策提到:“在您同意的情况下,我们可能出于安全、安保和身份识别目的收集和使用您的生物识别信息。”
2023年德国柏林消费电子展上,各大企业都带来了最新的理念和产品,而高端化、本土化的中国产品正在不断吸引欧洲等国际市场的目光。
罗永浩日前在直播中吐槽苹果即将推出的 iPhone 新品,具体内容为:“以我对我‘子公司’的了解,我认为 iPhone 15 跟 iPhone 14 不会有什么区别的,除了序(列)号变了,这个‘不要脸’的东西,这个‘臭厨子’。