MyBatis-Plus的代码生成器的使用

傷城~ 2022-12-12 13:43 120阅读 0赞

## MyBatis-Plus的代码生成器的使用 ##

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

### MyBatis-Plus ###

MyBatis-Plus（简称 MP）是一个 MyBatis 的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。  
![annotation(注释) extension（扩展）core（核心）generator（自动生成）][annotation_ extension_core_generator]  
官网：[https://baomidou.com/guide/generator.html][https_baomidou.com_guide_generator.html]

## 使用 ##

### 1、模板引擎 依赖 ###

MyBatis-Plus 支持 Velocity（默认）、Freemarker、Beetl，用户可以选择自己熟悉的模板引擎，如果都不满足您的要求，可以采用自定义模板引擎。

<dependency>
               <groupId>com.baomidou</groupId>
                <artifactId>mybatis-plus-boot-starter</artifactId>
                <version>3.4.0</version>
            </dependency>
            
            
            <dependency>
                <groupId>com.baomidou</groupId>
                <artifactId>mybatis-plus-generator</artifactId>
                <version>3.4.0</version>
            </dependency>
    
            
            <dependency>
                <groupId>org.apache.velocity</groupId>
                <artifactId>velocity-engine-core</artifactId>
                <version>2.2</version>
            </dependency>

注：如果使用非默认：需要在 AutoGenerator 中 设置模板引擎。

### 2、编写配置 ###

package com.flyfly.utils;
    
    public class MPUtil { 
        public static void main(String[] args) { 
            //选择引擎
            AutoGenerator mpg=new AutoGenerator();
            mpg.setTemplateEngine(new VelocityTemplateEngine());
    
            //配置全局属性
            GlobalConfig globalConfig = new GlobalConfig();
            String property = System.getProperty("user.dir");//此处定位到最上层的文件目录（F://MyProject）我的项目在MyProject文件下的campusRecruitment，因此下面加了：campusRecruitment
            globalConfig.setAuthor("flyfly") // 作者
                     .setOutputDir(property+"/campusRecruitment/src/main/java")// 生成路径
                     .setFileOverride(true) // 文件覆盖
                     .setIdType(IdType.AUTO) // 主键策略
                     .setEnableCache(false)  //是否开启二级缓存
                    //设置文件名%s 表示自动填充
                    .setMapperName("%sMapper")
                    .setXmlName("%sMapper")
                    .setServiceName("%sService")
                    .setServiceImplName("%sServiceImpl")
                    .setControllerName("%sController")
                    .setBaseResultMap(true)
                    .setBaseColumnList(true);
    
            //配置数据源
            DataSourceConfig dsConfig = new DataSourceConfig();
            dsConfig.setDbType(DbType.MYSQL)
                    .setDriverName("com.mysql.cj.jdbc.Driver")
                    .setUrl("jdbc:mysql://127.0.0.1:3306/school_ask_job?serverTimezone=GMT%2B8")
                    .setUsername("root")
                    .setPassword("password");
    
            //策略配置
            StrategyConfig stConfig = new StrategyConfig();
            stConfig.setCapitalMode(true)
                    //设置要生成代码的表名前缀
                    // .setTablePrefix("")
                    .setInclude("token","news")  //配置要生成的表名
                    //.setExclude("users") //排除要生成的表
                    .setNaming(NamingStrategy.underline_to_camel)  // 数据库表映射到实体的命名策略
                    .setEntityLombokModel(true)
                    .setEntityBuilderModel(true);   // 【实体】是否为构建者模型（默认 false）
    
            //包策略配置
            PackageConfig packageConfig = new PackageConfig();
            packageConfig.setParent("com.flyfly")
                    .setEntity("pojo")
                    .setMapper("mapper")
                    .setXml("mapper")
                    .setService("service")
                    .setServiceImpl("service.impl")
                    .setController("controller");
    
            //整合配置
            mpg.setGlobalConfig(globalConfig)
                    .setDataSource(dsConfig)
                    .setStrategy(stConfig)
                    .setPackageInfo(packageConfig);
    
            //执行
            mpg.execute();
        }
    }

点击运行此main方法则代码生成成功  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxNTEwNTUx_size_16_color_FFFFFF_t_70_pic_center]

### 遇到的坑 ###

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxNTEwNTUx_size_16_color_FFFFFF_t_70_pic_center 1]

<strategy> 标签中 <include> 与 <exclude> 只能配置一项!

意为下图中的include和exclude只能有一个  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxNTEwNTUx_size_16_color_FFFFFF_t_70_pic_center 2]

[annotation_ extension_core_generator]: /images/20221123/dfe9279329bd413299152b6b2ab3634b.png
[https_baomidou.com_guide_generator.html]: https://baomidou.com/guide/generator.html
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxNTEwNTUx_size_16_color_FFFFFF_t_70_pic_center]: /images/20221123/72cc3fcc148a4d6086f43dc824caf0f8.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxNTEwNTUx_size_16_color_FFFFFF_t_70_pic_center 1]: /images/20221123/17f05ee0243c4973a3fd4018b9f14e10.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxNTEwNTUx_size_16_color_FFFFFF_t_70_pic_center 2]: /images/20221123/0f7ecd22dfd24948b72ebe653f0c9868.png