登录/ 注册
 找回密码
 立即注册
关闭

CSDN热搜

程序园 精品问答 技术交流 资源下载
返回列表 发新帖
首页 › 业界区 › 安全 ›生成数据库的表结构文档

生成数据库的表结构文档

烯八 2025-7-30 15:47:41
背景说明
项目完成前后，需要提供各种各样的文档，我所在的公司，每次项目结束要整理的文档高达29个，其中有些文档很单一但是数据量很大，这个时候就必须偷懒一下了。
使用依赖
  1. <groupId>cn.smallbun.screw</groupId>
  2. screw-core</artifactId>
  3. <version>1.0.5</version>
复制代码
依赖说明
在企业级开发中、我们经常会有编写数据库表结构文档的时间付出，从业以来，待过几家企业，关于数据库表结构文档状态：要么没有、要么有、但都是手写、后期运维开发，需要手动进行维护到文档中，很是繁琐、如果忘记一次维护、就会给以后工作造成很多困扰、无形中制造了很多坑留给自己和后人，于是萌生了要自己写一个插件工具的想法，但由于自己前期在程序设计上没有很多造诣，且能力偏低，有想法并不能很好实现，随着工作阅历的增加，和知识的不断储备，终于在2020年的3月中旬开始进行编写，4月上旬完成初版，想完善差不多在开源，但由于工作太忙，业余时间不足，没有在进行完善，到了6月份由于工作原因、频繁设计和更改数据库、经常使用自己写的此插件、节省了很多时间，解决了很多问题 ，在仅有且不多的业余时间中、进行开源准备，于2020年6月22日，开源，欢迎大家使用、建议、并贡献。
  关于名字，想一个太难了，好在我这个聪明的小脑瓜灵感一现，怎么突出它的小，但重要呢？从小就学过雷锋的螺丝钉精神，摘自雷锋日记：虽然是细小的螺丝钉，是个细微的小齿轮，然而如果缺了它，那整个的机器就无法运转了，慢说是缺了它，即使是一枚小螺丝钉没拧紧，一个小齿轮略有破损，也要使机器的运转发生故障的...，感觉自己写的这个工具，很有这意味，虽然很小、但是开发中缺了它还不行，于是便起名为screw（螺丝钉）。
maven依赖配置
  1. 　　　　<dependency>
  2.             <groupId>cn.smallbun.screw</groupId>
  3.             screw-core</artifactId>
  4.             <version>1.0.5</version>
  5.             <exclusions>
  6.                 <exclusion>
  7.                     <groupId>org.freemarker</groupId>
  8.                     freemarker</artifactId>
  9.                 </exclusion>
  10.                 <exclusion>
  11.                     <groupId>com.alibaba</groupId>
  12.                     fastjson</artifactId>
  13.                 </exclusion>
  14.             </exclusions>
  15.         </dependency>
  16.         <dependency>
  17.             <groupId>org.apache.velocity</groupId>
  18.             velocity-engine-core</artifactId>
  19.             <version>2.3</version>
  20.         </dependency>
复制代码
主代码部分
  1. package com.heit.road.web.config;
  3. import cn.hutool.core.io.FileUtil;
  4. import cn.hutool.core.util.IdUtil;
  5. import cn.smallbun.screw.core.Configuration;
  6. import cn.smallbun.screw.core.engine.EngineConfig;
  7. import cn.smallbun.screw.core.engine.EngineFileType;
  8. import cn.smallbun.screw.core.engine.EngineTemplateType;
  9. import cn.smallbun.screw.core.execute.DocumentationExecute;
  10. import cn.smallbun.screw.core.process.ProcessConfig;
  11. import com.heit.road.service.util.ServletUtils;
  12. import com.zaxxer.hikari.HikariConfig;
  13. import com.zaxxer.hikari.HikariDataSource;
  14. import io.swagger.v3.oas.annotations.Operation;
  15. import io.swagger.v3.oas.annotations.Parameter;
  16. import io.swagger.v3.oas.annotations.tags.Tag;
  17. import org.springframework.web.bind.annotation.GetMapping;
  18. import org.springframework.web.bind.annotation.RequestMapping;
  19. import org.springframework.web.bind.annotation.RequestParam;
  20. import org.springframework.web.bind.annotation.RestController;
  22. import javax.annotation.Resource;
  23. import javax.servlet.http.HttpServletResponse;
  24. import javax.sql.DataSource;
  25. import java.io.File;
  26. import java.io.IOException;
  27. import java.util.Arrays;
  29. @Tag(name = "管理后台 - 数据库文档")
  30. @RestController
  31. @RequestMapping("/infra/db-doc")
  32. public class DatabaseDocController {
  34.     @Resource
  35.     private DataSource db; //获取项目数据源
  38.     private static final String FILE_OUTPUT_DIR = System.getProperty("java.io.tmpdir") + File.separator
  39.             + "db-doc";
  40.     private static final String DOC_FILE_NAME = "数据库文档";
  41.     private static final String DOC_VERSION = "1.0.0";
  42.     private static final String DOC_DESCRIPTION = "文档描述";
  44.     @GetMapping("/export-html")
  45.     @Operation(summary = "导出 html 格式的数据文档")
  46.     @Parameter(name = "deleteFile", description = "是否删除在服务器本地生成的数据库文档", example = "true")
  47.     public void exportHtml(@RequestParam(defaultValue = "true") Boolean deleteFile,
  48.                            HttpServletResponse response) throws IOException {
  49.         doExportFile(EngineFileType.HTML, deleteFile, response);
  50.     }
  52.     @GetMapping("/export-word")
  53.     @Operation(summary = "导出 word 格式的数据文档")
  54.     @Parameter(name = "deleteFile", description = "是否删除在服务器本地生成的数据库文档", example = "true")
  55.     public void exportWord(@RequestParam(defaultValue = "true") Boolean deleteFile,
  56.                            HttpServletResponse response) throws IOException {
  57.         doExportFile(EngineFileType.WORD, deleteFile, response);
  58.     }
  60.     @GetMapping("/export-markdown")
  61.     @Operation(summary = "导出 markdown 格式的数据文档")
  62.     @Parameter(name = "deleteFile", description = "是否删除在服务器本地生成的数据库文档", example = "true")
  63.     public void exportMarkdown(@RequestParam(defaultValue = "true") Boolean deleteFile,
  64.                                HttpServletResponse response) throws IOException {
  65.         doExportFile(EngineFileType.MD, deleteFile, response);
  66.     }
  68.     private void doExportFile(EngineFileType fileOutputType, Boolean deleteFile,
  69.                               HttpServletResponse response) throws IOException {
  70.         String docFileName = DOC_FILE_NAME + "_" + IdUtil.fastSimpleUUID();
  71.         String filePath = doExportFile(fileOutputType, docFileName);
  72.         String downloadFileName = DOC_FILE_NAME + fileOutputType.getFileSuffix(); //下载后的文件名
  73.         try {
  74.             // 读取，返回
  75.             ServletUtils.writeAttachment(response, downloadFileName, FileUtil.readBytes(filePath));
  76.         } finally {
  77.             handleDeleteFile(deleteFile, filePath);
  78.         }
  79.     }
  81.     /**
  82.      * 输出文件，返回文件路径
  83.      *
  84.      * @param fileOutputType 文件类型
  85.      * @param fileName       文件名, 无需 ".docx" 等文件后缀
  86.      * @return 生成的文件所在路径
  87.      */
  88.     private String doExportFile(EngineFileType fileOutputType, String fileName) {
  89.         try (HikariDataSource dataSource = buildDataSource()) {
  90.             // 创建 screw 的配置
  91.             Configuration config = Configuration.builder()
  92.                     .version(DOC_VERSION)  // 版本
  93.                     .description(DOC_DESCRIPTION) // 描述
  94.                     .dataSource(dataSource) // 数据源
  95.                     .engineConfig(buildEngineConfig(fileOutputType, fileName)) // 引擎配置
  96.                     .produceConfig(buildProcessConfig()) // 处理配置
  97.                     .build();
  99.             // 执行 screw，生成数据库文档
  100.             new DocumentationExecute(config).execute();
  102.             return FILE_OUTPUT_DIR + File.separator + fileName + fileOutputType.getFileSuffix();
  103.         }
  104.     }
  106.     private void handleDeleteFile(Boolean deleteFile, String filePath) {
  107.         if (!deleteFile) {
  108.             return;
  109.         }
  110.         FileUtil.del(filePath);
  111.     }
  113.     /**
  114.      * 创建数据源
  115.      */
  116.     private HikariDataSource buildDataSource() {
  117.         HikariConfig hikariConfig = new HikariConfig();
  118.         hikariConfig.setJdbcUrl(((HikariDataSource) db).getJdbcUrl());
  119.         hikariConfig.setUsername(((HikariDataSource) db).getUsername());
  120.         hikariConfig.setPassword(((HikariDataSource) db).getPassword());
  121.         hikariConfig.addDataSourceProperty("useInformationSchema", "true"); // 设置可以获取 tables remarks 信息
  122.         // 创建数据源
  123.         return new HikariDataSource(hikariConfig);
  124.     }
  126.     /**
  127.      * 创建 screw 的引擎配置
  128.      */
  129.     private static EngineConfig buildEngineConfig(EngineFileType fileOutputType, String docFileName) {
  130.         return EngineConfig.builder()
  131.                 .fileOutputDir(FILE_OUTPUT_DIR) // 生成文件路径
  132.                 .openOutputDir(false) // 打开目录
  133.                 .fileType(fileOutputType) // 文件类型
  134.                 .produceType(EngineTemplateType.velocity) // 文件类型
  135.                 .fileName(docFileName) // 自定义文件名称
  136.                 .build();
  137.     }
  139.     /**
  140.      * 创建 screw 的处理配置，一般可忽略
  141.      * 指定生成逻辑、当存在指定表、指定表前缀、指定表后缀时，将生成指定表，其余表不生成、并跳过忽略表配置
  142.      */
  143.     private static ProcessConfig buildProcessConfig() {
  144.         return ProcessConfig.builder()
  145.                 .ignoreTablePrefix(Arrays.asList("QRTZ_", "ACT_")) // 忽略表前缀
  146.                 .build();
  147.     }
  149. }
复制代码
 
工具类
  1. package com.heit.road.service.util;
  3. import cn.hutool.core.io.IoUtil;
  4. import cn.hutool.core.util.StrUtil;
  5. import cn.hutool.extra.servlet.ServletUtil;
  6. import org.springframework.http.MediaType;
  7. import org.springframework.web.context.request.RequestAttributes;
  8. import org.springframework.web.context.request.RequestContextHolder;
  9. import org.springframework.web.context.request.ServletRequestAttributes;
  11. import javax.servlet.ServletRequest;
  12. import javax.servlet.http.HttpServletRequest;
  13. import javax.servlet.http.HttpServletResponse;
  14. import java.io.IOException;
  15. import java.net.URLEncoder;
  17. /**
  18. * 客户端工具类
  19. *
  20. */
  21. public class ServletUtils {
  23.     /**
  24.      * 返回 JSON 字符串
  25.      *
  26.      * @param response 响应
  27.      * @param object 对象，会序列化成 JSON 字符串
  28.      */
  29.     @SuppressWarnings("deprecation") // 必须使用 APPLICATION_JSON_UTF8_VALUE，否则会乱码
  30.     public static void writeJSON(HttpServletResponse response, Object object) {
  31.         String content = JsonUtils.toJsonString(object);
  32.         ServletUtil.write(response, content, MediaType.APPLICATION_JSON_UTF8_VALUE);
  33.     }
  35.     /**
  36.      * 返回附件
  37.      *
  38.      * @param response 响应
  39.      * @param filename 文件名
  40.      * @param content 附件内容
  41.      * @throws IOException
  42.      */
  43.     public static void writeAttachment(HttpServletResponse response, String filename, byte[] content) throws IOException {
  44.         // 设置 header 和 contentType
  45.         response.setHeader("Content-Disposition", "attachment;filename=" + URLEncoder.encode(filename, "UTF-8"));
  46.         response.setContentType(MediaType.APPLICATION_OCTET_STREAM_VALUE);
  47.         // 输出附件
  48.         IoUtil.write(response.getOutputStream(), false, content);
  49.     }
  51.     /**
  52.      * @param request 请求
  53.      * @return ua
  54.      */
  55.     public static String getUserAgent(HttpServletRequest request) {
  56.         String ua = request.getHeader("User-Agent");
  57.         return ua != null ? ua : "";
  58.     }
  60.     /**
  61.      * 获得请求
  62.      *
  63.      * @return HttpServletRequest
  64.      */
  65.     public static HttpServletRequest getRequest() {
  66.         RequestAttributes requestAttributes = RequestContextHolder.getRequestAttributes();
  67.         if (!(requestAttributes instanceof ServletRequestAttributes)) {
  68.             return null;
  69.         }
  70.         return ((ServletRequestAttributes) requestAttributes).getRequest();
  71.     }
  73.     public static String getUserAgent() {
  74.         HttpServletRequest request = getRequest();
  75.         if (request == null) {
  76.             return null;
  77.         }
  78.         return getUserAgent(request);
  79.     }
  81.     public static String getClientIP() {
  82.         HttpServletRequest request = getRequest();
  83.         if (request == null) {
  84.             return null;
  85.         }
  86.         return ServletUtil.getClientIP(request);
  87.     }
  89.     public static boolean isJsonRequest(ServletRequest request) {
  90.         return StrUtil.startWithIgnoreCase(request.getContentType(), MediaType.APPLICATION_JSON_VALUE);
  91.     }
  93. }
复制代码
 

来源：程序园用户自行投稿发布，如果侵权，请联系站长删除
免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！

使用道具 举报
B Color Image Link Quote Code Smilies
您需要登录后才可以回帖 登录 | 立即注册
发帖
烯八
2025-7-30 15:47:41

0

粉丝关注

18

主题发布

板块介绍填写区域，请于后台编辑
微信扫一扫