springboot 之使用mybatis-plus-generator快速生成数据库对应实体类

迈不过友情╰ 2022-12-25 15:48 124阅读 0赞

**AutoGenerator 是 MyBatis-Plus 的代码生成器，通过 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各个模块的代码，极大的提升了开发效率。**

官网参考：  
[https://baomidou.com/guide][https_baomidou.com_guide]

## 实践 ##

1.数据库创建表 userinfo  
![在这里插入图片描述][20201202160119897.png]  
2.添加依赖

<dependency>
                <groupId>com.baomidou</groupId>
                <artifactId>mybatis-plus-boot-starter</artifactId>
                <version>3.3.0</version>
            </dependency>
            
            <dependency>
                <groupId>com.baomidou</groupId>
                <artifactId>mybatis-plus-generator</artifactId>
                <version>3.3.0</version>
            </dependency>
            <dependency>
                <groupId>com.ibeetl</groupId>
                <artifactId>beetl</artifactId>
                <version>3.0.15.RELEASE</version>
            </dependency>
           <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-freemarker</artifactId>
            </dependency>

3.创建一个 generator 包，创建一个 CodeGenerater 类，代码如下：

public class CodeGenerater { 
    
        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"); // 生成文件的输出目录,默认D根目录
            gc.setFileOverride(true); // 是否覆盖已有文件
            gc.setAuthor("gsy");
            gc.setOpen(false);        // 是否打开输出目录,默认true
            gc.setEnableCache(false); // 是否在xml中添加二级缓存配置,默认false
            gc.setSwagger2(false);    // 开启 swagger2 模式,默认false，这里推荐使用JApiDocs，使用方法见：https://blog.csdn.net/u013919153/article/details/110440311
    
            gc.setEntityName("%s");   //指定生成实体类名称
            gc.setMapperName("%sMapper");   // mapper文件名称
            gc.setXmlName("%sMapper");      // xml文件名称
            gc.setServiceName("I%sService");    // 服务名称
            gc.setServiceImplName("%sServiceImpl"); // 服务接口名称
            mpg.setGlobalConfig(gc);
    
            // 数据源配置
            DataSourceConfig dsc = new DataSourceConfig();
            dsc.setUrl("jdbc:mysql://127.0.0.1:3306/gsytest?useSSL=false&zeroDateTimeBehavior=convertToNull&useLegacyDatetimeCode=false");
            dsc.setSchemaName("databaseName");
            dsc.setDriverName("com.mysql.cj.jdbc.Driver");
            dsc.setUsername("root");
            dsc.setPassword("123465");
            mpg.setDataSource(dsc);
    
            // 包名配置
            PackageConfig pc = new PackageConfig();
            pc.setModuleName("demo");   //模块名
            pc.setParent("com.apidoc"); //包名
            pc.setEntity("Entity.Model");   //数据库对应的包名
            pc.setMapper("Dao");    //Mapper对应的包名
            pc.setController("Controller"); //Controller对应的包名
            mpg.setPackageInfo(pc);
    
            // 自定义配置
            InjectionConfig cfg = new InjectionConfig() { 
                @Override
                public void initMap() { 
                    // to do nothing
                }
            };
    
            // 如果模板引擎是 freemarker
            String templatePath = "/templates/mapper.xml.ftl";
    
            // 自定义输出配置
            List<FileOutConfig> focList = new ArrayList<>();
            // 自定义配置会被优先输出
            focList.add(new FileOutConfig(templatePath) { 
                @Override
                public String outputFile(TableInfo tableInfo) { 
                    // 自定义xml输出文件名
                    return projectPath + "/src/main/resources/mapper/"
                            + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
                }
            });
            cfg.setFileOutConfigList(focList);
            mpg.setCfg(cfg);
    
            // 配置模板
            TemplateConfig templateConfig = new TemplateConfig();
            // 配置自定义输出模板
            // templateConfig.setEntity();
            // templateConfig.setService();
            templateConfig.setController(null);
            templateConfig.setXml(null);
            mpg.setTemplate(templateConfig);
    
            // 策略配置
            StrategyConfig strategy = new StrategyConfig();
            strategy.setNaming(NamingStrategy.underline_to_camel); // 数据库表映射到实体的命名策略
            strategy.setColumnNaming(NamingStrategy.underline_to_camel); // 数据库表字段映射到实体的命名策略, 未指定按照 naming 执行
            //strategy.setSuperEntityClass("com.apidoc.demo.Entity.BaseEntity"); //自定义继承的Entity类全称，带包名
            //strategy.setSuperEntityColumns(new String[] {"id","gmtCreate","gmtModified"});// 自定义基础的Entity类，公共字段
            strategy.setEntityLombokModel(true); // 是否为lombok模型
            strategy.setEntityBooleanColumnRemoveIsPrefix(true); // Boolean类型字段是否移除is前缀
            strategy.setRestControllerStyle(false); // 生成 @RestController 控制器，个人觉得有点多余
            //strategy.setSuperControllerClass("com.music.taosim.ant.common.BaseController");
            //startegy.setInclude("tableName"); 当对某张表有所改动但只想重新生成这张表，可以这样设置
            strategy.setControllerMappingHyphenStyle(true); // 驼峰转连字符 如 umps_user 变为 upms/user
            // strategy.setTablePrefix(pc.getModuleName() + "_"); // 表前缀
            mpg.setStrategy(strategy);
            mpg.setTemplateEngine(new FreemarkerTemplateEngine()); //设置模板引擎类型，默认为 velocity
            mpg.execute();
        }
    }

4.根据注释，修改对应数据库信息及对应生成目标信息，执行main函数,即可看到结果。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTM5MTkxNTM_size_16_color_FFFFFF_t_70]  
之后就可以写代码了

[https_baomidou.com_guide]: https://baomidou.com/guide/
[20201202160119897.png]: /images/20221120/f2c03ea3e9ce4fb1adecb755904204bc.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTM5MTkxNTM_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20201202163455779.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTM5MTkxNTM=,size_16,color_FFFFFF,t_70