一起入门mybatis-plus之搭建逆向工程

mybatis-plus优势

官网：https://mp.baomidou.com/

官网介绍的特点：

• 主要宗旨：只做增强，不做改变。引入它不会对现有工程产生影响。
• 提高效率：只需要简单配置，即可快速进行CRUD操作，从而节省大量时间。
• 功能丰富：热加载、代码生成、分页、性能分析等功能一应俱全。

引入逆向工程依赖

• mybatis-plus逆向工程相关依赖

        
        
            com.baomidou
            mybatis-plus-boot-starter
        

        
        
            com.baomidou
            mybatis-plus-generator
            3.3.1
            test
        
        
        
            org.freemarker
            freemarker
            2.3.30
        

• 其他依赖

        
            org.apache.commons
            commons-lang3
            3.10
        

        
        
            mysql
            mysql-connector-java
            8.0.20
        

        
        
            org.projectlombok
            lombok
            1.18.12
            provided
        

• 要使用mybatis-plus还需要加上其他依赖，参考
  一起入门mybatis-plus之增删改查

逆向工程配置

/**
 * @author hugo0129
 * @description Mybatis-Plus代码生成器
 */
public class MyBatisPlusGenerator {
    /**
     * 

     * 读取控制台内容
     * 
     */
    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 + "！");
    }

    public static void main(String[] args) {
        // 代码生成器
        AutoGenerator mpg = new AutoGenerator();
        // 全局配置
        GlobalConfig gc = new GlobalConfig();
        String projectPath = System.getProperty("user.dir") + "/spring-mybatis-plus";
        gc.setOutputDir(projectPath + "/src/main/java");
        gc.setAuthor("hugo0129");
        gc.setOpen(false);
        gc.setDateType(ONLY_DATE);
        gc.setServiceImplName("%sRepository");
        // 实体属性 Swagger2 注解
        gc.setSwagger2(true);
        mpg.setGlobalConfig(gc);
        // 数据源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://localhost:3306/数据库名称?useUnicode=true&useSSL=false&characterEncoding=utf8&serverTimezone=GMT");
        // dsc.setSchemaName("public");
        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.hugo.talk.ssm");
        pc.setEntity("model.entity");
        pc.setMapper("repository.mapper");
        pc.setServiceImpl("repository");
        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 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.setServiceImpl("template/repository.java");
        templateConfig.setXml(null);
        mpg.setTemplate(templateConfig);

        // 策略配置
        StrategyConfig strategy = new StrategyConfig();
        strategy.setNaming(NamingStrategy.underline_to_camel);
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
        // strategy.setSuperEntityClass("你自己的父类实体,没有就不用设置!");
        strategy.setEntityLombokModel(true);
        strategy.setRestControllerStyle(true);
        // 公共父类
        // strategy.setSuperControllerClass("你自己的父类控制器,没有就不用设置!");
        // 写于父类中的公共字段
//      strategy.setSuperEntityColumns("id");
        strategy.setInclude(scanner("表名，多个英文逗号分割").split(","));
        strategy.setControllerMappingHyphenStyle(true);
        strategy.setTablePrefix("t_");
        strategy.setEntityBooleanColumnRemoveIsPrefix(true);
        strategy.setEntityColumnConstant(true);
        strategy.setEntityTableFieldAnnotationEnable(true);
        strategy.setLogicDeleteFieldName("deleted");
        mpg.setStrategy(strategy);
        mpg.setTemplateEngine(new FreemarkerTemplateEngine());
        mpg.execute();
    }
}

• 上述按需配置，一定要注意各个属性代表的意思，正确配置
• setOutputDir 这个属性一定要注意，正确的项目路径
• pc.setParent("com.hugo.talk.ssm"); //设置项目父包名
  pc.setEntity("model.entity");//设置实体类包名
  pc.setMapper("repository.mapper");//设置mapper包名
  pc.setServiceImpl("repository");//设置service Impl包名
  mpg.setPackageInfo(pc);
• 以上逆向工程如果配置错误，可以操作多次，类似于debug，发现问题再做相应更正

逆向工程模板

上述笔者逆向工程生成了一个repository，作为service impl的替代，作为数据操作中间层，与业务service脱离。
需要配置的模板如下：

• repository.java.btl

package ${package.ServiceImpl};

import ${package.Entity}.${entity};
import ${package.Mapper}.${table.mapperName};
import ${superServiceImplClassPackage};
import org.springframework.stereotype.Repository;

/**
 * 

 * ${table.comment!} 服务实现类
 * 
 *
 * @author ${author}
 * @since ${date}
 */
@Repository
<% if(kotlin){ %>
open class ${table.serviceImplName} : ${superServiceImplClass}<${table.mapperName}, ${entity}>() {

}
<% }else{ %>
public class ${table.serviceImplName} extends ${superServiceImplClass}<${table.mapperName}, ${entity}> {

}
<% } %>

• repository.java.ftl

package ${package.ServiceImpl};

import ${package.Entity}.${entity};
import ${package.Mapper}.${table.mapperName};
import ${superServiceImplClassPackage};
import org.springframework.stereotype.Repository;

/**
 * 

 * ${table.comment!} 服务实现类
 * 
 *
 * @author ${author}
 * @since ${date}
 */
@Repository
<#if kotlin>
open class ${table.serviceImplName} : ${superServiceImplClass}<${table.mapperName}, ${entity}>(){

}
<#else>
public class ${table.serviceImplName} extends ${superServiceImplClass}<${table.mapperName}, ${entity}>{

}

• repository.java.vm

package ${package.ServiceImpl};

import ${package.Entity}.${entity};
import ${package.Mapper}.${table.mapperName};
import ${superServiceImplClassPackage};
import org.springframework.stereotype.Repository;

/**
 * 

 * $!{table.comment} 服务实现类
 * 
 *
 * @author ${author}
 * @since ${date}
 */
@Repository
#if(${kotlin})
open class ${table.serviceImplName} : ${superServiceImplClass}<${table.mapperName}, ${entity}>(){

}
#else
public class ${table.serviceImplName} extends ${superServiceImplClass}<${table.mapperName}, ${entity}> {

}
#end

运行逆向工程

上述配置好之后，直接执行MyBatisPlusGenerator类，输入需要生成的mysql表名称，即可生成表对应的实体类、mapper、mybatis xml、repository类等。

逆向工程结构

在这里插入图片描述