告别晦涩难懂的JSON验证错误：使用Composer包m1x0n/opis-json-schema-error-presenter让错误信息更友好

<code class="bash">composer require m1x0n/opis-json-schema-error-presenter</code>

<pre class="brush:php;toolbar:false;"><?php

require __DIR__ . '/vendor/autoload.php';

use Opis\JsonSchema\Schema;
use Opis\JsonSchema\Validator;
use OpisErrorPresenter\Implementation\MessageFormatterFactory;
use OpisErrorPresenter\Implementation\PresentedValidationErrorFactory;
use OpisErrorPresenter\Implementation\ValidationErrorPresenter;
use OpisErrorPresenter\Contracts\PresentedValidationError;

// 假设你的JSON Schema和待验证数据
$jsonSchema ='{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Product",
  "type": "object",
  "properties": {
    "productId": { "type": "integer", "minimum": 1 },
    "productName": { "type": "string", "minLength": 3 },
    "price": {
      "type": "object",
      "properties": {
        "amount": { "type": "integer", "minimum": 0, "maximum": 1000 },
        "currency": { "type": "string", "enum": ["USD", "EUR", "BTC"] }
      },
      "required": ["amount", "currency"]
    }
  },
  "required": [ "productId", "productName", "price" ]
}';

$data = '{
  "productId": "123", // 期望整数，实际字符串
  "productName": "XX", // 期望最小长度3，实际2
  "price": {
    "amount": 200,
    "currency": "GBP" // 期望USD/EUR/BTC，实际GBP
  }
}';

$data = json_decode($data);
$jsonSchema = Schema::fromJsonString($jsonSchema);
$validator = new Validator();

// 获取所有验证错误
$result = $validator->schemaValidation($data, $jsonSchema, -1); // -1 表示获取所有错误

if (!$result->isValid()) {
    // 使用 ValidationErrorPresenter 来格式化错误
    $presenter = new ValidationErrorPresenter(
        new PresentedValidationErrorFactory(
            new MessageFormatterFactory()
        )
    );

    // 呈现错误
    $presentedErrors = $presenter->present(...$result->getErrors());

    // 输出格式化后的错误
    echo "验证失败，错误信息如下：\n";
    foreach ($presentedErrors as $error) {
        /** @var PresentedValidationError $error */
        echo "- 字段: " . $error->getPointer() . "\n";
        echo "  问题: " . $error->getMessage() . "\n";
        echo "  关键词: " . $error->getKeyword() . "\n";
        echo "---------------------------\n";
    }

    // 也可以直接转换为JSON格式输出
    echo "\nJSON格式错误输出:\n";
    echo json_encode(array_map(static function (PresentedValidationError $error) {
        return $error->toArray();
    }, $presentedErrors), JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE);
} else {
    echo "数据验证通过！\n";
}

<pre class="brush:php;toolbar:false;">验证失败，错误信息如下：
- 字段: productId
  问题: The attribute expected to be of type 'integer' but 'string' given.
  关键词: type
---------------------------
- 字段: productName
  问题: The attribute length should be at least 3 characters.
  关键词: minLength
---------------------------
- 字段: price/currency
  问题: The attribute must be one of the following values: 'USD', 'EUR', 'BTC'.
  关键词: enum
---------------------------

JSON格式错误输出:
[
    {
        "keyword": "type",
        "pointer": "productId",
        "message": "The attribute expected to be of type 'integer' but 'string' given."
    },
    {
        "keyword": "minLength",
        "pointer": "productName",
        "message": "The attribute length should be at least 3 characters."
    },
    {
        "keyword": "enum",
        "pointer": "price/currency",
        "message": "The attribute must be one of the following values: 'USD', 'EUR', 'BTC'."
    }
]