不到一百行代码实现一个Mysql数据库说明文档自动生成程序
yuyutoo 2024-10-12 00:48 7 浏览 0 评论
我们在做软件项目开发中，通常需要设计数据库说明文档，虽说有一些工具能帮我们实现，不过总是感觉太重了，有的时候我们是要边写代码，写查看数据库结构，两个软件来回切换总是那么不习惯。这个问题作为java攻城狮的我们，秉着发扬自己动手丰衣足食的品格，我们就手写一段程序，实现自动为指定的数据库生成说明文档的功能。
首先看一下程序的执行效果：
上面截图中，我们制作一个jsp程序，因为是jsp程序，这样我们可以通过pc、手机浏览器，只要输入程序网址，就会将指定数据库中所有表及每个表中的字段信息的属性都展示出来。我们公司通常都是每个小伙伴都把这个程序放在自己的web应用里，方便随时查看数据库信息。而且有了它，在设计数据库的时候，一边设计一边说明文档就有了，是不是很方便？)：）
下面看一下代码的样子
jsp程序文件源代码：
<%@page contentType="text/html" pageEncoding="UTF-8"%>
<%@page import="java.sql.DriverManager"%>
<%@page import="java.sql.DatabaseMetaData"%>
<%@page import="java.sql.Statement"%>
<%@page import="java.sql.SQLException"%>
<%@page import="java.sql.ResultSetMetaData"%>
<%@page import="java.sql.PreparedStatement"%>
<%@page import="java.sql.ResultSet"%>
<%@page import="java.sql.Connection"%>
<%@page import="java.sql.Types"%>
<%out.clear();%>
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>数据库说明文档</title>
<style>
h1{}
h2{font-size:14px; margin: 0; padding: 0; line-height: 32px; font-weight: 100;}
.fields{ width:800px;}
.fields th{ background-color: #46b8da; line-height: 22px; text-align: left; padding:5px;}
.fields td{ background-color: #f5f5f5; width: 25%; line-height: 22px; text-align: left; padding:5px;}
</style>
</head>
<body>
<%
Connection conn = null;
ResultSet rs = null,rs2=null;
Statement stmt=null,stmt2=null;
String dbname="totsdk";//你的数据库名称
String dbuser="root";//你的数据库连接用户名
String dbpassword="";//你的数据库连接密码
try {
conn = DriverManager.getConnection("jdbc:mysql://127.0.0.1/"+dbname+"?useUnicode=true&characterEncoding=UTF-8",dbuser,dbpassword);
stmt=conn.createStatement();
stmt2=conn.createStatement();
//遍历查询数据库中的表
rs =stmt.executeQuery("select table_name,table_comment from information_schema.tables where table_schema = '"+dbname+"'");
while (rs.next()) {
out.print("<h1>表名："+rs.getString(1)+"</h1>\n");
out.print("<h2>说明："+rs.getString(2)+"</h2>\n");
//查询表中的字段
rs2=stmt2.executeQuery("show full fields from "+rs.getString(1));
out.print("<table class=\"fields\" cellspacing=\"1\" cellpadding=\"0\">");
out.print("<tr>");
out.print("<th>名称</th>");
out.print("<th>类型</th>");
out.print("<th>默认值</th>");
out.print("<th>备注</th>");
out.print("</tr>");
while(rs2.next()){
out.print("<tr>");
out.print("<td>"+rs2.getString(1)+"</td>");
out.print("<td>"+rs2.getString(2)+"</td>");
out.print("<td>"+rs2.getString(6)+"</td>");
out.print("<td>"+rs2.getString(9)+"</td>");
out.print("</tr>");
}
out.print("</table>");
}
} catch (SQLException e) {
} finally {
try {
rs.close();
rs2.close();
stmt.close();
stmt2.close();
conn.close();
} catch (Exception e) {
}
}
%>
</body>
</html>
代码第30行dbname变量即是要查看的数据库名称信息。其实我们也可以把这个变量设计为获取url参数来的值 ，比如
String dbname=request.getParameter("dbname");
这样，这个程序就可以支持多个数据库结构信息的查看了，方法就是我们在浏览器中访问的地址换成以下：
好了，代码比较简单，短短几十行代码搞定数据库文档。但需要注意的是因为这里采用的mysql的内置的表和sql语句获取表和字段的信息，因此对于其它类型的数据库是不起作用的。如果想要做一个兼容所有数据库的程序，可以参考一下淘特jspcms，那里面有个在线数据库管理是可以兼容所有数据库，有兴趣的朋友可以去研究一下。
相关推荐
- 微软Win10/Win11版Copilot上线:支持OpenAI o3推理模型
-
IT之家4月3日消息，科技媒体WindowsLatest昨日（4月2日）发布博文，报道称Windows10、Windows11新版Copilot应用已摘掉Beta帽...
- WinForm 双屏幕应用开发:原理、实现与优化
-
在当今的软件开发领域，多屏幕显示技术的应用越来越广泛。对于WinForm应用程序来说，能够支持双屏幕显示不仅可以提升用户体验，还能满足一些特定场景下的业务需求，比如在演示、监控或者多任务处理等场景...
- OpenJDK 8 安装（openjdk 8 windows）
-
通常OpenJDK8和11都能互相编译和通用。我们建议使用11，但是如果你使用JDK8的话也是没有问题的。建议配置使用OpenJDK，不建议使用OracleJDK，主要是因为版...
- 基于 Linux 快速部署 OpenConnect VPN 服务(ocserv 实战指南)
-
一、前言在如今远程办公和内网穿透需求日益增长的背景下，搭建一套安全、稳定、高效的VPN系统显得尤为重要。OpenConnectServer（ocserv）是一个开源、高性能的VPN服务端软件...
- 巧妙设置让Edge浏览器更好用（edge怎么设置好用）
-
虽然现在新版本的Edge浏览器已经推出，但是毕竟还处于测试的状态中。而Win10系统里面自带的老版Edge浏览器，却越来越不被人重视。其实我们只需要根据实际情况对老版本的Edge浏览器进行一些简单的设...
- 微软开源博客工具Open Live Writer更新:多项Bug修复
-
OpenLiveWriter前身是WindowsLiveWriter，是微软WindowsLive系列软件之一，曾经是博主们非常喜爱的一款所见即所得博文编辑工具，支持离线保存，还支持图像编辑...
- 基于OpenVINO的在线设计和虚拟试穿 | OPENAIGC大赛企业组优秀作品
-
在第二届拯救者杯OPENAIGC开发者大赛中，涌现出一批技术突出、创意卓越的作品。为了让这些优秀项目被更多人看到，我们特意开设了优秀作品报道专栏，旨在展示其独特之处和开发者的精彩故事。...
- Python open函数详解（python open函数源码）
-
演示环境，操作系统：Win1021H2（64bit）；Python解释器：3.8.10。open是Python的一个内置函数，一般用于本地文件的读写操作。用法如下。my_file=open(fi...
- 世界上最好用的Linux发行版之一，OpenSUSE安装及简单体验
-
背景之前无意在论坛里看到openSUSE的Linux发行版，被称为世界上最好用的Linux发行版之一（阔怕），一直想体验一下，于是这期做一个安装和简单体验教程吧。...
欢迎 你 发表评论:
- 一周热门
-
-
前端面试:iframe 的优缺点? iframe有那些缺点
-
带斜线的表头制作好了，如何填充内容?这几种方法你更喜欢哪个?
-
漫学笔记之PHP.ini常用的配置信息
-
推荐7个模板代码和其他游戏源码下载的网址
-
其实模版网站在开发工作中很重要，推荐几个参考站给大家
-
[干货] JAVA - JVM - 2 内存两分 [干货]+java+-+jvm+-+2+内存两分吗
-
正在学习使用python搭建自动化测试框架?这个系统包你可能会用到
-
织梦(Dedecms)建站教程 织梦建站详细步骤
-
【开源分享】2024PHP在线客服系统源码(搭建教程+终身使用)
-
2024PHP在线客服系统源码+完全开源 带详细搭建教程
-
- 最近发表
-
- 微软Win10/Win11版Copilot上线:支持OpenAI o3推理模型
- WinForm 双屏幕应用开发:原理、实现与优化
- 推荐一个使用 C# 开发的 Windows10 磁贴美化小工具
- OpenJDK 8 安装（openjdk 8 windows）
- 基于 Linux 快速部署 OpenConnect VPN 服务(ocserv 实战指南)
- 巧妙设置让Edge浏览器更好用（edge怎么设置好用）
- WPF做一个漂亮的登录界面（wpf页面设计）
- 微软开源博客工具Open Live Writer更新:多项Bug修复
- 基于OpenVINO的在线设计和虚拟试穿 | OPENAIGC大赛企业组优秀作品
- C#开源免费的Windows右键菜单管理工具
- 标签列表
-
- mybatis plus (70)
- scheduledtask (71)
- css滚动条 (60)
- java学生成绩管理系统 (59)
- 结构体数组 (69)
- databasemetadata (64)
- javastatic (68)
- jsp实用教程 (53)
- fontawesome (57)
- widget开发 (57)
- vb net教程 (62)
- hibernate 教程 (63)
- case语句 (57)
- svn连接 (74)
- directoryindex (69)
- session timeout (58)
- textbox换行 (67)
- extension_dir (64)
- linearlayout (58)
- vba高级教程 (75)
- iframe用法 (58)
- sqlparameter (59)
- trim函数 (59)
- flex布局 (63)
- contextloaderlistener (56)