领导临时要数据库文档怎么办？

很多时候，我们为了着急忙慌赶项目进度，很容易忽略整理文档这件事
某一天，领导心血来潮，要搞一次突击检查， 想看看我们的数据库设计的是否规范， 但他又不想亲自去数据库查验（毕竟这么大领导）
那么，我们该怎么办？
第一种方法：离职，世界那么大，我想去看看（我相信一般人不会这么做）
也许你可以试试下面这种方法
此方法大概属于奇技淫巧，建议在工作中多用
基本思路就是通过Java代码自动生成数据库表结构文档
在Java中正好有个包可以实现这个功能

• POM文件引入相关包
  

1. ...
2. <dependency>
3.             <groupId>org.freemarker</groupId>
4.             <artifactId>freemarker</artifactId>
5.             <version>2.3.30</version>
6.         </dependency>
7.   <dependency>
8.       <groupId>cn.smallbun.screw</groupId>
9.       <artifactId>screw-core</artifactId>
10.       <version>1.0.3</version>
11.   </dependency>

复制代码

• 配置数据库
  

1. spring:
2.   datasource:
3.     url: jdbc:mysql://localhost:3306/xxx?useUnicode=true&characterEncoding=utf-8&serverTimezone=Asia/Shanghai&useSSL=false&allowMultiQueries=true&allowPublicKeyRetrieval=true
4.     username: root
5.     password: xxx
6.     driver-class-name: com.mysql.cj.jdbc.Driver

复制代码

• 编写转换代码
  

1. package com.example.createdoc;
3. import cn.smallbun.screw.core.Configuration;
4. import cn.smallbun.screw.core.engine.EngineConfig;
5. import cn.smallbun.screw.core.engine.EngineFileType;
6. import cn.smallbun.screw.core.engine.EngineTemplateType;
7. import cn.smallbun.screw.core.execute.DocumentationExecute;
8. import cn.smallbun.screw.core.process.ProcessConfig;
9. import org.assertj.core.util.Lists;
10. import org.junit.Test;
11. import org.junit.runner.RunWith;
12. import org.springframework.boot.test.context.SpringBootTest;
13. import org.springframework.test.context.junit4.SpringRunner;
15. import javax.annotation.Resource;
16. import javax.sql.DataSource;
18. /**
19. * <h1>数据库表文档生成</h1>
20. * */
21. @SpringBootTest
22. @RunWith(SpringRunner.class)
23. public class Table2DocTest {
25.     @Resource
26.     private DataSource dataSource;
28.     @Test
29.     public void buildDBDoc() {
31.         EngineConfig engineConfig = EngineConfig.builder()
32.                 // 生成文件路径
33.                 .fileOutputDir("D:\\temp")
34.                 .openOutputDir(false)
35.                 // 文件类型 支持 world，html， md
36.                 .fileType(EngineFileType.WORD)
37.                 .produceType(EngineTemplateType.freemarker).build();
39.         // 生成文档配置, 包含自定义版本号、描述等等
40.         Configuration config = Configuration.builder()
41.                 .version("1.0.0")
42.                 .description("瞎编数据库")
43.                 .dataSource(dataSource)
44.                 .engineConfig(engineConfig)
45.                 .produceConfig(
46.                     // 表的生成规则和忽略规则在这里配置
47.                      ProcessConfig.builder()
48.                             .designatedTableName(Lists.newArrayList())
49.                             .designatedTablePrefix(Lists.newArrayList())
50.                             .designatedTableSuffix(Lists.newArrayList())
51.                             .ignoreTableName(Lists.newArrayList())
52.                             .ignoreTablePrefix(Lists.newArrayList())
53.                             .ignoreTableSuffix(Lists.newArrayList())
54.                             .build()
55.                 ).build();
57.         // 执行生成
58.         new DocumentationExecute(config).execute();
59.     }
61.    
62. }

复制代码

我们用的这个组件 screw 可以实现生成doc、md、html类型的文档，生成的目录在代码中可配置

就这样，该下班下班，该下课下课
    微信公众号
  
免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！