java快速生成数据库文档详情

 更新时间:2022年07月18日 15:36:15   作者:小码农叔叔  
这篇文章主要介绍了java快速生成数据库文档详情,文章围绕主题展开详细的内容介绍,具有一定的参考价值,需要的朋友可以参考一下

前言

在产品发布前夕,经常因为编写各类设计文档感到心碎,倒不是难,而是比较繁琐,举例来说,像编写数据库文档这种操作来说,对于新手,甚至很多有一定开发经验的同学来说,都觉得是一件费力得事情,下面推荐一个小组件,并提供一段程序,帮助有需要得同学快速生成数据库文档,已解决这个麻烦得小事

环境准备

一个开发数据库,以下截取了部分表,实际中可能远不止这些

1、导入pom依赖

		<!-- screw核心 -->
        <dependency>
            <groupId>cn.smallbun.screw</groupId>
            <artifactId>screw-core</artifactId>
            <version>1.0.3</version>
        </dependency>

        <!-- HikariCP -->
        <dependency>
            <groupId>com.zaxxer</groupId>
            <artifactId>HikariCP</artifactId>
            <version>3.4.5</version>
        </dependency>

        <!--mysql driver-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.11</version>
        </dependency>

2、数据库连接工具类

public class JdbcUtils {
    public static String DRIVER_NAME = "com.mysql.jdbc.Driver";
    public static String JDBC_URL = "jdbc:mysql://IP:3306/tenant";
    public static String USER_NAME = "zhangcy";
    public static String PASSWORD = "zhangcy";
    public static DataSource getDataSourceFonfig() {
        //数据源
        HikariConfig hikariConfig = new HikariConfig();
        hikariConfig.setDriverClassName(DRIVER_NAME);
        hikariConfig.setJdbcUrl(JDBC_URL);
        hikariConfig.setUsername(USER_NAME);
        hikariConfig.setPassword(PASSWORD);
        //设置可以获取tables remarks信息
        hikariConfig.addDataSourceProperty("useInformationSchema", "true");
        hikariConfig.setMinimumIdle(2);
        hikariConfig.setMaximumPoolSize(5);
        return new HikariDataSource(hikariConfig);
    }
    public static Connection getConnection() {
        Connection conn = null;
        try {
            Class.forName(DRIVER_NAME).newInstance();
            conn = java.sql.DriverManager.getConnection(JDBC_URL, USER_NAME, PASSWORD);
            return conn;
        } catch (Exception e) {
            e.printStackTrace();
        }
        return conn;
    }
    /**
     * 获取某个数据库下的所有表
     *
     * @return
     */
    public static List<String> getTablesNames() {
        List<String> tables = new ArrayList<>();
        Connection connection = getConnection();
        ResultSet rs = null;
        Statement st = null;
        try {
            st = connection.createStatement();
            rs = st.executeQuery("show tables");
            while (rs.next()) {
                String string = rs.getString(1);
                tables.add(string);
            }
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            try {
                rs.close();
                st.close();
                connection.close();
            } catch (Exception e) {
                e.printStackTrace();
            }
        }
        return tables;
    }
}

3、生成数据库文档核心方法

public class GenerateDoc {
    /**
     * 生成的文档本地路径
     */
    public static final String LOCAL_PATH= "D:\\soft\\table";
    public static void main(String[] args) {
        DataSource dataSource = JdbcUtils.getDataSourceFonfig();
        EngineConfig engineConfig = EngineConfig.builder()
                //导出文件地址
                .fileOutputDir(LOCAL_PATH)
                //是否打开文件夹
                .openOutputDir(true)
                //文件类型:html、doc、mockdown
                .fileType(EngineFileType.WORD)
                //模板引擎
                .produceType(EngineTemplateType.freemarker).build();
        ProcessConfig processConfig = ProcessConfig.builder()
                //指定生成逻辑、当存在指定表、指定表前缀、指定表后缀时,将生成指定表,其余表不生成、并跳过忽略表配置
                //根据名称指定表生成
                .designatedTableName(JdbcUtils.getTablesNames())
                //根据表前缀生成
                .designatedTablePrefix(new ArrayList<>())
                //根据表后缀生成
                .designatedTableSuffix(new ArrayList<>()).build();

        //设置生成pojo相关配置
        Configuration config = Configuration.builder()
                .version("1.0.0")
                .description("数据库设计文档")
                .dataSource(dataSource)
                .engineConfig(engineConfig)
                .produceConfig(processConfig).build();
        new DocumentationExecute(config).execute();
    }
}

本段方法中有大量得注释,解释如何生成数据库文档的步骤,以及各个配置参数的作用,拿到程序之后,只需运行main方法即可,注意,可以根据自己的需要,选择生成那种展示形式的文档,比如是本地的doc,或者markdown,或html都是可选的

本段以doc为例,运行main方法,观察结果:

打开数据库文档,基本来说,我们只需简单调整下整体的格式即可使用了

不妨再换一下,生成HTML格式的文件看看,修改下程序中的参数

观察结果:

通过这种方式,可以让大家在编写数据库文档时候节省不少体力吧

到此这篇关于java快速生成数据库文档详情的文章就介绍到这了,更多相关java生成数据库文档内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • IDEA 使用mybatis插件Free Mybatis plugin的步骤(推荐)

    IDEA 使用mybatis插件Free Mybatis plugin的步骤(推荐)

    这篇文章主要介绍了IDEA 使用mybatis插件Free Mybatis plugin的相关知识,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-12-12
  • Java线程优先级变量及功能

    Java线程优先级变量及功能

    这篇文章主要介绍了Java线程优先级变量及功能,关于优先级的问可能有两个或更多线程被分配了相同的优先级,那么它们的执行取决于操作系统,更多相关介绍,需要的小伙伴可以参考一下
    2022-06-06
  • Java 二叉树遍历的常用方法

    Java 二叉树遍历的常用方法

    二叉树的遍历可以说是解决二叉树问题的基础。我们常用的遍历方式无外乎就四种 前序遍历、中序遍历、后续遍历、层次遍历 这四种。
    2021-05-05
  • Java生成UUID的常用方式示例代码

    Java生成UUID的常用方式示例代码

    UUID保证对在同一时空中的所有机器都是唯一的,通常平台会提供生成的API,按照开放软件基金会(OSF)制定的标准计算,用到了以太网卡地址、纳秒级时间、芯片ID码和许多可能的数字,下面这篇文章主要给大家介绍了关于Java生成UUID的常用方式,需要的朋友可以参考下
    2023-05-05
  • Nacos心跳时间配置及服务快速上下线方式

    Nacos心跳时间配置及服务快速上下线方式

    这篇文章主要介绍了Nacos心跳时间配置及服务快速上下线方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-03-03
  • SpringCloud可视化链路追踪系统Zipkin部署过程

    SpringCloud可视化链路追踪系统Zipkin部署过程

    这篇文章主要介绍了SpringCloud可视化链路追踪系统Zipkin部署过程,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-03-03
  • Redis作为缓存应用的情形详细分析

    Redis作为缓存应用的情形详细分析

    实际开发中缓存处理是必须的,不可能我们每次客户端去请求一次服务器,服务器每次都要去数据库中进行查找,为什么要使用缓存?说到底是为了提高系统的运行速度
    2023-01-01
  • SpringBoot 集成Kaptcha实现验证码功能实例详解

    SpringBoot 集成Kaptcha实现验证码功能实例详解

    在一个web应用中验证码是一个常见的元素。今天给大家介绍一下kaptcha的和springboot一起使用的简单例子。感兴趣的朋友参考下吧
    2017-08-08
  • JAVA JDK8 List分组的实现和用法

    JAVA JDK8 List分组的实现和用法

    今天小编就为大家分享一篇关于JAVA JDK8 List分组的实现和用法,小编觉得内容挺不错的,现在分享给大家,具有很好的参考价值,需要的朋友一起跟随小编来看看吧
    2018-12-12
  • Java字符串拼接的五种方法及性能比较分析(从执行100次到90万次)

    Java字符串拼接的五种方法及性能比较分析(从执行100次到90万次)

    字符串拼接一般使用“+”,但是“+”不能满足大批量数据的处理,Java中有以下五种方法处理字符串拼接及性能比较分析,感兴趣的可以了解一下
    2021-12-12

最新评论