iis服务器助手广告广告
返回顶部
首页 > 资讯 > 精选 >使用java怎么自动生成数据库文档
  • 138
分享到

使用java怎么自动生成数据库文档

2023-06-15 01:06:18 138人浏览 泡泡鱼
摘要

今天就跟大家聊聊有关使用java怎么自动生成数据库文档,可能很多人都不太了解,为了让大家更加了解,小编给大家总结了以下内容,希望大家根据这篇文章可以有所收获。一、引入pom.xml依赖<dependencies> &n

今天就跟大家聊聊有关使用java怎么自动生成数据库文档,可能很多人都不太了解,为了让大家更加了解,小编给大家总结了以下内容,希望大家根据这篇文章可以有所收获。

一、引入pom.xml依赖

<dependencies>  <!-- screw 库,简洁好用的数据库表结构文档生成器 -->  <dependency>      <groupId>cn.smallbun.screw</groupId>      <artifactId>screw-core</artifactId>      <version>1.0.5</version>  </dependency>  <!-- 数据库连接 -->  <dependency>      <groupId>com.zaxxer</groupId>      <artifactId>HikariCP</artifactId>      <version>3.4.5</version>  </dependency>  <dependency>      <groupId>mysql</groupId>      <artifactId>Mysql-connector-java</artifactId>      <version>8.0.22</version>  </dependency></dependencies>

二、创建Java类

public class TestScrewMain {    private static final String DB_URL = "jdbc:mysql://192.168.31.158:3306";    private static final String DB_NAME = "testdt?useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai";    private static final String DB_USERNAME = "root";    private static final String DB_PASSWord = "123456";    private static final String FILE_OUTPUT_DIR = "C:\\Users\\DT开发者\\Desktop\\";    // 可以设置 Word 或者 markdown 格式    private static final EngineFileType FILE_OUTPUT_TYPE = EngineFileType.WORD;    private static final String DOC_FILE_NAME = "数据库字典文档";    private static final String DOC_VERSION = "V1.0.0";    private static final String DOC_DESCRIPTION = "文档描述";    public static void main(String[] args) {        // 创建 screw 的配置        Configuration config = Configuration.builder()                // 版本                .version(DOC_VERSION)                // 描述                .description(DOC_DESCRIPTION)                // 数据源                .dataSource(buildDataSource())                // 引擎配置                .engineConfig(buildEngineConfig())                // 处理配置                .produceConfig(buildProcessConfig())                .build();        // 执行 screw,生成数据库文档        new DocumentationExecute(config).execute();    }        private static DataSource buildDataSource() {        // 创建 HikariConfig 配置类        HikariConfig hikariConfig = new HikariConfig();        hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver");        hikariConfig.setJdbcUrl(DB_URL + "/" + DB_NAME);        hikariConfig.setUsername(DB_USERNAME);        hikariConfig.setPassword(DB_PASSWORD);        // 设置可以获取 tables remarks 信息        hikariConfig.aDDDataSourceProperty("useInfORMationSchema", "true");        // 创建数据源        return new HikariDataSource(hikariConfig);    }        private static EngineConfig buildEngineConfig() {        return EngineConfig.builder()                // 生成文件路径                .fileOutputDir(FILE_OUTPUT_DIR)                // 打开目录                .openOutputDir(false)                // 文件类型                .fileType(FILE_OUTPUT_TYPE)                // 文件类型                .produceType(EngineTemplateType.freemarker)                // 自定义文件名称                .fileName(DOC_FILE_NAME)                .build();    }        private static ProcessConfig buildProcessConfig() {        return ProcessConfig.builder()                // 根据名称指定表生成                .designatedTableName(Collections.<String>emptyList())                // 根据表前缀生成                .designatedTablePrefix(Collections.<String>emptyList())                // 根据表后缀生成                .designatedTableSuffix(Collections.<String>emptyList())                // 忽略表名                .ignoreTableName(Arrays.asList("test", "mytable","role","t_role","t_user"))                // 忽略表前缀                //.ignoreTablePrefix(Collections.singletonList("t_"))                // 忽略表后缀                //.ignoreTableSuffix(Collections.singletonList("_test"))                .build();    }}

使用java怎么自动生成数据库文档
使用java怎么自动生成数据库文档

三、使用 Maven 插件的方式

<plugin> <groupId>cn.smallbun.screw</groupId> <artifactId>screw-maven-plugin</artifactId> <version>1.0.5</version> <dependencies>     <!-- 数据库连接 -->     <dependency>         <groupId>com.zaxxer</groupId>         <artifactId>HikariCP</artifactId>         <version>3.4.5</version>     </dependency>     <dependency>         <groupId>mysql</groupId>         <artifactId>mysql-connector-java</artifactId>         <version>8.0.17</version>     </dependency> </dependencies> <configuration>     <!-- 数据库相关配置 -->     <driverClassName>com.mysql.cj.jdbc.Driver</driverClassName>     <jdbcUrl>jdbc:mysql://192.168.31.158:3306/testdt?serverTimezone=Asia/Shanghai</jdbcUrl>     <username>root</username>     <password>123456</password>     <!-- screw 配置 -->     <fileType>WORD</fileType>     <title>数据库文档</title> <!--标题-->     <fileName>测试文档名称</fileName> <!--文档名称 为空时:将采用[数据库名称-描述-版本号]作为文档名称-->     <description>数据库文档生成</description> <!--描述-->     <version>${project.version}</version> <!--版本-->     <openOutputDir>false</openOutputDir> <!--打开文件输出目录-->     <produceType>freemarker</produceType> <!--生成模板--> </configuration> <executions>     <execution>         <phase>compile</phase>         <Goals>             <goal>run</goal>         </goals>     </execution> </executions></plugin>

执行 screw-maven-plugin 插件,会在 doc 目录下生成文档。如下图所示:

使用java怎么自动生成数据库文档

Java有哪些集合

Java中的集合主要分为四类:1、List列表:有序的,可重复的;2、Queue队列:有序,可重复的;3、Set集合:不可重复;4、Map映射:无序,键唯一,值不唯一。

看完上述内容,你们对使用java怎么自动生成数据库文档有进一步的了解吗?如果还想了解更多知识或者相关内容,请关注编程网精选频道,感谢大家的支持。

--结束END--

本文标题: 使用java怎么自动生成数据库文档

本文链接: https://www.lsjlt.com/news/276523.html(转载时请注明来源链接)

有问题或投稿请发送至: 邮箱/279061341@qq.com    QQ/279061341

本篇文章演示代码以及资料文档资料下载

下载Word文档到电脑,方便收藏和打印~

下载Word文档
猜你喜欢
  • C++ 生态系统中流行库和框架的贡献指南
    作为 c++++ 开发人员,通过遵循以下步骤即可为流行库和框架做出贡献:选择一个项目并熟悉其代码库。在 issue 跟踪器中寻找适合初学者的问题。创建一个新分支,实现修复并添加测试。提交...
    99+
    2024-05-15
    框架 c++ 流行库 git
  • C++ 生态系统中流行库和框架的社区支持情况
    c++++生态系统中流行库和框架的社区支持情况:boost:活跃的社区提供广泛的文档、教程和讨论区,确保持续的维护和更新。qt:庞大的社区提供丰富的文档、示例和论坛,积极参与开发和维护。...
    99+
    2024-05-15
    生态系统 社区支持 c++ overflow 标准库
  • c++中if elseif使用规则
    c++ 中 if-else if 语句的使用规则为:语法:if (条件1) { // 执行代码块 1} else if (条件 2) { // 执行代码块 2}// ...else ...
    99+
    2024-05-15
    c++
  • c++中的继承怎么写
    继承是一种允许类从现有类派生并访问其成员的强大机制。在 c++ 中,继承类型包括:单继承:一个子类从一个基类继承。多继承:一个子类从多个基类继承。层次继承:多个子类从同一个基类继承。多层...
    99+
    2024-05-15
    c++
  • c++中如何使用类和对象掌握目标
    在 c++ 中创建类和对象:使用 class 关键字定义类,包含数据成员和方法。使用对象名称和类名称创建对象。访问权限包括:公有、受保护和私有。数据成员是类的变量,每个对象拥有自己的副本...
    99+
    2024-05-15
    c++
  • c++中优先级是什么意思
    c++ 中的优先级规则:优先级高的操作符先执行,相同优先级的从左到右执行,括号可改变执行顺序。操作符优先级表包含从最高到最低的优先级列表,其中赋值运算符具有最低优先级。通过了解优先级,可...
    99+
    2024-05-15
    c++
  • c++中a+是什么意思
    c++ 中的 a+ 运算符表示自增运算符,用于将变量递增 1 并将结果存储在同一变量中。语法为 a++,用法包括循环和计数器。它可与后置递增运算符 ++a 交换使用,后者在表达式求值后递...
    99+
    2024-05-15
    c++
  • c++中a.b什么意思
    c++kquote>“a.b”表示对象“a”的成员“b”,用于访问对象成员,可用“对象名.成员名”的语法。它还可以用于访问嵌套成员,如“对象名.嵌套成员名.成员名”的语法。 c++...
    99+
    2024-05-15
    c++
  • C++ 并发编程库的优缺点
    c++++ 提供了多种并发编程库,满足不同场景下的需求。线程库 (std::thread) 易于使用但开销大;异步库 (std::async) 可异步执行任务,但 api 复杂;协程库 ...
    99+
    2024-05-15
    c++ 并发编程
  • 如何在 Golang 中备份数据库?
    在 golang 中备份数据库对于保护数据至关重要。可以使用标准库中的 database/sql 包,或第三方包如 github.com/go-sql-driver/mysql。具体步骤...
    99+
    2024-05-15
    golang 数据库备份 mysql git 标准库
软考高级职称资格查询
编程网,编程工程师的家园,是目前国内优秀的开源技术社区之一,形成了由开源软件库、代码分享、资讯、协作翻译、讨论区和博客等几大频道内容,为IT开发者提供了一个发现、使用、并交流开源技术的平台。
  • 官方手机版

  • 微信公众号

  • 商务合作