使用 Mybatis Plus 插件自动生成代码
2021-01-22 本文已影响0人
高节
- 之前我一直使用的 mybatis，生成代码的时候还算行，可是只有entity,mapper,xml这3个，而且还要去删掉里面不要的一些方法，实体类也要做一些修改，也比较麻烦
- 后来也用过idea自带的database，也有代码生成的功能，但是那个操作的界面是超级难用，每次生成都要配置一大堆，一不小心就找不到生成的代码了
-
现在大家都在用 mybatis plus 和 lombok，这样能很大程度的减少项目的代码，所以必须要来试一试
- 我是觉得生成代码的插件可以放到项目里面，这样别人需要的时候可以直接使用，而且生成的位置直接在项目中，减少了复制粘贴次数，所以我就把生成代码需要的依赖也放了进来
代码生成器需要的额外依赖
- 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 - ==========================文件生成完成！！！==========================
非常方便，比以前用过的工具都要好用，奶思
代码结构
