java中SpringBoot项目使用mybatis-plus逆向自动生成全套代码,解放双手,专注于业务!

分手后的思念是犯贱 2023-01-03 14:24 283阅读 0赞

## java程序小白也能学会的mybatis-plus逆向自动生成全套代码 ##

### 章节导航 ###

*   *  java程序小白也能学会的mybatis-plus逆向自动生成全套代码
     *  1.在你的SpringBoot项目下新建子模块项目
     *  2.在此模块下新建一个包与一个java类 类名: CodeGenerator
     *  3.在 resources 下新建 文件夹,用来存放 mapper文件
     *  4.配置CodeGenerator类
     *  5.启动代码生成类main方法
     *  6.删除文件

## 1.在你的SpringBoot项目下新建子模块项目 ##

**pom.xml添加以下依赖:**

<properties>
            <java.version>1.8</java.version>
        </properties>
    
        <dependencies>
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
            </dependency>
            <dependency>
                <groupId>com.baomidou</groupId>
                <artifactId>mybatis-plus-generator</artifactId>
                <version>3.3.2</version>
            </dependency>
            <dependency>
                <groupId>com.baomidou</groupId>
                <artifactId>mybatis-plus-extension</artifactId>
                <version>3.3.2</version>
            </dependency>
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
                <optional>true</optional>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-freemarker</artifactId>
                <version>2.3.1.RELEASE</version>
            </dependency>
        </dependencies>
    
        <build>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                </plugin>
            </plugins>
        </build>

**ps:名称随意,最好带上generator 来辨别这是代码自动生成模块**  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDk4MDExNg_size_16_color_FFFFFF_t_70]

## 2.在此模块下新建一个包与一个java类 类名: CodeGenerator ##

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

**完整代码如下:**

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.DateType;
    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;
    
    /** * @Description: 代码生成类 */
    public class CodeGenerator { 
        //数据库连接参数
        public static String driver = "com.mysql.cj.jdbc.Driver";
        public static String url = "jdbc:mysql://localhost:3306/rht_test?characterEncoding=utf8&useSSL=false&serverTimezone=Asia/Shanghai&rewriteBatchedStatements=true";
        public static String username="root";
        public static String password="123456";
        //父级别包名称
        public static String parentPackage = "cn.rht";
        //代码生成的目标路径
        public static String generateTo = "/rht-generator/src/main/java";
        //mapper.xml的生成路径
        public static String mapperXmlPath = "/rht-generator/src/main/resources/mapper";
        //控制器的公共基类，用于抽象控制器的公共方法，null值表示没有父类
        public static String baseControllerClassName ;
        //业务层的公共基类，用于抽象公共方法
        public static String baseServiceClassName ;
        //作者名
        public static String author = "rht.cn";
        //模块名称，用于组成包名
        public static String modelName = "portal";
        //Mapper接口的模板文件，不用写后缀 .ftl
        public static String mapperTempalte = "/ftl/mapper.java";
    
        /** * <p> * 读取控制台内容 * </p> */
        public static String scanner(String tip) { 
            Scanner scanner = new Scanner(System.in);
            StringBuilder help = new StringBuilder();
            help.append("请输入" + tip + "：");
            System.out.println(help.toString());
            if (scanner.hasNext()) { 
                String ipt = scanner.next();
                if (StringUtils.isNotEmpty(ipt)) { 
                    return ipt;
                }
            }
            throw new MybatisPlusException("请输入正确的" + tip + "！");
        }
    
        /** * RUN THIS */
        public static void main(String[] args) { 
            // 代码生成器
            AutoGenerator mpg = new AutoGenerator();
    
            // 全局配置
            GlobalConfig gc = new GlobalConfig();
            String projectPath = System.getProperty("user.dir");
            gc.setOutputDir(projectPath + generateTo);
            gc.setAuthor(author);
            gc.setOpen(false);
            //设置时间类型为Date
            gc.setDateType(DateType.TIME_PACK);
            //开启swagger
            //gc.setSwagger2(true);
            //设置mapper.xml的resultMap
            gc.setBaseResultMap(true);
            mpg.setGlobalConfig(gc);
    
            // 数据源配置
            DataSourceConfig dsc = new DataSourceConfig();
            dsc.setUrl(url);
            // dsc.setSchemaName("public");
            dsc.setDriverName(driver);
            dsc.setUsername(username);
            dsc.setPassword(password);
            mpg.setDataSource(dsc);
    
            // 包配置
            PackageConfig pc = new PackageConfig();
            pc.setEntity("model");
            //pc.setModuleName(scanner("模块名"));
            pc.setModuleName(modelName);
            pc.setParent(parentPackage);
            mpg.setPackageInfo(pc);
    
            // 自定义配置
            InjectionConfig cfg = new InjectionConfig() { 
                @Override
                public void initMap() { 
                    // to do nothing
                }
            };
            List<FileOutConfig> focList = new ArrayList<>();
            focList.add(new FileOutConfig("/templates/mapper.xml.ftl") { 
                @Override
                public String outputFile(TableInfo tableInfo) { 
                    // 自定义输入文件名称
                    return projectPath + mapperXmlPath
                            + "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
                }
            });
            cfg.setFileOutConfigList(focList);
            mpg.setCfg(cfg);
            mpg.setTemplate(new TemplateConfig().setXml(null));
            mpg.setTemplate(new TemplateConfig().setMapper(mapperTempalte));
    
            // 策略配置
            StrategyConfig strategy = new StrategyConfig();
            strategy.setNaming(NamingStrategy.underline_to_camel);
            //字段驼峰命名
            strategy.setColumnNaming(NamingStrategy.underline_to_camel);
            //设置实体类的lombok
            strategy.setEntityLombokModel(true);
            //设置controller的父类
            if (baseControllerClassName!=null) strategy.setSuperControllerClass(baseControllerClassName);
            //设置服务类的父类
            if (baseServiceClassName !=null ) strategy.setSuperServiceImplClass(baseServiceClassName);
            // strategy.
            //设置实体类属性对应表字段的注解
            strategy.setEntityTableFieldAnnotationEnable(true);
            //设置表名
            String tableName = scanner("表名, all全部表");
            if(! "all".equalsIgnoreCase(tableName)){ 
                strategy.setInclude(tableName);
            }
    
            strategy.setTablePrefix(pc.getModuleName() + "_");
            strategy.setRestControllerStyle(true);
            mpg.setStrategy(strategy);
    
            // 选择 freemarker 引擎需要指定如下加，注意 pom 依赖必须有！
            mpg.setTemplateEngine(new FreemarkerTemplateEngine());
            mpg.execute();
        }
    
    }

## 3.在 resources 下新建 文件夹,用来存放 mapper文件 ##

**新建模板文件: mapper.java.ftl**  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDk4MDExNg_size_16_color_FFFFFF_t_70 2]

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDk4MDExNg_size_16_color_FFFFFF_t_70 3]  
模板完整代码如下:

package ${package.Mapper};
    
    import ${package.Entity}.${entity};
    import ${superMapperClassPackage};
    import org.springframework.stereotype.Repository;
    
    /**
     * <p>
     * ${table.comment!} Mapper 接口
     * </p>
     *
     * @author ${author}
     * @since ${date}
     */
    <#if kotlin>
    interface ${table.mapperName} : ${superMapperClass}<${entity}>
    <#else>
    @Repository
    public interface ${table.mapperName} extends ${superMapperClass}<${entity}> {
    
    }
    </#if>

## 4.配置CodeGenerator类 ##

ps:请根据自己实际路径配置  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDk4MDExNg_size_16_color_FFFFFF_t_70 4]

## 5.启动代码生成类main方法 ##

**ps:输入all 将会自动生成配置数据库下的所有配置文件,或者直接输入单表名称生成某一个表的Controller,mapper,service,model层与mapper.xml文件**

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDk4MDExNg_size_16_color_FFFFFF_t_70 5]  
**下面是我输入表名为:user,自动生成的部分文件信息展示**  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDk4MDExNg_size_16_color_FFFFFF_t_70 6]  
**User实体类**  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDk4MDExNg_size_16_color_FFFFFF_t_70 7]  
**UserMapper.xml文件**  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDk4MDExNg_size_16_color_FFFFFF_t_70 8]  
**如果你有很多表要生成时,但又不想全部生成时,可以在CodeGenerator类代码中134行代码**

//设置表名
            String tableName = scanner("表名, all全部表");
            if(! "all".equalsIgnoreCase(tableName)){ 
                strategy.setInclude(tableName);
            }

**替换为:**

String[] tableNames = {"user","dept"};//数据库表名的集合
    for (int i = 0; i <tableNames.length ; i++) {
        strategy.setInclude(tableNames);
    }

**来生成自己想要生成的文件**

## 6.删除文件 ##

**最后:也是重要的一点,在您将这些文件复制到了项目模块上的时候,留下CodeGenerator类与文件夹下的mapper.java.ftl配置,其他生成的请及时删除**

**至于原因是将来业务拓展后,数据库新增表后,只要新创建表的文件,如果不删除以前生成过的文件,到时候找起来比较麻烦,没必要给自己添这层麻烦**

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDk4MDExNg_size_16_color_FFFFFF_t_70 9]  
**好了,这篇文章就到这里啦,这篇文章对你有帮助欢迎点赞转发,支持一下博主,有什么问题的话也可以留言,或者私信哈!**

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDk4MDExNg_size_16_color_FFFFFF_t_70]: /images/20221119/b0324ab0dcba40a8a6c45391b44c74b2.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDk4MDExNg_size_16_color_FFFFFF_t_70 1]: /images/20221119/ad496743b3994729841506a1879d36e6.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDk4MDExNg_size_16_color_FFFFFF_t_70 2]: /images/20221119/98df9d77228441f2b31091759529221d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDk4MDExNg_size_16_color_FFFFFF_t_70 3]: /images/20221119/f76ef940c4624851940dd6dace209be1.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDk4MDExNg_size_16_color_FFFFFF_t_70 4]: https://img-blog.csdnimg.cn/20210108194432851.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDk4MDExNg==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDk4MDExNg_size_16_color_FFFFFF_t_70 5]: https://img-blog.csdnimg.cn/20210108194137879.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDk4MDExNg==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDk4MDExNg_size_16_color_FFFFFF_t_70 6]: https://img-blog.csdnimg.cn/20210108195005933.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDk4MDExNg==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDk4MDExNg_size_16_color_FFFFFF_t_70 7]: https://img-blog.csdnimg.cn/20210108200917754.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDk4MDExNg==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDk4MDExNg_size_16_color_FFFFFF_t_70 8]: https://img-blog.csdnimg.cn/20210108201027337.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDk4MDExNg==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDk4MDExNg_size_16_color_FFFFFF_t_70 9]: https://img-blog.csdnimg.cn/2021010819575798.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDk4MDExNg==,size_16,color_FFFFFF,t_70