关于Mybatis mybatis-generator自动生成格式代码样例

缺乏、安全感 2022-03-18 06:11 106阅读 0赞

## 关于Mybatis mybatis-generator自动生成格式代码样例 ##

1.  pom.xml

<dependency>
                <groupId>org.mybatis.spring.boot</groupId>
                <artifactId>mybatis-spring-boot-starter</artifactId>
                <version>1.3.2</version>
            </dependency>
            
            <dependency>
                <groupId>org.mybatis.generator</groupId>
                <artifactId>mybatis-generator-core</artifactId>
                <version>1.3.5</version>
            </dependency>

1.  重写代码生成时的内容注解（根据需要调整）

/**
     * @ClassName: MyCommentGenerator
     * @Description: 重写代码生成时的内容注解
     * @Author: Mr.Zhang
     * @Date: Created in 15:32 2019/2/19
     * @Verson: 1.0
     **/
    public class MyCommentGenerator implements CommentGenerator {
        /**
         * properties配置文件
         */
        private Properties properties;
        /**
         * properties配置文件
         */
        private Properties systemPro;
    
        /*
         * 父类时间
         */
        private boolean suppressDate;
    
        /**
         * 父类所有注释
         */
        private boolean suppressAllComments;
    
        /**
         * 当前时间
         */
        private String currentDateStr;
    
        public MyCommentGenerator() {
            super();
            properties = new Properties();
            systemPro = System.getProperties();
            suppressDate = false;
            suppressAllComments = false;
            currentDateStr = (new SimpleDateFormat("yyyy-MM-dd HH:mm:ss")).format(new Date());
        }
    
        /**
         * Java类的类注释
         */
        @Override
        public void addClassComment(InnerClass innerClass, IntrospectedTable introspectedTable) {
            if (suppressAllComments) {
                return;
            }
    
            StringBuilder sb = new StringBuilder();
            innerClass.addJavaDocLine("/**");
            sb.append(" * ");
            sb.append(introspectedTable.getFullyQualifiedTable());
            sb.append(" ");
            sb.append(getDateString());
            innerClass.addJavaDocLine(sb.toString().replace("\n", " "));
            innerClass.addJavaDocLine(" */");
        }
    
        /**
         * 为类添加注释
         */
        @Override
        public void addClassComment(InnerClass innerClass, IntrospectedTable introspectedTable, boolean markAsDoNotDelete) {
            if (suppressAllComments) {
                return;
            }
            StringBuilder sb = new StringBuilder();
            innerClass.addJavaDocLine("/**");
            sb.append(" * ");
            sb.append(" * ");
            sb.append(introspectedTable.getFullyQualifiedTable());
            innerClass.addJavaDocLine(sb.toString().replace("\n", " "));
            sb.setLength(0);
            sb.append(" * @author ");
            sb.append(systemPro.getProperty("user.name"));
            sb.append(" ");
            sb.append(currentDateStr);
            innerClass.addJavaDocLine(" */");
        }
    
    
        /**
         * Mybatis的Mapper.xml文件里面的注释
         */
        @Override
        public void addComment(XmlElement xmlElement) {
    
        }
    
        /**
         *
         *@Title addConfigurationProperties
         *@Description: 从该配置中的任何属性添加此实例的属性CommentGenerator配置。
         *              这个方法将在任何其他方法之前被调用。
         *@Author
         *@Date 2017年10月5日 下午3:45:58
         *@return
         *@throws
         */
        @Override
        public void addConfigurationProperties(Properties properties) {
            this.properties.putAll(properties);
            suppressDate = isTrue(properties.getProperty(PropertyRegistry.COMMENT_GENERATOR_SUPPRESS_DATE));
            suppressAllComments = isTrue(properties.getProperty(PropertyRegistry.COMMENT_GENERATOR_SUPPRESS_ALL_COMMENTS));
        }
    
        /**
         *
         *@Title getDateString
         *@Description: 此方法返回格式化的日期字符串以包含在Javadoc标记中和XML注释。 如果您不想要日期，则可以返回null在这些文档元素中。
         *@Author
         *@Date 2017年10月5日 下午3:45:58
         *@return
         *@throws
         */
        protected String getDateString() {
            String result = null;
            if (!suppressDate) {
                result = currentDateStr;
            }
            return result;
        }
    
        /**
         *
         *@Title addJavadocTag
         *@Description: 此方法为其添加了自定义javadoc标签。
         *@Author
         *@Date 2017年10月5日 下午3:49:05
         *@param javaElement
         *@param markAsDoNotDelete
         *@throws
         */
        protected void addJavadocTag(JavaElement javaElement, boolean markAsDoNotDelete) {
            javaElement.addJavaDocLine(" *");
            StringBuilder sb = new StringBuilder();
            sb.append(" * ");
            sb.append(MergeConstants.NEW_ELEMENT_TAG);
            if (markAsDoNotDelete) {
                sb.append(" do_not_delete_during_merge");
            }
            String s = getDateString();
            if (s != null) {
                sb.append(' ');
                sb.append(s);
            }
            javaElement.addJavaDocLine(sb.toString());
        }
    
    
        /**
         * 为枚举添加注释
         */
        @Override
        public void addEnumComment(InnerEnum innerEnum, IntrospectedTable introspectedTable) {
            if (suppressAllComments) {
                return;
            }
            StringBuilder sb = new StringBuilder();
            innerEnum.addJavaDocLine("/**");
            sb.append(" * ");
            sb.append(introspectedTable.getFullyQualifiedTable());
            innerEnum.addJavaDocLine(sb.toString().replace("\n", " "));
            innerEnum.addJavaDocLine(" */");
        }
    
        /**
         * Java属性注释
         */
        @Override
        public void addFieldComment(Field field, IntrospectedTable introspectedTable) {
            if (suppressAllComments) {
                return;
            }
            StringBuilder sb = new StringBuilder();
            field.addJavaDocLine("/**");
            sb.append(" * ");
            sb.append(introspectedTable.getFullyQualifiedTable());
            field.addJavaDocLine(sb.toString().replace("\n", " "));
            field.addJavaDocLine(" */");
        }
    
        /**
         * 为字段添加注释
         */
        @Override
        public void addFieldComment(Field field, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn) {
            if (suppressAllComments) {
                return;
            }
            StringBuilder sb = new StringBuilder();
            field.addJavaDocLine("/**");
            sb.append(" * ");
            sb.append(introspectedColumn.getRemarks());
            field.addJavaDocLine(sb.toString().replace("\n", " "));
            field.addJavaDocLine(" */");
        }
    
        /**
         * 普通方法的注释，这里主要是XXXMapper.java里面的接口方法的注释
         */
        @Override
        public void addGeneralMethodComment(Method method, IntrospectedTable introspectedTable) {
            if (suppressAllComments) {
                return;
            }
            method.addJavaDocLine("/**");
            addJavadocTag(method, false);
            method.addJavaDocLine(" */");
        }
    
    
        /**
         * 给getter方法加注释
         */
        @Override
        public void addGetterComment(Method method, IntrospectedTable introspectedTable,IntrospectedColumn introspectedColumn) {
            if (suppressAllComments) {
                return;
            }
            method.addJavaDocLine("/**");
            StringBuilder sb = new StringBuilder();
            sb.append(" * ");
            sb.append(introspectedColumn.getRemarks());
            method.addJavaDocLine(sb.toString().replace("\n", " "));
            sb.setLength(0);
            sb.append(" * @return ");
            sb.append(introspectedColumn.getActualColumnName());
            sb.append(" ");
            sb.append(introspectedColumn.getRemarks());
            method.addJavaDocLine(sb.toString().replace("\n", " "));
            method.addJavaDocLine(" */");
        }
    
        /**
         * 给Java文件加注释，这个注释是在文件的顶部，也就是package上面。
         */
        @Override
        public void addJavaFileComment(CompilationUnit compilationUnit) {
            SimpleDateFormat sdf=new SimpleDateFormat("yyyy-MM-dd");
            compilationUnit.addFileCommentLine("/*");
            compilationUnit.addFileCommentLine("*");
            compilationUnit.addFileCommentLine("* "+compilationUnit.getType().getShortName()+".java");
            compilationUnit.addFileCommentLine("* ");
            compilationUnit.addFileCommentLine("* @date "+sdf.format(new Date())+"");
            compilationUnit.addFileCommentLine("*/");
        }
    
        /**
         * 为模型类添加注释
         */
        @Override
        public void addModelClassComment(TopLevelClass arg0, IntrospectedTable arg1) {
    
        }
    
        /**
         * 为调用此方法作为根元素的第一个子节点添加注释。
         */
        @Override
        public void addRootComment(XmlElement arg0) {
    
        }
    
    
        /**
         * 给setter方法加注释
         */
        @Override
        public void addSetterComment(Method method, IntrospectedTable introspectedTable,IntrospectedColumn introspectedColumn) {
            if (suppressAllComments) {
                return;
            }
            method.addJavaDocLine("/**");
            StringBuilder sb = new StringBuilder();
            sb.append(" * ");
            sb.append(introspectedColumn.getRemarks());
            method.addJavaDocLine(sb.toString().replace("\n", " "));
            Parameter parm = method.getParameters().get(0);
            sb.setLength(0);
            sb.append(" * @param ");
            sb.append(parm.getName());
            sb.append(" ");
            sb.append(introspectedColumn.getRemarks());
            method.addJavaDocLine(sb.toString().replace("\n", " "));
            method.addJavaDocLine(" */");
        }
    }

1.  解决到重复生产时代码覆盖的问题（重写PluginAdapter类）

/**
     * @ClassName: OverIsMergeablePlugin
     * @Description:
     * @Author: Mr.Zhang
     * @Date: Created in 15:38 2019/2/19
     * @Verson: 1.0
     **/
    public class OverIsMergeablePlugin extends PluginAdapter {
    
        @Override
        public boolean validate(List<String> list) {
            return false;
        }
    
        @Override
        public boolean sqlMapGenerated(GeneratedXmlFile sqlMap, IntrospectedTable introspectedTable) {
            try {
                Field field = sqlMap.getClass().getDeclaredField("isMergeable");
                field.setAccessible(true);
                field.setBoolean(sqlMap, false);
            } catch (Exception e) {
                e.printStackTrace();
            }
            return true;
        }
    }

1.  mybatis-generator模板配置文件（generatorConfig.xml）

<?xml version="1.0" encoding="UTF-8"?>
    <!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="config.properties" />
    
        
        <classPathEntry location="F:\repository\mysql\mysql-connector-java\5.1.25\mysql-connector-java-5.1.25.jar" />
    
        <context id="generatorContext" targetRuntime="MyBatis3">
    
            <plugin type="com.bookreflect.generator.OverIsMergeablePlugin" />
    
            
            <commentGenerator type="com.bookreflect.generator.MyCommentGenerator">
                <property name="suppressDate" value="false" />
                <property name="suppressAllComments" value="false" />
                <property name="addRemarkComments" value="true" />
                <property name="dateFormat" value="yyyy-MM-dd HH:mm:ss" />
            </commentGenerator>
    
            <jdbcConnection driverClass="${jdbc.driver}" connectionURL="${jdbc.url}" userId="${jdbc.username}" password="${jdbc.password}"></jdbcConnection>
    
            <javaTypeResolver>
                <property name="forceBigDecimals" value="false" />
            </javaTypeResolver>
    
            <javaModelGenerator targetPackage="${model.pojo}" targetProject="src/main/java">
                <property name="enableSubPackages" value="true" />
                <property name="trimStrings" value="true" />
            </javaModelGenerator>
    
            <sqlMapGenerator targetPackage="${model.mapper}" targetProject="src/main/java">
                <property name="enableSubPackages" value="true" />
            </sqlMapGenerator>
    
            <javaClientGenerator targetPackage="${model.dao}" targetProject="src/main/java" type="XMLMAPPER">
                <property name="enableSubPackages" value="true" />
            </javaClientGenerator>
    
            <table tableName="${table.name}"
                   domainObjectName="${table.object}"
                   enableSelectByPrimaryKey="${table.enableSelectByPrimaryKey}"
                   enableCountByExample="${table.enableCountByExample}"
                   enableUpdateByExample="${table.enableUpdateByExample}"
                   enableDeleteByExample="${table.enableDeleteByExample}"
                   enableSelectByExample="${table.enableSelectByExample}"
                   selectByExampleQueryId="${table.selectByExampleQueryId}"></table>
    
        </context>
    </generatorConfiguration>

1.  模板配置文件中的变量统一管理（主要修改这里的参数生产不同的代码）

####数据库连接地址
    jdbc.driver = com.mysql.cj.jdbc.Driver
    jdbc.url = jdbc:mysql://127.0.0.1:3306/dbtdx?serverTimezone=GMT%2B8
    jdbc.username = root
    jdbc.password = 123456
    
    ####生成代码地址
    model.pojo = com.goldctp.main.test
    model.mapper = com.goldctp.main.test
    model.dao = com.goldctp.main.test
    
    ####*.xml文件生成内容
    table.enableSelectByPrimaryKey = true
    table.enableCountByExample = false
    table.enableUpdateByExample = false
    table.enableDeleteByExample = false
    table.enableSelectByExample = false
    table.selectByExampleQueryId = false
    
    ####实体对象
    table.name = tblweight
    table.object = Tblweight

1.  main 方法运行程序，自动生成代码

/**
     * @ClassName: MybatisPlus
     * @Description:
     * @Author: Mr.Zhang
     * @Date: Created in 15:40 2019/2/19
     * @Verson: 1.0
     **/
    public class MybatisPlus {
    
        private final static Logger logger = LoggerFactory.getLogger(MybatisPlus.class);
    
        public static void main(String[] args) throws Exception {
            logger.info("1.开始运行程序……");
            List<String> warnings = new ArrayList<>();
            boolean overwrite = true;
            ConfigurationParser cp = new ConfigurationParser(warnings);
            ClassLoader classloader = Thread.currentThread().getContextClassLoader();
            logger.info("2.加载配置文件……");
            InputStream is = classloader.getResourceAsStream("generatorConfig.xml");
            Configuration config = cp.parseConfiguration(is);
            DefaultShellCallback callback = new DefaultShellCallback(overwrite);
            logger.info("3.对应配置关系……");
            MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config, callback, warnings);
            myBatisGenerator.generate(null);
            logger.info("4.代码生成成功---------------------------------------------------------");
        }
    }

具体源码，已上传到下载中心：[https://download.csdn.net/download/qq\_33624284/10965333][https_download.csdn.net_download_qq_33624284_10965333]

[https_download.csdn.net_download_qq_33624284_10965333]: https://download.csdn.net/download/qq_33624284/10965333