马士兵说 发表于 2020-8-28 14:49:48

一键生成数据库文档，堪称数据库界的Swagger，有点厉害

最近部门订单业务调整，收拢其他业务线的下单入口，做个同一大订单平台。需要梳理各业务线的数据表，但每个业务线库都有近百张和订单相关的表，挨个表一个一个字段的弄脑瓜子嗡嗡的。
为了不重复 CV 操作，抱着一丝希望开始在GitHub里找，看看有没有什么工具可以用，结果就真的发现了宝藏，screw（螺丝钉），居然可以生成数据库文档，优秀啊~。
https://p3.pstatp.com/large/pgc-image/fd92d47e2bc24a48b123ec4aa3b991e7
数据库支持


[*]MySQL
[*]MariaDB
[*]TIDB
[*]Oracle
[*]SqlServer
[*]PostgreSQL
[*]Cache DB
配置

1、pom文件

引入screw核心包，HikariCP数据库毗连池，HikariCP号称性能最精彩的数据库毗连池。
https://p9.pstatp.com/large/pgc-image/30e3a634fa544d60bb0256b87df01419
2、配置数据源

配置数据源，设置 useInformationSchema 可以获取tables注释信息。
spring.datasource.url=jdbc:mysql://45.93.1.5:3306/fire?useUnicode=true&characterEncoding=UTF-8&useSSL=falsespring.datasource.username=rootspring.datasource.password=123456spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driverspring.datasource.xa.properties.useInformationSchema=true3、screw 核心配置

screw有两种执行方式，第一种是pom文件配置，另一种是代码执行。
                         org.springframework.boot            spring-boot-maven-plugin                            cn.smallbun.screw            screw-maven-plugin            1.0.3                                                                com.zaxxer                  HikariCP                  3.4.5                                                                  mysql                  mysql-connector-java                  8.0.20                                                                        root                              123456                              com.mysql.cj.jdbc.Driver                              jdbc:mysql://41.92.6.5:3306/fire                              HTML                              false                              freemarker                                                                数据库文档生成                              ${project.version}                              fire数据库文档                                                            compile                                          run                                                            配置完以后在 maven project->screw 双击执行ok。
https://p1.pstatp.com/large/pgc-image/bfde66efc734404795e47feddb96b4af
代码生成方式也非常简单。
@SpringBootTestpublic class ScrewApplicationTests {    @Autowired    ApplicationContext applicationContext;    @Test    void contextLoads() {      DataSource dataSourceMysql = applicationContext.getBean(DataSource.class);      // 生成文件配置      EngineConfig engineConfig = EngineConfig.builder()                // 生成文件路径，自己mac本地的地址，这里需要自己更换下路径                .fileOutputDir("D:/")                // 打开目录                .openOutputDir(false)                // 文件类型                .fileType(EngineFileType.HTML)                // 生成模板实现                .produceType(EngineTemplateType.freemarker).build();      // 生成文档配置（包罗以下自定义版本号、描述等配置毗连）      Configuration config = Configuration.builder()                .version("1.0.3")                .description("生成文档信息描述")                .dataSource(dataSourceMysql)                .engineConfig(engineConfig)                .produceConfig(getProcessConfig())                .build();      // 执行生成      new DocumentationExecute(config).execute();    }    /**   * 配置想要生成的表+ 配置想要忽略的表   *   * @return 生成表配置   */    public static ProcessConfig getProcessConfig() {      // 忽略表名      List ignoreTableName = Arrays.asList("a", "test_group");      // 忽略表前缀，如忽略a开头的数据库表      List ignorePrefix = Arrays.asList("a", "t");      // 忽略表后缀      List ignoreSuffix = Arrays.asList("_test", "czb_");      return ProcessConfig.builder()                //根据名称指定表生成                .designatedTableName(Arrays.asList("fire_user"))                //根据表前缀生成                .designatedTablePrefix(new ArrayList())                //根据表后缀生成                .designatedTableSuffix(new ArrayList())                //忽略表名                .ignoreTableName(ignoreTableName)                //忽略表前缀                .ignoreTablePrefix(ignorePrefix)                //忽略表后缀                .ignoreTableSuffix(ignoreSuffix).build();    }}4、文档格式

screw 有 HTML、DOC、MD 三种格式的文档。
代码中的修改
.fileType(EngineFileType.HTML)或者pom文件
MDDOC文档样式

https://p3.pstatp.com/large/pgc-image/3953202ab5ef4933b06b45cbe9a8dad1
HTML文档样式

https://p1.pstatp.com/large/pgc-image/a6d32066b46c4c9ba1ee2005b22b5fe6
MD文档样式

https://p3.pstatp.com/large/pgc-image/1446ccb2a0fc4f3fa40b4c9f6d56e1e5
末了

不得不说这个工具是真TM好用，提前完成任务，有点傲娇有木有！

听说这个名字被取了 发表于 2020-8-29 06:36:51

转发了

nameyoyo 发表于 2020-8-28 22:21:03

转发了

Intel酷睿i9 发表于 2020-8-30 01:06:32

转发了

sanri1993 发表于 2020-8-30 09:30:25

我也有个工具，比他的好用

SL007315 发表于 2020-8-29 07:37:56

之前找了好久也折腾了好久，最终通过pb实现了，只不过确实太复杂了这，这个数据库文档生成软件好。

这小子真丑 发表于 2020-8-29 23:12:29

公网ip删一下，虽然没试，但是这种东西，最好不要出现，容易出现问题

科技娱乐谈 发表于 2020-8-30 16:25:43

我自己也写了个

放逐所有 发表于 2020-8-30 23:39:24

不错很实用

西安石头石头 发表于 2020-8-29 08:57:53

试一下
页: [1] 2 3
查看完整版本: 一键生成数据库文档，堪称数据库界的Swagger，有点厉害