在 JSON 响应中正确显示双引号

在使用 PHP Symfony 框架构建 API 时，经常需要返回包含错误信息的 JSON 响应。JsonResponse 组件是一个方便的工具，用于生成符合 JSON 格式的响应数据。然而，当错误消息中包含双引号时，可能会遇到转义字符的问题，导致返回的 JSON 字符串中出现额外的反斜杠。

例如，以下代码尝试返回一个包含双引号的错误消息：

public function error($codeError, $message, $statusCode): JsonResponse
{
    return new JsonResponse([
        'code' => $codeError,
        'description' => $message
    ], $statusCode);
}

// 调用示例
return (new ErrTC)->error('AUTH_ERROR', 'Variable "user" is invalid', 401);

上述代码返回的 JSON 响应如下：

{
  "code": "AUTH_ERROR",
  "description": "Variable \"user\" is invalid"
}

可以看到，双引号被转义成了 \"，这在某些情况下可能影响可读性。

解决方法：使用单引号代替双引号

避免双引号转义的最简单方法是使用单引号代替双引号。修改 $message 变量的值，将双引号替换为单引号：

return (new ErrTC)->error('AUTH_ERROR', "Variable 'user' is invalid", 401);

修改后的代码返回的 JSON 响应如下：

{
  "code": "AUTH_ERROR",
  "description": "Variable 'user' is invalid"
}

现在，错误消息中的双引号不再需要转义，JSON 响应更加清晰易读。

总结

当需要在 JsonResponse 中返回包含双引号的字符串时，可以通过使用单引号代替双引号来避免不必要的转义。这种方法简单有效，可以提高 JSON 响应的可读性。在设计 API 错误消息时，应尽量选择合适的引号类型，以避免转义带来的困扰。 此外，前端在解析JSON数据时，通常会自动处理转义字符，因此即使后端返回了转义后的双引号，在前端显示时也可能不会出现反斜杠。但是，为了保证数据的一致性和可读性，建议在后端就避免不必要的转义。