Springboot集成MyBatis-plus的代码生成工具CodeGenerator（注释比较详细）

小咪咪 2021-09-01 09:19 270阅读 0赞

## 1.mybatis-plus依赖，代码生成器还有其所需要模板velocity（默认） ##

<mybatis-plus.version>3.1.0</mybatis-plus.version>
            <velocity.version>2.0</velocity.version>
            <connector.version>8.0.18</connector.version>

<dependency>
                    <groupId>com.baomidou</groupId>
                    <artifactId>mybatis-plus-boot-starter</artifactId>
                    <version>${ mybatis-plus.version}</version>
                </dependency>
                
                <dependency>
                    <groupId>com.baomidou</groupId>
                    <artifactId>mybatis-plus-generator</artifactId>
                    <version>${ mybatis-plus.version}</version>
                </dependency>
    
                
                <dependency>
                    <groupId>org.apache.velocity</groupId>
                    <artifactId>velocity-engine-core</artifactId>
                    <version>${ velocity.version}</version>
                </dependency>
     
                
                <dependency>
                    <groupId>mysql</groupId>
                    <artifactId>mysql-connector-java</artifactId>
                    <version>${ connector.version}</version>
                </dependency>

## 2.编写代码生成类MybatisPlusCodeGenerator ##

**部分内容请自行修改**

import com.baomidou.mybatisplus.annotation.DbType;
    import com.baomidou.mybatisplus.annotation.IdType;
    import com.baomidou.mybatisplus.generator.AutoGenerator;
    import com.baomidou.mybatisplus.generator.InjectionConfig;
    import com.baomidou.mybatisplus.generator.config.*;
    import com.baomidou.mybatisplus.generator.config.po.TableInfo;
    import com.baomidou.mybatisplus.generator.config.rules.DateType;
    import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
    
    import java.util.ArrayList;
    import java.util.HashMap;
    import java.util.List;
    import java.util.Map;
    
    /** * @Author: dxf * @Description: 代码生成工具 * @Date: Created in 2020-08-22 17:06 * @Modified By: */
    public class MybatisPlusCodeGenerator { 
    
        // ================= 自定义配置 =================
    
        private static final DbType DB_TYPE = DbType.MYSQL;
        private static final String JDBC_URL = "jdbc:mysql://localhost:3306/***?serverTimezone=UTC&useUnicode=true&characterEncoding=UTF-8";
        private static final String JDBC_DRIVER = "com.mysql.cj.jdbc.Driver";
        private static final String JDBC_USERNAME = "root";
        private static final String JDBC_PASSWORD = "****";
        /** * 生成文件根目录及包名 */
        private static final String ROOT_DIR =System.getProperty("user.dir")+ "/src/main/java";
        //java文件夹下路径
        private static final String PACKAGE_PARENT_NAME = "com.dxf.***";
        private static final String PACKAGE_CONTROLLER_NAME = "controller";
        private static final String PACKAGE_SERVICE_NAME = "service";
        private static final String PACKAGE_SERVICEIMPL_NAME = "service.impl";
        //entity
        private static final String PACKAGE_ENTITY_NAME = "domain";
        private static final String PACKAGE_MAPPER_NAME = "mapper";
        private static final String RESOURCES_DIR =System.getProperty("user.dir")+  "/src/main/resources";
        private static final String MAPPER_XML_PATH = "mapper";
        /** * 生成代码的@author */
        private static final String AUTHOR = "dxf";
        /** * 需要生成代码的数据库表名 */
        private static final String[] TABLES = new String[]{ "fa_admin"};
        /** * 数据库表名前缀 */
        private static final String[] TABLE_PREFIXS = new String[]{ "fa_"};
    
    
        public static void main(String[] args) { 
            AutoGenerator mpg = new AutoGenerator();
            mpg.setDataSource(getDataSourceConfig());
            mpg.setGlobalConfig(getGlobalConfig());
            mpg.setStrategy(getStrategyConfig());
            mpg.setPackageInfo(getPackageConfig());
            mpg.setCfg(getInjectionConfig());
            mpg.setTemplate(getTemplateConfig());
            // 执行生成
            mpg.execute();
        }
    
        /** * 数据源配置 * * @return */
        private static DataSourceConfig getDataSourceConfig() { 
            DataSourceConfig dsc = new DataSourceConfig();
            dsc.setDbType(DB_TYPE);
            dsc.setDriverName(JDBC_DRIVER);
            dsc.setUrl(JDBC_URL);
            dsc.setUsername(JDBC_USERNAME);
            dsc.setPassword(JDBC_PASSWORD);
            return dsc;
        }
    
        /** * 全局配置 * * @return */
        private static GlobalConfig getGlobalConfig() { 
            GlobalConfig gc = new GlobalConfig();
            //生成后是否打开资源管理器
            gc.setOpen(false);
            gc.setOutputDir(ROOT_DIR);
            //重新生成时文件是否覆盖
            gc.setFileOverride(true);
            gc.setActiveRecord(true);
            //主键策略
            gc.setIdType(IdType.ID_WORKER_STR);
            //定义生成的实体类中日期类型
            gc.setDateType(DateType.ONLY_DATE);
            //开启Swagger2模式
            gc.setSwagger2(true);
            // XML 二级缓存
            gc.setEnableCache(false);
            // XML ResultMap
            gc.setBaseResultMap(true);
            // XML columList
            gc.setBaseColumnList(true);
            gc.setAuthor(AUTHOR);
            gc.setMapperName("%sMapper");
            gc.setXmlName("%sMapper");
            gc.setServiceName("%sService");
            gc.setServiceImplName("%sServiceImpl");
            gc.setControllerName("%sController");
            return gc;
        }
    
        /** * 生成策略配置 * * @return */
        private static StrategyConfig getStrategyConfig() { 
            StrategyConfig strategy = new StrategyConfig();
            // 此处可以修改为您的表前缀
            strategy.setTablePrefix(TABLE_PREFIXS);
            // 表名生成策略
            strategy.setNaming(NamingStrategy.underline_to_camel);
            // 需要生成的表
            strategy.setInclude(TABLES);
            // lombok 模型 @Accessors(chain = true) setter链式操作
            strategy.setEntityLombokModel(true);
            //restful api风格控制器
            strategy.setRestControllerStyle(true);
            //url中驼峰转连字符
            strategy.setControllerMappingHyphenStyle(true);
            return strategy;
        }
    
        /** * 生成包名设置 * * @return */
        private static PackageConfig getPackageConfig() { 
            // 4.生成文件所在包配置：
            PackageConfig pc = new PackageConfig();
            pc.setParent(PACKAGE_PARENT_NAME);
            pc.setController(PACKAGE_CONTROLLER_NAME);
            pc.setService(PACKAGE_SERVICE_NAME);
            pc.setServiceImpl(PACKAGE_SERVICEIMPL_NAME);
            pc.setEntity(PACKAGE_ENTITY_NAME);
            pc.setMapper(PACKAGE_MAPPER_NAME);
            return pc;
        }
    
        /** * xml文件配置 * * @return */
        private static InjectionConfig getInjectionConfig() { 
            InjectionConfig cfg = new InjectionConfig() { 
                @Override
                public void initMap() { 
                    Map<String, Object> map = new HashMap<String, Object>();
                    //map.put("abc", this.getConfig().getGlobalConfig().getAuthor() + "-rb");
                    this.setMap(map);
                }
            };
            //xml生成路径
            List<FileOutConfig> focList = new ArrayList<>();
            // 如果模板引擎是 freemarker
            //String templatePath = "/templates/mapper.xml.ftl";
            // 如果模板引擎是 velocity
            // String templatePath = "/templates/mapper.xml.vm";
            focList.add(new FileOutConfig("/templates/mapper.xml.vm") { 
                @Override
                public String outputFile(TableInfo tableInfo) { 
                    return RESOURCES_DIR + "/" + MAPPER_XML_PATH + "/" + tableInfo.getEntityName() + "Mapper.xml";
                }
            });
            cfg.setFileOutConfigList(focList);
            return cfg;
        }
    
        /** * 关闭默认 xml 生成 * * @return */
        private static TemplateConfig getTemplateConfig() { 
            TemplateConfig tc = new TemplateConfig();
            tc.setXml(null);
            return tc;
        }
    }