生成数据库设计文档

女爷i 2024-02-18 12:29 40阅读 0赞

<dependency>
        <groupId>cn.smallbun.screw</groupId>
        <artifactId>screw-core</artifactId>
        <version>1.0.2</version>
    </dependency>
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>8.0.28</version>
    </dependency>
    <dependency>
        <groupId>com.zaxxer</groupId>
        <artifactId>HikariCP</artifactId>
    </dependency>

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 com.zaxxer.hikari.HikariConfig;
    import com.zaxxer.hikari.HikariDataSource;
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    
    import java.util.Arrays;
    import java.util.List;
    
    /**
     * 生成数据库设计文档
     */
    public class GenerateDatabaseDocument {
    
        private static final Logger logger = LoggerFactory.getLogger(GenerateDatabaseDocument.class);
    
        private static HikariConfig createDataSourceConfig() {
            // 数据源配置
            HikariConfig hikariConfig = new HikariConfig();
            hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver");
            hikariConfig.setJdbcUrl("jdbc:mysql://127.0.0.1:3306/要修改的数据库名称");
            hikariConfig.setUsername("要修改的数据库用户名");
            hikariConfig.setPassword("要修改的数据库密码");
            hikariConfig.addDataSourceProperty("useInformationSchema", "true");
            hikariConfig.setMinimumIdle(2);
            hikariConfig.setMaximumPoolSize(5);
            return hikariConfig;
        }
    
        private static EngineConfig createEngineConfig() {
            // 生成文件配置
            return EngineConfig.builder()
                    .fileOutputDir("要修改的生成路径\\generator")
                    .openOutputDir(false)
                    .fileType(EngineFileType.HTML)
                    .produceType(EngineTemplateType.freemarker)
                    .build();
        }
    
        private static ProcessConfig createProcessConfig() {
            // 配置想要忽略的表
            return ProcessConfig.builder()
                    .ignoreTableName(List.of("test"))
                    .ignoreTablePrefix(Arrays.asList("test_", "test"))
                    .ignoreTableSuffix(Arrays.asList("_test", "test"))
                    .build();
        }
    
        private static Configuration createScrewConfig() {
            // 生成文档配置
            return Configuration.builder()
                    .version("1.0.0")
                    .description("数据库文档")
                    .dataSource(new HikariDataSource(createDataSourceConfig()))
                    .engineConfig(createEngineConfig())
                    .produceConfig(createProcessConfig())
                    .build();
        }
    
        public static void main(String[] args) {
            try {
                // 执行生成数据库文档
                new DocumentationExecute(createScrewConfig()).execute();
                logger.info("数据库文档生成成功！");
            } catch (Exception e) {
                logger.error("数据库文档生成失败！", e);
            }
        }
    }