文章详情

短信预约-IT技能 免费直播动态提醒

请输入下面的图形验证码

提交验证

短信预约提醒成功

好用!一键生成数据库文档,这个开源的文档生成工具值得了解

2024-12-03 14:33

关注

在企业级开发中、我们经常会有编写数据库表结构文档的时间付出,从业以来,待过几家企业,关于数据库表结构文档状态:要么没有、要么有、但都是手写、后期运维开发,需要手动进行维护到文档中,很是繁琐、如果忘记一次维护、就会给以后工作造成很多困扰、无形中制造了很多坑留给自己和后人。

于是萌生了要自己写一个插件工具的想法,但由于自己前期在程序设计上没有很多造诣,且能力偏低,有想法并不能很好实现,随着工作阅历的增加,和知识的不断储备,终于在2020年的3月中旬开始进行编写。

4月上旬完成初版,想完善差不多在开源,但由于工作太忙,业余时间不足,没有在进行完善,到了6月份由于工作原因、频繁设计和更改数据库、经常使用自己写的此插件、节省了很多时间,解决了很多问题 ,在仅有且不多的业余时间中、进行开源准备,于2020年6月22日,开源,欢迎大家使用、建议、并贡献。

关于名字,想一个太难了,好在我这个聪明的小脑瓜灵感一现,怎么突出它的小,但重要呢?从小就学过雷锋的螺丝钉精神,摘自雷锋日记:虽然是细小的螺丝钉,是个细微的小齿轮,然而如果缺了它,那整个的机器就无法运转了,慢说是缺了它,即使是一枚小螺丝钉没拧紧,一个小齿轮略有破损,也要使机器的运转发生故障的...,感觉自己写的这个工具,很有这意味,虽然很小、但是开发中缺了它还不行,于是便起名为screw(螺丝钉)。

特点

数据库支持

文档生成支持

文档截图

  

使用方式

普通方式

  1. <dependency>  
  2.     <groupId>cn.smallbun.screwgroupId>  
  3.     <artifactId>screw-coreartifactId>  
  4.     <version>${lastVersion}version>  
  5.  dependency> 
  1.   
  2. void documentGeneration() {  
  3.    //数据源  
  4.    HikariConfig hikariConfig = new HikariConfig();  
  5.    hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver");  
  6.    hikariConfig.setJdbcUrl("jdbc:mysql://127.0.0.1:3306/database");  
  7.    hikariConfig.setUsername("root");  
  8.    hikariConfig.setPassword("password");  
  9.    //设置可以获取tables remarks信息  
  10.    hikariConfig.addDataSourceProperty("useInformationSchema", "true");  
  11.    hikariConfig.setMinimumIdle(2);  
  12.    hikariConfig.setMaximumPoolSize(5);  
  13.    DataSource dataSource = new HikariDataSource(hikariConfig);  
  14.    //生成配置  
  15.    EngineConfig engineConfig = EngineConfig.builder()  
  16.          //生成文件路径  
  17.          .fileOutputDir(fileOutputDir)  
  18.          //打开目录  
  19.          .openOutputDir(true)  
  20.          //文件类型  
  21.          .fileType(EngineFileType.HTML)  
  22.          //生成模板实现  
  23.          .produceType(EngineTemplateType.freemarker)  
  24.          //自定义文件名称  
  25.          .fileName("自定义文件名称").build();  
  26.    //忽略表  
  27.    ArrayList<String> ignoreTableName = new ArrayList<>();  
  28.    ignoreTableName.add("test_user");  
  29.    ignoreTableName.add("test_group");  
  30.    //忽略表前缀  
  31.    ArrayList<String> ignorePrefix = new ArrayList<>();  
  32.    ignorePrefix.add("test_");  
  33.    //忽略表后缀      
  34.    ArrayList<String> ignoreSuffix = new ArrayList<>();  
  35.    ignoreSuffix.add("_test"); 
  36.     ProcessConfig processConfig = ProcessConfig.builder()  
  37.          //指定生成逻辑、当存在指定表、指定表前缀、指定表后缀时,将生成指定表,其余表不生成、并跳过忽略表配置   
  38.    //根据名称指定表生成  
  39.    .designatedTableName(new ArrayList<>())  
  40.    //根据表前缀生成  
  41.    .designatedTablePrefix(new ArrayList<>())  
  42.    //根据表后缀生成   
  43.    .designatedTableSuffix(new ArrayList<>())  
  44.          //忽略表名  
  45.          .ignoreTableName(ignoreTableName)  
  46.          //忽略表前缀 
  47.           .ignoreTablePrefix(ignorePrefix)  
  48.          //忽略表后缀 
  49.           .ignoreTableSuffix(ignoreSuffix).build();  
  50.    //配置  
  51.    Configuration config = Configuration.builder()  
  52.          //版本  
  53.          .version("1.0.0")  
  54.          //描述  
  55.          .description("数据库设计文档生成")  
  56.          //数据源  
  57.          .dataSource(dataSource)  
  58.          //生成配置  
  59.          .engineConfig(engineConfig) 
  60.           //生成配置  
  61.          .produceConfig(processConfig) 
  62.           .build();  
  63.    //执行生成  
  64.    new DocumentationExecute(config).execute();  

Maven 插件 

  1. <build>  
  2.     <plugins>  
  3.         <plugin>  
  4.             <groupId>cn.smallbun.screwgroupId>  
  5.             <artifactId>screw-maven-pluginartifactId>  
  6.             <version>${lastVersion}version>  
  7.             <dependencies>  
  8.                   
  9.                 <dependency>  
  10.                     <groupId>com.zaxxergroupId>  
  11.                     <artifactId>HikariCPartifactId>  
  12.                     <version>3.4.5version>  
  13.                 dependency>  
  14.                   
  15.                 <dependency>  
  16.                     <groupId>mysqlgroupId>  
  17.                     <artifactId>mysql-connector-javaartifactId>  
  18.                     <version>8.0.20version>  
  19.                 dependency>  
  20.             dependencies>  
  21.             <configuration>  
  22.                   
  23.                 <username>rootusername>  
  24.                   
  25.                 <password>passwordpassword>  
  26.                   
  27.                 <driverClassName>com.mysql.cj.jdbc.DriverdriverClassName>  
  28.                   
  29.                 <jdbcUrl>jdbc:mysql://127.0.0.1:3306/xxxxjdbcUrl>  
  30.                   
  31.                 <fileType>HTMLfileType>  
  32.                   
  33.                 <openOutputDir>falseopenOutputDir>  
  34.                   
  35.                 <produceType>freemarkerproduceType>  
  36.                   
  37.                 <fileName>测试文档名称fileName>  
  38.                   
  39.                 <description>数据库文档生成description>  
  40.                   
  41.                 <version>${project.version}version>  
  42.                   
  43.                 <title>数据库文档title>  
  44.             configuration> 
  45.              <executions>  
  46.                 <execution>  
  47.                     <phase>compilephase>  
  48.                     <goals>  
  49.                         <goal>rungoal>  
  50.                     goals>  
  51.                 execution>  
  52.             executions>  
  53.         plugin>  
  54.     plugins>  
  55. build> 

扩展模块

pojo生成功能

功能简介

pojo生成功能是基于screw延伸出的扩展模块,目前处于初步开发的状态。在日常的开发中,经过需求分析、建模之后,往往会先在数据库中建表,其次在进行代码的开发。那么pojo生成功能在这个阶段就可以帮助大家节省一些重复劳动了。

使用pojo生成功能可以直接根据数据库生成对应的java pojo对象。这样后续的修改,开发都会很方便。

数据库支持

使用方式

  1. <dependency>  
  2.     <groupId>cn.smallbun.screwgroupId>  
  3.     <artifactId>screw-extensionartifactId>  
  4.     <version>${lastVersion}version>  
  5.  dependency> 
  1.   
  2. void pojoGeneration() {  
  3.     //数据源  
  4.     HikariConfig hikariConfig = new HikariConfig();  
  5.     hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver");  
  6.     hikariConfig.setJdbcUrl("jdbc:mysql://127.0.0.1:3306/screw");  
  7.     hikariConfig.setUsername("screw");  
  8.     hikariConfig.setPassword("screw");  
  9.     //设置可以获取tables remarks信息 
  10.      hikariConfig.addDataSourceProperty("useInformationSchema", "true");  
  11.     hikariConfig.setMinimumIdle(2);  
  12.     hikariConfig.setMaximumPoolSize(5);  
  13.     DataSource dataSource = new HikariDataSource(hikariConfig);  
  14.     ProcessConfig processConfig = ProcessConfig.builder()  
  15.         //指定生成逻辑、当存在指定表、指定表前缀、指定表后缀时,将生成指定表,其余表不生成、并跳过忽略表配置  
  16.         //根据名称指定表生成  
  17.         .designatedTableName(new ArrayList<>())  
  18.         //根据表前缀生成  
  19.         .designatedTablePrefix(new ArrayList<>())  
  20.         //根据表后缀生成  
  21.         .designatedTableSuffix(new ArrayList<>()).build();  
  22.     //设置生成pojo相关配置  
  23.     PojoConfiguration config = new PojoConfiguration();  
  24.     //设置文件存放路径  
  25.     config.setPath("/cn/smallbun/screw/");  
  26.     //设置包名  
  27.     config.setPackageName("cn.smallbun.screw");  
  28.     //设置是否使用lombok  
  29.     config.setUseLombok(false);  
  30.     //设置数据源  
  31.     config.setDataSource(dataSource);  
  32.     //设置命名策略  
  33.     config.setNameStrategy(new HumpNameStrategy());  
  34.     //设置表过滤逻辑  
  35.     config.setProcessConfig(processConfig);  
  36.     //执行生成  
  37.     new PojoExecute(config).execute();  

常见问题

          MySQL:URL加入?characterEncoding=UTF-8。

           检查项目freemarker依赖,这是由于版本过低造成的,升级版本为2.3.30即可。

          这是因为oracle驱动版本过低造成的,删除或屏蔽目前驱动版本,驱动添加升级为以下版本:   

  1. <dependency>  
  2.        <groupId>com.oracle.ojdbcgroupId>  
  3.        <artifactId>ojdbc8artifactId>  
  4.        <version>19.3.0.0version>  
  5.     dependency>  
  6.     <dependency>  
  7.        <groupId>cn.easyprojectgroupId>  
  8.        <artifactId>orai18nartifactId>  
  9.        <version>12.1.0.2.0version>  
  10.     dependency> 

    URL链接加入useInformationSchema=true即可。

    这是因为mysql驱动版本过低造成的,升级mysql驱动版本为最新即可。 

 

来源:Java知音内容投诉

免责声明:

① 本站未注明“稿件来源”的信息均来自网络整理。其文字、图片和音视频稿件的所属权归原作者所有。本站收集整理出于非商业性的教育和科研之目的,并不意味着本站赞同其观点或证实其内容的真实性。仅作为临时的测试数据,供内部测试之用。本站并未授权任何人以任何方式主动获取本站任何信息。

② 本站未注明“稿件来源”的临时测试数据将在测试完成后最终做删除处理。有问题或投稿请发送至: 邮箱/279061341@qq.com QQ/279061341

软考中级精品资料免费领

  • 历年真题答案解析
  • 备考技巧名师总结
  • 高频考点精准押题
  • 2024年上半年信息系统项目管理师第二批次真题及答案解析(完整版)

    难度     813人已做
    查看
  • 【考后总结】2024年5月26日信息系统项目管理师第2批次考情分析

    难度     354人已做
    查看
  • 【考后总结】2024年5月25日信息系统项目管理师第1批次考情分析

    难度     318人已做
    查看
  • 2024年上半年软考高项第一、二批次真题考点汇总(完整版)

    难度     435人已做
    查看
  • 2024年上半年系统架构设计师考试综合知识真题

    难度     224人已做
    查看

相关文章

发现更多好内容

猜你喜欢

AI推送时光机
位置:首页-资讯-后端开发
咦!没有更多了?去看看其它编程学习网 内容吧
首页课程
资料下载
问答资讯