PHP 一鍵生成 MySQL 資料字典（Data Dictionary）完整程式碼

前言

專案開發中，資料字典是團隊溝通、新人上手、維護重構的關鍵文件。手工維護極易脫節，本文提供一支 PHP 腳本，自動讀取 MySQL 中繼資料，生成美觀的 HTML 資料字典，支援表註解、欄位型別、主鍵、預設值、編碼等完整資訊。

功能特色

• 自動掃描指定資料庫所有資料表
• 顯示：表名、表註解、欄位名、型別、是否可空、預設值、編碼、備註、主鍵標記
• 斑馬紋表格、響應式設計、支援 Ctrl+F 搜尋
• 單一檔案部署，修改 6 個常數即可使用

完整程式碼

<?php
header('Content-Type: text/html; charset=utf-8');

// ===== 修改這 6 個常數即可部署 =====
define('DB_HOST', 'localhost');
define('DB_USER', 'root');
define('DB_PASS', 'your_password');
define('DB_NAME', 'your_database');
define('DB_PORT', 3306);
define('DB_CHAR', 'utf8mb4');
define('APP_NAME', '我的專案');
// ===================================

$conn = mysqli_connect(DB_HOST, DB_USER, DB_PASS, DB_NAME, DB_PORT);
if (!$conn) die('資料庫連線失敗: ' . mysqli_connect_error());
mysqli_set_charset($conn, DB_CHAR);

// 取得所有資料表狀態（含註解）
$sql = "SHOW TABLE STATUS FROM `" . DB_NAME . "`";
$result = mysqli_query($conn, $sql);
$tables = [];
while ($row = mysqli_fetch_assoc($result)) {
  $tables[] = $row;
}
$tableCount = count($tables);

// 輸出 HTML 頭部
echo '<!DOCTYPE html>
<html lang="zh-TW">
<head>
  <meta charset="UTF-8">
  <title>' . APP_NAME . ' - 資料字典</title>
  <style>
    body { font-family: "Microsoft JhengHei", sans-serif; margin: 20px; background: #fafafa; }
    .header { background: #2c3e50; color: white; padding: 20px; text-align: center; border-radius: 8px 8px 0 0; }
    .info-bar { background: #ecf0f1; padding: 10px; text-align: center; color: #7f8c8d; border-radius: 0 0 8px 8px; }
    .table-card { background: white; margin: 20px 0; box-shadow: 0 2px 8px rgba(0,0,0,0.1); border-radius: 8px; overflow: hidden; }
    .table-title { background: #34495e; color: white; padding: 15px 20px; font-size: 1.1em; font-weight: bold; }
    .table-title span { color: #3498db; font-weight: normal; margin-left: 10px; }
    table { width: 100%; border-collapse: collapse; }
    th, td { padding: 12px 15px; text-align: left; border-bottom: 1px solid #eee; }
    th { background: #f8f9fa; font-weight: 600; color: #2c3e50; position: sticky; top: 0; }
    tr:hover { background: #f8f9fa; }
    tr:nth-child(even) { background: #fdfdfd; }
    .pk { color: #e74c3c; font-weight: bold; }
    .null-yes { color: #27ae60; }
    .null-no { color: #e74c3c; }
    @media (max-width: 768px) { .table-card { overflow-x: auto; } }
  </style>
</head>
<body>
  <div class="header"><h1>' . APP_NAME . ' 資料字典</h1></div>
  <div class="info-bar">共 ' . $tableCount . ' 張表 | 產生時間: ' . date('Y-m-d H:i:s') . ' | 提示: Ctrl+F 搜尋關鍵字</div>';

foreach ($tables as $i => $table) {
  $tableName = $table['Name'];
  $tableComment = $table['Comment'] ?: '（無註解）';
  
  // 取得欄位詳細資訊
  $fieldSql = "SHOW FULL COLUMNS FROM `" . $tableName . "`";
  $fieldResult = mysqli_query($conn, $fieldSql);
  $fields = [];
  while ($f = mysqli_fetch_assoc($fieldResult)) $fields[] = $f;
  
  // 取得主鍵資訊
  $keySql = "SHOW KEYS FROM `" . $tableName . "` WHERE Key_name = 'PRIMARY'";
  $keyResult = mysqli_query($conn, $keySql);
  $pkFields = [];
  while ($k = mysqli_fetch_assoc($keyResult)) $pkFields[] = $k['Column_name'];

  echo '<div class="table-card">';
  echo '<div class="table-title">' . ($i+1) . '. ' . $tableName . ' <span>' . htmlspecialchars($tableComment) . '</span></div>';
  echo '<table><thead><tr>';
  echo '<th style="width:140px">欄位名稱</th>';
  echo '<th style="width:160px">資料型別</th>';
  echo '<th style="width:80px">允許空值</th>';
  echo '<th style="width:100px">預設值</th>';
  echo '<th style="width:100px">編碼/排序</th>';
  echo '<th>備註</th>';
  echo '</tr></thead><tbody>';

  foreach ($fields as $field) {
    $isPk = in_array($field['Field'], $pkFields) ? 'PK' : '';
    $pkClass = $isPk ? 'pk' : '';
    $nullClass = $field['Null'] === 'YES' ? 'null-yes' : 'null-no';
    $nullText = $field['Null'] === 'YES' ? 'YES' : 'NO';
    $default = $field['Default'] !== null ? htmlspecialchars($field['Default']) : '(NULL)';
    
    echo '<tr>';
    echo '<td class="' . $pkClass . '">' . $field['Field'] . ($isPk ? ' <span class="pk">[PK]</span>' : '') . '</td>';
    echo '<td>' . $field['Type'] . '</td>';
    echo '<td class="' . $nullClass . '">' . $nullText . '</td>';
    echo '<td>' . $default . '</td>';
    echo '<td>' . ($field['Collation'] ?: '-') . '</td>';
    echo '<td>' . htmlspecialchars($field['Comment'] ?: '-') . '</td>';
    echo '</tr>';
  }
  echo '</tbody></table></div>';
}

echo '</body></html>';
mysqli_close($conn);

部署步驟

1. 將程式碼存為 `db_dictionary.php` 放入專案目錄
2. 修改頂部 6 個 `define` 常數對應你的資料庫
3. 瀏覽器開啟 `https://your-domain/db_dictionary.php`
4. 可另存為 HTML 檔案離線閱覽或分享給團隊

進階改良方向

常見問題

1. 顯示亂碼：確認 `DB_CHAR` 設為 `utf8mb4`，資料表/欄位編碼亦為 utf8mb4
2. 權限不足：資料庫帳號需有 `SHOW TABLE STATUS`、`SHOW COLUMNS`、`SHOW KEYS` 權限
3. 大量資料表載入慢：加入分頁或 AJAX 延遲載入
4. VIEW 不顯示欄位：`SHOW COLUMNS` 對 VIEW 可能受限，改用 `DESCRIBE` 或 `INFORMATION_SCHEMA.COLUMNS`

總結

這支資料字典生成器零依賴、單檔部署、介面美觀，能即時反映資料庫最新結構。建議納入專案部署流程，每次資料庫遷移後自動重新生成，讓文件永遠與代碼同步。