代码生成器的使用（使用SprintBoot 2、MyBatis-Plus框架）

本文链接：https://blog.youkuaiyun.com/CRMLF/article/details/108740657

版本：

Java：1.8.0_201
IDEA：2019.02
MySql：5.7.30
Navicat for MySql：15.0.6

具体代码请见Gtihub，欢迎star点一下

第一步：创建SpringBoot 2的基础项目

打开IDEA
File——>new——>project
选择SDK版本(Java版本)——>next
输入名称——>next
选择Web——>勾选Spring Web——>next
输入项目名称
在这里插入图片描述

在这里插入图片描述
打开新建的工程文件，可以看到以下的目录信息

第二步：导入依赖
在pom.xml文件中导入依赖
从MyBatis-Plus官方文档可以看到需要导入的依赖

添加MyBatisPlus启动项

<!--mybatis-plus启动器-->
        <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.4.0</version>
</dependency>

添加模板引擎依赖

Velocity（默认）

 <dependency>
    <groupId>org.apache.velocity</groupId>
    <artifactId>velocity-engine-core</artifactId>
    <version>2.2</version>
</dependency>

Freemarker

<dependency>
    <groupId>org.freemarker</groupId>
    <artifactId>freemarker</artifactId>
    <version>2.3.30</version>
</dependency>

(我的项目导入前两个依赖时，版本号标红，自己改了一下版本号之后可以运行，分别将代码生成器依赖版本3.4.0——>3.3.0和Velocity版本2.2——>2.1)

添加MySql依赖

<dependency>
			<groupId>mysql</groupId>
			<artifactId>mysql-connector-java</artifactId>
			<version>5.1.47</version>
</dependency>

导入依赖后右下角更新Maven。

在这里插入图片描述
第三步：建立数据库

在Navicat for MySql中建立名为test的数据库，在数据库中生成名为user和icon的两张表
在这里插入图片描述

第四步：写入代码生成器

将这段代码复制到CodeGeneratorApplicationTests类中(注意导包，如果不想手动导包，可以看看鄙人的自动导包设置)

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.setAuthor("LingZhi");
        gc.setOpen(false);
        // 默认生成的 service 会有 I 前缀
        gc.setServiceName("%sService");
        // gc.setSwagger2(true); 实体属性 Swagger2 注解
        mpg.setGlobalConfig(gc);
        // 数据源配置
        DataSourceConfig dsc = new DataSourceConfig();
        // 1.其中test为数据库库名
        dsc.setUrl("jdbc:mysql://localhost:3306/test?useUnicode=true&useSSL=false&characterEncoding=utf8");
        // dsc.setSchemaName("public");
        dsc.setDriverName("com.mysql.jdbc.Driver");
        // 2.数据库连接名、密码设置
        dsc.setUsername("root");
        dsc.setPassword("/*这里填写你的密码*/");
        mpg.setDataSource(dsc);
        // 包配置
        PackageConfig pc = new PackageConfig();
        // 3.生成的文件放在的目录
        pc.setParent("com.hznu.codegenerator.lz");
        //pc.setModuleName("sys");
        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"
                        + "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
            }
        });
        /*
        cfg.setFileCreate(new IFileCreate() {
            @Override
            public boolean isCreate(ConfigBuilder configBuilder, FileType fileType, String filePath) {
                // 判断自定义文件夹是否需要创建
                checkDir("调用默认方法创建的目录");
                return false;
            }
        });
        */
        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);
        //strategy.setSuperEntityClass("com.baomidou.ant.common.BaseEntity");

        //strategy.setEntityLombokModel(true);
        strategy.setRestControllerStyle(true);
        // 公共父类
        //strategy.setSuperControllerClass("com.baomidou.ant.common.BaseController");
        // 写于父类中的公共字段
        //strategy.setSuperEntityColumns("id");
        // 4.数据库中的表名
        strategy.setInclude("user","icon");
        strategy.setControllerMappingHyphenStyle(true);
        strategy.setTablePrefix(pc.getModuleName() + "_");
        mpg.setStrategy(strategy);
        mpg.setTemplateEngine(new FreemarkerTemplateEngine());
        mpg.execute();
    }