mybatis(mysql)代码生成器扩展

前些天在做我的KSF框架的时候需要用到mybatis代码生成器，

但是发现有一些东西需要调整，主要集中在以下几点：

1. 加入batchInsert 

2. 加入batchUpdate

3. mysql字段名和关键字冲突问题

4. 生成的实体类继承基类

5. mapper继承基础接口，实现自己的代码

6. insert之后获取生成的ID

7. 使实体可序列化

---

 加入batchInsert 

1.在generatorConfig.xml中加入以下插件

<plugin type="com.itfsw.mybatis.generator.plugins.BatchInsertPlugin"/>

2.在pom的mybatis-generator-maven-plugin中加入以下依赖

<dependency>
    <groupId>com.itfsw</groupId>
    <artifactId>mybatis-generator-plugin</artifactId>
    <version>1.0.5</version>
</dependency>

加入batchUpdate

1.在generatorConfig.xml中加入以下插件

<plugin type="com.kuta.base.mybatis.plugins.KutaBatchUpdatePlugin"/>

2.编写插件代码

 package com.kuta.base.mybatis.plugins;

 import java.util.List;

 import org.mybatis.generator.api.IntrospectedColumn;
 import org.mybatis.generator.api.IntrospectedTable;
 import org.mybatis.generator.api.dom.java.FullyQualifiedJavaType;
 import org.mybatis.generator.api.dom.java.Interface;
 import org.mybatis.generator.api.dom.java.TopLevelClass;
 import org.mybatis.generator.api.dom.xml.Document;
 import org.mybatis.generator.api.dom.xml.TextElement;
 import org.mybatis.generator.api.dom.xml.XmlElement;
 import org.mybatis.generator.codegen.mybatis3.MyBatis3FormattingUtilities;
 import org.mybatis.generator.config.MergeConstants;

 import com.kuta.base.database.util.SqlMapperGeneratorTool;

 public class KutaBatchUpdatePlugin extends org.mybatis.generator.api.PluginAdapter{

     private final static String BATCH_UPDATE = "batchUpdate";

     private final static String PARAMETER_NAME = "recordList";

     @Override
     public boolean validate(List<String> list) {
         return true;
     }

     @Override
     public boolean clientGenerated(Interface interfaze, TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {

         if (introspectedTable.getTargetRuntime().equals(IntrospectedTable.TargetRuntime.MYBATIS3)) {
             MethodGeneratorTool.defaultBatchInsertOrUpdateMethodGen(MethodGeneratorTool.UPDATE, interfaze, introspectedTable, context);
         }
         return super.clientGenerated(interfaze, topLevelClass, introspectedTable);
     }

     @Override
     public boolean sqlMapDocumentGenerated(Document document, IntrospectedTable introspectedTable) {
         if (introspectedTable.getTargetRuntime().equals(IntrospectedTable.TargetRuntime.MYBATIS3)) {
             addSqlMapper(document, introspectedTable);
         }
         return super.sqlMapDocumentGenerated(document, introspectedTable);
     }

     public void addSqlMapper(Document document, IntrospectedTable introspectedTable) {
         String tableName = introspectedTable.getFullyQualifiedTableNameAtRuntime();
         List<IntrospectedColumn> columnList = introspectedTable.getAllColumns();
         //primaryKey的JDBC名字
         String primaryKeyName = introspectedTable.getPrimaryKeyColumns().get(0).getActualColumnName();

         //primaryKey的JAVA变量
         String primaryKeyParameterClause = MyBatis3FormattingUtilities.getParameterClause(introspectedTable.getPrimaryKeyColumns().get(0), "item.");

         //primaryKey的JAVA名字
         String primaryKeyJavaName = introspectedTable.getPrimaryKeyColumns().get(0).getJavaProperty();

         XmlElement updateXmlElement = SqlMapperGeneratorTool.baseElementGenerator(SqlMapperGeneratorTool.UPDATE,
                 BATCH_UPDATE,
                 FullyQualifiedJavaType.getNewListInstance());
         updateXmlElement.addElement(new TextElement("<!-- generated by Kuta batchUpdate plugin - "
                 + MergeConstants.NEW_ELEMENT_TAG + " -->"));
         updateXmlElement.addElement(new TextElement(String.format("update %s ", tableName)));

         XmlElement trimElement = SqlMapperGeneratorTool.baseTrimElement("set", null, ",");

         for (int i = 0; i < columnList.size(); i++) {

             IntrospectedColumn introspectedColumn = columnList.get(i);

             String columnName = introspectedColumn.getActualColumnName();

             String columnJavaTypeName = introspectedColumn.getJavaProperty("item.");

             String parameterClause = MyBatis3FormattingUtilities.getParameterClause(introspectedColumn, "item.");

             if (introspectedColumn.isIdentity()) {
                 continue;
             }

             String ifSql = String.format("when %s then %s", primaryKeyParameterClause, parameterClause);
             XmlElement ifElement = SqlMapperGeneratorTool.baseIfJudgeElementGen(columnJavaTypeName, ifSql, false);

             String ifNullSql = String.format("when %s then %s", primaryKeyParameterClause, tableName + "." + columnName);
             XmlElement ifNullElement = SqlMapperGeneratorTool.baseIfJudgeElementGen(columnJavaTypeName, ifNullSql, true);

             XmlElement foreachElement = SqlMapperGeneratorTool.baseForeachElementGenerator(PARAMETER_NAME, "item", "index", null);
             foreachElement.addElement(ifElement);
             foreachElement.addElement(ifNullElement);

             XmlElement caseTrimElement = SqlMapperGeneratorTool.baseTrimElement(columnName + " =case " + primaryKeyName, "end,", null);
             caseTrimElement.addElement(foreachElement);

             trimElement.addElement(caseTrimElement);
         }

         updateXmlElement.addElement(trimElement);

         XmlElement foreachElement = SqlMapperGeneratorTool.baseForeachElementGenerator(PARAMETER_NAME,
                 "item",
                 "index",
                 ",");
         foreachElement.addElement(new TextElement(primaryKeyParameterClause));

         updateXmlElement.addElement(new TextElement(String.format("where %s in(", primaryKeyName)));

         updateXmlElement.addElement(foreachElement);

         updateXmlElement.addElement(new TextElement(")"));

         document.getRootElement().addElement(updateXmlElement);
     }

 }

 package com.kuta.base.mybatis.plugins;

 import java.util.Set;
 import java.util.TreeSet;

 import org.mybatis.generator.api.CommentGenerator;
 import org.mybatis.generator.api.IntrospectedTable;
 import org.mybatis.generator.api.dom.java.FullyQualifiedJavaType;
 import org.mybatis.generator.api.dom.java.Interface;
 import org.mybatis.generator.api.dom.java.JavaVisibility;
 import org.mybatis.generator.api.dom.java.Method;
 import org.mybatis.generator.api.dom.java.Parameter;
 import org.mybatis.generator.config.Context;

 public class MethodGeneratorTool {
     private final static String BATCH_INSERT = "batchInsert";

     private final static String PARAMETER_NAME = "recordList";

     private final static String DELETE_PARAMETER_NAME = "ids";

     private final static String BATCH_UPDATE = "batchUpdate";

     private final static String BATCH_DELETE = "batchDelete";

     public final static Integer INSERT = 0;

     public final static Integer UPDATE = 1;
     /**
      * java方法生成构造器.
      *
      * @param methodName     the method name
      * @param visibility     the visibility
      * @param returnJavaType the return java type
      * @param parameters     the parameters
      * @author HuWeihui
      * @since hui_project v1
      */
     public static Method methodGenerator(String methodName,
                                        JavaVisibility visibility,
                                        FullyQualifiedJavaType returnJavaType,
                                        Parameter... parameters) {
         Method method = new Method();
         method.setName(methodName);
         method.setVisibility(visibility);
         method.setReturnType(returnJavaType);
         for (Parameter parameter : parameters) {
             method.addParameter(parameter);
         }
         return method;
     }

     /**
      * 导入基础的java类型
      *
      * @param introspectedTable the introspected table
      * @return the set
      * @author HuWeihui
      * @since hui_project v1
      */
     public static Set<FullyQualifiedJavaType> importedBaseTypesGenerator(IntrospectedTable introspectedTable){
         //获取实体类类型
         FullyQualifiedJavaType parameterType = introspectedTable.getRules().calculateAllFieldsClass();
         //@Param需要导入的类型
         FullyQualifiedJavaType paramType = new FullyQualifiedJavaType("org.apache.ibatis.annotations.Param");
         //Integer类型
         FullyQualifiedJavaType intInstance = FullyQualifiedJavaType.getIntInstance();
         //List<Entity>
         FullyQualifiedJavaType listParameterType = FullyQualifiedJavaType.getNewListInstance();

         Set<FullyQualifiedJavaType> importedTypes = new TreeSet<FullyQualifiedJavaType>();
         importedTypes.add(parameterType);
         importedTypes.add(intInstance);
         importedTypes.add(paramType);
         importedTypes.add(listParameterType);
         return importedTypes;
     }

     /**
      * 默认的批量新增/更新方法构造器.
      *
      * @param interfaze         the interfaze
      * @param introspectedTable the introspected table
      * @param context           the context
      * @author HuWeihui
      * @since hui_project v1
      */
     public static void defaultBatchInsertOrUpdateMethodGen(Integer type ,Interface interfaze,IntrospectedTable introspectedTable, Context context){
         //JAVA导入基础包
         Set<FullyQualifiedJavaType> importedTypes = MethodGeneratorTool.importedBaseTypesGenerator(introspectedTable);

         //List<Entity>
         FullyQualifiedJavaType listParameterType = FullyQualifiedJavaType.getNewListInstance();
         listParameterType.addTypeArgument(introspectedTable.getRules().calculateAllFieldsClass());

         String methodName = BATCH_INSERT;
         //1.batchInsert
         if (type.equals(UPDATE)){
             methodName = BATCH_UPDATE;
         }
         Method insertMethod = MethodGeneratorTool.methodGenerator(methodName,
                 JavaVisibility.DEFAULT,
                 FullyQualifiedJavaType.getIntInstance(),
                 new Parameter(listParameterType, PARAMETER_NAME, "@Param(\"" + PARAMETER_NAME + "\")"));

         CommentGenerator commentGenerator = context.getCommentGenerator();
         commentGenerator.addGeneralMethodComment(insertMethod, introspectedTable);

         interfaze.addImportedTypes(importedTypes);
         interfaze.addMethod(insertMethod);
     }

     /**
      * 默认的批量删除方法构造器.
      *
      * @param interfaze         the interfaze
      * @param introspectedTable the introspected table
      * @param context           the context
      * @author HuWeihui
      * @since hui_project v1
      */
     public static void defaultBatchDeleteMethodGen(Interface interfaze,IntrospectedTable introspectedTable, Context context){
         //JAVA导入基础包
         Set<FullyQualifiedJavaType> importedTypes = MethodGeneratorTool.importedBaseTypesGenerator(introspectedTable);
         FullyQualifiedJavaType paramType = introspectedTable.getPrimaryKeyColumns().get(0).getFullyQualifiedJavaType();
         Method batchDeleteMethod = MethodGeneratorTool.methodGenerator(BATCH_DELETE,
                 JavaVisibility.DEFAULT,
                 FullyQualifiedJavaType.getIntInstance(),
                 new Parameter(new FullyQualifiedJavaType(paramType.getFullyQualifiedName()+"[]"), DELETE_PARAMETER_NAME, "@Param(\""+DELETE_PARAMETER_NAME+"\")"));

         context.getCommentGenerator().addGeneralMethodComment(batchDeleteMethod,introspectedTable);
         interfaze.addImportedTypes(importedTypes);
         interfaze.addMethod(batchDeleteMethod);
     }
 }

3. 在pom的mybatis-generator-maven-plugin中加入以上代码所在库的依赖

mysql字段名和关键字冲突问题

1.在generatorConfig.xml中加入以下属性配置

<property name="beginningDelimiter" value="`"></property >
<property name="endingDelimiter" value="`"></property >

2. 在table节点加入delimitAllColumns="true"属性

生成的实体类继承基类

在generatorConfig.xml文件中的javaModelGenerator节点中加入以下属性配置

<property name="rootClass" value="com.kuta.base.database.entity.KutaDBEntity"/>

mapper继承基础接口，实现自己的代码

在generatorConfig.xml文件中的table节点加入以下属性配置

<property name="rootInterface" value="com.simcity.database.dao.extend.BuildMapperBase"/>

insert之后获取生成的ID

在generatorConfig.xml文件中的table节点加入以下属性配置

<generatedKey column="bid" sqlStatement="MySql" identity="true"/>

使实体可序列化

在generatorConfig.xml文件中加入以下属性配置

<plugin type="org.mybatis.generator.plugins.SerializablePlugin" />