Mybatis是如何实现SQL语句复用功能的（）
点击上方蓝色“程序猿DD”，选择“设为星标”
回复“资源”获取独家整理的学习资料！
文章图片
来源 | https://my.oschina.net/zudajun/blog/687326
今天，我们将分析Mybatis之sqlFragment，可以翻译为sql片段，它的存在价值在于可复用sql片段，避免到处重复编写。
在工作中，往往有这样的需求，对于同一个sql条件查询，首先需要统计记录条数，用以计算pageCount，然后再对结果进行分页查询显示，看下面一个例子。
select
stud_id as studId
, name, email
, dob
, phone
from studentsselect count(1) from (
这就是sqlFragment，它可以为select|insert|update|delete标签服务，可以定义很多sqlFragment，然后使用include标签引入多个sqlFragment。在工作中，也是比较常用的一个功能，它的优点很明显，复用sql片段，它的缺点也很明显，不能完整的展现sql逻辑，如果一个标签，include了四至五个sqlFragment，其可读性就非常差了。
sqlFragment里的内容是可以随意写的，它不需要是一个完整的sql，它可以是“,phone”这么简单的文本。
1.sqlFragment的解析过程
sqlFragment存储于Configuration内部。
protected final Map sqlFragments = new StrictMap("XML fragments parsed from previous mappers");
解析sqlFragment的过程非常简单。
org.apache.ibatis.builder.xml.XMLMapperBuilder.configurationElement(XNode)方法部分源码。
// 解析sqlFragment
sqlElement(context.evalNodes("/mapper/sql"));
// 为select|insert|update|delete提供服务
buildStatementFromContext(context.evalNodes("select|insert|update|delete"));
sqlFragment存储于Map结构当中。其实最关键的，是它如何为select|insert|update|delete提供服务的。
2.select|insert|update|delete标签中，解析include标签的过程
org.apache.ibatis.builder.xml.XMLStatementBuilder.parseStatementNode()方法源码。
// Include Fragments before parsing
XMLIncludeTransformer includeParser = new XMLIncludeTransformer(configuration, builderAssistant);
// 重点关注的方法
includeParser.applyIncludes(context.getNode());
// Parse selectKey after includes and remove them.
processSelectKeyNodes(id, parameterTypeClass, langDriver);
// Parse the SQL (pre:and were parsed and removed)
SqlSource sqlSource = langDriver.createSqlSource(configuration, context, parameterTypeClass);
注释“pre:and
org.apache.ibatis.builder.xml.XMLIncludeTransformer.applyIncludes(Node, Properties)方法源码。
/**
* Recursively apply includes through all SQL fragments.
* @param source Include node in DOM tree
* @param variablesContext Current context for static variables with values
*/
private void applyIncludes(Node source, final Properties variablesContext) {
if (source.getNodeName().equals("include")) {
// new full context for included SQL - contains inherited context and new variables from current include node
Properties fullContext;
String refid = getStringAttribute(source, "refid");
// replace variables in include refid value
refid = PropertyParser.parse(refid, variablesContext);
Node toInclude = findSqlFragment(refid);
Properties newVariablesContext = getVariablesContext(source, variablesContext);
if (!newVariablesContext.isEmpty()) {
// merge contexts
fullContext = new Properties();
fullContext.putAll(variablesContext);
fullContext.putAll(newVariablesContext);
} else {
// no new context - use inherited fully
fullContext = variablesContext;
}
// 递归调用
applyIncludes(toInclude, fullContext);
if (toInclude.getOwnerDocument() != source.getOwnerDocument()) {
toInclude = source.getOwnerDocument().importNode(toInclude, true);
}
// 将include节点，替换为sqlFragment节点
source.getParentNode().replaceChild(toInclude, source);
while (toInclude.hasChildNodes()) {
// 将sqlFragment的子节点（也就是文本节点），插入到sqlFragment的前面
toInclude.getParentNode().insertBefore(toInclude.getFirstChild(), toInclude);
}
// 移除sqlFragment节点
toInclude.getParentNode().removeChild(toInclude);
} else if (source.getNodeType() == Node.ELEMENT_NODE) {
NodeList children = source.getChildNodes();
for (int i=0;
i上面是对源码的解读，为了便于理解，我们接下来采用图示的办法，演示其过程。
3.图示过程演示
①解析节点
select count(1) from (
②include节点替换为sqlFragment节点
select count(1) from (select
stud_id as studId
, name, email
, dob
, phone
from students) tmp③将sqlFragment的子节点（文本节点）insert到sqlFragment节点的前面。注意，对于dom来说，文本也是一个节点，叫TextNode。
select count(1) from (
select
stud_id as studId
, name, email
, dob
, phone
from studentsselect
stud_id as studId
, name, email
, dob
, phone
from students) tmp④移除sqlFragment节点
select count(1) from (
select
stud_id as studId
, name, email
, dob
, phone
from students
) tmp⑤最终结果如图所示
文章图片
（Made In QQ截图及时编辑）
如此一来，TextNode1 + TextNode2 + TextNode3，就组成了一个完整的sql。遍历select的三个子节点，分别取出TextNode的value，append到一起，就是最终完整的sql。
这也是为什么要移除 and
这就是Mybatis的sqlFragment，以上示例，均为静态sql，即static sql。
往期推荐
扛住100亿次请求？我们来试一试！
SpringBoot + Mybatis + Druid + PageHelper 实现多数据源分页
Java 中的 BigDecimal，你真的会用吗？
华为阿里下班时间曝光：所有的光鲜，都有加班的味道
MySQL 的 Binlog 日志处理工具（Canal，Maxwell，Databus，DTS）对比
Serverless：为我们到底带来了什么
星球限时拼团优惠进行中
文章图片
我的星球是否适合你？
【Mybatis是如何实现SQL语句复用功能的（）】点击阅读原文看看我们都聊过啥？
推荐阅读
- 热闹中的孤独
- 我要做大厨
- 《真与假的困惑》???|《真与假的困惑》??? ——致良知是一种伟大的力量
- 爱就是希望你好好活着
- 太平之莲
- 知识
- 叙述作文
- 时间老了
- 清明，是追思、是传承、是感恩。
- 考研英语阅读终极解决方案——阅读理解如何巧拿高分