如何在 Laravel 模型中测试相等的 JSON 列

各位小伙伴们，大家好呀！看看今天我又给各位带来了什么文章？本文标题是《如何在 Laravel 模型中测试相等的 JSON 列》，很明显是关于文章的文章哈哈哈，其中内容主要会涉及到等等，如果能帮到你，觉得很不错的话，欢迎各位多多点评和分享！

Laravel 中 JSON 列的等值测试并非易事，因为数据库将 JSON 数据存储为字符串。 细微的 JSON 编码差异（例如键的顺序或空格）可能导致测试意外失败。本文将指导您如何在 Laravel 测试中有效地比较 JSON 列。

挑战：JSON 编码差异

数据库中存储的 JSON 数据是字符串形式。JSON 编码的细微差别（例如键的顺序或空格）会导致直接字符串比较失败。即使逻辑上等价，$this->assertDatabaseHas() 也可能因这些差异而导致测试失败。

模型示例：PriceSchedule

假设有一个 PriceSchedule 模型，包含 JSON 列：

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

    protected $casts = [
        'weekday' => 'array',
        'hour' => 'array',
    ];
}

weekday 和 hour 属性被转换为数组，方便应用内操作。

测试案例：更新 PriceSchedule

以下是一个更新 PriceSchedule 的测试示例：

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' => $updatedData['weekday'],
            'hour' => $updatedData['hour'],
        ]);
    }
}

JSON 比较问题

使用 $this->assertDatabaseHas() 直接比较 weekday、hour 等 JSON 列时，JSON 编码差异可能导致测试失败。例如：

• 数据库中的 JSON: {"key":"value"}
• PHP 生成的 JSON: { "key":"value" }

即使数据逻辑上相同，测试也可能因字符串不匹配而失败。

解决方案：使用自定义辅助函数或 json_encode

为了确保一致的比较，在断言 JSON 列时，可以使用一个自定义的辅助函数或直接使用PHP的json_encode函数，并设置合适的选项以确保一致的JSON格式：

//方法一：使用自定义辅助函数
//在你的测试辅助函数中添加以下函数：
function castAsJson($data) {
    return json_encode($data, JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES | JSON_PRETTY_PRINT);
}
//然后在测试中使用：
$this->assertDatabaseHas(PriceSchedule::class, [
    'user_id' => $user->id,
    'is_active' => $updatedData['is_active'],
    'weekday' => castAsJson($updatedData['weekday']),
    'hour' => castAsJson($updatedData['hour']),
]);


//方法二：直接使用json_encode
$this->assertDatabaseHas(PriceSchedule::class, [
    'user_id' => $user->id,
    'is_active' => $updatedData['is_active'],
    'weekday' => json_encode($updatedData['weekday'], JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES),
    'hour' => json_encode($updatedData['hour'], JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES),
]);

这确保了测试数据和数据库数据在比较前都转换为标准化的 JSON 格式。 JSON_UNESCAPED_UNICODE 和 JSON_UNESCAPED_SLASHES 选项可以防止特殊字符导致的差异。 JSON_PRETTY_PRINT (方法一) 可以使JSON输出更易读，但如果只是为了测试相等性，可以省略。

测试结果

运行测试后，结果应该显示测试通过：

Price Export Schedule (PriceExportSchedule)
✔ Price export schedule update
OK (1 test, 3 assertions)

通过使用自定义辅助函数或 json_encode 并设置合适的选项，可以避免 JSON 编码问题，确保测试的可靠性和准确性。

今天带大家了解了的相关知识，希望对你有所帮助；关于文章的技术知识我们会一点点深入介绍，欢迎大家关注golang学习网公众号，一起学习编程~