mybatis-plus generator代码生成器使用教程

1.添加代码生成器依赖(依赖看需要添加)


    com.baomidou
    mybatis-plus-generator
    3.3.2

//mybatis-plus依赖
 
            com.baomidou
            mybatisplus-spring-boot-starter
            3.0.5
        
        
        

            com.baomidou
            mybatis-plus
            3.0.5
        


            mysql
            mysql-connector-java
            runtime
        

        
            com.alibaba
            druid
            1.1.6
        


            org.projectlombok
            lombok
            true
        

2.添加模板引擎

添加 模板引擎 依赖,MyBatis-Plus 支持 Velocity(默认)、Freemarker、Beetl,用户可以选择自己熟悉的模板引擎,如果都不满足您的要求,可以采用自定义模板引擎。

2.1 Velocity(默认):


    org.apache.velocity
    velocity-engine-core
    2.2

2.2 Freemarker:


    org.freemarker
    freemarker
    2.3.30

2.3 Beetl:


    com.ibeetl
    beetl
    3.1.8.RELEASE

注意!如果您选择了非默认引擎,需要在 AutoGenerator 中 设置模板引擎。

AutoGenerator generator = new AutoGenerator();

// set freemarker engine
generator.setTemplateEngine(new FreemarkerTemplateEngine());

// set beetl engine
generator.setTemplateEngine(new BeetlTemplateEngine());

// set custom engine (reference class is your custom engine class)
generator.setTemplateEngine(new CustomTemplateEngine());

// other config
...

3.个人使用代码(非直接官方,有部分修改,可修改参数直接使用)

import java.util.*;

import com.baomidou.mybatisplus.annotation.DbType;
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.converts.MySqlTypeConvert;
import com.baomidou.mybatisplus.generator.config.po.TableInfo;
import com.baomidou.mybatisplus.generator.config.rules.DbColumnType;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;

/**
 * 

* 代码生成器演示 *

*/ public class MpGenerator { final static String dirPath = System.getProperty("user.dir"); /*final static String dirPath = "classpath:/com/example/mybatisP/";*/ 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 + "!"); } /** *

* MySQL 生成演示 *

*/ public static void main(String[] args) { AutoGenerator mpg = new AutoGenerator(); // 选择 freemarker 引擎,默认 Veloctiy //mpg.setTemplateEngine(new FreemarkerTemplateEngine()); // 全局配置 GlobalConfig gc = new GlobalConfig(); gc.setOutputDir(dirPath + "/mybatisplus/src/main/java/"); System.out.println( "路径为" + gc.getOutputDir()); gc.setAuthor("zhengweihe"); gc.setFileOverride(true); //是否覆盖 gc.setActiveRecord(true);// 不需要ActiveRecord特性的请改为false gc.setEnableCache(false);// XML 二级缓存 gc.setBaseResultMap(true);// XML ResultMap gc.setBaseColumnList(true);// XML columList // 自定义文件命名,注意 %s 会自动填充表实体属性! // gc.setMapperName("%sDao"); // gc.setXmlName("%sMapper"); // gc.setServiceName("MP%sService"); // gc.setServiceImplName("%sServiceDiy"); // gc.setControllerName("%sAction"); mpg.setGlobalConfig(gc); // 数据源配置 DataSourceConfig dsc = new DataSourceConfig(); dsc.setDbType(DbType.MYSQL); /*dsc.setTypeConvert(new MySqlTypeConvert(){ // 自定义数据库表字段类型转换【可选】 @Override public DbColumnType processTypeConvert(String fieldType) { System.out.println("转换类型:" + fieldType); // 注意!!processTypeConvert 存在默认类型转换,如果不是你要的效果请自定义返回、非如下直接返回。 return super.processTypeConvert(fieldType); } });*/ dsc.setDriverName("com.mysql.cj.jdbc.Driver"); dsc.setUsername("root"); dsc.setPassword("root"); dsc.setUrl("jdbc:mysql://localhost:3306/tale?useUnicode=true&characterEncoding=utf8&allowMultiQueries=true&serverTimezone=UTC"); mpg.setDataSource(dsc); // 策略配置 StrategyConfig strategy = new StrategyConfig(); strategy.setEntityLombokModel(true); // strategy.setCapitalMode(true);// 全局大写命名 ORACLE 注意 //strategy.setTablePrefix(new String[] { "tb_", "tsys_" });// 此处可以修改为您的表前缀 strategy.setNaming(NamingStrategy.underline_to_camel);// 表名生成策略 strategy.setColumnNaming(NamingStrategy.underline_to_camel);//列名规则 strategy.setEntityLombokModel(true);//是否生成lombok注解 //自动填充的配置 TableFill create_time = new TableFill("create_time", FieldFill.INSERT);//设置时的生成策略 TableFill update_time = new TableFill("update_time", FieldFill.INSERT_UPDATE);//设置更新时间的生成策略 ArrayList list = new ArrayList<>(); list.add(create_time); list.add(update_time); strategy.setTableFillList(list); strategy.setRestControllerStyle(true);//开启驼峰命名 // 如果 setInclude() 不加参数, 会自定查找所有表 //strategy.setInclude(new String[] { "t_users" }); // 需要生成的表 //strategy.setInclude(scanner("表名")); strategy.setInclude(scanner("表名,多个英文逗号分割").split(",")); // strategy.setExclude(new String[]{"test"}); // 排除生成的表 // 自定义实体父类 // strategy.setSuperEntityClass("com.baomidou.demo.TestEntity"); // 自定义实体,公共字段 // strategy.setSuperEntityColumns(new String[] { "test_id", "age" }); // 自定义 mapper 父类 // strategy.setSuperMapperClass("com.baomidou.demo.TestMapper"); // 自定义 service 父类 // strategy.setSuperServiceClass("com.baomidou.demo.TestService"); // 自定义 service 实现类父类 // strategy.setSuperServiceImplClass("com.baomidou.demo.TestServiceImpl"); // 自定义 controller 父类 // strategy.setSuperControllerClass("com.baomidou.demo.TestController"); // 【实体】是否生成字段常量(默认 false) // public static final String ID = "test_id"; // strategy.setEntityColumnConstant(true); // 【实体】是否为构建者模型(默认 false) // public User setName(String name) {this.name = name; return this;} strategy.setEntityBuilderModel(true); mpg.setStrategy(strategy); // 包配置 PackageConfig pc = new PackageConfig(); pc.setParent("com"); pc.setModuleName("example.mybatisP"); pc.setController("controller"); pc.setEntity("entity"); pc.setMapper("mapper"); pc.setService("service"); pc.setServiceImpl("serviceImpl"); /*pc.setXml("mapperXml");*/ mpg.setPackageInfo(pc); // 注入自定义配置,可以在 VM 中使用 cfg.zwh 【可无】 InjectionConfig cfg = new InjectionConfig() { @Override public void initMap() { Map map = new HashMap(); map.put("zhengweihe", this.getConfig().getGlobalConfig().getAuthor() + "的模板生成完成!"); this.setMap(map); } }; // 自定义 xxList.jsp 生成 List focList = new ArrayList(); /* focList.add(new FileOutConfig("/template/list.jsp.vm") { @Override public String outputFile(TableInfo tableInfo) { // 自定义输入文件名称 return "D://my_" + tableInfo.getEntityName() + ".jsp"; } }); cfg.setFileOutConfigList(focList); mpg.setCfg(cfg);*/ // 调整 xml 生成目录演示 /* focList.add(new FileOutConfig("/templates/mapper.xml.vm") { @Override public String outputFile(TableInfo tableInfo) { return dirPath + tableInfo.getEntityName() + "Mapper.xml"; } }); cfg.setFileOutConfigList(focList); mpg.setCfg(cfg);*/ // 如果模板引擎是 freemarker //String templatePath = "/templates/mapper.xml.ftl"; // 如果模板引擎是 velocity // String templatePath = "/templates/mapper.xml.vm"; //自定义配置会优先输出 focList.add(new FileOutConfig("/templates/mapper.xml.vm") { @Override public String outputFile(TableInfo tableInfo) { // 自定义输出文件名 , 如果你 Entity 设置了前后缀、此处注意 xml 的名称会跟着发生变化!! return dirPath + "/mybatisplus/src/main/resources/mapper/" //+ tableInfo.getEntityName() + "Mapper.xml"; + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML; } }); cfg.setFileOutConfigList(focList); mpg.setCfg(cfg); // 关闭默认 xml 生成,调整生成 至 根目录 /* TemplateConfig tc = new TemplateConfig(); tc.setXml(null); mpg.setTemplate(tc);*/ // 自定义模板配置,可以 copy 源码 mybatis-plus/src/main/resources/templates 下面内容修改, // 放置自己项目的 src/main/resources/templates 目录下, 默认名称一下可以不配置,也可以自定义模板名称 // TemplateConfig tc = new TemplateConfig(); // tc.setController("..."); // tc.setEntity("..."); // tc.setMapper("..."); // tc.setXml("..."); // tc.setService("..."); // tc.setServiceImpl("..."); // 如上任何一个模块如果设置 空 OR Null 将不生成该模块。 // mpg.setTemplate(tc); // 执行生成 mpg.execute(); // 打印注入设置【可无】 System.err.println(mpg.getCfg().getMap().get("zhengweihe")); } }

4.直接运行main()函数即可。

5.yml配置文件(个人笔记)

# 2.x配置
mybatis-plus:
  #mapper-locations:
    #- classpath*:mapper/**/*Mapper.xml
  mapper-locations: classpath:/mapper/*.xml
  typeAliasesPackage: com.example.mybatis-plus.entity
  global-config:
    id-type: 0            //(0, "数据库ID自增"),
                          //INPUT(1, "用户输入ID"),
                          //ID_WORKER(2, "全局唯一ID"),
                          //UUID(3, "全局唯一ID"),
                          //NONE(4, "该类型为未设置主键类型"),
                          //ID_WORKER_STR(5, "字符串全局唯一ID")
    field-strategy: 2
    db-column-underline: true
    refresh-mapper: true
  configuration:
    map-underscore-to-camel-case: true
    cache-enabled: false

#3.x的配置
mybatis-plus:
  #mapper-locations:
    #- classpath*:mapper/**/*Mapper.xml
  mapper-locations: classpath:/mapper/*.xml
  typeAliasesPackage: com.example.mybatis-plus.entity
  global-config:
    db-config:
      select-strategy: not_empty
      insert-strategy: not_empty
      update-strategy: not_empty
      id-type: auto
  configuration:
    map-underscore-to-camel-case: true
    cache-enabled: false

你可能感兴趣的:(mybatis-plus generator代码生成器使用教程)