mirror of
https://github.com/baomidou/mybatis-plus.git
synced 2024-10-23 06:33:49 +08:00
调整jsqlparser支持.
This commit is contained in:
聂秋荣
parent
37251cf9db
commit
4c81c10b7d
@ -18,14 +18,12 @@ ext {
|
||||
springBootVersion = '2.7.18',
|
||||
springBoot3Version = '3.3.3',
|
||||
springCloudVersion = '3.1.8',
|
||||
jsqlparserVersion = '5.0',
|
||||
junitVersion = '5.11.0',
|
||||
]
|
||||
|
||||
lib = [
|
||||
"kotlin-reflect" : "org.jetbrains.kotlin:kotlin-reflect:2.0.20",
|
||||
"kotlin-stdlib-jdk8" : "org.jetbrains.kotlin:kotlin-stdlib-jdk8:2.0.20",
|
||||
"jsqlparser" : "com.github.jsqlparser:jsqlparser:${jsqlparserVersion}",
|
||||
"mybatis" : "org.mybatis:mybatis:${mybatisVersion}",
|
||||
"mybatis-spring" : "org.mybatis:mybatis-spring:${mybatisSpringVersion}",
|
||||
"mybatis-thymeleaf" : "org.mybatis.scripting:mybatis-thymeleaf:1.0.4",
|
||||
|
||||
@ -24,6 +24,7 @@ dependencyManagement {
|
||||
dependency "com.baomidou:mybatis-plus-spring-boot-test-autoconfigure:${APP_VERSION}"
|
||||
dependency "com.baomidou:mybatis-plus-spring-boot3-starter:${APP_VERSION}"
|
||||
dependency "com.baomidou:mybatis-plus-spring-boot3-starter-test:${APP_VERSION}"
|
||||
|
||||
dependency "com.baomidou:mybatis-plus-jsqlparser:${APP_VERSION}"
|
||||
dependency "com.baomidou:mybatis-plus-jsqlparser-4.9:${APP_VERSION}"
|
||||
}
|
||||
}
|
||||
|
||||
@ -1,319 +0,0 @@
|
||||
/*
|
||||
* Copyright (c) 2011-2024, baomidou (jobob@qq.com).
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
package com.baomidou.mybatisplus.extension.plugins.inner;
|
||||
|
||||
import com.baomidou.mybatisplus.annotation.Version;
|
||||
import com.baomidou.mybatisplus.core.conditions.AbstractWrapper;
|
||||
import com.baomidou.mybatisplus.core.conditions.ISqlSegment;
|
||||
import com.baomidou.mybatisplus.core.conditions.Wrapper;
|
||||
import com.baomidou.mybatisplus.core.conditions.segments.NormalSegmentList;
|
||||
import com.baomidou.mybatisplus.core.conditions.update.Update;
|
||||
import com.baomidou.mybatisplus.core.conditions.update.UpdateWrapper;
|
||||
import com.baomidou.mybatisplus.core.enums.SqlKeyword;
|
||||
import com.baomidou.mybatisplus.core.mapper.Mapper;
|
||||
import com.baomidou.mybatisplus.core.metadata.TableFieldInfo;
|
||||
import com.baomidou.mybatisplus.core.metadata.TableInfo;
|
||||
import com.baomidou.mybatisplus.core.metadata.TableInfoHelper;
|
||||
import com.baomidou.mybatisplus.core.toolkit.Constants;
|
||||
import com.baomidou.mybatisplus.core.toolkit.ExceptionUtils;
|
||||
import com.baomidou.mybatisplus.core.toolkit.ReflectionKit;
|
||||
import com.baomidou.mybatisplus.core.toolkit.StringPool;
|
||||
import org.apache.ibatis.executor.Executor;
|
||||
import org.apache.ibatis.mapping.MappedStatement;
|
||||
import org.apache.ibatis.mapping.SqlCommandType;
|
||||
|
||||
import java.lang.reflect.Field;
|
||||
import java.sql.SQLException;
|
||||
import java.sql.Timestamp;
|
||||
import java.time.Instant;
|
||||
import java.time.LocalDateTime;
|
||||
import java.util.Date;
|
||||
import java.util.HashMap;
|
||||
import java.util.Map;
|
||||
import java.util.Objects;
|
||||
import java.util.concurrent.ConcurrentHashMap;
|
||||
import java.util.function.Function;
|
||||
import java.util.regex.Matcher;
|
||||
import java.util.regex.Pattern;
|
||||
|
||||
/**
|
||||
* Optimistic Lock Light version
|
||||
* <p>Intercept on {@link Executor}.update;</p>
|
||||
* <p>Support version types: int/Integer, long/Long, java.util.Date, java.sql.Timestamp</p>
|
||||
* <p>For extra types, please define a subclass and override {@code getUpdatedVersionVal}() method.</p>
|
||||
* <br>
|
||||
* <p>How to use?</p>
|
||||
* <p>(1) Define an Entity and add {@link Version} annotation on one entity field.</p>
|
||||
* <p>(2) Add {@link OptimisticLockerInnerInterceptor} into mybatis plugin.</p>
|
||||
* <br>
|
||||
* <p>How to work?</p>
|
||||
* <p>if update entity with version column=1:</p>
|
||||
* <p>(1) no {@link OptimisticLockerInnerInterceptor}:</p>
|
||||
* <p>SQL: update tbl_test set name='abc' where id=100001;</p>
|
||||
* <p>(2) add {@link OptimisticLockerInnerInterceptor}:</p>
|
||||
* <p>SQL: update tbl_test set name='abc',version=2 where id=100001 and version=1;</p>
|
||||
*
|
||||
* @author yuxiaobin
|
||||
* @since 3.4.0
|
||||
*/
|
||||
@SuppressWarnings({"unchecked"})
|
||||
public class OptimisticLockerInnerInterceptor implements InnerInterceptor {
|
||||
private RuntimeException exception;
|
||||
|
||||
public void setException(RuntimeException exception) {
|
||||
this.exception = exception;
|
||||
}
|
||||
|
||||
/**
|
||||
* entity类缓存
|
||||
*/
|
||||
private static final Map<String, Class<?>> ENTITY_CLASS_CACHE = new ConcurrentHashMap<>();
|
||||
/**
|
||||
* 变量占位符正则
|
||||
*/
|
||||
private static final Pattern PARAM_PAIRS_RE = Pattern.compile("#\\{ew\\.paramNameValuePairs\\.(" + Constants.WRAPPER_PARAM + "\\d+)\\}");
|
||||
/**
|
||||
* paramNameValuePairs存放的version值的key
|
||||
*/
|
||||
private static final String UPDATED_VERSION_VAL_KEY = "#updatedVersionVal#";
|
||||
/**
|
||||
* Support wrapper mode
|
||||
*/
|
||||
private final boolean wrapperMode;
|
||||
|
||||
public OptimisticLockerInnerInterceptor() {
|
||||
this(false);
|
||||
}
|
||||
|
||||
public OptimisticLockerInnerInterceptor(boolean wrapperMode) {
|
||||
this.wrapperMode = wrapperMode;
|
||||
}
|
||||
|
||||
@Override
|
||||
public void beforeUpdate(Executor executor, MappedStatement ms, Object parameter) throws SQLException {
|
||||
if (SqlCommandType.UPDATE != ms.getSqlCommandType()) {
|
||||
return;
|
||||
}
|
||||
if (parameter instanceof Map) {
|
||||
Map<String, Object> map = (Map<String, Object>) parameter;
|
||||
doOptimisticLocker(map, ms.getId());
|
||||
}
|
||||
}
|
||||
|
||||
protected void doOptimisticLocker(Map<String, Object> map, String msId) {
|
||||
// updateById(et), update(et, wrapper);
|
||||
Object et = map.getOrDefault(Constants.ENTITY, null);
|
||||
if (Objects.nonNull(et)) {
|
||||
|
||||
// version field
|
||||
TableFieldInfo fieldInfo = this.getVersionFieldInfo(et.getClass());
|
||||
if (null == fieldInfo) {
|
||||
return;
|
||||
}
|
||||
|
||||
try {
|
||||
Field versionField = fieldInfo.getField();
|
||||
// 旧的 version 值
|
||||
Object originalVersionVal = versionField.get(et);
|
||||
if (originalVersionVal == null) {
|
||||
if (null != exception) {
|
||||
/**
|
||||
* 自定义异常处理
|
||||
*/
|
||||
throw exception;
|
||||
}
|
||||
return;
|
||||
}
|
||||
String versionColumn = fieldInfo.getColumn();
|
||||
// 新的 version 值
|
||||
Object updatedVersionVal = this.getUpdatedVersionVal(fieldInfo.getPropertyType(), originalVersionVal);
|
||||
String methodName = msId.substring(msId.lastIndexOf(StringPool.DOT) + 1);
|
||||
if ("update".equals(methodName)) {
|
||||
AbstractWrapper<?, ?, ?> aw = (AbstractWrapper<?, ?, ?>) map.getOrDefault(Constants.WRAPPER, null);
|
||||
if (aw == null) {
|
||||
UpdateWrapper<?> uw = new UpdateWrapper<>();
|
||||
uw.eq(versionColumn, originalVersionVal);
|
||||
map.put(Constants.WRAPPER, uw);
|
||||
} else {
|
||||
aw.apply(versionColumn + " = {0}", originalVersionVal);
|
||||
}
|
||||
} else {
|
||||
map.put(Constants.MP_OPTLOCK_VERSION_ORIGINAL, originalVersionVal);
|
||||
}
|
||||
versionField.set(et, updatedVersionVal);
|
||||
} catch (IllegalAccessException e) {
|
||||
throw ExceptionUtils.mpe(e);
|
||||
}
|
||||
}
|
||||
|
||||
// update(LambdaUpdateWrapper) or update(UpdateWrapper)
|
||||
else if (wrapperMode && map.entrySet().stream().anyMatch(t -> Objects.equals(t.getKey(), Constants.WRAPPER))) {
|
||||
setVersionByWrapper(map, msId);
|
||||
}
|
||||
}
|
||||
|
||||
protected TableFieldInfo getVersionFieldInfo(Class<?> entityClazz) {
|
||||
TableInfo tableInfo = TableInfoHelper.getTableInfo(entityClazz);
|
||||
return (null != tableInfo && tableInfo.isWithVersion()) ? tableInfo.getVersionFieldInfo() : null;
|
||||
}
|
||||
|
||||
private void setVersionByWrapper(Map<String, Object> map, String msId) {
|
||||
Object ew = map.get(Constants.WRAPPER);
|
||||
if (ew instanceof AbstractWrapper && ew instanceof Update) {
|
||||
Class<?> entityClass = ENTITY_CLASS_CACHE.get(msId);
|
||||
if (null == entityClass) {
|
||||
try {
|
||||
final String className = msId.substring(0, msId.lastIndexOf('.'));
|
||||
entityClass = ReflectionKit.getSuperClassGenericType(Class.forName(className), Mapper.class, 0);
|
||||
ENTITY_CLASS_CACHE.put(msId, entityClass);
|
||||
} catch (ClassNotFoundException e) {
|
||||
throw ExceptionUtils.mpe(e);
|
||||
}
|
||||
}
|
||||
|
||||
final TableFieldInfo versionField = getVersionFieldInfo(entityClass);
|
||||
if (null == versionField) {
|
||||
return;
|
||||
}
|
||||
|
||||
final String versionColumn = versionField.getColumn();
|
||||
final FieldEqFinder fieldEqFinder = new FieldEqFinder(versionColumn, (Wrapper<?>) ew);
|
||||
if (!fieldEqFinder.isPresent()) {
|
||||
return;
|
||||
}
|
||||
final Map<String, Object> paramNameValuePairs = ((AbstractWrapper<?, ?, ?>) ew).getParamNameValuePairs();
|
||||
final Object originalVersionValue = paramNameValuePairs.get(fieldEqFinder.valueKey);
|
||||
if (originalVersionValue == null) {
|
||||
return;
|
||||
}
|
||||
final Object updatedVersionVal = getUpdatedVersionVal(originalVersionValue.getClass(), originalVersionValue);
|
||||
if (originalVersionValue == updatedVersionVal) {
|
||||
return;
|
||||
}
|
||||
// 拼接新的version值
|
||||
paramNameValuePairs.put(UPDATED_VERSION_VAL_KEY, updatedVersionVal);
|
||||
((Update<?, ?>) ew).setSql(String.format("%s = #{%s.%s}", versionColumn, "ew.paramNameValuePairs", UPDATED_VERSION_VAL_KEY));
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* EQ字段查找器
|
||||
*/
|
||||
private static class FieldEqFinder {
|
||||
|
||||
/**
|
||||
* 状态机
|
||||
*/
|
||||
enum State {
|
||||
INIT,
|
||||
FIELD_FOUND,
|
||||
EQ_FOUND,
|
||||
VERSION_VALUE_PRESENT;
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* 字段值的key
|
||||
*/
|
||||
private String valueKey;
|
||||
/**
|
||||
* 当前状态
|
||||
*/
|
||||
private State state;
|
||||
/**
|
||||
* 字段名
|
||||
*/
|
||||
private final String fieldName;
|
||||
|
||||
public FieldEqFinder(String fieldName, Wrapper<?> wrapper) {
|
||||
this.fieldName = fieldName;
|
||||
state = State.INIT;
|
||||
find(wrapper);
|
||||
}
|
||||
|
||||
/**
|
||||
* 是否已存在
|
||||
*/
|
||||
public boolean isPresent() {
|
||||
return state == State.VERSION_VALUE_PRESENT;
|
||||
}
|
||||
|
||||
private boolean find(Wrapper<?> wrapper) {
|
||||
Matcher matcher;
|
||||
final NormalSegmentList segments = wrapper.getExpression().getNormal();
|
||||
for (ISqlSegment segment : segments) {
|
||||
// 如果字段已找到并且当前segment为EQ
|
||||
if (state == State.FIELD_FOUND && segment == SqlKeyword.EQ) {
|
||||
this.state = State.EQ_FOUND;
|
||||
// 如果EQ找到并且value已找到
|
||||
} else if (state == State.EQ_FOUND
|
||||
&& (matcher = PARAM_PAIRS_RE.matcher(segment.getSqlSegment())).matches()) {
|
||||
this.valueKey = matcher.group(1);
|
||||
this.state = State.VERSION_VALUE_PRESENT;
|
||||
return true;
|
||||
// 处理嵌套
|
||||
} else if (segment instanceof Wrapper) {
|
||||
if (find((Wrapper<?>) segment)) {
|
||||
return true;
|
||||
}
|
||||
// 判断字段是否是要查找字段
|
||||
} else if (segment.getSqlSegment().equals(this.fieldName)) {
|
||||
this.state = State.FIELD_FOUND;
|
||||
}
|
||||
}
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
private static class VersionFactory {
|
||||
|
||||
/**
|
||||
* 存放版本号类型与获取更新后版本号的map
|
||||
*/
|
||||
private static final Map<Class<?>, Function<Object, Object>> VERSION_FUNCTION_MAP = new HashMap<>();
|
||||
|
||||
static {
|
||||
VERSION_FUNCTION_MAP.put(long.class, version -> (long) version + 1);
|
||||
VERSION_FUNCTION_MAP.put(Long.class, version -> (long) version + 1);
|
||||
VERSION_FUNCTION_MAP.put(int.class, version -> (int) version + 1);
|
||||
VERSION_FUNCTION_MAP.put(Integer.class, version -> (int) version + 1);
|
||||
VERSION_FUNCTION_MAP.put(Date.class, version -> new Date());
|
||||
VERSION_FUNCTION_MAP.put(Timestamp.class, version -> new Timestamp(System.currentTimeMillis()));
|
||||
VERSION_FUNCTION_MAP.put(LocalDateTime.class, version -> LocalDateTime.now());
|
||||
VERSION_FUNCTION_MAP.put(Instant.class, version -> Instant.now());
|
||||
}
|
||||
|
||||
public static Object getUpdatedVersionVal(Class<?> clazz, Object originalVersionVal) {
|
||||
Function<Object, Object> versionFunction = VERSION_FUNCTION_MAP.get(clazz);
|
||||
if (versionFunction == null) {
|
||||
// not supported type, return original val.
|
||||
return originalVersionVal;
|
||||
}
|
||||
return versionFunction.apply(originalVersionVal);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* This method provides the control for version value.<BR>
|
||||
* Returned value type must be the same as original one.
|
||||
*
|
||||
* @param originalVersionVal ignore
|
||||
* @return updated version val
|
||||
*/
|
||||
protected Object getUpdatedVersionVal(Class<?> clazz, Object originalVersionVal) {
|
||||
return VersionFactory.getUpdatedVersionVal(clazz, originalVersionVal);
|
||||
}
|
||||
}
|
||||
@ -1,62 +0,0 @@
|
||||
/*
|
||||
* Copyright (c) 2011-2024, baomidou (jobob@qq.com).
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
package com.baomidou.mybatisplus.extension.plugins.inner;
|
||||
|
||||
import com.baomidou.mybatisplus.core.config.GlobalConfig;
|
||||
import com.baomidou.mybatisplus.core.toolkit.CollectionUtils;
|
||||
import com.baomidou.mybatisplus.core.toolkit.PluginUtils;
|
||||
import com.baomidou.mybatisplus.core.toolkit.sql.SqlUtils;
|
||||
import org.apache.ibatis.executor.Executor;
|
||||
import org.apache.ibatis.logging.Log;
|
||||
import org.apache.ibatis.logging.LogFactory;
|
||||
import org.apache.ibatis.mapping.BoundSql;
|
||||
import org.apache.ibatis.mapping.MappedStatement;
|
||||
import org.apache.ibatis.session.ResultHandler;
|
||||
import org.apache.ibatis.session.RowBounds;
|
||||
|
||||
import java.sql.SQLException;
|
||||
import java.util.List;
|
||||
|
||||
/**
|
||||
* 功能类似于 {@link GlobalConfig.DbConfig#isReplacePlaceholder()},
|
||||
* 只是这个是在运行时实时替换,适用范围更广
|
||||
*
|
||||
* @author miemie
|
||||
* @since 2020-11-19
|
||||
*/
|
||||
public class ReplacePlaceholderInnerInterceptor implements InnerInterceptor {
|
||||
|
||||
protected final Log logger = LogFactory.getLog(this.getClass());
|
||||
|
||||
private String escapeSymbol;
|
||||
|
||||
public ReplacePlaceholderInnerInterceptor() {
|
||||
}
|
||||
|
||||
public ReplacePlaceholderInnerInterceptor(String escapeSymbol) {
|
||||
this.escapeSymbol = escapeSymbol;
|
||||
}
|
||||
|
||||
@Override
|
||||
public void beforeQuery(Executor executor, MappedStatement ms, Object parameter, RowBounds rowBounds, ResultHandler resultHandler, BoundSql boundSql) throws SQLException {
|
||||
String sql = boundSql.getSql();
|
||||
List<String> find = SqlUtils.findPlaceholder(sql);
|
||||
if (CollectionUtils.isNotEmpty(find)) {
|
||||
sql = SqlUtils.replaceSqlPlaceholder(sql, find, escapeSymbol);
|
||||
PluginUtils.mpBoundSql(boundSql).sql(sql);
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -1,8 +1,12 @@
|
||||
compileJava {
|
||||
options.release = 11
|
||||
}
|
||||
|
||||
dependencies {
|
||||
api "${lib.'jsqlparser'}"
|
||||
api "com.github.jsqlparser:jsqlparser:5.0"
|
||||
api project(":mybatis-plus-jsqlparser:mybatis-plus-jsqlparser-common")
|
||||
implementation "${lib."slf4j-api"}"
|
||||
implementation "de.ruedigermoeller:fst:3.0.4-jdk17"
|
||||
implementation "de.ruedigermoeller:fst:3.0.3"
|
||||
implementation "com.github.ben-manes.caffeine:caffeine:2.9.3"
|
||||
testImplementation "io.github.classgraph:classgraph:4.8.176"
|
||||
testImplementation "${lib."spring-context-support"}"
|
||||
@ -73,7 +73,6 @@ public class FstFactory {
|
||||
conf.registerClass(net.sf.jsqlparser.expression.OracleNamedFunctionParameter.class);
|
||||
conf.registerClass(net.sf.jsqlparser.expression.OrderByClause.class);
|
||||
conf.registerClass(net.sf.jsqlparser.expression.OverlapsCondition.class);
|
||||
conf.registerClass(net.sf.jsqlparser.expression.Parenthesis.class);
|
||||
conf.registerClass(net.sf.jsqlparser.expression.PartitionByClause.class);
|
||||
conf.registerClass(net.sf.jsqlparser.expression.RangeExpression.class);
|
||||
conf.registerClass(net.sf.jsqlparser.expression.RowConstructor.class);
|
||||
@ -4,7 +4,6 @@ dependencies {
|
||||
api project(":mybatis-plus-spring")
|
||||
|
||||
api "${lib.mybatis}"
|
||||
api "${lib.'jsqlparser'}"
|
||||
|
||||
implementation "${lib."mybatis-spring"}"
|
||||
|
||||
@ -28,6 +27,6 @@ dependencies {
|
||||
testImplementation "${lib.'logback-classic'}"
|
||||
testImplementation "${lib.cglib}"
|
||||
testImplementation "${lib.postgresql}"
|
||||
testImplementation project(":mybatis-plus-jsqlparser:mybatis-plus-jsqlparser-5.0")
|
||||
testImplementation project(":mybatis-plus-jsqlparser:mybatis-plus-jsqlparser")
|
||||
// testCompile ('org.apache.phoenix:phoenix-core:5.0.0-HBase-2.0')
|
||||
}
|
||||
|
||||
@ -30,7 +30,6 @@ include ':spring-boot-starter:mybatis-plus-spring-boot-test-autoconfigure'
|
||||
include ':spring-boot-starter:mybatis-plus-spring-boot3-starter'
|
||||
include ':spring-boot-starter:mybatis-plus-spring-boot3-starter-test'
|
||||
include 'mybatis-plus-jsqlparser'
|
||||
include ':mybatis-plus-jsqlparser:mybatis-plus-jsqlparser'
|
||||
include ':mybatis-plus-jsqlparser:mybatis-plus-jsqlparser-common'
|
||||
include ':mybatis-plus-jsqlparser:mybatis-plus-jsqlparser-4.9'
|
||||
include ':mybatis-plus-jsqlparser:mybatis-plus-jsqlparser-5.0'
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user