AutoGenerator 是 MyBatis-Plus 的代码生成器,通过 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各个模块的代码,极大的提升了开发效率。
适用版本:mybatis-plus-generator 3.5.1 以下版本
com.baomidou mybatis-plus-generator 3.5.0
`
2.添加 模板引擎 依赖
MyBatis-Plus 支持 Velocity(默认)、Freemarker、Beetl等引擎,用户可以选择自己熟悉的模板引擎,如果都不满足您的要求,可以采用自定义模板引擎。
默认模板Velocity足够使用
org.apache.velocity velocity-engine-core 2.3
3.添加 swagger2 依赖
Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务的接口文档。
io.springfox springfox-swagger2 2.9.2
4.添加 数据库,spring等依赖
com.alibaba druid-spring-boot-starter 1.2.16
dependency>com.mysql mysql-connector-j runtime
5.设置数据库的连接配置文件
在application.properties或者自定义的配置文件中配置数据库的路径,用户名和密码
spring.datasource.druid.driver-class-name= com.mysql.cj.jdbc.Driver
spring.datasource.druid.url= jdbc:mysql://localhost:3306/test?useUnicode=true&characterEncoding=utf-8&useSSL=true
useUnicode=true&characterEncoding=utf-8&useSSL=true
spring.datasource.druid.username= root
spring.datasource.druid.password= 1234
4.编写生成代码文件,
MyBatis-Plus 的代码生成器提供了大量的自定义参数供用户选择,能够满足绝大部分人的使用需求。
在src\main\java\dzxx\crud\ 目录下创建在GeneratorApp.java文件,对参数进行配置,
执行 main 方法控制台输入模块表名回车自动生成对应项目目录中
package dzxx.crud;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.NamingStrategy;import java.util.ArrayList;
import java.util.List;
import java.util.Scanner;public class GeneratorApp {/*** 读取控制台内容*/private 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.isNotBlank(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");//设置生成路径gc.setOutputDir(projectPath + "/src/main/java");//设置生成作者gc.setAuthor("chx");//设置生成是不是要打开所在文件夹gc.setOpen(false);//设置生成swagger,需要添加swagger依赖gc.setSwagger2(true);//在mapper.xml生成一个基础的《resultMap>映射所有的字段gc.setBaseResultMap(true);//设置同文件生成的覆盖gc.setFileOverride(true);//设置实体名:直接用表名 %s=表名gc.setEntityName("%s");//设置mapper接口名gc.setMapperName("%sMapper");//设置mapper.xml名gc.setXmlName("%sMapper");//设置service 接口名称gc.setServiceName("%sService");//设置 serviceImp 名称gc.setServiceImplName("%sServiceImp");//设置controller 名称gc.setControllerName("%sController");mpg.setGlobalConfig(gc);// 数据源配置DataSourceConfig dsc = new DataSourceConfig();dsc.setUrl("jdbc:mysql://localhost:3306/test?useUnicode=true&characterEncoding=utf-8&useSSL=true");// dsc.setSchemaName("public");dsc.setDriverName("com.mysql.jdbc.Driver");dsc.setUsername("root");dsc.setPassword("1234");mpg.setDataSource(dsc);// 包配置PackageConfig pc = new PackageConfig();pc.setModuleName(scanner("模块名"));//设置包名pc.setParent("dzxx.crud");//完整的包名:dzxx.crud.模块名mpg.setPackageInfo(pc);//把已有的xml生成位置取消TemplateConfig templateConfig=new TemplateConfig();templateConfig.setXml(null);mpg.setTemplate(templateConfig);// 自定义配置, 主要设置mapper.xml文件的生成名称和位置InjectionConfig cfg = new InjectionConfig() {@Overridepublic void initMap() {// to do nothing}};// 如果模板引擎是 freemarker// String templatePath = "/templates/mapper.xml.ftl";// 如果模板引擎是 velocityString templatePath = "/templates/mapper.xml.vm";// 自定义输出配置 mapper.xml文件的位置List focList = new ArrayList<>();// 自定义配置会被优先输出focList.add(new FileOutConfig(templatePath) {@Overridepublic String outputFile(TableInfo tableInfo) {// 自定义输出文件名 , 如果你 Entity 设置了前后缀、此处注意 xml 的名称会跟着发生变化!!return projectPath + "/src/main/resources/mapper/" + pc.getModuleName()+ "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;}});cfg.setFileOutConfigList(focList);mpg.setCfg(cfg);// 策略配置StrategyConfig strategy = new StrategyConfig();//表名的生成策略,下划线转驼峰strategy.setNaming(NamingStrategy.underline_to_camel);//列名的生成策略,下划线转驼峰strategy.setColumnNaming(NamingStrategy.underline_to_camel);// strategy.setSuperEntityClass("你自己的父类实体,没有就不用设置!");// strategy.setEntityLombokModel(true);//在controller类上是否生成@RestControllerstrategy.setRestControllerStyle(true);// 公共父类// strategy.setSuperControllerClass("你自己的父类控制器,没有就不用设置!");// 写于父类中的公共字段// strategy.setSuperEntityColumns("id");//按表的前缀模糊生成实体// strategy.setLikeTable(new LikeTable("stu_"));//按表名生成实体strategy.setInclude(scanner("表名,多个英文逗号分割").split(","));//设置controller请求路径:比如:表pms_product生成的对应controller路径为:@RequestMapping("/pms/product")strategy.setControllerMappingHyphenStyle(true);//设置把表前缀替换掉,比如shop_stu_cat_,生成entity、service、controller名称为:stu_catstrategy.setTablePrefix("shop_");mpg.setStrategy(strategy);// mpg.setTemplateEngine(new FreemarkerTemplateEngine());//进行生成mpg.execute();}
}