AutoGenerator
文章作者原创
除了此处 公众号“阿祁爱编程”也在更新,希望大家可以关注一下小编
创作不易 忘多多包涵
01.背景
最近你在家里过的还好吗?反正我是实在无聊到爆,所以每天就是睡觉,玩手机,哦忘了还有想你呢!想起今年10月份就开始实习了,有点担心找不到工作,所以每天开始努力学习,最近呢准备学习前端和后端分离的知识,由于知识点太多无从下手,所以直接开始搞项目。话不多说,上今天的主角!
02.介绍
AutoGenerator 是 MyBatis-Plus 的代码生成器,通过 AutoGenerator 可以快速生成EntityMapper、Mapper XML、Service、Controller 等各个模块的代码,极大的提升了开发效率。是不是看着有点不懂呢?简单的说就是你可以使用这个生成器来自动生成代码,就不用你一个一个写了,原来几个小时的代码,用这个不到一分钟搞定
03.使用场景
我们在写软件后端的时候需要从数据库拿数据,然后用web的三层架构来写实体类,控制器类,接口类等,但是如果数据库中的表少可能不会太浪费时间,但是表一多就会很慢,而且写着重复的代码,浪费时间(前提是项目是使用SSM框架,用maven整合)
04.配置
电脑:联想小新
网络:wifi
软件:IDEA2020.3.2
JDK:11
项目:Spring boot项目
05.如何使用
你可以重新创建一个项目来写,也可以在原来的项目里创建一个module来写(这里我是在module写的)
第一步 创建module
1.在项目上创建一个module
2.选择maven 以及相关参数
3.给module命名
4.选择finish
5.等待项目构建完
6.配置module下的pom.xml 文件
7.找到下边这里 然后粘贴依赖(下边)
<dependencies>
//依赖要放的地方
</dependencies>
这是依赖!!!!
<!--web 依赖-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!--mybatis-plus 依赖-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.3.1.tmp</version>
</dependency>
<!--mybatis-plus 代码生成器依赖-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>3.3.1.tmp</version>
</dependency>
<!--freemarker 依赖-->
<dependency>
<groupId>org.freemarker</groupId>
<artifactId>freemarker</artifactId>
</dependency>
<!--mysql 依赖-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
<dependency>
<groupId>io.swagger</groupId>
<artifactId>swagger-annotations</artifactId>
<version>1.5.13</version>
<scope>compile</scope>
</dependency>
8.修改参数
9.删掉不用的文件夹和文件 (app和test文件夹)
10.到此处,module就创建好啦
第二步 创建generator的启动类
1.在module名/src/main/java/com/xxx下创建一个generator包,在包下创建一个CodeGenerator Java类
2.注意:
如果你创建的java文件的颜色和我的不一样是下边的这样,请根据步骤修改
3.粘贴代码(从package com.xxx.generator下边开始粘贴
/**
* @author 王祁
*/
public class CodeGenerator {
/**
* <p>
* 读取控制台内容
* </p>
*/
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 + "!");
}
public static void main(String[] args) {
// 代码生成器
AutoGenerator mpg = new AutoGenerator();
// 全局配置
GlobalConfig gc = new GlobalConfig();
String projectPath = System.getProperty("user.dir");
gc.setOutputDir(projectPath + "/yeb-generator/src/main/java");
gc.setAuthor("王祁");
gc.setOpen(false);
//xml 开启BaseColumnList
gc.setBaseColumnList(true);//xml开启 BaseResultMap
gc.setBaseResultMap(true);
// 实体属性 Swagger2 注解
gc.setSwagger2(true);
mpg.setGlobalConfig(gc);
// 数据源配置
DataSourceConfig dsc = new DataSourceConfig();
dsc.setUrl("jdbc:mysql://localhost:3306/yeb?useUnicode=true&useSSL=false&characterEncoding=utf8");
// dsc.setSchemaName("public");
dsc.setDriverName("com.mysql.cj.jdbc.Driver");
dsc.setUsername("yeb");
dsc.setPassword("root");
mpg.setDataSource(dsc);
// 包配置
PackageConfig pc = new PackageConfig();
//pc.setModuleName(scanner("模块名"));
pc.setParent("com.coco")
.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 + "/yeb-generator/src/main/resources/mapper/"
+ "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
}
});
/*
cfg.setFileCreate(new IFileCreate() {
@Override
public boolean isCreate(ConfigBuilder configBuilder, FileType fileType, String filePath) {
// 判断自定义文件夹是否需要创建
checkDir("调用默认方法创建的目录,自定义目录用");
if (fileType == FileType.MAPPER) {
// 已经生成 mapper 文件判断存在,不想重新生成返回 false
return !new File(filePath).exists();
}
// 允许生成模板文件
return true;
}
});
*/
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.underline_to_camel);
//strategy.setSuperEntityClass("你自己的父类实体,没有就不用设置!");
strategy.setEntityLombokModel(true);
strategy.setRestControllerStyle(true);
// 公共父类
//strategy.setSuperControllerClass("你自己的父类控制器,没有就不用设置!");
// 写于父类中的公共字段
//strategy.setSuperEntityColumns("id");
strategy.setInclude(scanner("表名,多个英文逗号分割").split(","));
strategy.setControllerMappingHyphenStyle(true);
strategy.setTablePrefix("t_");
mpg.setStrategy(strategy);
mpg.setTemplateEngine(new FreemarkerTemplateEngine());
mpg.execute();
}
}
4.看到这么多的报错不要担心,原因就是没有导入相关的包(自己去导入包就行),导包完成以后需要修改几个地方
5.然后配置输出的包的路径以及包名(这个输出的路径的根目录是java)然后配置存放实体类,mapper接口,service服务,service实现类,控制器controller的包名
6.自定义输出配置也需要修改路径,根目录是项目
7.最后就是如果你的数据库设置的表名有统一的前缀的话要修改这个,括号里边就是前缀
8.到此处,启动类就做好了
第三步 当然是最胆战心惊的一步了,启动程序(小编每次到这一步是心跳最快的)
1.页面右击run或者找到main方法点击左侧的绿色按钮(生活要想过得去,头上必须带点绿,对吧)
2.输入的时候一定要按要求输入
3.然后静静等待程序跑完,有异常的话自己去解决,或者网上搜索,因为我没有遇到异常,嘿嘿嘿。跑完你就发现多了这么多的文件夹,里边就是根据数据库创建的各种实体类和接口
到此处,文件已经创建完了,可以把这些文件复制粘贴到要用的module中去了
06.小结
怎么样,是不是感觉beautiful,节省了一大把时间啊,还可以防止出错呢(对于我这么粗心的大汉)