在现代 Web 应用开发中，JSON 数据的使用已成为一种常态，尤其是在使用 Laravel 这类现代 PHP 框架时。然而，在进行数据库测试时，尤其是对 JSON 列进行比较，往往会遇到一些棘手的问题。这些问题不仅影响了测试的可靠性，还可能导致开发进度的延误。本文将深入探讨如何在 Laravel 模型中高效地测试 JSON 列的相等性，帮助开发者轻松应对这一挑战。

JSON 列的复杂性

首先，我们需要理解 JSON 数据在数据库中的存储方式。JSON 数据在数据库中通常以字符串的形式存储，这意味着任何细微的编码差异，如键的顺序、空格或换行符，都可能导致直接的字符串比较失败。这种情况在使用 Laravel 的 $this->assertDatabaseHas() 方法时尤为明显，即使逻辑上完全相等，测试也可能因为这些微小的差别而失败。

举例来说，假设我们在数据库中存储了以下 JSON 数据：

{"name":"Alice","age":30}

而我们的 PHP 代码生成的 JSON 数据却是：

{
  "name": "Alice",
  "age": 30
}

表面上看这两者是相同的，但在 PHP 的字符串比较中，它们却被视为不同的字符串。这种情况让开发者在进行测试时措手不及。

实际案例：PriceSchedule 模型

我们以一个名为 PriceSchedule 的模型为例，该模型包含 JSON 列 weekday 和 hour。在 Laravel 中，这些属性可以被轻松地转换为数组，方便我们在应用程序中进行操作。

final class PriceSchedule extends Model {
    protected $fillable = [
        'user_id',
        'price_supplier_id',
        'weekday',
        'hour',
        'is_active'
    ];
    protected $casts = [
        'weekday' => 'array',
        'hour' => 'array',
    ];
}

在进行更新测试时，我们需要验证更新后的数据是否正确存储在数据库中。然而，正是 JSON 列的编码差异可能导致我们的测试失败。

解决方案：自定义辅助函数

为了确保我们在进行 JSON 列的比较时能够得到一致的结果，我们可以创建一个自定义的辅助函数，来标准化 JSON 数据的格式。以下是一个简单的示例：

function castAsJson($data) {
    return json_encode($data, JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES | JSON_PRETTY_PRINT);
}

在我们的测试用例中，我们可以像这样使用这个辅助函数：

final class PriceExportScheduleTest extends TestCase {
    public function test_price_export_schedule_update(): void {
        $user = UserFactory::new()->create();
        $this->actingAsFrontendUser($user);
        $priceSchedule = PriceScheduleFactory::new()->make();
        $updatedData = [
            'weekday' => $this->faker->randomElements(DayOfWeek::values(), 3),
            'hour' => $priceSchedule->hour,
            'is_active' => true,
        ];
        $response = $this->putJson(route('api-v2:price-export.suppliers.schedules.update'), $updatedData);
        $response->assertNoContent();
        $this->assertDatabaseHas(PriceSchedule::class, [
            'user_id' => $user->id,
            'is_active' => $updatedData['is_active'],
            'weekday' => castAsJson($updatedData['weekday']),
            'hour' => castAsJson($updatedData['hour']),
        ]);
    }
}

通过这种方法，我们确保了测试数据和数据库中的 JSON 数据在比较前都被转换为标准化的格式，从而避免了因编码差异导致的测试失败。

结论

在 Laravel 模型中测试相等的 JSON 列虽然挑战重重，但通过自定义辅助函数和合理的 JSON 编码选项，我们可以有效地解决这些问题。通过本文提供的示例和技巧，开发者不仅能够提高测试的可靠性，还能在实际开发中减少不必要的麻烦。希望大家能够在今后的开发中灵活运用这些方法，让 JSON 数据的处理变得更加顺畅和高效！