使用 SpringBoot + Screw 实现生成数据表数据字典功能开发-51CTO.COM

在软件开发过程中，数据字典是一个非常重要的组成部分，它能够清晰地描述数据库中表结构和字段的详细信息。在本文中，我们将介绍如何使用 Springboot 结合 screw 来实现生成数据表数据字典的功能。

screw 介绍

Screw 是一款功能强大、易于使用的数据库文档生成工具。它旨在帮助开发人员快速、准确地获取和整理数据库的结构信息，从而提高开发效率和减少因数据库结构不清晰而导致的错误。

Screw 具有以下显著特点：

多数据库支持：它能够处理多种主流数据库，如 MySQL、Oracle、SQL Server、PostgreSQL 等，具有广泛的适用性。
丰富的文档格式：支持生成多种常见的文档格式，如 HTML、Word、Markdown 等，满足不同场景下的需求。
详细的表结构和字段信息：提供包括表名、字段名、数据类型、长度、约束条件、注释等全面而详细的信息，让开发人员对数据库结构一目了然。
可定制性：允许用户根据特定需求进行配置，例如选择要生成文档的表、过滤特定字段等。
良好的兼容性：能够与各种开发框架和环境集成，包括 Spring Boot 等，方便在项目中直接使用。

pom.xml 依赖配置

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>3.0.0</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.example</groupId>
    <artifactId>data-dictionary-generator</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>Data Dictionary Generator</name>
    <description>Generate data dictionary using Spring Boot and Screw</description>

    <properties>
        <java.version>17</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>cn.smallbun.screw</groupId>
            <artifactId>screw-core</artifactId>
            <version>1.0.5</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

属性配置

在application.yml 中进行相关配置，以下是 application.yml 的示例：

screw:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:3306/database_name
    username: root
    password: root
  generate:
    enabled: true
    output-dir: /yourPath/data_dictionary
    file-type: html

前端代码实现（示例）

<!DOCTYPE html>
<html lang="en">

<head>
  <meta charset="UTF-8">
  <title>数据字典展示</title>
</head>

<body>
  <h2>数据字典</h2>
  <select id="formatSelect">
    <option value="html">HTML</option>
    <option value="word">Word</option>
    <option value="markdown">Markdown</option>
  </select>
  <button onclick="fetchDataDictionary()">获取数据字典</button>
  <div id="dataDictionary"></div>

  <script>
    function fetchDataDictionary() {
      var formatType = document.getElementById('formatSelect').value;
      fetch('/dataDictionary?formatType=' + formatType)
      .then(response => response.text())
      .then(data => {
          document.getElementById('dataDictionary').innerHTML = data;
        })
      .catch(error => console.error('获取数据字典出错:', error));
    }
  </script>
</body>

</html>

后端

添加相应的 Controller 处理请求：

package com.example.controller;

import com.example.service.DataDictionaryService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

import javax.sql.DataSource;

@RestController
public class DataDictionaryController {

    @Autowired
    private DataDictionaryService dataDictionaryService;

    @Autowired
    private DataSource dataSource;

    @GetMapping("/dataDictionary")
    public String getDataDictionary(@RequestParam("formatType") String formatType) {
        return dataDictionaryService.generateDataDictionary(formatType, dataSource);
    }
}

DataDictionaryService 实现类：

package com.example.service;

import cn.smallbun.screw.core.Configuration;
import cn.smallbun.screw.core.engine.EngineConfig;
import cn.smallbun.screw.core.engine.EngineFileType;
import cn.smallbun.screw.core.engine.EngineTemplateType;
import cn.smallbun.screw.core.execute.DocumentationExecute;
import cn.smallbun.screw.core.process.ProcessConfig;
import org.springframework.stereotype.Service;

import javax.sql.DataSource;
import java.util.HashMap;
import java.util.Map;

@Service
public class DataDictionaryService {

    public String generateDataDictionary(String formatType, DataSource dataSource) {
        EngineConfig engineConfig = EngineConfig.builder()
              .fileType(getEngineFileType(formatType))
              .produceName("data_dictionary")
              .openOutputDir(false)
              .build();

        ProcessConfig processConfig = ProcessConfig.builder()
              .includeTables(new String[]{"your_table_names"})
              .build();

        Configuration configuration = Configuration.builder()
              .dataSource(dataSource)
              .engineConfig(engineConfig)
              .processConfig(processConfig)
              .build();

        DocumentationExecute.execute(configuration);

        // 根据生成的结果返回相应的字符串
        // 具体的返回逻辑根据生成的文件类型和存储方式进行处理
        return "Generated data dictionary";
    }

    private EngineFileType getEngineFileType(String formatType) {
        Map<String, EngineFileType> formatTypeMap = new HashMap<>();
        formatTypeMap.put("html", EngineFileType.HTML);
        formatTypeMap.put("word", EngineFileType.WORD);
        formatTypeMap.put("markdown", EngineFileType.MARKDOWN);

        return formatTypeMap.getOrDefault(formatType, EngineFileType.HTML);
    }
}

使用总结

通过使用 Springboot 和 screw 结合，我们能够方便快捷地生成数据库的数据字典。在实际开发中，这有助于提高开发效率，减少因对数据库结构不清晰而导致的错误。同时，通过前端页面的展示，使得数据字典的查看更加直观和便捷。