springcloud或者springboot中使用Generator插件反响生成数据库中对应的实体类等文件

绝地灬酷狼 2022-05-20 04:25 128阅读 0赞

## 添加generator依赖 ##

<dependency>
                <groupId>org.mybatis.generator</groupId>
                <artifactId>mybatis-generator-core</artifactId>
                <version>1.3.2</version>
    </dependency>

## 通过main方法实现 ##

public class GeneratorHelper { 
    
        public static void main(String[] args) throws Exception { 
            try { 
                GeneratorHelper generatorSqlmap = new GeneratorHelper();
                generatorSqlmap.generator();
            } catch (Exception e) { 
                e.printStackTrace();
            }
        }
    
        public void generator() throws Exception { 
            List<String> warnings = new ArrayList<String>();
            boolean overwrite = true;
            ConfigurationParser cp = new ConfigurationParser(warnings);
            //指定 逆向工程配置文件（generatorConfig.xml里面context节点必须按顺序配置,不然会报错）
            //InputStream configFile = GeneratorHelper.class.getClassLoader().getResourceAsStream("generatorConfig.xml");
            File configFile = new ClassPathResource("generatorConfig.xml").getFile();
            InputStream configFileStream = autoTransferConfig(configFile);
            Configuration config = cp.parseConfiguration(configFileStream);
            DefaultShellCallback callback = new DefaultShellCallback(overwrite);
            MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config, callback, warnings);
            myBatisGenerator.generate(null);
            warnings.forEach(System.out::println);
            System.out.println("------ generator is finish ------");
        }
    
        private InputStream autoTransferConfig(File configFile) throws DocumentException, UnsupportedEncodingException { 
            SAXReader sr = new SAXReader(); // 需要导入jar包:dom4j
            Document document = sr.read(configFile);
            // 获取根元素
            Element generatorConfiguration = document.getRootElement();
            String projectRoot = document.getName().split("target")[0].replace("file://", "");
            if(isWindows() && projectRoot.startsWith("/")){ 
                projectRoot = projectRoot.substring(1);
            }
            // 获取标签
            Element classPathEntry = generatorConfiguration.element("classPathEntry");
            Element context = generatorConfiguration.element("context");
            Element javaModelGenerator = context.element("javaModelGenerator");
            Element sqlMapGenerator = context.element("sqlMapGenerator");
            Element javaClientGenerator = context.element("javaClientGenerator");
            Attribute classPathEntryLoc = classPathEntry.attribute("location");
            Attribute javaModelTarget = javaModelGenerator.attribute("targetProject");
            Attribute sqlMapTarget = sqlMapGenerator.attribute("targetProject");
            Attribute javaClientTarget = javaClientGenerator.attribute("targetProject");
            String classPathEntryLocText = classPathEntryLoc.getText();
            if (isRelativePath(classPathEntryLocText)) { 
                classPathEntryLoc.setText(projectRoot + classPathEntryLocText);
            }
            String javaModelTargetText = javaModelTarget.getText();
            if (isRelativePath(javaModelTargetText)) { 
                javaModelTarget.setText(projectRoot + javaModelTargetText);
            }
            String sqlMapTargetText = sqlMapTarget.getText();
            if (isRelativePath(sqlMapTargetText)) { 
                sqlMapTarget.setText(projectRoot + sqlMapTargetText);
            }
            String javaClientTargetText = javaClientTarget.getText();
            if (isRelativePath(javaClientTargetText)) { 
                javaClientTarget.setText(projectRoot + javaClientTargetText);
            }
            return new ByteArrayInputStream(document.asXML().getBytes("utf-8"));
        }
    
        //判断是否为相对路径
        private boolean isRelativePath(String value) { 
            if (value != null) { 
                if (!value.contains(":") && !value.startsWith("/")) { 
                    return true;
                }
            }
            return false;
        }
    
        //判断是否为Windows操作系统
        public boolean isWindows() { 
            return System.getProperties().getProperty("os.name").toLowerCase().indexOf("windows") >= 0;
        }
    
    }

## 在项目的resource目录下添加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>
        <context id="test" targetRuntime="MyBatis3">
            <plugin type="org.mybatis.generator.plugins.EqualsHashCodePlugin"></plugin>
            <plugin type="org.mybatis.generator.plugins.SerializablePlugin"></plugin>
            <plugin type="org.mybatis.generator.plugins.ToStringPlugin"></plugin>
            <plugin type="org.mybatis.generator.plugins.RenameExampleClassPlugin">
                <property name="searchString" value="Example$"/>
                <property name="replaceString" value="Criteria"/>
            </plugin>
     
     
            <plugin type="com.ocean.serivce.dal.generator.GeneratorConfigPlugin" />
            <commentGenerator type="com.ocean.serivce.dal.generator.DbCommentGenerator">
                
                <property name="suppressAllComments" value="false" />
             
                
                <property name="suppressDate" value="true" />
            </commentGenerator>
            
            <jdbcConnection driverClass="com.mysql.jdbc.Driver" connectionURL="jdbc:mysql://47.106.12.216:3306/xinqiuboche_test?autoReconnect=true&useUnicode=true&characterEncoding=UTF-8" userId="数据库账号" password="数据库密码">
            </jdbcConnection>
            <javaTypeResolver>
                
                <property name="forceBigDecimals" value="false"/>
            </javaTypeResolver>
    
            
            <javaModelGenerator targetPackage="com.xinqiuboche.provider_auxiliary.entity" targetProject="src/main/java">
                <property name="enableSubPackages" value="true"/>
                <property name="trimStrings" value="true"/>
            </javaModelGenerator>
    
            
            <sqlMapGenerator targetPackage="com.xinqiuboche.provider_auxiliary.mapper" targetProject="src/main/resources">
                <property name="enableSubPackages" value="true"/>
            </sqlMapGenerator>
    
            
            <javaClientGenerator type="XMLMAPPER" targetPackage="com.xinqiuboche.provider_auxiliary.mapper" targetProject="src/main/java">
                <property name="enableSubPackages" value="true"/>
            </javaClientGenerator>
    
            
                <table schema="" tableName="customer"/>
        </context>
    </generatorConfiguration>

添加自定义插件防止merge是多生成xml文件

public class GeneratorConfigPlugin extends PluginAdapter { 
        @Override
        public boolean validate(List<String> warnings) { 
            return true;
        }
    
        @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;
        }
    
    }

为生成的java类生成数据库中定义好的注释

public class DbCommentGenerator implements CommentGenerator { 
    
        /** * properties配置文件 */
        private Properties properties;
        /** * properties配置文件 */
        private Properties systemPro;
    
        /* * 父类时间 */
        private boolean suppressDate;
    
        /** * 父类所有注释 */
        private boolean suppressAllComments;
    
        /** * 当前时间 */
        private String currentDateStr;
    
        public DbCommentGenerator() { 
            super();
            properties = new Properties();
            systemPro = System.getProperties();
            suppressDate = false;
            suppressAllComments = false;
            currentDateStr = (new SimpleDateFormat("yyyy-MM-dd")).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) { 
    
        }
    
        /** * @return * @throws * @Title addConfigurationProperties * @Description: 从该配置中的任何属性添加此实例的属性CommentGenerator配置。 * 这个方法将在任何其他方法之前被调用。 * @Author fendo * @Date 2017年10月5日 下午3:45:58 */
        @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));
        }
    
        /** * @return * @throws * @Title getDateString * @Description: 此方法返回格式化的日期字符串以包含在Javadoc标记中和XML注释。 如果您不想要日期，则可以返回null在这些文档元素中。 * @Author fendo * @Date 2017年10月5日 下午3:45:58 */
        protected String getDateString() { 
            String result = null;
            if (!suppressDate) { 
                result = currentDateStr;
            }
            return result;
        }
    
        /** * @param javaElement * @param markAsDoNotDelete * @throws * @Title addJavadocTag * @Description: 此方法为其添加了自定义javadoc标签。 * @Author fendo * @Date 2017年10月5日 下午3:49:05 */
        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("* Copyright(C) 2018-2020 ocean-springcloud");
            compilationUnit.addFileCommentLine("* @date " + sdf.format(new Date()) + "");
            compilationUnit.addFileCommentLine("*/");
        }
    
        /** * 为模型类添加注释 */
        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(" */");
        }
    
    }