Mabitis 代码生成器--细节控制器

---

流程

一、插件代码编写 -> 插件编译为.class 文件  -> 插件放入maven仓库：repository\org\mybatis\generator\mybatis-generator-core\
1.3.6\mybatis-generator-core-1.3.6.jar压缩文件中
二、xml文件配置。
三、生成代码

---

一、插件代码编写

//注意文件路径 org.mybatis.generator.plugins;
    package org.mybatis.generator.plugins;
    
    import org.mybatis.generator.api.GeneratedXmlFile;
    import org.mybatis.generator.api.IntrospectedColumn;
    import org.mybatis.generator.api.IntrospectedTable;
    import org.mybatis.generator.api.PluginAdapter;
    import org.mybatis.generator.api.dom.java.Field;
    import org.mybatis.generator.api.dom.java.Interface;
    import org.mybatis.generator.api.dom.java.Method;
    import org.mybatis.generator.api.dom.java.TopLevelClass;
    import org.mybatis.generator.internal.util.StringUtility;
    
    import java.text.SimpleDateFormat;
    import java.util.Date;
    import java.util.List;
    
    public class LombokPlugin extends PluginAdapter {
    
        @Override
        public boolean validate(List<String> list) {
            return true;
        }
    
        /**
         * 为实体添加lombok的注解
         * @param topLevelClass
         * @param introspectedTable
         * @return
         */
        @Override
        public boolean modelBaseRecordClassGenerated(TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
            //添加domain的import
            //todo 添加注解  修改xml
    //        		<plugin type="org.mybatis.generator.plugins.LombokPlugin" >
    //			<property name="hasLombok" value="true"/>
    //		</plugin>
            topLevelClass.addImportedType("com.***.DataName");
            topLevelClass.addImportedType("lombok.NoArgsConstructor");
            topLevelClass.addImportedType("lombok.AllArgsConstructor");
            topLevelClass.addImportedType("lombok.Data");
    //        topLevelClass.addImportedType("lombok.Builder");
            //import lombok.Builder;java.util.Date
    
            //添加domain的注解
            //todo 添加注解
            topLevelClass.addAnnotation("@NoArgsConstructor");
            topLevelClass.addAnnotation("@AllArgsConstructor");
            topLevelClass.addAnnotation("@Data");
            //添加domain的注释
            topLevelClass.addJavaDocLine("/**");
            topLevelClass.addJavaDocLine("* Created by Mybatis Generator on " + date2Str(new Date()));
            topLevelClass.addJavaDocLine("*/");
    
            return true;
        }
    
        /**
         * 为实体类字段添加注释
         */
        @Override
        public boolean modelFieldGenerated(Field field, TopLevelClass topLevelClass, IntrospectedColumn introspectedColumn, IntrospectedTable introspectedTable, ModelClassType modelClassType) {
    //        field.addJavaDocLine("/**");
            String remarks = introspectedColumn.getRemarks();
            if (StringUtility.stringHasValue(remarks)) {
                String[] remarkLines = remarks.split(System.getProperty("line.separator"));
    //            for (String remarkLine : remarkLines) {
                    //todo 添加注解
                    field.addJavaDocLine("@DataName(name = \"" + remarks + "\")");
    //            }
            }
    //        field.addJavaDocLine(")");
    //        field.addAnnotation("@DataName");
            return true;
    
        }
    
        /**
         * mapper.xml的注释
         */
        @Override
        public boolean clientGenerated(Interface interfaze, TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
            //Mapper文件的注释
            interfaze.addJavaDocLine("/**");
            interfaze.addJavaDocLine("* Created by Mybatis Generator on " + date2Str(new Date()));
            interfaze.addJavaDocLine("*/");
            return true;
        }
    
        @Override
        public boolean modelSetterMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedColumn introspectedColumn, IntrospectedTable introspectedTable, ModelClassType modelClassType) {
            //生成getter return true;
            return false;
        }
    
        @Override
        public boolean modelGetterMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedColumn introspectedColumn, IntrospectedTable introspectedTable, ModelClassType modelClassType) {
            //生成setter  return true;
            return false;
        }
    
        @Override
        //解决每次更新需要删除mapper的情况
        public boolean sqlMapGenerated(GeneratedXmlFile sqlMap, IntrospectedTable introspectedTable) {
            try {
                java.lang.reflect.Field isMergeable = GeneratedXmlFile.class.getDeclaredField("isMergeable");
                isMergeable.setAccessible(true);
                isMergeable.setBoolean(sqlMap, false);
                isMergeable.setAccessible(false);
            } catch (Exception e) {
                e.printStackTrace();
            }
            return true;
        }
    
        private String date2Str(Date date) {
            SimpleDateFormat sdf = new SimpleDateFormat("yyyy/MM/dd hh:mm:ss");
            return sdf.format(date);
        }
    }

二、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="***.properties" />
    	<context id="testTables" targetRuntime="MyBatis3">
            <!--插件导入-->
    		<plugin type="org.mybatis.generator.plugins.LombokPlugin" >
    			<property name="hasLombok" value="true"/>
    		</plugin>
    
    		<commentGenerator>
    			<!-- 是否去除自动生成的注释 true：是 ： false:否 -->
    			<property name="suppressAllComments" value="false" />
    		</commentGenerator>
    		
    		<!--数据库连接的信息：驱动类、连接地址、用户名、密码 -->
    		<jdbcConnection 
    			driverClass="${jdbc.driver}"
    			connectionURL="${jdbc.url}" 
    			userId="${jdbc.username}" 
    			password="${jdbc.password}">
    		</jdbcConnection>
    		
    		<!-- 默认false，把JDBC DECIMAL 和 NUMERIC 类型解析为 Integer， 
    			 为true时把JDBC DECIMAL 和 NUMERIC 类型解析为java.math.BigDecimal -->
    		<javaTypeResolver>
    			<property name="forceBigDecimals" value="false" />
    		</javaTypeResolver>
    
    		<!-- targetProject:生成PO类的位置 -->
    		<javaModelGenerator 
    			targetPackage="com.**.orm.pojo" targetProject=".\src\main\java">
    			<!-- enableSubPackages:是否让schema作为包的后缀 -->
    			<property name="enableSubPackages" value="false" />
    			<!-- 从数据库返回的值被清理前后的空格 -->
    			<property name="trimStrings" value="true" />
    		</javaModelGenerator>
    		
            <!-- targetProject:mapper映射文件生成的位置 -->
    		<sqlMapGenerator 
    			targetPackage="com.**.orm.mapper" targetProject=".\src\main\java">
    			<!-- enableSubPackages:是否让schema作为包的后缀 -->
    			<property name="enableSubPackages" value="false" />
    		</sqlMapGenerator>
    		
    		<!-- targetPackage：mapper接口生成的位置 -->
    		<javaClientGenerator type="XMLMAPPER"
    			targetPackage="com.**.orm.dao" targetProject=".\src\main\java">
    			<!-- enableSubPackages:是否让schema作为包的后缀 -->
    			<property name="enableSubPackages" value="false" />
    		</javaClientGenerator>
    		
    		<!-- 指定数据库表 -->
    		<table schema="" tableName="t_user">
    			<property name="useActualColumnNames" value="false" />
    			<generatedKey column="id" sqlStatement="JDBC" identity="true" />
    			<domainObjectRenamingRule searchString="^T" replaceString="" />
    		</table>
    	</context>
    </generatorConfiguration>

三、pom配置

<plugins>
            <plugin>
                <groupId>org.mybatis.generator</groupId>
                <artifactId>mybatis-generator-maven-plugin</artifactId>
                <version>1.3.6</version>
                <dependencies>
                    <dependency>
                        <groupId>mysql</groupId>
                        <artifactId>mysql-connector-java</artifactId>
                        <version>${mysql-connector.version}</version>
                    </dependency>
                </dependencies>
                <configuration>
                    <!--配置文件的路径 -->
                    <configurationFile>${project.basedir}/src/main/resources/generatorConfig.xml</configurationFile>
                    <overwrite>true</overwrite>
                </configuration>
            </plugin>
        </plugins>

四、使用步骤

点击maven插件生成代码

结果预览：

---

总结

Mybatis代码生成工具。第一次配置后只需修改配置文件可以实现快速更新和生成数据库中字段。