不到一百行代码实现一个Mysql数据库说明文档自动生成程序
yuyutoo 2024-10-12 00:48 4 浏览 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，那里面有个在线数据库管理是可以兼容所有数据库，有兴趣的朋友可以去研究一下。
相关推荐
- 网站建设:从新手到高手
-
现代化网站应用领域非常广泛，从个人形象网站展示、企业商业网站运作、到政府公益等服务网站，各行各业都需要网站建设。大体上可以归结四类：宣传型网站设计、产品型网站制作、电子商务型网站建设、定制型功能网站开...
- JetBrains 推出全新 AI 编程工具 Junie，助力高效开发
-
JetBrains宣布推出名为Junie的全新AI编程工具。这款工具不仅能执行简单的代码生成与检查任务，还能应对编写测试、验证结果等复杂项目，为开发者提供全方位支持。根据SWEBench...
- AI也能写代码!代码生成、代码补全、注释生成、代码翻译轻松搞定
-
清华GLM技术团队打造的多语言代码生成模型CodeGeeX近期更新了新的开源版本「CodeGeeX2-6B」。CodeGeeX2是多语言代码生成模型CodeGeeX的第二代模型，不同于一代CodeG...
- 一键生成前后端代码，一个36k星的企业级低代码平台
-
「企业级低代码平台」前后端分离架构SpringBoot2.x，SpringCloud，AntDesign&Vue，Mybatis，Shiro，JWT。强大的代码生成器让前后端代码一键生成，无需写任...
- Gitee 代码托管实战指南:5 步完成本地项目云端同步(附避坑要点)
-
核心流程拆解：远程仓库的搭建登录Gitee官网（注册账号比较简单，大家自行操作），点击“新建仓库”，建议勾选“初始化仓库”和“设置模板文件”（如.gitignore），避免上传临时文件。...
- jeecg-boot 源码项目-强烈推荐使用
-
JEECGBOOT低代码开发平台...
- JetBrains推出全新AI编程工具Junie，强调以开发者为中心
-
IT之家2月1日消息，JetBrains发文，宣布推出一款名为Junie的全新AI编程工具，官方声称这款AI工具既能执行简单的代码生成与检查等基础任务，也能应对“编写测试、验证结...
- JetBrains旗下WebStorm和Rider现已加入“非商用免费”阵营
-
IT之家10月25日消息，软件开发商JetBrains今日宣布，旗下WebStorm（JavaScript开发工具）和Rider（.NET开发工具）现已加入“非商用免费”阵营。如果...
- 谈谈websocket跨域
-
了解websocketwebsocket是HTML5的新特性，在客户端和服务端提供了一个基于TCP连接的双向通道。...
- websocket调试工具
-
...
- 利用webSocket实现消息的实时推送
-
1.什么是webSocketwebSocket实现实现推送消息WebSocket是HTML5开始提供的一种在单个TCP连接上进行全双工通讯的协议。以前的推送技术使用Ajax轮询，浏览器需...
- 为 Go 开发的 WebSocket 库
-
#记录我的2024#...
- 「Java基础」Springboot+Websocket的实现后端数据实时推送
-
这篇文章主要就是实现这个功能，只演示一个基本的案例。使用的是websocket技术。...
欢迎 你 发表评论:
- 一周热门
- 最近发表
- 标签列表
-
- 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)