代码开发技巧之快速逆向工程
我们都知道,在开发的时候,是百分百都能够使用到我们的实体类,各种工具类,而有些实体类,因为表中字段的增多,一个实体类,有可能有二三十个字段,而如果每一个字段都让我们自己去编辑,那你有一多半的时间,都会浪费在处理这个字段上面,所以,今天阿粉就来交给你,这个快速而又简单的根据表结构,生成实体类的小工具,逆向工我们都知道,在开发的时候,是百分百都能够使用到我们的实体类,各种工具类,而有些实体类,因为表中字段的增多,一个实体类,有可能有二三十个字段,而如果每一个字段都让我们自己去编辑,那你有一多半的时间,都会浪费在处理这个字段上面,所以,今天阿粉就来交给你,这个快速而又简单的根据表结构,生成实体类的小工具,逆向工程
。
什么是逆向工程
根据数据库生成java代码,这就是逆向工程,也就是需要我们根据数据库表结构,然后生成我们的对应代码。
话不多说,我们先来安排一下,直接建一个大约十几个字段的表,然后我们直接使用逆向工程来安排它。
我们简单设计了一个订单表,表结构上面,然后我们把这个表创建到我们的数据库中。
建表语句如下:
CREATE TABLE order_central(
ID VARCHAR(32) NOT NULL COMMENT '主键ID' ,
ORDER_SOURCE VARCHAR(32) COMMENT '订单来源' ,
ORDER_CODE VARCHAR(64) COMMENT '订单编号' ,
USER_ID VARCHAR(32) COMMENT '用户ID' ,
USER_NAME VARCHAR(32) COMMENT '用户姓名' ,
USER_PHONE VARCHAR(32) COMMENT '用户手机号' ,
USER_ADDRESS VARCHAR(32) COMMENT '用户地址' ,
ORDER_AMOUNT DECIMAL(32,10) COMMENT '订单金额' ,
ORDER_STATUS INT COMMENT '订单状态' ,
ORDER_SETTLE VARCHAR(32) COMMENT '是否结算' ,
REVISION INT COMMENT '乐观锁' ,
CREATED_BY VARCHAR(32) COMMENT '创建人' ,
CREATED_TIME DATETIME COMMENT '创建时间' ,
UPDATED_BY VARCHAR(32) COMMENT '更新人' ,
UPDATED_TIME DATETIME COMMENT '更新时间' ,
PRIMARY KEY (ID)
)
我们创建好了项目之后,就需要弄出一个简单的main方法,然后去生成,我们来搭建一个基础的springboot的项目。
怎样构建springboot项目,阿粉就不说了,我们直接来看都需要引入什么依赖,
依赖如下:
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.28</version>
</dependency>
<dependency>
<groupId>org.freemarker</groupId>
<artifactId>freemarker</artifactId>
<version>2.3.30</version>
</dependency>
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.3.1</version>
</dependency>
<!--mybatis-plus 代码生成器依赖-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>3.3.2</version>
</dependency>
如果你是其他的数据库,比如 oracle 或者是 sqlserver,那么你去找一下自己的制定版本就可以了,数据库驱动不同而已。
接下来直接上代码:
直接在自己的utils 包中新建一个utils,使用main方法就能完美操作。
代码如下:
package com.yikeji.reverseproject.util;
import com.baomidou.mybatisplus.annotation.IdType;
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 com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;
import java.util.*;
public class reverse {
/**
* 主要
* mybatis-plus 代码生成器,可生成实体类,controller,service,mapper,xml文件
* @param args arg
*/
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("yi"); //作者
gc.setOpen(false); //是否打开目录
gc.setBaseResultMap(true);//xml开启BaseResultMap
gc.setBaseColumnList(true);//xml 开启BaseColumn
gc.setSwagger2(true); //实体属性 Swagger2 注解
mpg.setGlobalConfig(gc);
// 数据源配置
DataSourceConfig dsc = new DataSourceConfig();
dsc.setUrl("jdbc:mysql://localhost:3306/central?useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai");
// dsc.setSchemaName("public");
dsc.setDriverName("com.mysql.cj.jdbc.Driver");
dsc.setUsername("root");
dsc.setPassword("root");
mpg.setDataSource(dsc);
// 包配置
PackageConfig pc = new PackageConfig();
pc.setModuleName(scanner("模块名"));
pc.setParent("com.yikeji")
.setEntity("pojo")
.setMapper("mapper")
.setService("service")
.setServiceImpl("service.impl")
.setController("controller");
mpg.setPackageInfo(pc);
// 自定义配置
InjectionConfig cfg = new InjectionConfig() {
@Override
public void initMap() {
// to do nothing
}
};
// 如果模板引擎是 freemarker
String templatePath = "/templates/mapper.xml.ftl";
// 如果模板引擎是 velocity
// String templatePath = "/templates/mapper.xml.vm";
// 自定义输出配置
List<FileOutConfig> focList = new ArrayList<>();
// 自定义配置会被优先输出
focList.add(new FileOutConfig(templatePath) {
@Override
public 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);
// 配置模板
TemplateConfig templateConfig = new TemplateConfig();
// 配置自定义输出模板
//指定自定义模板路径,注意不要带上.ftl/.vm, 会根据使用的模板引擎自动识别
// templateConfig.setEntity("templates/entity2.java");
// templateConfig.setService();
// templateConfig.setController();
templateConfig.setXml(null);
mpg.setTemplate(templateConfig);
// 策略配置
StrategyConfig strategy = new StrategyConfig();
//数据库表映射到实体的命名策略
strategy.setNaming(NamingStrategy.underline_to_camel);
//数据库表字段映射到实体的命名策略
strategy.setColumnNaming(NamingStrategy.no_change);
//strategy.setSuperEntityClass("你自己的父类实体,没有就不用设置!");
//lombok模型
strategy.setEntityLombokModel(true);
//生成RestController
strategy.setRestControllerStyle(true);
// 公共父类
//strategy.setSuperControllerClass("你自己的父类控制器,没有就不用设置!");
// 写于父类中的公共字段
//strategy.setSuperEntityColumns("id");
strategy.setInclude(scanner("表名,多个英文逗号分割").split(","));
strategy.setControllerMappingHyphenStyle(true);
//表前缀
mpg.setStrategy(strategy);
mpg.setTemplateEngine(new FreemarkerTemplateEngine());
mpg.execute();
}
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.isNotBlank(ipt)) {
return ipt;
}
}
throw new MybatisPlusException("请输入正确的" + tip + "!");
}
}
其实代码很简单,阿粉也在上面加上了注释,你需要改动的也就是项目的路径,以及作者,看阿粉生成的代码。
接着我们看看实体类:
package com.yikeji.reverseproject.pojo;
import java.math.BigDecimal;
import com.baomidou.mybatisplus.annotation.TableName;
import java.time.LocalDateTime;
import java.io.Serializable;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
import lombok.EqualsAndHashCode;
/**
* <p>
*
* </p>
*
* @author yi
* @since 2022-09-23
*/
@Data
@EqualsAndHashCode(callSuper = false)
@TableName("order_central")
@ApiModel(value="OrderCentral对象", description="")
public class OrderCentral implements Serializable {
private static final long serialVersionUID = 1L;
@ApiModelProperty(value = "主键ID")
private String ID;
@ApiModelProperty(value = "订单来源")
private String ORDER_SOURCE;
@ApiModelProperty(value = "订单编号")
private String ORDER_CODE;
@ApiModelProperty(value = "用户ID")
private String USER_ID;
@ApiModelProperty(value = "用户姓名")
private String USER_NAME;
@ApiModelProperty(value = "用户手机号")
private String USER_PHONE;
@ApiModelProperty(value = "用户地址")
private String USER_ADDRESS;
@ApiModelProperty(value = "订单金额")
private BigDecimal ORDER_AMOUNT;
@ApiModelProperty(value = "订单状态")
private Integer ORDER_STATUS;
@ApiModelProperty(value = "是否结算")
private String ORDER_SETTLE;
@ApiModelProperty(value = "乐观锁")
private Integer REVISION;
@ApiModelProperty(value = "创建人")
private String CREATED_BY;
@ApiModelProperty(value = "创建时间")
private LocalDateTime CREATED_TIME;
@ApiModelProperty(value = "更新人")
private String UPDATED_BY;
@ApiModelProperty(value = "更新时间")
private LocalDateTime UPDATED_TIME;
}
看着是不是非常舒服,直接连带着swagger的注解都带着,是不是看起来就很舒服了,这对大家的开发时间,就会缩短很多,而且还能给前端同事一个非常好用的swagger 文档,大家有需要的可以安排上了!
文章转载自公众号: Java极客技术