Mybatis生成器插件扩展，生成findInSet方法

梦里梦外; 2022-12-26 14:27 317阅读 0赞

Mybatis生成器插件扩展，生成findInSet方法 

  1. public Criteria andNameFindInSet(String value) {
  2.             addCriterionPattern("find_in_set($value, `name`)", value, "name");
  3.             return (Criteria) this;
  4.         }
  6.         public Criteria andNamePattern(String pattern, String value) {
  7.             addCriterionPattern(pattern.replace("##column##", "`name`"), value, "name");
  8.             return (Criteria) this;
  9.         }

一、生成模式原理

（1）Example.Criterion添加pattern字段

  1. public static class Criterion {
  2.         private String condition;
  4.         private Object value;
  6.         private Object secondValue;
  8.         private boolean noValue;
  10.         private boolean singleValue;
  12.         private boolean betweenValue;
  14.         private boolean listValue;
  16.         private String typeHandler;
  18.         private boolean pattern;
  19. }

（2）Example.GeneratedCriteria加方法addCriterionPattern

  1. protected abstract static class GeneratedCriteria
  3.        protected void addCriterionPattern(String condition, Object value, String property) {
  4.             if (value == null) {
  5.                 throw new RuntimeException("Value for " + property + " cannot be null");
  6.             }
  7.             Criterion c = new Criterion(condition, value);
  8.             c.setPattern(true);
  9.             criteria.add(c);
  10.         }
  11. }

（3） 加对应列FindInSet方法

  1. protected abstract static class GeneratedCriteria {
  3.         public Criteria andXXXFindInSet(String value) {
  4.             addCriterionPattern("find_in_set(##value##, `xxx`)", value, "xxx");
  5.             return (Criteria) this;
  6.         }
  7. }

（4）改造XXXSqlProvider.applyWhere的 if (criterion.isNoValue()) 前增加模式代码

  1. if (criterion.isPattern()) {
  2.     String value;
  3.      if (criterion.getTypeHandler() == null) {
  4.         value = String.format(parmPhrase1, "", i, j).trim();
  5.     } else {
  6.         value = String.format(parmPhrase1_th, "", i, j, criterion.getTypeHandler()).trim();
  7.     }
  8.     sb.append(criterion.getCondition().replaceAll("##value##", value));
  9. } else if (criterion.isNoValue()) {
  10.     sb.append(criterion.getCondition());
  11. } else if (criterion.isSingleValue()) {
  13. }

（5）改造XXXMapper.xml的前增加模式代码

  1. <when test="criterion.pattern">
  2.   and
  3.   <foreach collection="criterion.condition.split('##value##')" item="criterionCond" separator="#{criterion.value}">
  4.     ${criterionCond}
  5.   </foreach>
  6. </when>
  7. <when test="criterion.noValue">
  8.   and ${criterion.condition}
  9. </when>

二、插件代码

  1. package com.mk.mybatisgenerator.plugins;
  3. import org.mybatis.generator.api.IntrospectedColumn;
  4. import org.mybatis.generator.api.IntrospectedTable;
  5. import org.mybatis.generator.api.PluginAdapter;
  6. import org.mybatis.generator.api.dom.java.*;
  7. import org.mybatis.generator.api.dom.xml.Attribute;
  8. import org.mybatis.generator.api.dom.xml.Element;
  9. import org.mybatis.generator.api.dom.xml.TextElement;
  10. import org.mybatis.generator.api.dom.xml.XmlElement;
  11. import org.mybatis.generator.codegen.ibatis2.Ibatis2FormattingUtilities;
  12. import java.util.ArrayList;
  13. import java.util.List;
  15. public class MySQLMethodPlugin extends PluginAdapter {
  17.     private final String valueName = "##value##";//值占位符
  18.     private final String columnName = "##column##";//列名占位符
  20.     public MySQLMethodPlugin() {
  21.         super();
  22.     }
  24.     @Override
  25.     public boolean validate(List<String> warnings) {
  26.         return true;
  27.     }
  30.     /**
  31.      * 重写example
  32.      * @param topLevelClass
  33.      * @param introspectedTable
  34.      * @return
  35.      */
  36.     @Override
  37.     public boolean modelExampleClassGenerated(TopLevelClass topLevelClass,
  38.                                               IntrospectedTable introspectedTable) {
  40.         addCriterionPattern(topLevelClass, introspectedTable);//增加模式匹配
  41.         addFindInSet(topLevelClass, introspectedTable);//增加find_in_set方法
  42.         addPattern(topLevelClass,  introspectedTable);//增加模式方法
  44.         return true;
  45.     }
  48.     /**
  49.      * xml ExampleWhere重写
  50.      * @param element
  51.      * @param introspectedTable
  52.      * @return
  53.      */
  54.     @Override
  55.     public boolean sqlMapExampleWhereClauseElementGenerated(XmlElement element, IntrospectedTable introspectedTable) {
  58.         XmlElement whereElement = (XmlElement) element.getElements().get(0);
  59.         XmlElement foreachElement = (XmlElement) whereElement.getElements().get(0);
  60.         XmlElement ifElement = (XmlElement) foreachElement.getElements().get(0);
  61.         XmlElement trimElement = (XmlElement) ifElement.getElements().get(0);
  62.         XmlElement foreachCriteriaElement = (XmlElement) trimElement.getElements().get(0);
  63.         XmlElement chooseElement = (XmlElement) foreachCriteriaElement.getElements().get(0);
  65.         for (Element ele : chooseElement.getElements()) {
  66.             XmlElement noValueElement = (XmlElement) ele;
  67.             for (Attribute attribute : noValueElement.getAttributes()) {
  68.                 //找到criterion.noValue行插入模式代码
  69.                 if (attribute.getName().equals("test") && attribute.getValue().equals("criterion.noValue")) {
  71.                     XmlElement patternElement = new XmlElement("when");
  72.                     patternElement.addAttribute(new Attribute("test", "criterion.pattern"));
  73.                     //<foreach collection="oredCriteria" item="criteria" separator="or">
  74.                     XmlElement forElement = new XmlElement("foreach");
  75.                     forElement.addAttribute(new Attribute("collection", "criterion.condition.split('" + valueName + "')"));
  76.                     forElement.addAttribute(new Attribute("item", "criterionCond"));
  77.                     forElement.addAttribute(new Attribute("separator", "#{criterion.value}"));
  78.                     forElement.addElement(new TextElement("${criterionCond}"));
  80.                     patternElement.addElement(new TextElement("and"));
  81.                     patternElement.addElement(forElement);
  82.                     chooseElement.addElement(0, patternElement);
  83.                     return true;
  84.                 }
  85.             }
  86.         }
  89.         throw new RuntimeException("ChooseElement not exist");
  90.     }
  92.     /**
  93.      * 重写ApplyWhere方法
  94.      * @param method
  95.      * @param topLevelClass
  96.      * @param introspectedTable
  97.      * @return
  98.      */
  99.     @Override
  100.     public boolean providerApplyWhereMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
  102.         List<String> lines = method.getBodyLines();
  103.         for (int i = 0, len = lines.size(); i < len; i++) {
  104.             String line = lines.get(i).trim();
  105.             //找到criterion.noValue行插入模式代码
  106.             if (line.matches("if\\s*\\(criterion\\.isNoValue\\(\\)\\)\\s*\\{")) {
  107.                 lines.remove(i);
  108.                 List<String> appends = new ArrayList<>();
  109.                 appends.add("if (criterion.isPattern()) {");
  110.                 appends.add("String value;");
  111.                 appends.add(" if (criterion.getTypeHandler() == null) {");
  112.                 appends.add("value = String.format(parmPhrase1, \"\", i, j).trim();");
  113.                 appends.add("} else {");
  114.                 appends.add("value = String.format(parmPhrase1_th, \"\", i, j, criterion.getTypeHandler()).trim();");
  115.                 appends.add("}");
  116.                 appends.add("sb.append(criterion.getCondition().replaceAll(\"" + valueName + "\", value));");
  117.                 appends.add("} else " + line);
  118.                 method.addBodyLines(i, appends);
  119.                 return true;
  120.             }
  121.         }
  122.         throw new RuntimeException("criterion.isNoValue() not exist");
  123.     }
  125.     /*
  126.          protected void addCriterionPattern(String condition, Object value, String property) {
  127.                 if (value == null) {
  128.                     throw new RuntimeException("Value for " + property + " cannot be null");
  129.                 }
  130.                 Criterion c = new Criterion(condition, value);
  131.                 c.setPattern(true);
  132.                 criteria.add(c);
  133.             }
  134.          */
  135.     public void addCriterionPattern(TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
  137.         addCriterionPatternField(topLevelClass, introspectedTable);
  139.         InnerClass criteria = null;
  140.         // first, find the Criteria inner class
  141.         for (InnerClass innerClass : topLevelClass.getInnerClasses()) {
  142.             if ("GeneratedCriteria".equals(innerClass.getType().getShortName())) { //$NON-NLS-1$
  143.                 criteria = innerClass;
  144.                 break;
  145.             }
  146.         }
  147.         if (criteria == null) {
  148.             throw new RuntimeException("GeneratedCriteria not exist");
  149.         }
  151.         Method method = new Method();
  152.         method.setVisibility(JavaVisibility.PROTECTED);
  153.         method.addParameter(new Parameter(FullyQualifiedJavaType.getStringInstance(), "condition"));
  154.         method.addParameter(new Parameter(FullyQualifiedJavaType.getObjectInstance(), "value"));
  155.         method.addParameter(new Parameter(FullyQualifiedJavaType.getStringInstance(), "property"));
  157.         method.setName("addCriterionPattern");
  159.         method.addBodyLine("if (value == null) {");
  160.         method.addBodyLine("throw new RuntimeException(\"Value for \" + property + \" cannot be null\");");
  161.         method.addBodyLine("}");
  162.         method.addBodyLine("Criterion c = new Criterion(condition, value);");
  163.         method.addBodyLine("c.setPattern(true);");
  164.         method.addBodyLine("criteria.add(c);");
  165.         criteria.addMethod(method);
  167.     }
  169.     public void addCriterionPatternField(TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
  170.         InnerClass criterion = null;
  171.         // first, find the Criteria inner class
  172.         for (InnerClass innerClass : topLevelClass.getInnerClasses()) {
  173.             if ("Criterion".equals(innerClass.getType().getShortName())) { //$NON-NLS-1$
  174.                 criterion = innerClass;
  175.                 break;
  176.             }
  177.         }
  178.         if (criterion == null) {
  179.             throw new RuntimeException("Criterion not exist");
  180.         }
  182.         FullyQualifiedJavaType booleanPrimitive = FullyQualifiedJavaType.getBooleanPrimitiveInstance();
  184.         Field pattern = new Field();
  185.         pattern.setName("pattern");
  186.         pattern.setVisibility(JavaVisibility.PRIVATE);
  187.         pattern.setType(booleanPrimitive);
  188.         criterion.addField(pattern);
  190.         Method setPattern = new Method();
  191.         setPattern.setVisibility(JavaVisibility.PUBLIC);
  192.         setPattern.setName("setPattern");
  193.         setPattern.addParameter(new Parameter(booleanPrimitive, "pattern"));
  194.         setPattern.addBodyLine("this.pattern = pattern;");
  195.         criterion.addMethod(setPattern);
  197.         Method isPattern = new Method();
  198.         isPattern.setVisibility(JavaVisibility.PUBLIC);
  199.         isPattern.setReturnType(booleanPrimitive);
  200.         isPattern.setName("isPattern");
  201.         isPattern.addBodyLine("return pattern;");
  202.         criterion.addMethod(isPattern);
  203.     }
  205.     public void addFindInSet(TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
  206.         addFindInSetPattern(topLevelClass, introspectedTable, "findInSet", "find_in_set(" + valueName + ", " + columnName + ")");
  207.     }
  211.     public void addFindInSetPattern(TopLevelClass topLevelClass, IntrospectedTable introspectedTable, String opName, String pattern) {
  212.         InnerClass criteria = null;
  213.         // first, find the Criteria inner class
  214.         for (InnerClass innerClass : topLevelClass.getInnerClasses()) {
  215.             if ("GeneratedCriteria".equals(innerClass.getType().getShortName())) { //$NON-NLS-1$
  216.                 criteria = innerClass;
  217.                 break;
  218.             }
  219.         }
  221.         if (criteria == null) {
  222.             throw new RuntimeException("GeneratedCriteria not exist");
  223.         }
  225.         for (IntrospectedColumn introspectedColumn : introspectedTable
  226.                 .getNonBLOBColumns()) {
  227.             if (!introspectedColumn.isJdbcCharacterColumn()
  228.                     || !introspectedColumn.isStringColumn()) {
  229.                 continue;
  230.             }
  232.             Method method = new Method();
  233.             method.setVisibility(JavaVisibility.PUBLIC);
  234.             method.addParameter(new Parameter(introspectedColumn
  235.                     .getFullyQualifiedJavaType(), "value")); //$NON-NLS-1$
  237.             StringBuilder opNameBuilder = new StringBuilder(opName);
  238.             opNameBuilder.setCharAt(0, Character.toUpperCase(opNameBuilder.charAt(0)));
  239.             opName = opNameBuilder.toString();
  241.             StringBuilder sb = new StringBuilder();
  242.             sb.append(introspectedColumn.getJavaProperty());
  243.             sb.setCharAt(0, Character.toUpperCase(sb.charAt(0)));
  244.             sb.insert(0, "and"); //$NON-NLS-1$
  245.             sb.append(opName);
  246.             method.setName(sb.toString());
  247.             method.setReturnType(FullyQualifiedJavaType.getCriteriaInstance());
  249.             sb.setLength(0);
  250.             sb.append("addCriterionPattern(\"")
  251.                     .append(pattern.replaceAll(columnName, Ibatis2FormattingUtilities.getAliasedActualColumnName(introspectedColumn)))
  252.                     .append("\", value, \"")
  253.                     .append(introspectedColumn.getJavaProperty());
  254.             sb.append("\");");
  255.             method.addBodyLine(sb.toString());
  256.             method.addBodyLine("return (Criteria) this;");
  258.             criteria.addMethod(method);
  259.         }
  260.     }
  262.     public void addPattern(TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
  263.         addPatternMethod(topLevelClass, introspectedTable, "pattern");
  264.     }
  266.     public void addPatternMethod(TopLevelClass topLevelClass, IntrospectedTable introspectedTable, String opName){
  267.         InnerClass criteria = null;
  268.         // first, find the Criteria inner class
  269.         for (InnerClass innerClass : topLevelClass.getInnerClasses()) {
  270.             if ("GeneratedCriteria".equals(innerClass.getType().getShortName())) { //$NON-NLS-1$
  271.                 criteria = innerClass;
  272.                 break;
  273.             }
  274.         }
  276.         if (criteria == null) {
  277.             throw new RuntimeException("GeneratedCriteria not exist");
  278.         }
  280.         for (IntrospectedColumn introspectedColumn : introspectedTable
  281.                 .getNonBLOBColumns()) {
  282.             if (!introspectedColumn.isJdbcCharacterColumn()
  283.                     || !introspectedColumn.isStringColumn()) {
  284.                 continue;
  285.             }
  287.             Method method = new Method();
  288.             method.setVisibility(JavaVisibility.PUBLIC);
  289.             method.addParameter(new Parameter(FullyQualifiedJavaType.getStringInstance(), "pattern"));
  290.             method.addParameter(new Parameter(introspectedColumn
  291.                     .getFullyQualifiedJavaType(), "value"));
  293.             StringBuilder opNameBuilder = new StringBuilder(opName);
  294.             opNameBuilder.setCharAt(0, Character.toUpperCase(opNameBuilder.charAt(0)));
  295.             opName = opNameBuilder.toString();
  297.             StringBuilder sb = new StringBuilder();
  298.             sb.append(introspectedColumn.getJavaProperty());
  299.             sb.setCharAt(0, Character.toUpperCase(sb.charAt(0)));
  300.             sb.insert(0, "and"); //$NON-NLS-1$
  301.             sb.append(opName);
  302.             method.setName(sb.toString());
  303.             method.setReturnType(FullyQualifiedJavaType.getCriteriaInstance());
  305.             sb.setLength(0);
  306.             sb.append("addCriterionPattern(pattern.replaceAll(\"")
  307.                     .append(columnName).append("\", \"")
  308.                     .append(Ibatis2FormattingUtilities.getAliasedActualColumnName(introspectedColumn)).append("\")")
  309.                     .append(", value, \"")
  310.                     .append(introspectedColumn.getJavaProperty());
  311.             sb.append("\");");
  312.             method.addBodyLine(sb.toString());
  313.             method.addBodyLine("return (Criteria) this;");
  315.             criteria.addMethod(method);
  316.         }
  317.     }
  319. }

三、配置插件

  1. <plugin type="com.mk.mybatisgenerator.plugins.MySQLMethodPlugin"/>

发表评论

表情：
评论列表 （有 0 条评论，317人围观）

还没有评论，来说两句吧...

相关阅读