MybatisPlus学习笔记(九)------MybatisPlus代码生成器(即取即用)

代码生成器

MybatisPlus与Mybatis的代码生成器对比

Mybatis是基于xml生成代码;

MybatisPlus是Mybatis的增强版,故代码生成器进化为基于Java生成代码;

MyBatis 的代码生成器只可生成: 实体类、Mapper 接口、Mapper 映射文件;

AutoGenerator 是 MyBatis-Plus 的代码生成器,通过 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller等各个模块的代码;

MybatisPlus提供了大量的自定义设置,生成的代码完全能够满足各类型的需求。(例如生成的实体类可以选择是否支持AR模式。)

步骤演示

1.引入依赖


<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>3.3.0</version>
</dependency>

<dependency>
<groupId>org.apache.velocity</groupId>
<artifactId>velocity-engine-core</artifactId>
<version>2.1</version>
</dependency>
2.创建代码生成器主类

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

import java.io.File;
import java.util.*;

/**

  • Created by ASUS on 2020/1/17.
    */
    public class MysqlGenerator {
    private static String packageName = "src/main"; //初始文件路径
    private static String customPath = "codegen"; //自定义路径
    private static String authorName = "Ethan"; //作者
    private static String table = "sys_account"; //table名字
    private static String prefix = "sys_"; //table前缀
    private static File file = new File(packageName);
    private static String path = file.getAbsolutePath();

    // 执行 main 方法自动生成代码到项目目录中
    public static void main(String[] args) {
    System.out.println("绝对路径" + path);

     // 自定义需要填充的字段
     List<TableFill> tableFillList = new ArrayList<>();
     tableFillList.add(new TableFill("ASDD_SS", FieldFill.INSERT_UPDATE));
    
     // 代码生成器
     AutoGenerator generator = new AutoGenerator();
    
     // 全局配置
     GlobalConfig gc = new GlobalConfig()
             .setOutputDir(path + "/java")//输出目录
             .setFileOverride(false)// 是否覆盖文件
             .setActiveRecord(true)// 开启 activeRecord 模式
             .setEnableCache(false)// XML 二级缓存
             .setBaseResultMap(true)// XML ResultMap
             .setBaseColumnList(true)// XML columList
             .setOpen(false)//生成后打开文件夹
             .setAuthor(authorName)
             // 自定义文件命名,注意 %s 会自动填充表实体属性!
             .setMapperName("%sMapper")
             .setXmlName("%sMapper")
             .setServiceName("%sService")
             .setServiceImplName("%sServiceImpl")
             .setControllerName("%sController");
     generator.setGlobalConfig(gc);
    
     // 数据源配置
     DataSourceConfig dsc = new DataSourceConfig()
             .setDbType(DbType.MYSQL)// 数据库类型
             .setDriverName("com.mysql.jdbc.Driver")
             .setUsername("root")
             .setPassword("mysql94")
             .setUrl("jdbc:mysql://localhost:3306/mybatis-plus?characterEncoding=utf8&useSSL=false&serverTimezone=UTC&rewriteBatchedStatements=true");
     generator.setDataSource(dsc);
    
     // 包配置
     PackageConfig pc = new PackageConfig()
             //.setModuleName("User")
             .setParent("com.ethan." + customPath)// 自定义包路径
             .setController("controller")// 这里是控制器包名,默认 web
             .setEntity("entity")
             .setMapper("dao")
             .setService("service")
             .setServiceImpl("service.impl");
             //.setXml("mapper")
     generator.setPackageInfo(pc);
    
     // 策略配置
     StrategyConfig strategy = new StrategyConfig()
             .setTablePrefix(new String[]{prefix})// 此处可以修改为您的表前缀
             .setNaming(NamingStrategy.underline_to_camel)// 表名生成策略
             .setColumnNaming(NamingStrategy.underline_to_camel)
             .setInclude(new String[]{table}) // 需要生成的表
             .setRestControllerStyle(true)
             .setEntityLombokModel(true)
             .setTableFillList(tableFillList);
             //.setExclude(new String[]{"test"}) // 排除生成的表
             // 自定义实体父类
             // .setSuperEntityClass("com.baomidou.demo.TestEntity")
             // 自定义实体,公共字段
             //.setSuperEntityColumns(new String[]{"test_id"})
             // 自定义 mapper 父类
             // .setSuperMapperClass("com.baomidou.demo.TestMapper")
             // 自定义 service 父类
             // .setSuperServiceClass("com.baomidou.demo.TestService")
             // 自定义 service 实现类父类
             // .setSuperServiceImplClass("com.baomidou.demo.TestServiceImpl")
             // 自定义 controller 父类
             //.setSuperControllerClass("com.ethan"+packageName+".controller.AbstractController")
             // 【实体】是否生成字段常量(默认 false)
             // public static final String ID = "test_id";
             // .setEntityColumnConstant(true)
             // 【实体】是否为构建者模型(默认 false)
             // public User setName(String name) {this.name = name; return this;}
             // .setEntityBuilderModel(true)
             // 【实体】是否为lombok模型(默认 false)<a href="https://projectlombok.org/">document</a>
             // Boolean类型字段是否移除is前缀处理
             // .setEntityBooleanColumnRemoveIsPrefix(true)
             // .setControllerMappingHyphenStyle(true)
             // .setCapitalMode(true)// 全局大写命名
             //.setDbColumnUnderline(true)//全局下划线命名
     generator.setStrategy(strategy);
    
     // 自定义配置
     InjectionConfig cfg = new InjectionConfig() {
         @Override
         public void initMap() {
             Map<String, Object> map = new HashMap<>();
             map.put("abc", this.getConfig().getGlobalConfig().getAuthor() + "-mp");
             this.setMap(map);
         }
     }.setFileOutConfigList(Collections.<FileOutConfig>singletonList(new FileOutConfig("/templates/mapper.xml.vm") {
         // 自定义输出文件目录
         @Override
         public String outputFile(TableInfo tableInfo) {
             return path + "/resources/mapper/" + tableInfo.getEntityName() + "Mapper.xml";
         }
     }));
     generator.setCfg(cfg);
    
     // 配置模板
     TemplateConfig templateConfig = new TemplateConfig()
             // 关闭默认 xml 生成,调整生成 至 根目录
             .setXml(null);
             // 自定义模板配置,模板可以参考源码 /mybatis-plus/src/main/resources/template 使用 copy
             // 至您项目 src/main/resources/template 目录下,模板名称也可自定义如下配置:
             // .setController("...");
             // .setEntity("...");
             // .setMapper("...");
             // .setXml("...");
             // .setService("...");
             // .setServiceImpl("...");
     generator.setTemplate(templateConfig);
    
     // 执行生成
     generator.execute();
    
     // 打印注入设置,这里演示模板里面怎么获取注入内容【可无】
     System.err.println(generator.getCfg().getMap().get("abc"));
    

    }
    }
    3.执行结果

执行主类中的main方法即可生成所有代码到com.ethan.codegen目录中(代码生成器类是utils.gen中的MysqlGenerator.java)

image

4.代码测试

image

注:

1.生成的AccountServiceImpl中不再进行mapper的注入,AccountServiceImpl继承ServiceImpl,MP提供的ServiceImpl类已经完成了mapper对象的注入。

2.ServiceImpl中也给我们提供了CRUD方法,基本的一些CRUD的方法在Service中不需要自己定义了,这些CRUD方法都是对单表操作的。

代码已同步更新至Github:https://github.com/NightOnewith/mybatisplus-basic

本篇文章由一文多发平台ArtiPub自动发布

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,547评论 6 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,399评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,428评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,599评论 1 274
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,612评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,577评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,941评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,603评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,852评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,605评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,693评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,375评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,955评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,936评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,172评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 43,970评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,414评论 2 342

推荐阅读更多精彩内容

  • 1. 简介 1.1 什么是 MyBatis ? MyBatis 是支持定制化 SQL、存储过程以及高级映射的优秀的...
    笨鸟慢飞阅读 5,422评论 0 4
  • 一、MybatisPlus简介 1.1.简介 Mybatis-Plus(简称MP)是一个 Mybatis 的增强工...
    Waldeinsamkeit4阅读 18,204评论 3 76
  • Valentine 转载请标明出处。 Mybatis介绍以及使用 MyBatis is a first class...
    valentine_liang阅读 768评论 0 5
  • 1、什么是Mybatis? (1)Mybatis是一个半ORM(对象关系映射)框架,它内部封装了JDBC,开发时只...
    月哥说了算阅读 459评论 0 0
  • 从上次更新到现在,按照承诺我应该把撒哈拉来回写了八遍了。可是我鬼迷心窍,不想说沙漠了,因为一个故事——《海的女...
    晕啦阅读 379评论 0 0