Mybatis系列八：SqlSource的创建

最新推荐文章于 2024-07-26 03:51:44 发布
最新推荐文章于 2024-07-26 03:51:44 发布
阅读量1.3k 收藏
点赞数
分类专栏： Mybatis3
本文为博主原创文章，未经博主允许不得转载。
本文链接：https://blog.csdn.net/hjtlovelife/article/details/104784151
版权

Mybatis系列八：SqlSource的创建

概述

在《Mybatis系列七：XMLStatementBuilder创建MappedStatement》一文【4.2 解析SQL语句】章节中，解析SQL节点得到的SqlSource有两种：
DynamicSqlSource SQL语句有${param0}(文本替换，可能是一段SQL)或者使用了if/where(运行时决定是否拼接SQL片段)等节点需要运行时才能解析出要执行的SQL。
RawSqlSource 使用了#{param1}占位符或者没有使用，就是一个完整SQL，不需要运行时解析得到SQL。

一、RawLanguageDriver

1.1 根绝节点创建SqlSource

public SqlSource createSqlSource(Configuration configuration, XNode script, Class<?> parameterType) {
SqlSource source = super.createSqlSource(configuration, script, parameterType);
checkIsNotDynamic(source);
return source;
}

1.2 根据脚本创建SqlSource

public SqlSource createSqlSource(Configuration configuration, String script, Class<?> parameterType) {
SqlSource source = super.createSqlSource(configuration, script, parameterType);
checkIsNotDynamic(source);
return source;
}

1.3 使用RAW语言时不允许动态内容

private void checkIsNotDynamic(SqlSource source) {
if (!RawSqlSource.class.equals(source.getClass())) {
throw new BuilderException(“Dynamic content is not allowed when using RAW language”);
}
}

二、XMLLanguageDriver

2.1 SQL参数设置处理器

// 创建一个{@link ParameterHandler}，该参数将实际参数传递给JDBC语句。
public ParameterHandler createParameterHandler(MappedStatement mappedStatement, Object parameterObject, BoundSql boundSql) {
return new DefaultParameterHandler(mappedStatement, parameterObject, boundSql);
}

2.2 根据节点创建SqlSource

public SqlSource createSqlSource(Configuration configuration, XNode script, Class<?> parameterType) {
**参考《Mybatis系列七：XMLStatementBuilder创建MappedStatement》【**四、解析SQL语句 XMLScriptBuilder】
XMLScriptBuilder builder = new XMLScriptBuilder(configuration, script, parameterType);
return builder.parseScriptNode();
}

2.3 根据脚本创建SqlSource

public SqlSource createSqlSource(Configuration configuration, String script, Class<?> parameterType) {
if (script.startsWith("

三、静态SQL(加载时确定的SQL) RawSqlSource

静态SqlSource。它比{@link DynamicSqlSource}更快，因为映射是在启动期间计算的。

3.1 构造器

public RawSqlSource(Configuration configuration, SqlNode rootSqlNode, Class<?> parameterType) {
this(configuration, getSql(configuration, rootSqlNode), parameterType);
}

public RawSqlSource(Configuration configuration, String sql, Class<?> parameterType) {
SqlSourceBuilder sqlSourceParser = new SqlSourceBuilder(configuration);
Class<?> clazz = parameterType == null ? Object.class : parameterType;
// 解析配置时解析SQL
sqlSource = sqlSourceParser.parse(sql, clazz, new HashMap<String, Object>());
}

3.2 获取SQL语句

private static String getSql(Configuration configuration, SqlNode rootSqlNode) {
DynamicContext context = new DynamicContext(configuration, null);
rootSqlNode.apply(context);
return context.getSql();
}

3.3 根据参数获取BoundSql

public BoundSql getBoundSql(Object parameterObject) {
return sqlSource.getBoundSql(parameterObject);
}

四、动态SQL(运行时确定的SQL) DynamicSqlSource

4.1 构造器

public DynamicSqlSource(Configuration configuration, SqlNode rootSqlNode) {
this.configuration = configuration;
this.rootSqlNode = rootSqlNode;
}

4.2 根据参数获取BoundSql

public BoundSql getBoundSql(Object parameterObject) {
DynamicContext context = new DynamicContext(configuration, parameterObject);
rootSqlNode.apply(context);
SqlSourceBuilder sqlSourceParser = new SqlSourceBuilder(configuration);
Class<?> parameterType = parameterObject == null ? Object.class : parameterObject.getClass();
// 运行时根据参数解析SQL
SqlSource sqlSource = sqlSourceParser.parse(context.getSql(), parameterType, context.getBindings());
BoundSql boundSql = sqlSource.getBoundSql(parameterObject);
for (Map.Entry<String, Object> entry : context.getBindings().entrySet()) {
boundSql.setAdditionalParameter(entry.getKey(), entry.getValue());
}
return boundSql;
}

五、替换占位符 SqlSourceBuilder

5.1 解析SQL语句

#{param0}中可使用的属性有：javaType、jdbcTyp、mode、numericScale、resultMap、typeHandler、
jdbcTypeName。
public SqlSource parse(String originalSql, Class<?> parameterType, Map<String, Object> additionalParameters) {
// 处理参数占位符#{param0}替换为?，并记录下参数名称
ParameterMappingTokenHandler handler = new ParameterMappingTokenHandler(configuration, parameterType, additionalParameters);
// 寻找占位符并调用ParameterMappingTokenHandler处理占位符
GenericTokenParser parser = new GenericTokenParser("#{", “}”, handler);
// #{param0}替换为?，占位符名称即param0封装为ParameterMapping
String sql = parser.parse(originalSql);
return new StaticSqlSource(configuration, sql, handler.getParameterMappings());
}

5.2 占位符处理 ParameterMappingTokenHandler

private static class ParameterMappingTokenHandler extends BaseBuilder implements TokenHandler {
// 按照占位符#{param0}出现的顺序记录下参数信息
private List parameterMappings = new ArrayList();
private Class<?> parameterType;
private MetaObject metaParameters;

public ParameterMappingTokenHandler(Configuration configuration, Class<?> parameterType, Map<String, Object> additionalParameters) {
super(configuration);
this.parameterType = parameterType;
this.metaParameters = configuration.newMetaObject(additionalParameters);
}

public List getParameterMappings() {
return parameterMappings;
}

// 占位符#{param0}中的param0封装为ParameterMapping，并替换为?
public String handleToken(String content) {
parameterMappings.add(buildParameterMapping(content));
return “?”;
}

// 占位符#{param0}中的param0封装为ParameterMapping。#{param0}中可使用的属性有：javaType、jdbcTyp、mode、numericScale、resultMap、typeHandler、jdbcTypeName，需要都解析出来。
// #{param0, jdbcType=BIGINT, typeHandler=com.lemon.handler.DateForLongTypeHandler}
private ParameterMapping buildParameterMapping(String content) {
Map<String, String> propertiesMap = parseParameterMapping(content);
// 参数名即param0
String property = propertiesMap.get(“property”);
Class<?> propertyType;
// 解析param0的Java类型
if (metaParameters.hasGetter(property)) {
propertyType = metaParameters.getGetterType(property);
} else if (typeHandlerRegistry.hasTypeHandler(parameterType)) {
propertyType = parameterType;
} else if (JdbcType.CURSOR.name().equals(propertiesMap.get(“jdbcType”))) {
propertyType = java.sql.ResultSet.class;
} else if (property == null || Map.class.isAssignableFrom(parameterType)) {
propertyType = Object.class;
} else {
MetaClass metaClass = MetaClass.forClass(parameterType, configuration.getReflectorFactory());
if (metaClass.hasGetter(property)) {
propertyType = metaClass.getGetterType(property);
} else {
propertyType = Object.class;
}
}
ParameterMapping.Builder builder = new ParameterMapping.Builder(configuration, property, propertyType);
Class<?> javaType = propertyType;
String typeHandlerAlias = null;
for (Map.Entry<String, String> entry : propertiesMap.entrySet()) {
String name = entry.getKey();
String value = entry.getValue();
if (“javaType”.equals(name)) {
javaType = resolveClass(value);
builder.javaType(javaType);
} else if (“jdbcType”.equals(name)) {
builder.jdbcType(resolveJdbcType(value));
} else if (“mode”.equals(name)) {
builder.mode(resolveParameterMode(value));
} else if (“numericScale”.equals(name)) {
builder.numericScale(Integer.valueOf(value));
} else if (“resultMap”.equals(name)) {
builder.resultMapId(value);
} else if (“typeHandler”.equals(name)) {
typeHandlerAlias = value;
} else if (“jdbcTypeName”.equals(name)) {
builder.jdbcTypeName(value);
} else if (“property”.equals(name)) {
// Do Nothing
} else if (“expression”.equals(name)) {
// 尚不支持基于表达式的参数
throw new BuilderException(“Expression based parameters are not supported yet”);
} else {
throw new BuilderException(“An invalid property '” + name + “’ was found in mapping #{” + content + "}. Valid properties are " + parameterProperties);
}
}
if (typeHandlerAlias != null) {
builder.typeHandler(resolveTypeHandler(javaType, typeHandlerAlias));
}
return builder.build();
}

// 解析占位符#{param0}中的param0封装为ParameterMapping。#{param0}中可使用的属性有：javaType、jdbcTyp、mode、numericScale、resultMap、typeHandler、jdbcTypeName，需要都解析出来。

// #{param0, jdbcType=BIGINT, typeHandler=com.lemon.handler.DateForLongTypeHandler}
private Map<String, String> parseParameterMapping(String content) {
try {
return new ParameterExpression(content);
} catch (BuilderException ex) {
throw ex;
} catch (Exception ex) {
throw new BuilderException(“Parsing error was found in mapping #{” + content + "}. Check syntax #{property|(expression), var1=value1, var2=value2, …} ", ex);
}
}
}

六、StaticSqlSource

6.1 构造器

public StaticSqlSource(Configuration configuration, String sql, List parameterMappings) {
this.sql = sql;
this.parameterMappings = parameterMappings;
this.configuration = configuration;
}

6.2 创建BoundSql

public BoundSql getBoundSql(Object parameterObject) {
return new BoundSql(configuration, sql, parameterMappings, parameterObject);
}

只道当时是寻常
关注
专栏目录
MyBatis的动态SQL实现原理.pdf
04-28
2. **XMLLanguageDriver**：通过`createSqlSource()`方法创建`SqlSource`对象。这个方法接收`XNode`（即映射文件中CRUD标签对应的节点）作为参数，并返回`SqlSource`对象。 3. **XMLScriptBuilder**：通过`...
深入浅出Mybatis源码解析——SqlSource的创建流程
寒山道杳
11-19 803
前言 在前一篇文章深入浅出Mybatis源码解析——映射文件加载流程中，最后说到了创建SqlSource和创建MappedStatement对象，由于篇幅原因最后只好终止了，所以便只好在写一篇文章来说说SqlSource这样的一个创建流程是怎样的，在本系列第一篇完成后，也曾问过一两个认识的读者，有说不太看得懂，可能本人写博客不够图文并茂，所以在下一篇博文中准备来整理一张Mybatis的一个完整的...
MyBatis源码的学习（13）---Mybatis是如何构建sql的？
itw_zhangzx02的博客
12-27 382
统一的一个接口：sqlSource 俩个实现类： 1.RawSqlSource 解析：select * from user where name = #{name} 属性字段 sqlSource --StaticSqlSource类型的 StaticSqlSource进行将'#{}'替换为 ？占位符 StaticSqlSource中的属性字段sql用于存储解析后的sql select ...
mysql sql文件source 传参
最新发布
weixin_36961186的博客
07-26 60
MySQL SQL 文件与参数传递 在进行数据库操作时，我们经常需要使用SQL文件来批量执行SQL语句。然而，在某些情况下，我们需要在SQL文件中传递参数，以实现更灵活的数据库操作。本文将介绍如何使用MySQL SQL文件进行参数传递，并提供相应的代码示例。 SQL文件与参数传递 在MySQL中，我们可以使用source命...
mybatis -- sqlsource
hc1428090104的博客
05-26 1180
sqlsource
mybatis源码学习------动态sql的解析(SqlSource)
我是兴锅的博客
11-10 1917
SqlSource SqlSource为SQL 来源接口。它代表从 Mapper XML 或方法注解上，读取的一条 SQL 内容。 SqlSource接口 SqlSource接口的定义如下： public interface SqlSource { //根据传入的实际参数，返回一个BoundSql对象 BoundSql getBoundSql(Object parameterObject); } SqlSource有多个实现类，类图如下： 实现类的区别 DynamicSqlSource 表示
MyBatis 基石之 SqlSource
qq_42419406的博客
07-21 1202
MyBatis 基石之 SqlSource简介分类类图StaticSqlSourceDynamicSqlSourceRawSqlSourceProviderSqlSource总结 简介 在上一篇 SqlNode 中通过 DynamicContext 连串联 SqlNode 间 SQL 的拼接，其实这个功能是通过 SqlSource 来完成的。通过 SqlSource 接口的 getBoundSql() 方法传入的参数获取 BoundSql，BoundSql 里面有完整的 SQL 语句以及参数列表和实参。Sq
Mybatis—LanguageDriver
乐只悠悠
11-15 1392
LanguageDriver主要用于构造SqlSource和ParameterHandler，从LanguageDriver在Mybatis中调用链路来看，Configuration#newParameterHandler通过调用LanguageDriver#createParameterHandler完成构建ParameterHandler，通过调用LanguageDriver#createSqlSource来完成构建SqlSource。
Mybatis源码分析十一之SqlSource
solayang的博客
12-13 973
一、SqlSource 在分析mapper映射文件解析时，我们只是整体介绍了mapper映射文件，而sql语句的解析过程没做进一步说明，分析中可知，用户编写的sql语句是存放在SqlSource对象中，但是语句中的参数怎么解析的、参数映射关系是怎么保存的以及动态sql是怎么实现的，将是本文的重点。 SqlSource是只有一个方法的简单接口。 public interface SqlSource { BoundSql getBoundSql(Object parameterObject); } 它有如
mybatis-3.2.7.zip
08-31
这个版本的MyBatis提供了一系列的增强功能，使得开发者在处理数据库操作时更加便捷高效。以下是关于MyBatis 3.2.7的一些关键知识点： 1. **配置文件**： - MyBatis的核心配置文件是`mybatis-config.xml`，其中定义...
mybatis-3-mybatis-3.2.6.zip
04-19
描述中提到"MyBatis Source code.jar 各个版本，免费下载"，意味着提供的是MyBatis的源代码，开发者可以深入理解其内部工作原理，学习如何实现ORM（对象关系映射）机制，包括SQL动态生成、结果映射等核心功能。...
Spring、mybatis、SpringMVC
10-09
使用外部属性文件需要创建资源文件并引入外部属性文件，使用 @PropertySource 获取外部属性文件中的变量值。 Spring Boot 需要创建 Spring 项目，并选择依赖项，例如 MyBatis Framework 和 MySQL Driver。使用 @...
mybatis-3.2.8jar包及其源码jar包
08-21
在3.2.8版本中，MyBatis提供了一系列强大的功能，帮助开发者更高效地处理数据库操作。这个压缩包包含了MyBatis的核心库mybatis-3.2.8.jar以及对应的源码jar包，使得开发者可以深入理解MyBatis的工作原理，进行定制化...
MyBatis源码通~SqlSource
一只打杂的码农
05-18 1909
SqlSource 构建动态SQL //XMLStatementBuilder.parseStatementNode() SqlSource sqlSource = langDriver.createSqlSource(configuration, context, parameterTypeClass); 涉及类 LanguageDriverRegistry+LanguageDriver X...
Mybatis加载Mapper的原理以及自定义动态sql的几种思路
FAHA的博客
05-29 2989
mybatis是目前非常流行的数据库框架。它的轻便灵活的特性使的我们更加方便的操作数据库。所以我们来扒一扒Mybatis的原理。 先扒一张百度上对mybatis结构的描述的图 百度的图 从上可以看出mysql的几个组件Configiration，MappedStatements，Mapper，xml。 先写个demo试验一下。 mybatis版本是 <depende...
Mybatis源码解析-DynamicSqlSource和RawSqlSource的区别
weixin_30278311的博客
09-21 708
XMLLanguageDriver是ibatis的默认解析sql节点帮助类，其中的方法会调用生成DynamicSqlSource和RawSqlSource这两个帮助类，本文将对此作下简单的简析 应用场景 我们在编写mybatis的sql语句的时候，经常用到的是#{}的字符去替代其中的查询入参，偶尔也会在网上看到${}这样的字符使用。 经过笔者分析源码得知，其实前者调用的为RawSqlSourc...
Mybatis—SqlSource与BoundSql
乐只悠悠
11-13 1774
SqlSource用于描述通过@Select、@Insert、@Delete、@Update、@SelectProvider、@InsertProvider、@DeleteProvider和@UpdateProvider等注解配置的SQL信息，或者通过XML配置文件配置的SQL信息。SqlSource接口又定义了BoundSql getBoundSql(Object parameterObject)方法来获取对SQL信息进行封装的BoundSql实例。
java培训Mybatis动态Sql处理解析
weixin_45695430的博客
04-18 791
以下文章来源于架构师必备 动态Sql介绍 动态 SQL 是 MyBatis 的强大特性之一。如果你使用过 JDBC 或其它类似的框架，你应该能理解根据不同条件拼接 SQL 语句有多痛苦，例如拼接时要确保不能忘记添加必要的空格，还要注意去掉列表最后一个列名的逗号。利用动态 SQL，可以彻底摆脱这种痛苦。 使用动态 SQL 并非一件易事，但借助可用于任何 SQL 映射语句中的强大的动态 SQL 语言，MyBatis 显著地提升了这一特性的易用性。 Mybatis动态解析里面有2个核心的类SqlNode、
Mybatis动态SQL解析
weixin_43914798的博客
05-16 1192
利用Mybatis解析动态SQL,获取SQL的请求参数及返回参数
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值