利用PDOStatement::columnCount 實現接口輸出結構一致性測試，有哪些實用技巧？

M66 2025-06-13

在開發過程中，接口輸出的數據結構是否穩定，直接關係到前端和其他系統調用的穩定性。特別是涉及數據庫查詢時，如何保證接口返回的字段數量和結構一致，是非常重要的一環。本文將圍繞PHP 中的PDOStatement::columnCount方法，探討如何實現接口輸出結構的一致性測試，並分享一些實用技巧。

1. 什麼是PDOStatement::columnCount？

PDOStatement::columnCount是PDO 查詢結果對像中的一個方法，用於獲取當前結果集中列的數量。它的基本用法如下：

 <?php
$stmt = $pdo->query("SELECT id, name, email FROM users");
$columnCount = $stmt->columnCount();
echo "查詢結果包含的列數: " . $columnCount;
?>

在接口測試中，通過檢測列數是否符合預期，可以快速判斷接口的輸出結構是否變化。

2. 結合接口測試，為什麼要用columnCount？

很多接口都是基於數據庫查詢的，尤其是RESTful API 或GraphQL。接口輸出的字段變化，可能由於：

數據庫表結構變更
SQL 語句修改
代碼層處理邏輯變動

通過columnCount可以在接口層快速確認返回字段數量，有助於：

發現接口字段變更導致前端適配失敗
自動化測試中預設字段數量斷言
簡化對複雜數據結構的字段數量校驗

3. 實用技巧及示例

3.1 預設期望字段數量，自動斷言

在測試代碼中，可以定義期望的字段數，然後和columnCount返回值比對：

 <?php
$expectedColumns = 5; // 期望接口返回5個字段

$stmt = $pdo->prepare("SELECT id, username, email, status, created_at FROM users WHERE id = ?");
$stmt->execute([$userId]);
$actualColumns = $stmt->columnCount();

if ($actualColumns !== $expectedColumns) {
    throw new Exception("接口字段數不匹配，期望：{$expectedColumns}，實際：{$actualColumns}");
}
?>

3.2 結合接口返回數據的字段校驗

接口一般返回JSON，可以先用columnCount檢查數據庫結果字段，再與返回的JSON 字段數量做對比，保證接口和數據庫一致。

 <?php
$stmt = $pdo->prepare("SELECT id, name, age FROM m66.net_api.users WHERE status = ?");
$stmt->execute([1]);

$columnCount = $stmt->columnCount();
$data = $stmt->fetch(PDO::FETCH_ASSOC);

if (count($data) !== $columnCount) {
    throw new Exception("接口數據字段數與數據庫查詢字段數不一致");
}
echo json_encode($data);
?>

3.3 動態字段校驗

有些接口返回字段可能是動態生成的，比如根據用戶權限或參數返回不同字段，這時通過columnCount配合業務邏輯判斷可以靈活處理。

 <?php
$stmt = $pdo->prepare("SELECT id, email FROM m66.net_api.users WHERE role = ?");
$stmt->execute([$role]);

$columnCount = $stmt->columnCount();

if ($role === 'admin' && $columnCount < 5) {
    throw new Exception("管理員接口返回字段不足");
}
?>

3.4 使用columnCount 結合接口自動化測試框架

結合PHPUnit 或其他測試框架，可以將columnCount作為斷言點，編寫自動化接口結構一致性測試。

 <?php
class ApiOutputTest extends PHPUnit\Framework\TestCase
{
    protected $pdo;

    protected function setUp(): void
    {
        $this->pdo = new PDO("mysql:host=m66.net;dbname=testdb", "username", "password");
    }

    public function testUserApiColumns()
    {
        $stmt = $this->pdo->query("SELECT id, username, email FROM users WHERE active = 1");
        $this->assertEquals(3, $stmt->columnCount(), "接口字段數不符合預期");
    }
}
?>

4. 注意事項

列數不等於字段有效性： columnCount只反映列數量，不保證列名稱、順序或數據類型一致。更嚴格的測試需要對字段名稱和類型做額外校驗。
支持的驅動有限：部分PDO 驅動可能不支持columnCount ，需先確認驅動兼容性。
動態SQL ：對於動態生成的SQL 查詢，字段數量可能變化，測試時需要結合業務邏輯靈活處理。

5. 總結

通過PDOStatement::columnCount可以快速檢測接口數據庫查詢結果的字段數量，有助於實現接口輸出結構一致性的基礎測試。結合自動化測試框架、字段名稱和數據類型的進一步校驗，能夠大幅提高接口的穩定性和可維護性。希望本文的技巧能為你的接口測試提供有價值的幫助。

PDOStatement::columnCount