欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

t通过数据库逆向生成文档工具——screw

程序员文章站 2022-03-15 13:34:12
...

目录
一、pom.xml准备
二、工具类配置及生成
三、导出示例(html)
四、说明
目标
将数据库表字段分表生成表单,自动对应表字段以及注释,可导出为 html | doc | md 文件

一、pom.xml准备

<!-- screw核心 -->
        <dependency>
            <groupId>cn.smallbun.screw</groupId>
            <artifactId>screw-core</artifactId>
            <version>1.0.3</version>
        </dependency>

二、工具类配置及生成

修改数据库连接信息,直接运行即可。
默认导出文件为html格式,导出到D盘,如果没有特殊的要求,其他的配置不用更改。

@Test
public  void contextLoads() {
    //数据源
    HikariConfig hikariConfig = new HikariConfig();
    hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver");
    hikariConfig.setJdbcUrl("jdbc:mysql://localhost:3306/test?useUnicode=true&characterEncoding=UTF8&failOverReadOnly=false&zeroDateTimeBehavior=convertToNull&useSSL=false&serverTimezone=Asia/Shanghai");
    hikariConfig.setUsername("root");
    hikariConfig.setPassword("");
    //设置可以获取tables remarks信息
    hikariConfig.addDataSourceProperty("useInformationSchema", "true");
    hikariConfig.setMinimumIdle(2);
    hikariConfig.setMaximumPoolSize(5);
    DataSource dataSource = new HikariDataSource(hikariConfig);

    // 生成文件配置
    EngineConfig engineConfig = EngineConfig.builder()
            // 生成文件路径,自己mac本地的地址,这里需要自己更换下路径
            .fileOutputDir("D:\\temp")
            // 打开目录
            .openOutputDir(false)
            // 文件类型
            .fileType(EngineFileType.HTML)
            // 生成模板实现
            .produceType(EngineTemplateType.freemarker).build();

    // 生成文档配置(包含以下自定义版本号、描述等配置连接)
    Configuration config = Configuration.builder()
            .version("1.0.3")
            .description("生成文档信息描述")
            .dataSource(dataSource)
            .engineConfig(engineConfig)
            .produceConfig(getProcessConfig())
            .build();

    // 执行生成
    new DocumentationExecute(config).execute();
}


/**
 * 配置想要生成的表+ 配置想要忽略的表
 * @return 生成表配置
 */
public static ProcessConfig getProcessConfig(){
    // 忽略表名
    List<String> ignoreTableName = Arrays.asList("");
    // 忽略表前缀,如忽略a开头的数据库表
    List<String> ignorePrefix = Arrays.asList("a");
    // 忽略表后缀
    List<String> ignoreSuffix = Arrays.asList("_test","_czb");

    return ProcessConfig.builder()
            //根据名称指定表生成
            .designatedTableName(new ArrayList<>())
            //根据表前缀生成
            .designatedTablePrefix(new ArrayList<>())
            //根据表后缀生成
            .designatedTableSuffix(new ArrayList<>())
            //忽略表名
            .ignoreTableName(ignoreTableName)
            //忽略表前缀
            .ignoreTablePrefix(ignorePrefix)
            //忽略表后缀
            .ignoreTableSuffix(ignoreSuffix).build();
}

三、导出示例(html)

数据库设计文档

数据库名:test
文档版本:1.0.3
文档描述:生成文档信息描述

序号 表名 说明
1 batch_job_execution_seq  
2 batch_job_instance  
3 batch_job_seq  
4 batch_step_execution_seq  
5 t_channel_file_notify 渠道文件通知记录表
6 t_contract_data 合同数据表
7 t_contract_file  
8 t_core_deal_data 代偿赎回核心交易数据表
9 t_core_deal_sum 核心交易数据汇总表
10 t_fee_subject 费用科目表
11 t_fee_type 费用类型表
12 t_fund_use_notify 资金使用通知
13 t_loan_subject_info 科目信息
14 t_mer_acct 渠道商户账户表
15 t_mer_acct_set 渠道商户账户设置表
16 t_pay_info 支付信息表
17 t_settle_data 结算数据表
18 t_settle_deal_data (代收 结清 对公)交易数据表
19 t_settle_fee_type_data 结算费用数据
20 t_settle_order 结算单表
21 t_settle_rule 结算规则表
22 t_settle_rule_active 结算待**规则表
23 t_settle_rule_history 结算规则历史表
24 t_settle_voucher 结算凭证表
25 t_settle_voucher_detail 结算凭证明细表
26 t_system_param 系统参数表

返回目录表名:batch_job_execution_seq

说明:

数据列:

序号 名称 数据类型 长度 小数位 允许空值 主键 默认值 说明
1 ID bigint 19 0 N N    
2 UNIQUE_KEY char 1 0 N N  

四、说明
数据库支持
MySQL、MariaDB、TIDB、Oracle、SqlServer、PostgreSQL、Cache DB
文件类型
  EngineFileType枚举类中提供三种类型:HTML、WORD、MD。
模板类型
  EngineTemplateType枚举类中提供两种类型:freemarker、velocity。
生成方式
  一种是代码生成,还有一种是通过Maven打包生成,私以为直接用工具类比较方便直接。

相关标签: JAVA