Skip to content

M
mybatis-generator-plugin
Commit a8c0a38a authored by hewei's avatar hewei
Browse files
Options

重写 SelectiveEnhanced 插件

parent 75509542
Show whitespace changes
Inline Side-by-side
Showing with 832 additions and 393 deletions
src/main/java/com/itfsw/mybatis/generator/plugins/IncrementsPlugin.java
View file @ a8c0a38a
......@@ -99,7 +99,12 @@ public class IncrementsPlugin extends BasePlugin {
*/
@Override
public boolean sqlMapUpdateByExampleSelectiveElementGenerated(XmlElement element, IntrospectedTable introspectedTable) {
if (PluginTools.checkDependencyPlugin(context, SelectiveEnhancedPlugin.class)) {
// TODO SelectiveEnhancedPlugin.sqlMapUpdateByExampleSelectiveElementGenerated
} else {
generatedWithSelective(element, introspectedTable, true);
}
return true;
}
......@@ -135,7 +140,12 @@ public class IncrementsPlugin extends BasePlugin {
*/
@Override
public boolean sqlMapUpdateByPrimaryKeySelectiveElementGenerated(XmlElement element, IntrospectedTable introspectedTable) {
if (PluginTools.checkDependencyPlugin(context, SelectiveEnhancedPlugin.class)) {
// TODO SelectiveEnhancedPlugin.sqlMapUpdateByPrimaryKeySelectiveElementGenerated
} else {
generatedWithSelective(element, introspectedTable, false);
}
return true;
}
......
src/main/java/com/itfsw/mybatis/generator/plugins/LogicalDeletePlugin.java
View file @ a8c0a38a
......@@ -339,21 +339,7 @@ public class LogicalDeletePlugin extends BasePlugin {
logicalDeleteByPrimaryKey.addElement(new TextElement(sb1.toString()));
boolean and = false;
for (IntrospectedColumn introspectedColumn : introspectedTable.getPrimaryKeyColumns()) {
sb.setLength(0);
if (and) {
sb.append(" and ");
} else {
sb.append("where ");
and = true;
}
sb.append(MyBatis3FormattingUtilities.getEscapedColumnName(introspectedColumn));
sb.append(" = ");
sb.append(MyBatis3FormattingUtilities.getParameterClause(introspectedColumn));
logicalDeleteByPrimaryKey.addElement(new TextElement(sb.toString()));
}
XmlElementGeneratorTools.generateWhereByPrimaryKeyTo(logicalDeleteByPrimaryKey, introspectedTable.getPrimaryKeyColumns());
document.getRootElement().addElement(logicalDeleteByPrimaryKey);
logger.debug("itfsw(逻辑删除插件):" + introspectedTable.getMyBatis3XmlMapperFileName() + "增加方法logicalDeleteByPrimaryKey的实现。");
......@@ -394,21 +380,7 @@ public class LogicalDeletePlugin extends BasePlugin {
sb.append(introspectedTable.getAliasedFullyQualifiedTableNameAtRuntime());
selectByPrimaryKey.addElement(new TextElement(sb.toString()));
and = false;
for (IntrospectedColumn introspectedColumn : introspectedTable.getPrimaryKeyColumns()) {
sb.setLength(0);
if (and) {
sb.append(" and ");
} else {
sb.append("where ");
and = true;
}
sb.append(MyBatis3FormattingUtilities.getAliasedEscapedColumnName(introspectedColumn));
sb.append(" = ");
sb.append(MyBatis3FormattingUtilities.getParameterClause(introspectedColumn));
selectByPrimaryKey.addElement(new TextElement(sb.toString()));
}
XmlElementGeneratorTools.generateWhereByPrimaryKeyTo(selectByPrimaryKey, introspectedTable.getPrimaryKeyColumns());
// 逻辑删除的判断
sb.setLength(0);
......
src/main/java/com/itfsw/mybatis/generator/plugins/ModelColumnPlugin.java
View file @ a8c0a38a
......@@ -17,6 +17,7 @@
package com.itfsw.mybatis.generator.plugins;
import com.itfsw.mybatis.generator.plugins.utils.BasePlugin;
import com.itfsw.mybatis.generator.plugins.utils.JavaElementGeneratorTools;
import org.mybatis.generator.api.IntrospectedColumn;
import org.mybatis.generator.api.IntrospectedTable;
import org.mybatis.generator.api.dom.java.*;
......@@ -73,12 +74,11 @@ public class ModelColumnPlugin extends BasePlugin {
/**
* 生成Column字段枚举
*
* @param topLevelClass
* @param introspectedTable
* @return
*/
private InnerEnum generateColumnEnum(TopLevelClass topLevelClass, IntrospectedTable introspectedTable){
private InnerEnum generateColumnEnum(TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
// 生成内部枚举
InnerEnum innerEnum = new InnerEnum(new FullyQualifiedJavaType(ENUM_NAME));
innerEnum.setVisibility(JavaVisibility.PUBLIC);
......@@ -93,6 +93,18 @@ public class ModelColumnPlugin extends BasePlugin {
commentGenerator.addFieldComment(columnField, introspectedTable);
innerEnum.addField(columnField);
Field javaPropertyField = new Field("javaProperty", FullyQualifiedJavaType.getStringInstance());
javaPropertyField.setVisibility(JavaVisibility.PRIVATE);
javaPropertyField.setFinal(true);
commentGenerator.addFieldComment(javaPropertyField, introspectedTable);
innerEnum.addField(javaPropertyField);
Field jdbcTypeField = new Field("jdbcType", FullyQualifiedJavaType.getStringInstance());
jdbcTypeField.setVisibility(JavaVisibility.PRIVATE);
jdbcTypeField.setFinal(true);
commentGenerator.addFieldComment(jdbcTypeField, introspectedTable);
innerEnum.addField(jdbcTypeField);
Method mValue = new Method("value");
mValue.setVisibility(JavaVisibility.PUBLIC);
mValue.setReturnType(FullyQualifiedJavaType.getStringInstance());
......@@ -107,10 +119,22 @@ public class ModelColumnPlugin extends BasePlugin {
commentGenerator.addGeneralMethodComment(mGetValue, introspectedTable);
innerEnum.addMethod(mGetValue);
Method mGetJavaProperty = JavaElementGeneratorTools.generateGetterMethod(javaPropertyField);
commentGenerator.addGeneralMethodComment(mGetJavaProperty, introspectedTable);
innerEnum.addMethod(mGetJavaProperty);
Method mGetJdbcType = JavaElementGeneratorTools.generateGetterMethod(jdbcTypeField);
commentGenerator.addGeneralMethodComment(mGetJdbcType, introspectedTable);
innerEnum.addMethod(mGetJdbcType);
Method constructor = new Method(ENUM_NAME);
constructor.setConstructor(true);
constructor.addBodyLine("this.column = column;");
constructor.addBodyLine("this.javaProperty = javaProperty;");
constructor.addBodyLine("this.jdbcType = jdbcType;");
constructor.addParameter(new Parameter(FullyQualifiedJavaType.getStringInstance(), "column"));
constructor.addParameter(new Parameter(FullyQualifiedJavaType.getStringInstance(), "javaProperty"));
constructor.addParameter(new Parameter(FullyQualifiedJavaType.getStringInstance(), "jdbcType"));
commentGenerator.addGeneralMethodComment(constructor, introspectedTable);
innerEnum.addMethod(constructor);
logger.debug("itfsw(数据Model属性对应Column获取插件):" + topLevelClass.getType().getShortName() + ".Column增加构造方法和column属性。");
......@@ -123,6 +147,10 @@ public class ModelColumnPlugin extends BasePlugin {
sb.append(field.getName());
sb.append("(\"");
sb.append(introspectedColumn.getActualColumnName());
sb.append("\", \"");
sb.append(introspectedColumn.getJavaProperty());
sb.append("\", \"");
sb.append(introspectedColumn.getJdbcTypeName());
sb.append("\")");
innerEnum.addEnumConstant(sb.toString());
......
src/main/java/com/itfsw/mybatis/generator/plugins/SelectiveEnhancedPlugin.java
View file @ a8c0a38a
/*
* Copyright (c) 2017.
* Copyright (c) 2018.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
......@@ -17,30 +17,31 @@
package com.itfsw.mybatis.generator.plugins;
import com.itfsw.mybatis.generator.plugins.utils.BasePlugin;
import com.itfsw.mybatis.generator.plugins.utils.IntrospectedTableTools;
import com.itfsw.mybatis.generator.plugins.utils.PluginTools;
import com.itfsw.mybatis.generator.plugins.utils.XmlElementGeneratorTools;
import org.mybatis.generator.api.IntrospectedColumn;
import org.mybatis.generator.api.IntrospectedTable;
import org.mybatis.generator.api.dom.java.*;
import org.mybatis.generator.api.dom.xml.*;
import org.mybatis.generator.codegen.mybatis3.MyBatis3FormattingUtilities;
import org.mybatis.generator.api.dom.java.FullyQualifiedJavaType;
import org.mybatis.generator.api.dom.java.Interface;
import org.mybatis.generator.api.dom.java.Method;
import org.mybatis.generator.api.dom.java.Parameter;
import org.mybatis.generator.api.dom.xml.Attribute;
import org.mybatis.generator.api.dom.xml.TextElement;
import org.mybatis.generator.api.dom.xml.XmlElement;
import org.mybatis.generator.codegen.mybatis3.ListUtilities;
import org.mybatis.generator.config.GeneratedKey;
import java.util.List;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
/**
* ---------------------------------------------------------------------------
* Selective 增强插件
* ---------------------------------------------------------------------------
*
* @author: hewei
* @time:2017/4/20 15:39
* @time:2018/4/20 15:39
* ---------------------------------------------------------------------------
*/
public class SelectiveEnhancedPlugin extends BasePlugin {
public static final String METHOD_HAS_SELECTIVE = "hasSelective"; // 方法名
/**
* {@inheritDoc}
......@@ -50,246 +51,315 @@ public class SelectiveEnhancedPlugin extends BasePlugin {
// 插件使用前提是使用了ModelColumnPlugin插件
if (!PluginTools.checkDependencyPlugin(getContext(), ModelColumnPlugin.class)) {
warnings.add("itfsw:插件" + this.getClass().getTypeName() + "插件需配合com.itfsw.mybatis.generator.plugins.ModelColumnPlugin插件使用！");
warnings.add("itfsw:插件" + this.getClass().getTypeName() + "插件需配合" + ModelColumnPlugin.class.getTypeName() + "插件使用！");
return false;
}
// 插件位置
PluginTools.shouldAfterPlugins(getContext(), this.getClass(), warnings, UpsertPlugin.class);
// 和 OldSelectiveEnhancedPlugin 不能同时使用
if (PluginTools.checkDependencyPlugin(getContext(), OldSelectiveEnhancedPlugin.class)) {
warnings.add("itfsw:插件" + this.getClass().getTypeName() + "不能和" + OldSelectiveEnhancedPlugin.class.getTypeName() + "插件同时使用！");
return false;
}
return super.validate(warnings);
}
/**
* Model Methods 生成
* insertSelective 方法生成
* 具体执行顺序 http://www.mybatis.org/generator/reference/pluggingIn.html
*
* @param topLevelClass
* @param method
* @param interfaze
* @param introspectedTable
* @return
*/
@Override
public boolean modelBaseRecordClassGenerated(TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
// import
topLevelClass.addImportedType(FullyQualifiedJavaType.getNewMapInstance());
topLevelClass.addImportedType(FullyQualifiedJavaType.getNewHashMapInstance());
// field
Field selectiveColumnsField = new Field("selectiveColumns", new FullyQualifiedJavaType("Map<String, Boolean>"));
commentGenerator.addFieldComment(selectiveColumnsField, introspectedTable);
selectiveColumnsField.setVisibility(JavaVisibility.PRIVATE);
selectiveColumnsField.setInitializationString("new HashMap<String, Boolean>()");
topLevelClass.addField(selectiveColumnsField);
// Method hasSelective
Method mHasSelective = new Method(METHOD_HAS_SELECTIVE);
commentGenerator.addGeneralMethodComment(mHasSelective, introspectedTable);
mHasSelective.setVisibility(JavaVisibility.PUBLIC);
mHasSelective.setReturnType(FullyQualifiedJavaType.getBooleanPrimitiveInstance());
mHasSelective.addBodyLine("return this.selectiveColumns.size() > 0;");
topLevelClass.addMethod(mHasSelective);
// Method hasSelective
Method mHasSelective1 = new Method(METHOD_HAS_SELECTIVE);
commentGenerator.addGeneralMethodComment(mHasSelective1, introspectedTable);
mHasSelective1.setVisibility(JavaVisibility.PUBLIC);
mHasSelective1.setReturnType(FullyQualifiedJavaType.getBooleanPrimitiveInstance());
mHasSelective1.addParameter(new Parameter(FullyQualifiedJavaType.getStringInstance(), "column"));
mHasSelective1.addBodyLine("return this.selectiveColumns.get(column) != null;");
topLevelClass.addMethod(mHasSelective1);
// Method selective
Method mSelective = new Method("selective");
commentGenerator.addGeneralMethodComment(mSelective, introspectedTable);
mSelective.setVisibility(JavaVisibility.PUBLIC);
mSelective.setReturnType(topLevelClass.getType());
mSelective.addParameter(new Parameter(new FullyQualifiedJavaType(ModelColumnPlugin.ENUM_NAME), "columns", true));
mSelective.addBodyLine("this.selectiveColumns.clear();");
mSelective.addBodyLine("if (columns != null) {");
mSelective.addBodyLine("for (" + ModelColumnPlugin.ENUM_NAME + " column : columns) {");
mSelective.addBodyLine("this.selectiveColumns.put(column.value(), true);");
mSelective.addBodyLine("}");
mSelective.addBodyLine("}");
mSelective.addBodyLine("return this;");
topLevelClass.addMethod(mSelective);
return true;
public boolean clientInsertSelectiveMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable) {
method.getParameters().clear();
FullyQualifiedJavaType parameterType = introspectedTable.getRules().calculateAllFieldsClass();
method.addParameter(new Parameter(parameterType, "record", "@Param(\"record\")"));
// 找出全字段对应的Model
FullyQualifiedJavaType fullFieldModel = introspectedTable.getRules().calculateAllFieldsClass();
// column枚举
FullyQualifiedJavaType selectiveType = new FullyQualifiedJavaType(fullFieldModel.getShortName() + "." + ModelColumnPlugin.ENUM_NAME);
method.addParameter(new Parameter(selectiveType, "selective", "@Param(\"selective\")", true));
method.getJavaDocLines().clear();
commentGenerator.addGeneralMethodComment(method, introspectedTable);
return super.clientInsertSelectiveMethodGenerated(method, interfaze, introspectedTable);
}
/**
* SQL Map Methods 生成
* updateByExampleSelective
* 具体执行顺序 http://www.mybatis.org/generator/reference/pluggingIn.html
*
* @param document
* @param method
* @param interfaze
* @param introspectedTable
* @return
*/
@Override
public boolean sqlMapDocumentGenerated(Document document, IntrospectedTable introspectedTable) {
List<Element> rootElements = document.getRootElement().getElements();
for (Element rootElement : rootElements) {
if (rootElement instanceof XmlElement) {
XmlElement xmlElement = (XmlElement) rootElement;
List<Attribute> attributes = xmlElement.getAttributes();
// 查找ID
String id = "";
for (Attribute attribute : attributes) {
if (attribute.getName().equals("id")) {
id = attribute.getValue();
}
}
public boolean clientUpdateByExampleSelectiveMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable) {
method.getParameters().clear();
// ====================================== 1. insertSelective ======================================
if ("insertSelective".equals(id)) {
List<XmlElement> eles = XmlElementGeneratorTools.findXmlElements(xmlElement, "trim");
for (XmlElement ele : eles) {
this.replaceEle(ele, "_parameter.", introspectedTable);
}
}
// ====================================== 2. updateByExampleSelective ======================================
if ("updateByExampleSelective".equals(id)) {
List<XmlElement> eles = XmlElementGeneratorTools.findXmlElements(xmlElement, "set");
for (XmlElement ele : eles) {
this.replaceEle(ele, "record.", introspectedTable);
}
}
// ====================================== 3. updateByPrimaryKeySelective ======================================
if ("updateByPrimaryKeySelective".equals(id)) {
List<XmlElement> eles = XmlElementGeneratorTools.findXmlElements(xmlElement, "set");
for (XmlElement ele : eles) {
this.replaceEle(ele, "_parameter.", introspectedTable);
}
}
// ====================================== 4. upsertSelective ======================================
if ("upsertSelective".equals(id)) {
List<XmlElement> eles = XmlElementGeneratorTools.findXmlElements(xmlElement, "trim");
for (XmlElement ele : eles) {
this.replaceEle(ele, "_parameter.", introspectedTable);
}
}
// ====================================== 5. upsertByExampleSelective ======================================
if ("upsertByExampleSelective".equals(id)) {
List<XmlElement> eles = XmlElementGeneratorTools.findXmlElements(xmlElement, "trim");
this.replaceEle(eles.get(0), "record.", introspectedTable);
// upsertByExampleSelective的第二个trim比较特殊，需另行处理
this.replaceEleForUpsertByExampleSelective(eles.get(1), "record.", introspectedTable, !introspectedTable.getRules().generateRecordWithBLOBsClass());
List<XmlElement> eles1 = XmlElementGeneratorTools.findXmlElements(xmlElement, "set");
for (XmlElement ele : eles1) {
this.replaceEle(ele, "record.", introspectedTable);
}
}
}
}
return true;
FullyQualifiedJavaType parameterType = introspectedTable.getRules().calculateAllFieldsClass();
method.addParameter(new Parameter(parameterType, "record", "@Param(\"record\")"));
FullyQualifiedJavaType exampleType = new FullyQualifiedJavaType(introspectedTable.getExampleType());
method.addParameter(new Parameter(exampleType, "example", "@Param(\"example\")"));
// 找出全字段对应的Model
FullyQualifiedJavaType fullFieldModel = introspectedTable.getRules().calculateAllFieldsClass();
// column枚举
FullyQualifiedJavaType selectiveType = new FullyQualifiedJavaType(fullFieldModel.getShortName() + "." + ModelColumnPlugin.ENUM_NAME);
method.addParameter(new Parameter(selectiveType, "selective", "@Param(\"selective\")", true));
method.getJavaDocLines().clear();
commentGenerator.addGeneralMethodComment(method, introspectedTable);
return super.clientUpdateByExampleSelectiveMethodGenerated(method, interfaze, introspectedTable);
}
/**
* 替换节点if信息
*
* @param element
* @param prefix
* updateByPrimaryKeySelective
* 具体执行顺序 http://www.mybatis.org/generator/reference/pluggingIn.html
* @param method
* @param interfaze
* @param introspectedTable
* @return
*/
private void replaceEle(XmlElement element, String prefix, IntrospectedTable introspectedTable) {
// choose
XmlElement chooseEle = new XmlElement("choose");
// when
XmlElement whenEle = new XmlElement("when");
whenEle.addAttribute(new Attribute("test", prefix + METHOD_HAS_SELECTIVE + "()"));
for (Element ele : element.getElements()) {
// 对于字符串主键，是没有if判断节点的
if (ele instanceof XmlElement) {
// if的text节点
XmlElement xmlElement = (XmlElement) ele;
// 找出field 名称
String text = ((TextElement) xmlElement.getElements().get(0)).getContent();
String columnName = "";
if (text.matches("#\\{.*\\},?")) {
Pattern pattern = Pattern.compile("#\\{(.*?),.*\\},?");
Matcher matcher = pattern.matcher(text);
if (matcher.find()) {
String field = matcher.group(1);
// 查找对应column
for (IntrospectedColumn column : introspectedTable.getAllColumns()) {
if (column.getJavaProperty().equals(field)) {
columnName = column.getActualColumnName();
}
}
}
} else {
if (text.matches(".*=.*")) {
columnName = text.split("=")[0];
@Override
public boolean clientUpdateByPrimaryKeySelectiveMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable) {
method.getParameters().clear();
FullyQualifiedJavaType parameterType;
if (introspectedTable.getRules().generateRecordWithBLOBsClass()) {
parameterType = new FullyQualifiedJavaType(introspectedTable.getRecordWithBLOBsType());
} else {
columnName = text.replaceAll(",", "");
}
// bug fixed: 修正使用autoDelimitKeywords过滤关键词造成的field前后加了特殊字符的问题
// columnName = columnName.trim().replaceAll("`", "").replaceAll("\"", "").replaceAll("'", "");
parameterType = new FullyQualifiedJavaType(introspectedTable.getBaseRecordType());
}
IntrospectedColumn column = IntrospectedTableTools.safeGetColumn(introspectedTable, columnName);
method.addParameter(new Parameter(parameterType, "record", "@Param(\"record\")"));
// 找出全字段对应的Model
FullyQualifiedJavaType fullFieldModel = introspectedTable.getRules().calculateAllFieldsClass();
// column枚举
FullyQualifiedJavaType selectiveType = new FullyQualifiedJavaType(fullFieldModel.getShortName() + "." + ModelColumnPlugin.ENUM_NAME);
method.addParameter(new Parameter(selectiveType, "selective", "@Param(\"selective\")", true));
XmlElement ifEle = new XmlElement("if");
method.getJavaDocLines().clear();
commentGenerator.addGeneralMethodComment(method, introspectedTable);
ifEle.addAttribute(new Attribute("test", prefix + METHOD_HAS_SELECTIVE + "(\'" + column.getActualColumnName() + "\')"));
for (Element ifChild : xmlElement.getElements()) {
ifEle.addElement(ifChild);
return super.clientUpdateByPrimaryKeySelectiveMethodGenerated(method, interfaze, introspectedTable);
}
whenEle.addElement(ifEle);
/**
* insertSelective
* 具体执行顺序 http://www.mybatis.org/generator/reference/pluggingIn.html
* @param element
* @param introspectedTable
* @return
*/
@Override
public boolean sqlMapInsertSelectiveElementGenerated(XmlElement element, IntrospectedTable introspectedTable) {
// 清空
XmlElement answer = element;
answer.getElements().clear();
answer.getAttributes().clear();
answer.addAttribute(new Attribute("id", introspectedTable.getInsertSelectiveStatementId()));
answer.addAttribute(new Attribute("parameterType", "map"));
commentGenerator.addComment(answer);
GeneratedKey gk = introspectedTable.getGeneratedKey();
if (gk != null) {
IntrospectedColumn introspectedColumn = introspectedTable.getColumn(gk.getColumn());
// if the column is null, then it's a configuration error. The
// warning has already been reported
if (introspectedColumn != null) {
if (gk.isJdbcStandard()) {
answer.addAttribute(new Attribute("useGeneratedKeys", "true"));
answer.addAttribute(new Attribute("keyProperty", introspectedColumn.getJavaProperty()));
answer.addAttribute(new Attribute("keyColumn", introspectedColumn.getActualColumnName()));
} else {
whenEle.addElement(ele);
answer.addElement(XmlElementGeneratorTools.getSelectKey(introspectedColumn, gk));
}
}
// otherwise
XmlElement otherwiseEle = new XmlElement("otherwise");
for (Element ele : element.getElements()) {
otherwiseEle.addElement(ele);
}
chooseEle.addElement(whenEle);
chooseEle.addElement(otherwiseEle);
StringBuilder sb = new StringBuilder();
sb.append("insert into ");
sb.append(introspectedTable.getFullyQualifiedTableNameAtRuntime());
answer.addElement(new TextElement(sb.toString()));
// selective
XmlElement insertChooseEle = new XmlElement("choose");
answer.addElement(insertChooseEle);
XmlElement insertWhenEle = new XmlElement("when");
insertWhenEle.addAttribute(new Attribute("test", "selective.length > 0"));
insertChooseEle.addElement(insertWhenEle);
XmlElement insertForeachEle = new XmlElement("foreach");
insertForeachEle.addAttribute(new Attribute("collection", "selective"));
insertForeachEle.addAttribute(new Attribute("item", "column"));
insertForeachEle.addAttribute(new Attribute("open", "("));
insertForeachEle.addAttribute(new Attribute("separator", ","));
insertForeachEle.addAttribute(new Attribute("close", ")"));
insertForeachEle.addElement(new TextElement("${column.value}"));
insertWhenEle.addElement(insertForeachEle);
XmlElement insertOtherwiseEle = new XmlElement("otherwise");
insertOtherwiseEle.addElement(XmlElementGeneratorTools.generateKeysSelective(
ListUtilities.removeIdentityAndGeneratedAlwaysColumns(introspectedTable.getAllColumns()),
"record."
));
insertChooseEle.addElement(insertOtherwiseEle);
XmlElement insertTrimElement = new XmlElement("trim");
insertTrimElement.addAttribute(new Attribute("prefix", "("));
insertTrimElement.addAttribute(new Attribute("suffix", ")"));
insertTrimElement.addAttribute(new Attribute("suffixOverrides", ","));
insertOtherwiseEle.addElement(insertTrimElement);
// 清空原始节点，新增choose节点
element.getElements().clear();
element.addElement(chooseEle);
XmlElement valuesChooseEle = new XmlElement("choose");
answer.addElement(valuesChooseEle);
XmlElement valuesWhenEle = new XmlElement("when");
valuesWhenEle.addAttribute(new Attribute("test", "selective.length > 0"));
valuesChooseEle.addElement(valuesWhenEle);
XmlElement valuesForeachEle = new XmlElement("foreach");
valuesForeachEle.addAttribute(new Attribute("collection", "selective"));
valuesForeachEle.addAttribute(new Attribute("item", "column"));
valuesForeachEle.addAttribute(new Attribute("open", "values ("));
valuesForeachEle.addAttribute(new Attribute("separator", ","));
valuesForeachEle.addAttribute(new Attribute("close", ")"));
valuesForeachEle.addElement(new TextElement("#{record.${column.javaProperty},jdbcType=${column.jdbcType}}"));
valuesWhenEle.addElement(valuesForeachEle);
XmlElement valuesOtherwiseEle = new XmlElement("otherwise");
valuesOtherwiseEle.addElement(XmlElementGeneratorTools.generateValuesSelective(
ListUtilities.removeIdentityAndGeneratedAlwaysColumns(introspectedTable.getAllColumns()),
"record."
));
valuesChooseEle.addElement(valuesOtherwiseEle);
XmlElement valuesTrimElement = new XmlElement("trim");
valuesTrimElement.addAttribute(new Attribute("prefix", "values ("));
valuesTrimElement.addAttribute(new Attribute("suffix", ")"));
valuesTrimElement.addAttribute(new Attribute("suffixOverrides", ","));
valuesOtherwiseEle.addElement(valuesTrimElement);
return super.sqlMapInsertSelectiveElementGenerated(element, introspectedTable);
}
/**
* 替换节点upsertByExampleSelective if信息
*
* updateByExampleSelective
* 具体执行顺序 http://www.mybatis.org/generator/reference/pluggingIn.html
* @param element
* @param prefix
* @param introspectedTable
* @param allColumns
* @return
*/
private void replaceEleForUpsertByExampleSelective(XmlElement element, String prefix, IntrospectedTable introspectedTable, boolean allColumns) {
// choose
XmlElement chooseEle = new XmlElement("choose");
// when
XmlElement whenEle = new XmlElement("when");
whenEle.addAttribute(new Attribute("test", prefix + METHOD_HAS_SELECTIVE + "()"));
for (IntrospectedColumn introspectedColumn : (allColumns ? introspectedTable.getAllColumns() : introspectedTable.getNonBLOBColumns())) {
XmlElement eleIf = new XmlElement("if");
eleIf.addAttribute(new Attribute("test", prefix + METHOD_HAS_SELECTIVE + "(\'" + introspectedColumn.getActualColumnName() + "\')"));
eleIf.addElement(new TextElement(MyBatis3FormattingUtilities.getParameterClause(introspectedColumn, prefix) + ","));
whenEle.addElement(eleIf);
}
@Override
public boolean sqlMapUpdateByExampleSelectiveElementGenerated(XmlElement element, IntrospectedTable introspectedTable) {
// 清空
XmlElement answer = element;
answer.getElements().clear();
answer.getAttributes().clear();
answer.addAttribute(new Attribute("id", introspectedTable.getUpdateByExampleSelectiveStatementId()));
answer.addAttribute(new Attribute("parameterType", "map"));
// otherwise
XmlElement otherwiseEle = new XmlElement("otherwise");
for (Element ele : element.getElements()) {
otherwiseEle.addElement(ele);
commentGenerator.addComment(answer);
StringBuilder sb = new StringBuilder();
sb.append("update ");
sb.append(introspectedTable.getAliasedFullyQualifiedTableNameAtRuntime());
answer.addElement(new TextElement(sb.toString()));
// selective
XmlElement setChooseEle = new XmlElement("choose");
answer.addElement(setChooseEle);
XmlElement setWhenEle = new XmlElement("when");
setWhenEle.addAttribute(new Attribute("test", "selective.length > 0"));
setChooseEle.addElement(setWhenEle);
XmlElement setForeachEle = new XmlElement("foreach");
setForeachEle.addAttribute(new Attribute("collection", "selective"));
setForeachEle.addAttribute(new Attribute("item", "column"));
setForeachEle.addAttribute(new Attribute("open", "SET"));
setForeachEle.addAttribute(new Attribute("separator", ","));
setForeachEle.addElement(new TextElement("${column.value} = #{record.${column.javaProperty},jdbcType=${column.jdbcType}}"));
setWhenEle.addElement(setForeachEle);
XmlElement setOtherwiseEle = new XmlElement("otherwise");
setOtherwiseEle.addElement(XmlElementGeneratorTools.generateSetsSelective(
ListUtilities.removeGeneratedAlwaysColumns(introspectedTable.getAllColumns()),
"record."
));
setChooseEle.addElement(setOtherwiseEle);
answer.addElement(XmlElementGeneratorTools.getUpdateByExampleIncludeElement(introspectedTable));
return super.sqlMapUpdateByExampleSelectiveElementGenerated(element, introspectedTable);
}
chooseEle.addElement(whenEle);
chooseEle.addElement(otherwiseEle);
/**
* updateByPrimaryKeySelective
* 具体执行顺序 http://www.mybatis.org/generator/reference/pluggingIn.html
* @param element
* @param introspectedTable
* @return
*/
@Override
public boolean sqlMapUpdateByPrimaryKeySelectiveElementGenerated(XmlElement element, IntrospectedTable introspectedTable) {
// 清空
XmlElement answer = element;
answer.getElements().clear();
answer.getAttributes().clear();
answer.addAttribute(new Attribute("id", introspectedTable.getUpdateByPrimaryKeySelectiveStatementId()));
answer.addAttribute(new Attribute("parameterType", "map"));
commentGenerator.addComment(answer);
StringBuilder sb = new StringBuilder();
sb.append("update ");
sb.append(introspectedTable.getFullyQualifiedTableNameAtRuntime());
answer.addElement(new TextElement(sb.toString()));
// selective
XmlElement setChooseEle = new XmlElement("choose");
answer.addElement(setChooseEle);
XmlElement setWhenEle = new XmlElement("when");
setWhenEle.addAttribute(new Attribute("test", "selective.length > 0"));
setChooseEle.addElement(setWhenEle);
XmlElement setForeachEle = new XmlElement("foreach");
setForeachEle.addAttribute(new Attribute("collection", "selective"));
setForeachEle.addAttribute(new Attribute("item", "column"));
setForeachEle.addAttribute(new Attribute("open", "SET"));
setForeachEle.addAttribute(new Attribute("separator", ","));
setForeachEle.addElement(new TextElement("${column.value} = #{record.${column.javaProperty},jdbcType=${column.jdbcType}}"));
setWhenEle.addElement(setForeachEle);
XmlElement setOtherwiseEle = new XmlElement("otherwise");
setOtherwiseEle.addElement(XmlElementGeneratorTools.generateSetsSelective(
ListUtilities.removeGeneratedAlwaysColumns(introspectedTable.getNonPrimaryKeyColumns()),
"record."
));
setChooseEle.addElement(setOtherwiseEle);
XmlElementGeneratorTools.generateWhereByPrimaryKeyTo(answer, introspectedTable.getPrimaryKeyColumns(), "record.");
// 清空原始节点，新增choose节点
element.getElements().clear();
element.addElement(chooseEle);
return super.sqlMapUpdateByPrimaryKeySelectiveElementGenerated(element, introspectedTable);
}
}
src/main/java/com/itfsw/mybatis/generator/plugins/UpsertPlugin.java
View file @ a8c0a38a
......@@ -48,6 +48,7 @@ public class UpsertPlugin extends BasePlugin {
public static final String PRO_ALLOW_MULTI_QUERIES = "allowMultiQueries"; // property allowMultiQueries
private boolean allowMultiQueries = false; // 是否允许多sql提交
private boolean withSelectiveEnhancedPlugin = false; // 是否启用了Selective增强插件
/**
* {@inheritDoc}
......@@ -70,6 +71,9 @@ public class UpsertPlugin extends BasePlugin {
warnings.add("itfsw:插件" + this.getClass().getTypeName() + "插件您开启了allowMultiQueries支持，注意在jdbc url 配置中增加“allowMultiQueries=true”支持（不怎么建议使用该功能，开启多sql提交会增加sql注入的风险，请确保你所有sql都使用MyBatis书写，请不要使用statement进行sql提交）！");
}
// 是否启用了Selective增强插件
this.withSelectiveEnhancedPlugin = PluginTools.checkDependencyPlugin(context, SelectiveEnhancedPlugin.class);
return super.validate(warnings);
}
......@@ -111,12 +115,21 @@ public class UpsertPlugin extends BasePlugin {
}
// ====================================== upsertSelective ======================================
// 找出全字段对应的Model
FullyQualifiedJavaType fullFieldModel = introspectedTable.getRules().calculateAllFieldsClass();
Method mUpsertSelective = JavaElementGeneratorTools.generateMethod(
METHOD_UPSERT_SELECTIVE,
JavaVisibility.DEFAULT,
FullyQualifiedJavaType.getIntInstance(),
new Parameter(introspectedTable.getRules().calculateAllFieldsClass(), "record")
FullyQualifiedJavaType.getIntInstance()
);
if (withSelectiveEnhancedPlugin) {
mUpsertSelective.addParameter(new Parameter(fullFieldModel, "record", "@Param(\"record\")"));
// column枚举
FullyQualifiedJavaType selectiveType = new FullyQualifiedJavaType(fullFieldModel.getShortName() + "." + ModelColumnPlugin.ENUM_NAME);
mUpsertSelective.addParameter(new Parameter(selectiveType, "selective", "@Param(\"selective\")", true));
} else {
mUpsertSelective.addParameter(new Parameter(fullFieldModel, "record"));
}
commentGenerator.addGeneralMethodComment(mUpsertSelective, introspectedTable);
// interface 增加方法
interfaze.addMethod(mUpsertSelective);
......@@ -160,6 +173,11 @@ public class UpsertPlugin extends BasePlugin {
new Parameter(introspectedTable.getRules().calculateAllFieldsClass(), "record", "@Param(\"record\")"),
new Parameter(new FullyQualifiedJavaType(introspectedTable.getExampleType()), "example", "@Param(\"example\")")
);
if (withSelectiveEnhancedPlugin){
// column枚举
FullyQualifiedJavaType selectiveType = new FullyQualifiedJavaType(fullFieldModel.getShortName() + "." + ModelColumnPlugin.ENUM_NAME);
mUpsertByExampleSelective.addParameter(new Parameter(selectiveType, "selective", "@Param(\"selective\")", true));
}
commentGenerator.addGeneralMethodComment(mUpsertByExampleSelective, introspectedTable);
// interface 增加方法
interfaze.addMethod(mUpsertByExampleSelective);
......@@ -191,6 +209,190 @@ public class UpsertPlugin extends BasePlugin {
*/
private void generateXmlElementWithSelective(Document document, IntrospectedTable introspectedTable) {
List<IntrospectedColumn> columns = ListUtilities.removeGeneratedAlwaysColumns(introspectedTable.getAllColumns());
if (withSelectiveEnhancedPlugin) {
// ====================================== upsertSelective ======================================
XmlElement eleUpsertSelective = new XmlElement("insert");
eleUpsertSelective.addAttribute(new Attribute("id", METHOD_UPSERT_SELECTIVE));
eleUpsertSelective.addAttribute(new Attribute("parameterType", "map"));
// 添加注释(!!!必须添加注释，overwrite覆盖生成时，@see XmlFileMergerJaxp.isGeneratedNode会去判断注释中是否存在OLD_ELEMENT_TAGS中的一点，例子：@mbg.generated)
commentGenerator.addComment(eleUpsertSelective);
// 使用JDBC的getGenereatedKeys方法获取主键并赋值到keyProperty设置的领域模型属性中。所以只支持MYSQL和SQLServer
XmlElementGeneratorTools.useGeneratedKeys(eleUpsertSelective, introspectedTable, "record.");
// insert
eleUpsertSelective.addElement(new TextElement("insert into " + introspectedTable.getFullyQualifiedTableNameAtRuntime()));
// selective
XmlElement insertChooseEle = new XmlElement("choose");
eleUpsertSelective.addElement(insertChooseEle);
XmlElement insertWhenEle = new XmlElement("when");
insertWhenEle.addAttribute(new Attribute("test", "selective.length > 0"));
insertChooseEle.addElement(insertWhenEle);
XmlElement insertForeachEle = new XmlElement("foreach");
insertForeachEle.addAttribute(new Attribute("collection", "selective"));
insertForeachEle.addAttribute(new Attribute("item", "column"));
insertForeachEle.addAttribute(new Attribute("open", "("));
insertForeachEle.addAttribute(new Attribute("separator", ","));
insertForeachEle.addAttribute(new Attribute("close", ")"));
insertForeachEle.addElement(new TextElement("${column.value}"));
insertWhenEle.addElement(insertForeachEle);
XmlElement insertOtherwiseEle = new XmlElement("otherwise");
insertOtherwiseEle.addElement(XmlElementGeneratorTools.generateKeysSelective(
ListUtilities.removeIdentityAndGeneratedAlwaysColumns(introspectedTable.getAllColumns()),
"record."
));
insertChooseEle.addElement(insertOtherwiseEle);
XmlElement insertTrimElement = new XmlElement("trim");
insertTrimElement.addAttribute(new Attribute("prefix", "("));
insertTrimElement.addAttribute(new Attribute("suffix", ")"));
insertTrimElement.addAttribute(new Attribute("suffixOverrides", ","));
insertOtherwiseEle.addElement(insertTrimElement);
XmlElement valuesChooseEle = new XmlElement("choose");
eleUpsertSelective.addElement(valuesChooseEle);
XmlElement valuesWhenEle = new XmlElement("when");
valuesWhenEle.addAttribute(new Attribute("test", "selective.length > 0"));
valuesChooseEle.addElement(valuesWhenEle);
XmlElement valuesForeachEle = new XmlElement("foreach");
valuesForeachEle.addAttribute(new Attribute("collection", "selective"));
valuesForeachEle.addAttribute(new Attribute("item", "column"));
valuesForeachEle.addAttribute(new Attribute("open", "values ("));
valuesForeachEle.addAttribute(new Attribute("separator", ","));
valuesForeachEle.addAttribute(new Attribute("close", ")"));
valuesForeachEle.addElement(new TextElement("#{record.${column.javaProperty},jdbcType=${column.jdbcType}}"));
valuesWhenEle.addElement(valuesForeachEle);
XmlElement valuesOtherwiseEle = new XmlElement("otherwise");
valuesOtherwiseEle.addElement(XmlElementGeneratorTools.generateValuesSelective(
ListUtilities.removeIdentityAndGeneratedAlwaysColumns(introspectedTable.getAllColumns()),
"record."
));
valuesChooseEle.addElement(valuesOtherwiseEle);
XmlElement valuesTrimElement = new XmlElement("trim");
valuesTrimElement.addAttribute(new Attribute("prefix", "values ("));
valuesTrimElement.addAttribute(new Attribute("suffix", ")"));
valuesTrimElement.addAttribute(new Attribute("suffixOverrides", ","));
valuesOtherwiseEle.addElement(valuesTrimElement);
eleUpsertSelective.addElement(new TextElement("on duplicate key update "));
// update selective
XmlElement setChooseEle = new XmlElement("choose");
eleUpsertSelective.addElement(setChooseEle);
XmlElement setWhenEle = new XmlElement("when");
setWhenEle.addAttribute(new Attribute("test", "selective.length > 0"));
setChooseEle.addElement(setWhenEle);
XmlElement setForeachEle = new XmlElement("foreach");
setForeachEle.addAttribute(new Attribute("collection", "selective"));
setForeachEle.addAttribute(new Attribute("item", "column"));
setForeachEle.addAttribute(new Attribute("separator", ","));
setForeachEle.addElement(new TextElement("${column.value} = #{record.${column.javaProperty},jdbcType=${column.jdbcType}}"));
setWhenEle.addElement(setForeachEle);
XmlElement setOtherwiseEle = new XmlElement("otherwise");
// set 操作增加增量插件支持
this.incrementsSelectiveSupport(setOtherwiseEle, XmlElementGeneratorTools.generateSetsSelective(columns, "record.", false), introspectedTable, false);
setChooseEle.addElement(setOtherwiseEle);
document.getRootElement().addElement(eleUpsertSelective);
logger.debug("itfsw(存在即更新插件):" + introspectedTable.getMyBatis3XmlMapperFileName() + "增加upsertSelective实现方法。");
if (this.allowMultiQueries) {
// ====================================== upsertByExampleSelective ======================================
XmlElement eleUpsertByExampleSelective = new XmlElement("insert");
eleUpsertByExampleSelective.addAttribute(new Attribute("id", METHOD_UPSERT_BY_EXAMPLE_SELECTIVE));
// 参数类型
eleUpsertByExampleSelective.addAttribute(new Attribute("parameterType", "map"));
// 添加注释(!!!必须添加注释，overwrite覆盖生成时，@see XmlFileMergerJaxp.isGeneratedNode会去判断注释中是否存在OLD_ELEMENT_TAGS中的一点，例子：@mbg.generated)
commentGenerator.addComment(eleUpsertByExampleSelective);
// 使用JDBC的getGenereatedKeys方法获取主键并赋值到keyProperty设置的领域模型属性中。所以只支持MYSQL和SQLServer
XmlElementGeneratorTools.useGeneratedKeys(eleUpsertByExampleSelective, introspectedTable, "record.");
// insert
eleUpsertByExampleSelective.addElement(new TextElement("insert into " + introspectedTable.getFullyQualifiedTableNameAtRuntime()));
// selective
insertChooseEle = new XmlElement("choose");
eleUpsertByExampleSelective.addElement(insertChooseEle);
insertWhenEle = new XmlElement("when");
insertWhenEle.addAttribute(new Attribute("test", "selective.length > 0"));
insertChooseEle.addElement(insertWhenEle);
insertForeachEle = new XmlElement("foreach");
insertForeachEle.addAttribute(new Attribute("collection", "selective"));
insertForeachEle.addAttribute(new Attribute("item", "column"));
insertForeachEle.addAttribute(new Attribute("open", "("));
insertForeachEle.addAttribute(new Attribute("separator", ","));
insertForeachEle.addAttribute(new Attribute("close", ")"));
insertForeachEle.addElement(new TextElement("${column.value}"));
insertWhenEle.addElement(insertForeachEle);
insertOtherwiseEle = new XmlElement("otherwise");
insertOtherwiseEle.addElement(XmlElementGeneratorTools.generateKeysSelective(
ListUtilities.removeIdentityAndGeneratedAlwaysColumns(introspectedTable.getAllColumns()),
"record."
));
insertChooseEle.addElement(insertOtherwiseEle);
insertTrimElement = new XmlElement("trim");
insertTrimElement.addAttribute(new Attribute("prefix", "("));
insertTrimElement.addAttribute(new Attribute("suffix", ")"));
insertTrimElement.addAttribute(new Attribute("suffixOverrides", ","));
insertOtherwiseEle.addElement(insertTrimElement);
this.generateExistsClause(introspectedTable, eleUpsertByExampleSelective, true, columns);
// multiQueries
eleUpsertByExampleSelective.addElement(new TextElement(";"));
// update
eleUpsertByExampleSelective.addElement(new TextElement("update " + introspectedTable.getAliasedFullyQualifiedTableNameAtRuntime()));
eleUpsertByExampleSelective.addElement(new TextElement("set"));
// selective
setChooseEle = new XmlElement("choose");
eleUpsertByExampleSelective.addElement(setChooseEle);
setWhenEle = new XmlElement("when");
setWhenEle.addAttribute(new Attribute("test", "selective.length > 0"));
setChooseEle.addElement(setWhenEle);
setForeachEle = new XmlElement("foreach");
setForeachEle.addAttribute(new Attribute("collection", "selective"));
setForeachEle.addAttribute(new Attribute("item", "column"));
setForeachEle.addAttribute(new Attribute("separator", ","));
setForeachEle.addElement(new TextElement("${column.value} = #{record.${column.javaProperty},jdbcType=${column.jdbcType}}"));
setWhenEle.addElement(setForeachEle);
setOtherwiseEle = new XmlElement("otherwise");
setOtherwiseEle.addElement(XmlElementGeneratorTools.generateSetsSelective(
ListUtilities.removeIdentityAndGeneratedAlwaysColumns(introspectedTable.getAllColumns()),
"record."
));
setChooseEle.addElement(setOtherwiseEle);
// update where
eleUpsertByExampleSelective.addElement(XmlElementGeneratorTools.getUpdateByExampleIncludeElement(introspectedTable));
document.getRootElement().addElement(eleUpsertByExampleSelective);
logger.debug("itfsw(存在即更新插件):" + introspectedTable.getMyBatis3XmlMapperFileName() + "增加upsertSelective实现方法。");
}
} else {
// ====================================== upsertSelective ======================================
XmlElement eleUpsertSelective = new XmlElement("insert");
eleUpsertSelective.addAttribute(new Attribute("id", METHOD_UPSERT_SELECTIVE));
......@@ -247,6 +449,7 @@ public class UpsertPlugin extends BasePlugin {
logger.debug("itfsw(存在即更新插件):" + introspectedTable.getMyBatis3XmlMapperFileName() + "增加upsertSelective实现方法。");
}
}
}
/**
* 当Model有生成WithBLOBs类时的情况
......@@ -254,7 +457,7 @@ public class UpsertPlugin extends BasePlugin {
* @param introspectedTable
*/
private void generateXmlElementWithBLOBs(Document document, IntrospectedTable introspectedTable) {
if (introspectedTable.hasBLOBColumns()){
if (introspectedTable.hasBLOBColumns()) {
List<IntrospectedColumn> columns = ListUtilities.removeGeneratedAlwaysColumns(introspectedTable.getAllColumns());
// ====================================== upsertWithBLOBs ======================================
XmlElement eleUpsertWithBLOBs = new XmlElement("insert");
......@@ -405,7 +608,37 @@ public class UpsertPlugin extends BasePlugin {
private void generateExistsClause(IntrospectedTable introspectedTable, XmlElement element, boolean selective, List<IntrospectedColumn> columns) {
element.addElement(new TextElement("select"));
if (selective) {
if (this.withSelectiveEnhancedPlugin){
// selective
XmlElement chooseEle = new XmlElement("choose");
element.addElement(chooseEle);
XmlElement selectWhenEle = new XmlElement("when");
selectWhenEle.addAttribute(new Attribute("test", "selective.length > 0"));
chooseEle.addElement(selectWhenEle);
XmlElement valuesForeachEle = new XmlElement("foreach");
valuesForeachEle.addAttribute(new Attribute("collection", "selective"));
valuesForeachEle.addAttribute(new Attribute("item", "column"));
valuesForeachEle.addAttribute(new Attribute("separator", ","));
valuesForeachEle.addElement(new TextElement("#{record.${column.javaProperty},jdbcType=${column.jdbcType}}"));
selectWhenEle.addElement(valuesForeachEle);
XmlElement selectOtherwiseEle = new XmlElement("otherwise");
selectOtherwiseEle.addElement(XmlElementGeneratorTools.generateValuesSelective(
ListUtilities.removeIdentityAndGeneratedAlwaysColumns(introspectedTable.getAllColumns()),
"record."
));
chooseEle.addElement(selectOtherwiseEle);
XmlElement valuesTrimElement = new XmlElement("trim");
valuesTrimElement.addAttribute(new Attribute("prefix", "("));
valuesTrimElement.addAttribute(new Attribute("suffix", ")"));
valuesTrimElement.addAttribute(new Attribute("suffixOverrides", ","));
selectOtherwiseEle.addElement(valuesTrimElement);
} else {
element.addElement(XmlElementGeneratorTools.generateValuesSelective(columns, "record.", false));
}
} else {
for (Element element1 : XmlElementGeneratorTools.generateValues(columns, "record.", false)) {
element.addElement(element1);
......
src/main/java/com/itfsw/mybatis/generator/plugins/utils/XmlElementGeneratorTools.java
View file @ a8c0a38a
......@@ -346,7 +346,7 @@ public class XmlElementGeneratorTools {
sb.setLength(0);
}
}
if (sb.length() > 0 || bracket){
if (sb.length() > 0 || bracket) {
list.add(new TextElement(sb.append(bracket ? ")" : "").toString()));
}
......@@ -372,6 +372,21 @@ public class XmlElementGeneratorTools {
}
for (IntrospectedColumn introspectedColumn : columns) {
if (type != 3 && (introspectedColumn.isSequenceColumn() || introspectedColumn.getFullyQualifiedJavaType().isPrimitive())) {
// if it is a sequence column, it is not optional
// This is required for MyBatis3 because MyBatis3 parses
// and calculates the SQL before executing the selectKey
// if it is primitive, we cannot do a null check
switch (type) {
case 2:
eleTrim.addElement(new TextElement(MyBatis3FormattingUtilities.getParameterClause(introspectedColumn, prefix) + ","));
break;
case 1:
eleTrim.addElement(new TextElement(MyBatis3FormattingUtilities.getEscapedColumnName(introspectedColumn) + ","));
break;
}
} else {
XmlElement eleIf = new XmlElement("if");
eleIf.addAttribute(new Attribute("test", introspectedColumn.getJavaProperty(prefix) + " != null"));
......@@ -389,6 +404,7 @@ public class XmlElementGeneratorTools {
eleTrim.addElement(eleIf);
}
}
return eleTrim;
}
......@@ -413,4 +429,39 @@ public class XmlElementGeneratorTools {
return list;
}
/**
* 生成 xxxByPrimaryKey 的where 语句
* @param element
* @param primaryKeyColumns
* @return
*/
public static void generateWhereByPrimaryKeyTo(XmlElement element, List<IntrospectedColumn> primaryKeyColumns) {
generateWhereByPrimaryKeyTo(element, primaryKeyColumns, null);
}
/**
* 生成 xxxByPrimaryKey 的where 语句
* @param element
* @param primaryKeyColumns
* @param prefix
* @return
*/
public static void generateWhereByPrimaryKeyTo(XmlElement element, List<IntrospectedColumn> primaryKeyColumns, String prefix) {
StringBuilder sb = new StringBuilder();
boolean and = false;
for (IntrospectedColumn introspectedColumn : primaryKeyColumns) {
sb.setLength(0);
if (and) {
sb.append(" and ");
} else {
sb.append("where ");
and = true;
}
sb.append(MyBatis3FormattingUtilities.getEscapedColumnName(introspectedColumn));
sb.append(" = ");
sb.append(MyBatis3FormattingUtilities.getParameterClause(introspectedColumn, prefix));
element.addElement(new TextElement(sb.toString()));
}
}
}
src/test/java/com/itfsw/mybatis/generator/plugins/SelectiveEnhancedPluginTest.java
View file @ a8c0a38a
/*
* Copyright (c) 2017.
* Copyright (c) 2018.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
......@@ -33,7 +33,7 @@ import java.sql.SQLException;
*
* ---------------------------------------------------------------------------
* @author: hewei
* @time:2017/7/28 15:47
* @time:2018/4/20 10:57
* ---------------------------------------------------------------------------
*/
public class SelectiveEnhancedPluginTest {
......@@ -42,7 +42,7 @@ public class SelectiveEnhancedPluginTest {
*/
@BeforeClass
public static void init() throws SQLException, IOException, ClassNotFoundException {
DBHelper.createDB("scripts/SelectiveEnhancedPlugin/init.sql");
DBHelper.createDB("scripts/OldSelectiveEnhancedPlugin/init.sql");
}
/**
......@@ -55,36 +55,10 @@ public class SelectiveEnhancedPluginTest {
tool.generate();
Assert.assertEquals(tool.getWarnings().get(0), "itfsw:插件com.itfsw.mybatis.generator.plugins.SelectiveEnhancedPlugin插件需配合com.itfsw.mybatis.generator.plugins.ModelColumnPlugin插件使用！");
// 2. 没有配置UpsertPlugin插件位置配置错误
tool = MyBatisGeneratorTool.create("scripts/SelectiveEnhancedPlugin/mybatis-generator-with-UpsertPlugin-with-wrong-place.xml");
// 2. 同时配置了OldSelectiveEnhancedPlugin插件
tool = MyBatisGeneratorTool.create("scripts/SelectiveEnhancedPlugin/mybatis-generator-with-OldSelectiveEnhancedPlugin.xml");
tool.generate();
Assert.assertEquals(tool.getWarnings().get(0), "itfsw:插件com.itfsw.mybatis.generator.plugins.SelectiveEnhancedPlugin插件建议配置在插件com.itfsw.mybatis.generator.plugins.UpsertPlugin后面，否则某些功能可能得不到增强！");
}
/**
* 测试Model
*/
@Test
public void testModel() throws IOException, XMLParserException, InvalidConfigurationException, InterruptedException, SQLException {
MyBatisGeneratorTool tool = MyBatisGeneratorTool.create("scripts/SelectiveEnhancedPlugin/mybatis-generator.xml");
tool.generate(new AbstractShellCallback() {
@Override
public void reloadProject(SqlSession sqlSession, ClassLoader loader, String packagz) throws Exception {
ObjectUtil tb = new ObjectUtil(loader, packagz + ".Tb");
ObjectUtil TbColumnField1 = new ObjectUtil(loader, packagz + ".Tb$Column#field1");
ObjectUtil TbColumnTsIncF2 = new ObjectUtil(loader, packagz + ".Tb$Column#tsIncF2");
Object columns = Array.newInstance(TbColumnField1.getCls(), 2);
Array.set(columns, 0, TbColumnField1.getObject());
Array.set(columns, 1, TbColumnTsIncF2.getObject());
tb.invoke("selective", columns);
Assert.assertTrue((Boolean) tb.invoke("hasSelective"));
Assert.assertTrue((Boolean) tb.invoke("hasSelective", "field_1"));
Assert.assertFalse((Boolean) tb.invoke("hasSelective", "inc_f1"));
Assert.assertTrue((Boolean) tb.invoke("hasSelective", "inc_f2"));
}
});
Assert.assertEquals(tool.getWarnings().get(0), "itfsw:插件com.itfsw.mybatis.generator.plugins.SelectiveEnhancedPlugin不能和com.itfsw.mybatis.generator.plugins.OldSelectiveEnhancedPlugin插件同时使用！");
}
/**
......@@ -107,12 +81,11 @@ public class SelectiveEnhancedPluginTest {
Object columns = Array.newInstance(TbColumnField1.getCls(), 2);
Array.set(columns, 0, TbColumnField1.getObject());
Array.set(columns, 1, TbColumnTsIncF2.getObject());
tb.invoke("selective", columns);
// sql
String sql = SqlHelper.getFormatMapperSql(tbMapper.getObject(), "insertSelective", tb.getObject());
Assert.assertEquals(sql, "insert into tb ( field_1, inc_f2 ) values ( 'null', 5 )");
Object result = tbMapper.invoke("insertSelective", tb.getObject());
String sql = SqlHelper.getFormatMapperSql(tbMapper.getObject(), "insertSelective", tb.getObject(), columns);
Assert.assertEquals(sql, "insert into tb ( field_1 , inc_f2 ) values ( 'null' , 5 )");
Object result = tbMapper.invoke("insertSelective", tb.getObject(), columns);
Assert.assertEquals(result, 1);
}
});
......@@ -142,12 +115,11 @@ public class SelectiveEnhancedPluginTest {
Object columns = Array.newInstance(TbColumnField1.getCls(), 2);
Array.set(columns, 0, TbColumnField1.getObject());
Array.set(columns, 1, TbColumnTsIncF2.getObject());
tb.invoke("selective", columns);
// sql
String sql = SqlHelper.getFormatMapperSql(tbMapper.getObject(), "updateByExampleSelective", tb.getObject(), TbExample.getObject());
Assert.assertEquals(sql, "update tb SET field_1 = 'null', inc_f2 = 5 WHERE ( id = '1' )");
Object result = tbMapper.invoke("updateByExampleSelective", tb.getObject(), TbExample.getObject());
String sql = SqlHelper.getFormatMapperSql(tbMapper.getObject(), "updateByExampleSelective", tb.getObject(), TbExample.getObject(), columns);
Assert.assertEquals(sql, "update tb SET field_1 = 'null' , inc_f2 = 5 WHERE ( id = '1' )");
Object result = tbMapper.invoke("updateByExampleSelective", tb.getObject(), TbExample.getObject(), columns);
Assert.assertEquals(result, 1);
}
});
......@@ -174,12 +146,11 @@ public class SelectiveEnhancedPluginTest {
Object columns = Array.newInstance(TbColumnField1.getCls(), 2);
Array.set(columns, 0, TbColumnField1.getObject());
Array.set(columns, 1, TbColumnTsIncF2.getObject());
tb.invoke("selective", columns);
// sql
String sql = SqlHelper.getFormatMapperSql(tbMapper.getObject(), "updateByPrimaryKeySelective", tb.getObject());
Assert.assertEquals(sql, "update tb SET field_1 = 'null', inc_f2 = 5 where id = 2");
Object result = tbMapper.invoke("updateByPrimaryKeySelective", tb.getObject());
String sql = SqlHelper.getFormatMapperSql(tbMapper.getObject(), "updateByPrimaryKeySelective", tb.getObject(), columns);
Assert.assertEquals(sql, "update tb SET field_1 = 'null' , inc_f2 = 5 where id = 2");
Object result = tbMapper.invoke("updateByPrimaryKeySelective", tb.getObject(), columns);
Assert.assertEquals(result, 1);
}
});
......@@ -208,12 +179,11 @@ public class SelectiveEnhancedPluginTest {
Array.set(columns, 0, TbColumnId.getObject());
Array.set(columns, 1, TbColumnField1.getObject());
Array.set(columns, 2, TbColumnTsIncF2.getObject());
tb.invoke("selective", columns);
// sql
String sql = SqlHelper.getFormatMapperSql(tbMapper.getObject(), "upsertSelective", tb.getObject());
Assert.assertEquals(sql, "insert into tb ( id, field_1, inc_f2 ) values ( 10, 'null', 5 ) on duplicate key update id = 10, field_1 = 'null', inc_f2 = 5");
Object result = tbMapper.invoke("upsertSelective", tb.getObject());
String sql = SqlHelper.getFormatMapperSql(tbMapper.getObject(), "upsertSelective", tb.getObject(), columns);
Assert.assertEquals(sql, "insert into tb ( id , field_1 , inc_f2 ) values ( 10 , 'null' , 5 ) on duplicate key update id = 10 , field_1 = 'null' , inc_f2 = 5");
Object result = tbMapper.invoke("upsertSelective", tb.getObject(), columns);
Assert.assertEquals(result, 1);
}
});
......@@ -246,14 +216,13 @@ public class SelectiveEnhancedPluginTest {
Array.set(columns, 0, TbColumnId.getObject());
Array.set(columns, 1, TbColumnField1.getObject());
Array.set(columns, 2, TbColumnTsIncF2.getObject());
tb.invoke("selective", columns);
// sql
String sql = SqlHelper.getFormatMapperSql(tbMapper.getObject(), "upsertByExampleSelective", tb.getObject(), TbExample.getObject());
Assert.assertEquals(sql, "insert into tb ( id, field_1, inc_f2 ) select 99, 'null', 5 from dual where not exists ( select 1 from tb WHERE ( id = '99' ) ) ; update tb set inc_f2 = 5, inc_f3 = 10 WHERE ( id = '99' )");
Object result = tbMapper.invoke("upsertByExampleSelective", tb.getObject(), TbExample.getObject());
String sql = SqlHelper.getFormatMapperSql(tbMapper.getObject(), "upsertByExampleSelective", tb.getObject(), TbExample.getObject(), columns);
Assert.assertEquals(sql, "insert into tb ( id , field_1 , inc_f2 ) select 99 , 'null' , 5 from dual where not exists ( select 1 from tb WHERE ( id = '99' ) ) ; update tb set id = 99 , field_1 = 'null' , inc_f2 = 5 WHERE ( id = '99' )");
Object result = tbMapper.invoke("upsertByExampleSelective", tb.getObject(), TbExample.getObject(), columns);
Assert.assertEquals(result, 1);
result = tbMapper.invoke("upsertByExampleSelective", tb.getObject(), TbExample.getObject());
result = tbMapper.invoke("upsertByExampleSelective", tb.getObject(), TbExample.getObject(), columns);
Assert.assertEquals(result, 0);
}
});
......
src/test/java/com/itfsw/mybatis/generator/plugins/tools/SqlHelper.java
View file @ a8c0a38a
......@@ -60,7 +60,7 @@ public class SqlHelper {
*/
public static String getFormatMapperSql(Object mapper, String methodName, Object... args) {
String sql = getMapperSql(mapper, methodName, args);
return sql == null ? null : sql.replaceAll("\n\\s*", " ");
return sql == null ? null : sql.replaceAll("\n", " ").replaceAll("\\s+", " ");
}
/**
......
src/test/resources/scripts/SelectiveEnhancedPlugin/mybatis-generator-with-OldSelectiveEnhancedPlugin.xml 0 → 100644
View file @ a8c0a38a
<?xml version="1.0" encoding="UTF-8"?>
<!--
~ Copyright (c) 2018.
~
~ 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.
-->
<!DOCTYPE generatorConfiguration
PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
"http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">
<generatorConfiguration>
<properties resource="db.properties"/>
<!--导入属性配置 -->
<context id="default" targetRuntime="MyBatis3">
<!-- 插件 -->
<plugin type="com.itfsw.mybatis.generator.plugins.SelectiveEnhancedPlugin" />
<plugin type="com.itfsw.mybatis.generator.plugins.OldSelectiveEnhancedPlugin" />
<plugin type="com.itfsw.mybatis.generator.plugins.ModelColumnPlugin"/>
<!--jdbc的数据库连接 -->
<jdbcConnection driverClass="${driver}" connectionURL="${url}" userId="${username}" password="${password}" />
<!-- Model模型生成器,用来生成含有主键key的类，记录类 以及查询Example类
targetPackage 指定生成的model生成所在的包名
targetProject 指定在该项目下所在的路径 -->
<javaModelGenerator targetPackage="" targetProject=""/>
<!--Mapper映射文件生成所在的目录 为每一个数据库的表生成对应的SqlMap文件 -->
<sqlMapGenerator targetPackage="" targetProject="" />
<!-- 客户端代码，生成易于使用的针对Model对象和XML配置文件 的代码
type="ANNOTATEDMAPPER",生成Java Model 和基于注解的Mapper对象
type="MIXEDMAPPER",生成基于注解的Java Model 和相应的Mapper对象
type="XMLMAPPER",生成SQLMap XML文件和独立的Mapper接口 -->
<javaClientGenerator targetPackage="" targetProject="" type="XMLMAPPER"/>
<!-- +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 要自动生成的表 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
<table tableName="tb">
<generatedKey column="id" sqlStatement="MySql" identity="true"/>
<columnOverride column="inc_f2" property="tsIncF2"/>
</table>
</context>
</generatorConfiguration>
\ No newline at end of file
src/test/resources/scripts/SelectiveEnhancedPlugin/mybatis-generator-without-ModelColumnPlugin.xml
View file @ a8c0a38a
<?xml version="1.0" encoding="UTF-8"?>
<!--
~ Copyright (c) 2017.
~ Copyright (c) 2018.
~
~ Licensed under the Apache License, Version 2.0 (the "License");
~ you may not use this file except in compliance with the License.
......
src/test/resources/scripts/SelectiveEnhancedPlugin/mybatis-generator.xml 0 → 100644
View file @ a8c0a38a
<?xml version="1.0" encoding="UTF-8"?>
<!--
~ Copyright (c) 2018.
~
~ 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.
-->
<!DOCTYPE generatorConfiguration
PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
"http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">
<generatorConfiguration>
<properties resource="db.properties"/>
<!--导入属性配置 -->
<context id="default" targetRuntime="MyBatis3">
<!-- 插件 -->
<plugin type="com.itfsw.mybatis.generator.plugins.UpsertPlugin">
<property name="allowMultiQueries" value="true"/>
</plugin>
<plugin type="com.itfsw.mybatis.generator.plugins.SelectiveEnhancedPlugin"/>
<plugin type="com.itfsw.mybatis.generator.plugins.ModelColumnPlugin"/>
<!--jdbc的数据库连接 -->
<jdbcConnection driverClass="${driver}" connectionURL="${url}" userId="${username}" password="${password}" />
<!-- Model模型生成器,用来生成含有主键key的类，记录类 以及查询Example类
targetPackage 指定生成的model生成所在的包名
targetProject 指定在该项目下所在的路径 -->
<javaModelGenerator targetPackage="" targetProject=""/>
<!--Mapper映射文件生成所在的目录 为每一个数据库的表生成对应的SqlMap文件 -->
<sqlMapGenerator targetPackage="" targetProject="" />
<!-- 客户端代码，生成易于使用的针对Model对象和XML配置文件 的代码
type="ANNOTATEDMAPPER",生成Java Model 和基于注解的Mapper对象
type="MIXEDMAPPER",生成基于注解的Java Model 和相应的Mapper对象
type="XMLMAPPER",生成SQLMap XML文件和独立的Mapper接口 -->
<javaClientGenerator targetPackage="" targetProject="" type="XMLMAPPER"/>
<!-- +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 要自动生成的表 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
<table tableName="tb">
<generatedKey column="id" sqlStatement="MySql" identity="true"/>
<columnOverride column="inc_f2" property="tsIncF2"/>
</table>
</context>
</generatorConfiguration>
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment