基于SpinrgBoot的mybatis-plus代码生成器配置

素颜马尾好姑娘i 2023-07-12 14:15 6阅读 0赞

1.快速创建一个springboot项目，勾选web  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzY0Mzg3OQ_size_16_color_FFFFFF_t_70]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzY0Mzg3OQ_size_16_color_FFFFFF_t_70 1]  
2.导入pom.xml依赖

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>2.2.5.RELEASE</version>
            <relativePath/> 
        </parent>
        <groupId>com.zc</groupId>
        <artifactId>mp</artifactId>
        <version>1.0</version>
        <name>mp</name>
        <description>Create my codeGenerator</description>
    
        <properties>
            <java.version>1.8</java.version>
        </properties>
    
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
    
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
                <exclusions>
                    <exclusion>
                        <groupId>org.junit.vintage</groupId>
                        <artifactId>junit-vintage-engine</artifactId>
                    </exclusion>
                </exclusions>
            </dependency>
    
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
                <optional>true</optional>
            </dependency>
            <dependency>
                <groupId>com.baomidou</groupId>
                <artifactId>mybatis-plus-boot-starter</artifactId>
                <version>3.1.1</version>
            </dependency>
            <dependency>
                <groupId>com.baomidou</groupId>
                <artifactId>mybatis-plus-generator</artifactId>
                <version>3.1.1</version>
            </dependency>
            <dependency>
                <groupId>org.freemarker</groupId>
                <artifactId>freemarker</artifactId>
                <version>2.3.28</version>
            </dependency>
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <version>5.1.37</version>
            </dependency>
        </dependencies>
    
        <build>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                </plugin>
            </plugins>
        </build>
    
    </project>

3.新建包名com.leku.pmp，新建CodeGenerator类

package com.leku.pmp;
    
    import com.baomidou.mybatisplus.core.exceptions.MybatisPlusException;
    import com.baomidou.mybatisplus.core.toolkit.StringPool;
    import com.baomidou.mybatisplus.core.toolkit.StringUtils;
    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.NamingStrategy;
    import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;
    import java.util.ArrayList;
    import java.util.List;
    import java.util.Scanner;
    
    /** * @Author zc * @Date 2020/3/8 20:11 * @Version 1.0 */
    public class CodeGenerator { 
        public static String scanner(String someThing) { 
            Scanner scanner = new Scanner(System.in);
            StringBuilder help = new StringBuilder();
            help.append("请输入" + someThing + "：");
            System.out.println(help.toString());
            if (scanner.hasNext()) { 
                String sc = scanner.next();
                if (StringUtils.isNotEmpty(sc)) { 
                    return sc;
                }
            }
            throw new MybatisPlusException("请输入正确的" + someThing + "！");
        }
    
        public static void main(String[] args) { 
            // 代码生成器
            AutoGenerator mpg = new AutoGenerator();
    
            // 全局配置
            GlobalConfig gc = new GlobalConfig();
            String projectPath = System.getProperty("user.dir");//获取项目名称
            gc.setOutputDir(projectPath + "/src/main/java");//指定生成路径
            //gc.setOutputDir("D:\\workspace_mp\\zc-mp\\src\\main\\java") // 生成路径
            gc.setAuthor("zc");//作者
            gc.setFileOverride(true);// 文件覆盖
            gc.setOpen(false);//是否打开输出目录
            gc.setEntityName("%sEntity");			//实体命名方式 默认值：null 例如：%sEntity 生成 UserEntity
            gc.setMapperName("%sMapper");			//mapper 命名方式 默认值：null 例如：%sDao 生成 UserDao
            gc.setXmlName("%sMapper");				//Mapper xml 命名方式 默认值：null 例如：%sDao 生成 UserDao.xml
            //gc.setServiceName("%sService"); //service 命名方式 默认值：null 例如：%sBusiness 生成 UserBusiness
            // gc.setServiceImplName("%sServiceImpl"); //service impl 命名方式 默认值：null 例如：%sBusinessImpl 生成 UserBusinessImpl
            //gc.setControllerName("%sController"); //controller 命名方式 默认值：null 例如：%sAction 生成 UserAction
            mpg.setGlobalConfig(gc);
    
            // 数据源配置
            DataSourceConfig dsc = new DataSourceConfig();
            dsc.setUrl("jdbc:mysql://localhost:3306/db_pmp?useUnicode=true&useSSL=false&characterEncoding=utf8");
            dsc.setDriverName("com.mysql.jdbc.Driver");
            dsc.setUsername("root");
            dsc.setPassword("root");
            mpg.setDataSource(dsc);
    
            // 包配置
            PackageConfig pc = new PackageConfig();
            pc.setModuleName(scanner("请输入你的包名"));
            pc.setParent("com.leku.pmp");//指定你要生成的父包名
            mpg.setPackageInfo(pc);
    
            // 自定义配置
            InjectionConfig cfg = new InjectionConfig() { 
                @Override
                public void initMap() { 
                    // to do nothing
                }
            };
    
            // 如果模板引擎是 freemarker
            String templatePath = "/templates/mapper.xml.ftl";
            // 如果模板引擎是 velocity
            // String templatePath = "/templates/mapper.xml.vm";
    
            // 自定义输出配置
            List<FileOutConfig> focList = new ArrayList<>();
            // 自定义配置会被优先输出
            focList.add(new FileOutConfig(templatePath) { 
                @Override
                public String outputFile(TableInfo tableInfo) { 
                    // 自定义输出文件名 ， 如果你 Entity 设置了前后缀、此处注意 xml 的名称会跟着发生变化！！
                    return projectPath + "/src/main/resources/mapper/" + pc.getModuleName()
                            + "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
                }
            });
            cfg.setFileOutConfigList(focList);
            mpg.setCfg(cfg);
    
            // 配置模板
            TemplateConfig templateConfig = new TemplateConfig();
    
            // 配置自定义输出模板
            //指定自定义模板路径，注意不要带上.ftl/.vm, 会根据使用的模板引擎自动识别
            // templateConfig.setEntity("templates/entity2.java");
            // templateConfig.setService();
            // templateConfig.setController();
    
            templateConfig.setXml(null);
            mpg.setTemplate(templateConfig);
    
            // 策略配置,数据库表配置
            StrategyConfig strategy = new StrategyConfig();
            //数据库表映射到实体的命名策略
            strategy.setNaming(NamingStrategy.underline_to_camel);
            //数据库表字段映射到实体类的命名策略
            strategy.setColumnNaming(NamingStrategy.underline_to_camel);
            //自定义继承entity类，添加这一个会在生成实体类的时候继承entity
            //strategy.setSuperEntityClass("com.wy.testCodeGenerator.entity");
            //实体是否为lombok模型
            strategy.setEntityLombokModel(true);
            //生成@RestController控制器
            strategy.setRestControllerStyle(true);
            //是否继承controller
            // strategy.setSuperControllerClass("com.wy.testCodeGenerator.controller");
            strategy.setInclude(scanner("表名，多个英文逗号分割").split(","));
            //strategy.setSuperEntityColumns("id"); //去掉这个实体类中就有id
            //驼峰转连字符串
            strategy.setControllerMappingHyphenStyle(true);
            //表前缀
            strategy.setTablePrefix(pc.getModuleName() + "_");
            mpg.setStrategy(strategy);
            mpg.setTemplateEngine(new FreemarkerTemplateEngine());
            mpg.execute();
        }
    
    }
    在这里插入代码片

4.注意修改数据库连接信息，父包名和作者信息等等  
完成后，即可启动main方法测试，输入要生成的代码放在哪个包目录下，并且指定表名，逗号隔开，测试如下。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzY0Mzg3OQ_size_16_color_FFFFFF_t_70 2]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzY0Mzg3OQ_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20200308221729224.PNG?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzY0Mzg3OQ==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzY0Mzg3OQ_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20200308221840695.PNG?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzY0Mzg3OQ==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzY0Mzg3OQ_size_16_color_FFFFFF_t_70 2]: https://img-blog.csdnimg.cn/20200308222331213.PNG?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzY0Mzg3OQ==,size_16,color_FFFFFF,t_70