From 81a3c95cae1be86e015db15d2664d845c3a331c2 Mon Sep 17 00:00:00 2001
From: liuyueve <39432700+liuyueve@users.noreply.github.com>
Date: Mon, 24 Aug 2020 20:49:42 +0800
Subject: [PATCH] =?UTF-8?q?=E6=B7=BB=E5=8A=A0pojo=E5=8A=9F=E8=83=BDreadme?=
=?UTF-8?q?=EF=BC=8C=E4=BF=AE=E6=94=B9=E9=BB=98=E8=AE=A4=E6=A8=A1=E6=9D=BF?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
README.md | 85 ++++++++++++++++++-
.../extension/pojo/execute/PojoExecute.java | 14 ++-
.../template/freemarker/pojo_java.ftl | 8 +-
3 files changed, 99 insertions(+), 8 deletions(-)
diff --git a/README.md b/README.md
index 221a44d..1352ce3 100644
--- a/README.md
+++ b/README.md
@@ -29,7 +29,7 @@
## 简介
- 在企业级开发中、我们经常会有编写数据库表结构文档的时间付出，从业以来，待过几家企业，关于数据库表结构文档状态：要么没有、要么有、但都是手写、后期运维开发，需要手动进行维护到文档中，很是繁琐、如果忘记一次维护、就会给以后工作造成很多困扰、无形中制造了很多坑留给自己和后人，于是萌生了要自己写一个插件工具的想法，但由于自己前期在程序设计上没有很多造诣，且能力偏低，有想法并不能很好实现，随着工作阅历的增加，和知识的不断储备，终于在2020年的3月中旬开始进行编写，4月上旬完成初版，想完善差不多在开源，但由于工作太忙，业余时间不足，没有在进行完善，到了6月份由于工作原因、频繁设计和更改数据库、经常使用自己写的此插件、节省了很多时间，解决了很多问题 ，在仅有且不多的业余时间中、进行开源准备，于2020年6月22日，开源，欢迎大家使用、建议、并贡献。
+ 在企业级开发中、我们经常会有编写数据库表结构文档的时间付出，从业以来，待过几家企业，关于数据库表结构文档状态：要么没有、要么有、但都是手写、后期运维开发，需要手动进行维护到文档中，很是繁琐、如果忘记一次维护、就会给以后工作造成很多困扰、无形中制造了很多坑留给自己和后人，于是萌生了要自己写一个插件工具的想法，但由于自己前期在程序设计上没有很多造诣，且能力偏低，有想法并不能很好实现，随着工作阅历的增加，和知识的不断储备，终于在2020年的3月中旬开始进行编写，4月上旬完成初版，想完善差不多在开源，但由于工作太忙，业余时间不足，没有在进行完善，到了6月份由于工作原因、频繁设计和更改数据库、经常使用自己写的此插件、节省了很多时间，解决了很多问题 ，在仅有且不多的业余时间中、进行开源准备，于2020年6月22日，开源，欢迎大家使用、建议、并贡献。
关于名字，想一个太难了，好在我这个聪明的小脑瓜灵感一现，怎么突出它的小，但重要呢？从小就学过雷锋的螺丝钉精神，摘自雷锋日记：**虽然是细小的螺丝钉，是个细微的小齿轮，然而如果缺了它，那整个的机器就无法运转了，慢说是缺了它，即使是一枚小螺丝钉没拧紧，一个小齿轮略有破损，也要使机器的运转发生故障的...**，感觉自己写的这个工具，很有这意味，虽然很小、但是开发中缺了它还不行，于是便起名为**screw**（螺丝钉）。
## 特点
@@ -252,6 +252,89 @@ void documentGeneration() {
+ [微人事一键生成数据库文档！炫！](https://mp.weixin.qq.com/s/rUde6XSGSG0jKuy0Wgf1Mw)
+## 扩展模块
+
+### pojo生成功能
+
+#### 功能简介
+ pojo生成功能是基于screw延伸出的扩展模块,目前处于初步开发的状态。在日常的开发中,经过需求分析、建模之后,往往会先在数据库中建表,其次在进行代码的开发。那么pojo生成功能在这个阶段就可以帮助大家节省一些重复劳动了。使用pojo生成功能可以直接根据数据库生成对应的java pojo对象。这样后续的修改，开发都会很方便。
+
+#### 数据库支持
+
+- [x] MySQL
+
+#### 使用方式
+
++ **引入依赖**
+
+```xml
+
+ cn.smallbun.screw
+ screw-extension
+ ${lastVersion}
+
+```
+
++ **编写代码**
+
+``` java
+/**
+ * pojo生成
+ */
+void pojoGeneration() {
+ //数据源
+ HikariConfig hikariConfig = new HikariConfig();
+ hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver");
+ hikariConfig.setJdbcUrl("jdbc:mysql://127.0.0.1:3306/screw");
+ hikariConfig.setUsername("screw");
+ hikariConfig.setPassword("screw");
+ //设置可以获取tables remarks信息
+ hikariConfig.addDataSourceProperty("useInformationSchema", "true");
+ hikariConfig.setMinimumIdle(2);
+ hikariConfig.setMaximumPoolSize(5);
+ DataSource dataSource = new HikariDataSource(hikariConfig);
+
+ ProcessConfig processConfig = ProcessConfig.builder()
+ //指定生成逻辑、当存在指定表、指定表前缀、指定表后缀时，将生成指定表，其余表不生成、并跳过忽略表配置
+ //根据名称指定表生成
+ .designatedTableName(new ArrayList<>())
+ //根据表前缀生成
+ .designatedTablePrefix(new ArrayList<>())
+ //根据表后缀生成
+ .designatedTableSuffix(new ArrayList<>()).build();
+
+ //设置生成pojo相关配置
+ PojoConfiguration config = new PojoConfiguration();
+ //设置文件存放路径
+ config.setPath("/cn/smallbun/screw/");
+ //设置包名
+ config.setPackageName("cn.smallbun.screw");
+ //设置是否使用lombok
+ config.setUseLombok(false);
+ //设置数据源
+ config.setDataSource(dataSource);
+ //设置命名策略
+ config.setNameStrategy(new HumpNameStrategy());
+ //设置表过滤逻辑
+ config.setProcessConfig(processConfig);
+
+ //也可以使用builder方式生成pojo相关配置
+// PojoConfiguration build = PojoConfiguration.builder()
+// .path("/Users/liuyu/IdeaProjects/MyselfStudy/template/src/main/java/com/haizhi/template/bean/dto/")
+// .packageName("com.haizhi.template.bean.dto")
+// .useLombok(true)
+// .dataSource(dataSource)
+// .nameStrategy(new HumpNameStrategy())
+// .processConfig(processConfig)
+// .build();
+
+ //执行生成
+ new PojoExecute(config).execute();
+}
+```
+
+
+
## 更多支持
diff --git a/screw-extension/src/main/java/cn/smallbun/screw/extension/pojo/execute/PojoExecute.java b/screw-extension/src/main/java/cn/smallbun/screw/extension/pojo/execute/PojoExecute.java
index 524d9b0..be36e04 100644
--- a/screw-extension/src/main/java/cn/smallbun/screw/extension/pojo/execute/PojoExecute.java
+++ b/screw-extension/src/main/java/cn/smallbun/screw/extension/pojo/execute/PojoExecute.java
@@ -29,6 +29,7 @@ import cn.smallbun.screw.extension.pojo.process.PojoModelProcess;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
+import java.io.File;
import java.util.List;
/**
@@ -64,12 +65,19 @@ public class PojoExecute implements Execute {
PojoEngine pojoEngine = new FreeMarkerPojoEngine();
//确认路径
String path = configuration.getPath();
- if (!path.startsWith("/")) {
- path = "/" + path;
- }
if (!path.endsWith("/")) {
path = path + "/";
}
+ File pathFile = new File(path);
+ if (!pathFile.exists()) {
+ boolean mkdir = pathFile.mkdir();
+ if (!mkdir) {
+ throw new ScrewException("create directory failed");
+ }
+ }
+ if (!pathFile.isDirectory()) {
+ throw new ScrewException("path is not a directory");
+ }
//逐个产生文档
for (PojoModel pojoModel : process) {
pojoEngine.produce(pojoModel, path + pojoModel.getClassName() + ".java");
diff --git a/screw-extension/src/main/resources/template/freemarker/pojo_java.ftl b/screw-extension/src/main/resources/template/freemarker/pojo_java.ftl
index 83c6d74..07b6462 100644
--- a/screw-extension/src/main/resources/template/freemarker/pojo_java.ftl
+++ b/screw-extension/src/main/resources/template/freemarker/pojo_java.ftl
@@ -12,9 +12,9 @@ import lombok.Data;
/**
- * 数据库表名: ${tableName}
+ * table name: ${tableName}
<#if (remarks)??&&remarks?length gt 0>
- * 数据库表注释: ${remarks}
+ * table comment: ${remarks}
*/
<#if useLombok>
@@ -25,9 +25,9 @@ public class ${className} {
<#items as field>
<#if (field.remarks)??&&field.remarks?length gt 0>
- //数据库字段注释: ${field.remarks}
+ //comment: ${field.remarks}
- //数据库字段类型: ${field.fieldType},数据库字段名: ${field.fieldName}
+ //name: ${field.fieldName},type: ${field.fieldType}
private ${field.classType} ${field.className};