导航：首页 > 开发技术 >

怎么一键生成数据库文档

发表于：2024-11-20 作者：千家信息网编辑

千家信息网最后更新 2024年11月20日，本篇内容介绍了"怎么一键生成数据库文档"的有关知识，在实际案例的操作过程中，不少人都会遇到这样的困境，接下来就让小编带领大家学习一下如何处理这些情况吧！希望大家仔细阅读，能够学有所成！数据库文档图My

千家信息网最后更新 2024年11月20日怎么一键生成数据库文档

本篇内容介绍了"怎么一键生成数据库文档"的有关知识，在实际案例的操作过程中，不少人都会遇到这样的困境，接下来就让小编带领大家学习一下如何处理这些情况吧！希望大家仔细阅读，能够学有所成！

数据库文档图

MySQL
MariaDB
TIDB
Oracle
SqlServer
PostgreSQL
Cache DB

引入screw核心包，HikariCP数据库连接池，HikariCP号称性能最出色的数据库连接池。



    cn.smallbun.screw
    screw-core
    1.0.3




    com.zaxxer
    HikariCP
    3.4.5




    mysql
    mysql-connector-java
    8.0.20

配置数据源，设置 useInformationSchema 可以获取tables注释信息。

spring.datasource.url=jdbc:mysql://45.93.1.5:3306/fire?useUnicode=true&characterEncoding=UTF-8&useSSL=false
spring.datasource.username=root
spring.datasource.password=123456
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.xa.properties.useInformationSchema=true

screw有两种执行方式，第一种是pom文件配置，另一种是代码执行。

 
    
        
            org.springframework.boot
            spring-boot-maven-plugin
        
        
            cn.smallbun.screw
            screw-maven-plugin
            1.0.3
            
                
                
                    com.zaxxer
                    HikariCP
                    3.4.5
                
                
                
                    mysql
                    mysql-connector-java
                    8.0.20
                
            
            
                
                root
                
                123456
                
                com.mysql.cj.jdbc.Driver
                
                jdbc:mysql://41.92.6.5:3306/fire
                
                HTML
                
                false
                
                freemarker
                
                
                
                数据库文档生成
                
                ${project.version}
                
                fire数据库文档
            
            
                
                    compile
                    
                        run

配置完以后在 maven project->screw 双击执行ok。

在这里插入图片描述

代码生成方式也非常简单。

@SpringBootTest
public class ScrewApplicationTests {

    @Autowired
    ApplicationContext applicationContext;

    @Test
    void contextLoads() {
        DataSource dataSourceMysql = applicationContext.getBean(DataSource.class);
        // 生成文件配置
        EngineConfig engineConfig = EngineConfig.builder()
                // 生成文件路径，自己mac本地的地址，这里需要自己更换下路径
                .fileOutputDir("D:/")
                // 打开目录
                .openOutputDir(false)
                // 文件类型
                .fileType(EngineFileType.HTML)
                // 生成模板实现
                .produceType(EngineTemplateType.freemarker).build();
        // 生成文档配置（包含以下自定义版本号、描述等配置连接）
        Configuration config = Configuration.builder()
                .version("1.0.3")
                .description("生成文档信息描述")
                .dataSource(dataSourceMysql)
                .engineConfig(engineConfig)
                .produceConfig(getProcessConfig())
                .build();
        // 执行生成
        new DocumentationExecute(config).execute();
    }

    /**
     * 配置想要生成的表+ 配置想要忽略的表
     *
     * @return 生成表配置
     */
    public static ProcessConfig getProcessConfig() {
        // 忽略表名
        List ignoreTableName = Arrays.asList("a", "test_group");
        // 忽略表前缀，如忽略a开头的数据库表
        List ignorePrefix = Arrays.asList("a", "t");
        // 忽略表后缀
        List ignoreSuffix = Arrays.asList("_test", "czb_");
        return ProcessConfig.builder()
                //根据名称指定表生成
                .designatedTableName(Arrays.asList("fire_user"))
                //根据表前缀生成
                .designatedTablePrefix(new ArrayList<>())
                //根据表后缀生成
                .designatedTableSuffix(new ArrayList<>())
                //忽略表名
                .ignoreTableName(ignoreTableName)
                //忽略表前缀
                .ignoreTablePrefix(ignorePrefix)
                //忽略表后缀
                .ignoreTableSuffix(ignoreSuffix).build();
    }
}