PHP脚本自动生成MySQL全库数据表的数据字典在线查看
来源：SegmentFault
时间：2023-01-14 09:17:21 318浏览 收藏
知识点掌握了，还需要不断练习才能熟练运用。下面golang学习网给大家带来一个数据库开发实战，手把手教大家学习《PHP脚本自动生成MySQL全库数据表的数据字典在线查看》，在实现功能的过程中也带大家重新温习相关知识点，温故而知新，回头看看说不定又有不一样的感悟！
为什么需要数据字典
通过Navicat等数据库管理工具，我们也能看到数据表的结构设计，但是，如果我们把全部的数据表的结构设计都做成可在线预览的，会不会更加清晰明朗呢，而且也更加容易对比发现问题和及时优化，更有效率。
生成数据字典的方式
这里我主要利用
// 数据库连接配置信息 private $host = '127.0.0.1'; private $user_name = 'root'; private $password = 'root'; private $db_name = 'test'; private $port = 3306; private $conn; // showdoc文档API密钥配置，获取方法：https://www.showdoc.com.cn/page/741656402509783 private $api_key = '6b0ddb543b53f5002f6033cb2b00cec01908536369'; private $api_token = '9da3190d0dda1118de0e8bde08907fc51712469974';
连接和关闭MySQL数据库
为了方便快速跨平台使用，我使用的都是PHP原生的写法，所以，连接数据库以及查询数据都是使用原生的PHP写法，利用PHP类的语法特性，在构造函数中连接数据库并且在析构函数中关闭连接。
/**
* 构造函数，连接数据库
* GetMysqlDict constructor.
*/
public function __construct()
{
// 创建连接
$this->conn = new mysqli($this->host, $this->user_name, $this->password, $this->db_name, $this->port);
// 检测连接
if ($this->conn->connect_error) {
exit("数据库连接失败: " . $this->conn->connect_error);
}
$this->echoMsg('数据库连接成功');
}
/**
* 析构函数，关闭数据库连接
*/
public function __destruct()
{
$this->conn->close();
$this->echoMsg('已关闭数据库连接');
}查询表结构信息
连接上了数据库，那么我们就可以查询利用
/**
* 获取数据表列表
* @return array
*/
private function getTableList()
{
// 查看所有表信息
$sql = 'show table status;';
$result = $this->conn->query($sql);
// 循环获取表数据
$table_list = array();
while ($row = $result->fetch_assoc()) {
$table_list[] = $row;
}
return $table_list;
}
/**
* 获取表结构信息
* @param string $table
* @return array
*/
private function getDictList($table = '')
{
// 获取表结构信息（COLUMN_NAME,COLUMN_TYPE,NUMERIC_SCALE,IS_NULLABLE,COLUMN_DEFAULT,COLUMN_COMMENT）
$sql = "select * from information_schema.COLUMNS where table_schema='" . $this->db_name . "' and table_name='" . $table . "';";
$result = $this->conn->query($sql);
$dict_list = array();
while ($row = $result->fetch_assoc()) {
$dict_list[] = $row;
}
return $dict_list;
}通过API接口上传到项目
获取到表的数据结构信息，我们就可以拼装字段信息，并且通过开放API接口上传到执行的项目中，大家可以看我的一个测试的项目https://www.showdoc.com.cn/1383736300665067，大家需要上传到自己的项目，只需要按照上面的说明修改相关配置即可，如果不想上传到
/**
* 发送接口请求，生成文档
* @param string $title 页面标题（请保证其唯一）
* @param string $content 页面内容（支持Markdown和HTML）
* @param string $name 目录名（可选参数）
* @param int $number 页面序号（默认99，越小越靠前）
* @return array
*/
private function apiPost($title = '', $content = '', $name = '', $number = 99)
{
// 接口地址，如果是自己利用开源搭建的，则接口地址为：http://xx.com/server/index.php?s=/api/item/updateByApi
$url = 'https://www.showdoc.cc/server/api/item/updateByApi';
// 请求参数
$data = array(
'api_key' => $this->api_key,
'api_token' => $this->api_token,
'cat_name' => $name,
'page_title' => $title,
'page_content' => $content,
's_number' => $number
);
// 发送POST请求
$ch = curl_init();
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_HEADER, 0);
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($data));
curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 10);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
$response = curl_exec($ch);
curl_close($ch);
return json_decode($response, true);
}脚本执行核心处理
上面的数据获取以及上传方法有了，那么就可以将全部的表结构字段进行循环处理，拼装成Markdown的格式，上传到项目中。开放API接口有请求频率限制，也就是10分钟只能请求1000次，所以，如果单次请求过多的话，需要做频率控制，防止请求失败，未能成功上传到项目中。
/**
* 执行入口
*/
public function run()
{
// 获取数据表
$table_list = $this->getTableList();
$this->echoMsg('数据表总数：' . count($table_list));
// 循环表获取结构信息
$request_num = 0;
foreach ($table_list as $table) {
// 频率控制，10分钟内只能请求1000次
if ($request_num >= 1000) {
$request_num = 0;
$this->echoMsg('频率控制，请等待10分钟后继续');
sleep(600);
}
// 获取数据结构
$msg = '表名：' . $table['Name'] . '（' . $table['Comment'] . '）';
// 字典表头信息
$table_dict = '#### ' . $table['Name'] . ' ' . $table['Comment'] . PHP_EOL;
$table_dict .= '| 字段名称 | 类型长度 | 是否NULL | 默认值 | 注释 |' . PHP_EOL;
$table_dict .= '| --- | --- | --- | --- | --- |' . PHP_EOL;
// 获取表字段信息
$dict_list = $this->getDictList($table['Name']);
foreach ($dict_list as $dict) {
$c_name = $dict['COLUMN_NAME'];
$c_type = $dict['COLUMN_TYPE'];
$c_null = $dict['IS_NULLABLE'];
$c_default = $dict['COLUMN_DEFAULT'];
$c_comment = $dict['COLUMN_COMMENT'];
$table_dict .= '| ' . $c_name . ' | ' . $c_type . ' | ' . $c_null . ' | ' . $c_default . ' | ' . $c_comment . ' |' . PHP_EOL;
}
// 利用showdoc文档在线展示数据字典
$response = $this->apiPost($table['Name'], $table_dict);
if ($response['error_code'] == 0) {
$msg .= ' 生成文档成功';
} else {
$msg .= ' 生成文档失败（' . $response['error_message'] . '）';
}
$request_num++;
$this->echoMsg($msg);
}
}完整源码
上面的拆分部分，基本已经把核心的代码都列出来了，但是为了大家更方便快捷的使用以及反馈问题，一键复制完整源码直接运行，我把代码上传到交友网站了Github，同时，也把完整源码贴在下面，请叫我当代活雷锋……（我也不容易，别吐槽我用代码占用大量篇幅了）
conn = new mysqli($this->host, $this->user_name, $this->password, $this->db_name, $this->port);
// 检测连接
if ($this->conn->connect_error) {
exit("数据库连接失败: " . $this->conn->connect_error);
}
$this->echoMsg('数据库连接成功');
}
/**
* 执行入口
*/
public function run()
{
// 获取数据表
$table_list = $this->getTableList();
$this->echoMsg('数据表总数：' . count($table_list));
// 循环表获取结构信息
$request_num = 0;
foreach ($table_list as $table) {
// 频率控制，10分钟内只能请求1000次
if ($request_num >= 1000) {
$request_num = 0;
$this->echoMsg('频率控制，请等待10分钟后继续');
sleep(600);
}
// 获取数据结构
$msg = '表名：' . $table['Name'] . '（' . $table['Comment'] . '）';
// 字典表头信息
$table_dict = '#### ' . $table['Name'] . ' ' . $table['Comment'] . PHP_EOL;
$table_dict .= '| 字段名称 | 类型长度 | 是否NULL | 默认值 | 注释 |' . PHP_EOL;
$table_dict .= '| --- | --- | --- | --- | --- |' . PHP_EOL;
// 获取表字段信息
$dict_list = $this->getDictList($table['Name']);
foreach ($dict_list as $dict) {
$c_name = $dict['COLUMN_NAME'];
$c_type = $dict['COLUMN_TYPE'];
$c_null = $dict['IS_NULLABLE'];
$c_default = $dict['COLUMN_DEFAULT'];
$c_comment = $dict['COLUMN_COMMENT'];
$table_dict .= '| ' . $c_name . ' | ' . $c_type . ' | ' . $c_null . ' | ' . $c_default . ' | ' . $c_comment . ' |' . PHP_EOL;
}
// 利用showdoc文档在线展示数据字典
$response = $this->apiPost($table['Name'], $table_dict);
if ($response['error_code'] == 0) {
$msg .= ' 生成文档成功';
} else {
$msg .= ' 生成文档失败（' . $response['error_message'] . '）';
}
$request_num++;
$this->echoMsg($msg);
}
}
/**
* 获取数据表列表
* @return array
*/
private function getTableList()
{
// 查看所有表信息
$sql = 'show table status;';
$result = $this->conn->query($sql);
// 循环获取表数据
$table_list = array();
while ($row = $result->fetch_assoc()) {
$table_list[] = $row;
}
return $table_list;
}
/**
* 获取表结构信息
* @param string $table
* @return array
*/
private function getDictList($table = '')
{
// 获取表结构信息（COLUMN_NAME,COLUMN_TYPE,NUMERIC_SCALE,IS_NULLABLE,COLUMN_DEFAULT,COLUMN_COMMENT）
$sql = "select * from information_schema.COLUMNS where table_schema='" . $this->db_name . "' and table_name='" . $table . "';";
$result = $this->conn->query($sql);
$dict_list = array();
while ($row = $result->fetch_assoc()) {
$dict_list[] = $row;
}
return $dict_list;
}
/**
* 发送接口请求，生成文档
* @param string $title 页面标题（请保证其唯一）
* @param string $content 页面内容（支持Markdown和HTML）
* @param string $name 目录名（可选参数）
* @param int $number 页面序号（默认99，越小越靠前）
* @return array
*/
private function apiPost($title = '', $content = '', $name = '', $number = 99)
{
// 接口地址，如果是自己利用开源搭建的，则接口地址为：http://xx.com/server/index.php?s=/api/item/updateByApi
$url = 'https://www.showdoc.cc/server/api/item/updateByApi';
// 请求参数
$data = array(
'api_key' => $this->api_key,
'api_token' => $this->api_token,
'cat_name' => $name,
'page_title' => $title,
'page_content' => $content,
's_number' => $number
);
// 发送POST请求
$ch = curl_init();
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_HEADER, 0);
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($data));
curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 10);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
$response = curl_exec($ch);
curl_close($ch);
return json_decode($response, true);
}
/**
* 打印输出信息
* @param string $msg
*/
private function echoMsg($msg = '')
{
if (!empty($msg)) {
$msg = "[" . date("Y-m-d H:i:s") . "] " . $msg . PHP_EOL;
echo $msg;
@ob_flush();
@flush();
}
}
/**
* 析构函数，关闭数据库连接
*/
public function __destruct()
{
$this->conn->close();
$this->echoMsg('已关闭数据库连接');
}
}
// 实例化类并执行
$obj = new GetMysqlDict;
$obj->run();最后
任何的工具，都是为了方便你我他，希望大家能相处更多更好的工具以及办法，更好更快的完成工作内容，大家有什么好的想法也可以和我分享，一起集思广益，发现问题并及时解决，谢谢。
文中关于mysql的知识介绍，希望对你的学习有所帮助！若是受益匪浅，那就动动鼠标收藏这篇《PHP脚本自动生成MySQL全库数据表的数据字典在线查看》文章吧，也可关注golang学习网公众号了解相关技术文章。
声明：本文转载于：SegmentFault 如有侵犯，请联系study_golang@163.com删除
相关阅读
更多>
-
499 收藏
-
244 收藏
-
235 收藏
-
157 收藏
-
101 收藏
最新阅读
更多>
-
176 收藏
-
368 收藏
-
475 收藏
-
266 收藏
-
273 收藏
-
283 收藏
课程推荐
更多>
-
- 前端进阶之JavaScript设计模式
- 设计模式是开发人员在软件开发过程中面临一般问题时的解决方案，代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景，打造一站式知识长龙服务，适合有JS基础的同学学习。
- 立即学习 542次学习
-
- GO语言核心编程课程
- 本课程采用真实案例，全面具体可落地，从理论到实践，一步一步将GO核心编程技术、编程思想、底层实现融会贯通，使学习者贴近时代脉搏，做IT互联网时代的弄潮儿。
- 立即学习 507次学习
-
- 简单聊聊mysql8与网络通信
- 如有问题加微信：Le-studyg；在课程中，我们将首先介绍MySQL8的新特性，包括性能优化、安全增强、新数据类型等，帮助学生快速熟悉MySQL8的最新功能。接着，我们将深入解析MySQL的网络通信机制，包括协议、连接管理、数据传输等，让
- 立即学习 497次学习
-
- JavaScript正则表达式基础与实战
- 在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
- 立即学习 487次学习
-
- 从零制作响应式网站—Grid布局
- 本系列教程将展示从零制作一个假想的网络科技公司官网，分为导航，轮播，关于我们，成功案例，服务流程，团队介绍，数据部分，公司动态，底部信息等内容区块。网站整体采用CSSGrid布局，支持响应式，有流畅过渡和展现动画。
- 立即学习 484次学习