使用 Mybatis Plus 插件自动生成代码

  1. 之前我一直使用的 mybatis,生成代码的时候还算行,可是只有entity,mapper,xml这3个,而且还要去删掉里面不要的一些方法,实体类也要做一些修改,也比较麻烦
  2. 后来也用过idea自带的database,也有代码生成的功能,但是那个操作的界面是超级难用,每次生成都要配置一大堆,一不小心就找不到生成的代码了
  • 现在大家都在用 mybatis plus 和 lombok,这样能很大程度的减少项目的代码,所以必须要来试一试

Mybatis Plus 官网地址

  • 我是觉得生成代码的插件可以放到项目里面,这样别人需要的时候可以直接使用,而且生成的位置直接在项目中,减少了复制粘贴次数,所以我就把生成代码需要的依赖也放了进来
代码生成器需要的额外依赖
  • maven 依赖
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.4.2</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.gaojie</groupId>
    <artifactId>store</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>store</name>
    <description>Demo project for Spring Boot</description>
    <properties>
        <java.version>11</java.version>
        <mybatis.plus.version>3.4.2</mybatis.plus.version>
    </properties>

    <dependencies>
        <!-- 健康检查和一些监控 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>
        <!-- Web项目必备 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!-- JDBC 连接数据库 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-jdbc</artifactId>
        </dependency>
        <!-- 整合 Mybatis Plus -->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>${mybatis.plus.version}</version>
        </dependency>
        <!-- 自动生成代码插件:不知道为啥,最新版的下载不下来,所以只能用这个了 -->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-generator</artifactId>
            <version>3.4.1</version>
        </dependency>
        <!-- 模板引擎:没有的话、使用 MP 自动生成代码会报错 -->
        <dependency>
            <groupId>org.apache.velocity</groupId>
            <artifactId>velocity-engine-core</artifactId>
            <version>2.0</version>
        </dependency>

        <!-- MySQL -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <scope>runtime</scope>
        </dependency>
        <!-- Lombok 简化实体类代码 -->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <!-- 测试 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <excludes>
                        <exclude>
                            <groupId>org.projectlombok</groupId>
                            <artifactId>lombok</artifactId>
                        </exclude>
                    </excludes>
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>

然后就是编写生成代码的方法,可以自己写个类,然后需要的时候运行一下就好了,官网提供的方法和参数很多,但是对我来说不需要那么多,所以就把不需要的去除了,只留下了需要的部分

package com.gaojie.store;

import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.config.DataSourceConfig;
import com.baomidou.mybatisplus.generator.config.GlobalConfig;
import com.baomidou.mybatisplus.generator.config.PackageConfig;
import com.baomidou.mybatisplus.generator.config.StrategyConfig;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import org.junit.jupiter.api.Test;

/**
 * 自动生成代码类
 */
class MpGeneratorTest {

    @Test
    void generateCode() {
        generate("com.gaojie", "store",
                "delivery_record", "delivery_record_box", "delivery_record_box_detail", "logistics", "logistics_price", "logistics_price_weight", "product", "purchase_record", "purchase_record_detail", "supplier"
        );
    }

    /**
     * 自动生成代码
     *
     * @param parentPackage 父级包名
     * @param modelName     模块名称
     * @param tableNames    要生成的表名
     */
    private void generate(String parentPackage, String modelName, String... tableNames) {
        AutoGenerator mpg = new AutoGenerator();

        // 1.1.全局配置
        GlobalConfig gc = new GlobalConfig();
        gc.setOutputDir("E:\\Code\\Study\\store\\src\\main\\java"); // 文件保存位置
        gc.setAuthor("GaoJie"); // 每个类顶部注释的作者
        gc.setOpen(false); // 默认生成后会打开文件所在位置,不想打开可以设置为false,设计这个属性的初衷应该是怕用户找不到生成的文件
        // gc.setFileOverride(true); // 是否覆盖原有文件:这个属性慎用,要是哪天误点,把自己写了几天的代码覆盖,那就傻逼了
        mpg.setGlobalConfig(gc);

        // 1.2.策略配置
        StrategyConfig strategy = new StrategyConfig();
        strategy.setNaming(NamingStrategy.underline_to_camel); // 表名 -> 实体类名:使用驼峰命名
        strategy.setColumnNaming(NamingStrategy.underline_to_camel); // 数据库字段 -> 属性名:驼峰命名
        strategy.setEntityLombokModel(true); // 使用 lombok
        strategy.setRestControllerStyle(true); // 使用 @RestController 注解
        strategy.setControllerMappingHyphenStyle(true); // @RequestMapping 默认驼峰命名法 -> 改为用-分隔,更好看
        strategy.setEntityTableFieldAnnotationEnable(true); // 将表上的注释映射到实体类
        strategy.setInclude(tableNames); // 需要生成的表名 可变形参传入
        mpg.setStrategy(strategy);

        // 2.1.数据源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://127.0.0.1:3306/store?useUnicode=true&useSSL=false&characterEncoding=utf8&serverTimezone=GMT%2B8");
        dsc.setDriverName("com.mysql.cj.jdbc.Driver");
        dsc.setUsername("root");
        dsc.setPassword("123456");
        mpg.setDataSource(dsc);

        // 2.2.包配置、controller、service、mapper、entity都可以这里设置
        PackageConfig pc = new PackageConfig();
        pc.setParent(parentPackage); // 父级包路径
        pc.setModuleName(modelName); // 模块名称:生成 @RequestMapping 时的前缀
        mpg.setPackageInfo(pc);

        // 3.自动生成
        mpg.execute();
    }

}

然后点击运行

"D:\Software\Develop\Install\IntelliJ IDEA 2019.2.3\jbr\bin\java.exe" -ea -Didea.test.cyclic.buffer.size=1048576 "-javaagent:D:\Software\Develop\Install\IntelliJ IDEA 
09:51:13.914 [main] DEBUG com.baomidou.mybatisplus.generator.AutoGenerator - ==========================准备生成文件...==========================
09:51:14.392 [main] DEBUG org.apache.velocity - Initializing Velocity, Calling init()...
09:51:14.393 [main] DEBUG org.apache.velocity - Starting Apache Velocity v2.0
中间一顿操作...
09:51:14.544 [main] DEBUG org.apache.velocity.loader - ResourceManager: found /templates/controller.java.vm with loader org.apache.velocity.runtime.resource.loader.ClasspathResourceLoader
09:51:14.545 [main] DEBUG com.baomidou.mybatisplus.generator.engine.AbstractTemplateEngine - 模板:/templates/controller.java.vm;  文件:E:\Code\Study\store\src\main\java\com\gaojie\store\controller\DeliveryRecordBoxController.java
09:51:14.545 [main] DEBUG com.baomidou.mybatisplus.generator.AutoGenerator - ==========================文件生成完成!!!==========================

非常方便,比以前用过的工具都要好用,奶思


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

推荐阅读更多精彩内容