ChatGPT解决这个技术问题 Extra ChatGPT

从 PHP 脚本返回 JSON

我想从 PHP 脚本返回 JSON。

我只是回应结果吗?我必须设置 Content-Type 标头吗?


t
timdev

虽然您通常不用它也没问题,但您可以并且应该设置 Content-Type 标头:

<?php
$data = /** whatever you're serializing **/;
header('Content-Type: application/json; charset=utf-8');
echo json_encode($data);

如果我没有使用特定的框架,我通常允许一些请求参数来修改输出行为。通常对于快速故障排除而言,不发送标头或有时 print_r 不发送数据负载来观察它可能很有用(尽管在大多数情况下,这不是必需的)。


以防万一:除了输出缓冲之外,您应该只使用 header() 命令以避免“标头已发送”警告
始终将 header() 语句尽可能放在页面顶部是一种很好的做法,这样当您添加更多代码时,您不会想在 header() 语句之前插入代码,如果您开始可能会破坏事情输出。
@mikepote 我实际上认为没有必要在 PHP 文件的顶部放置 header 命令。如果您无意中吐出一些东西并且这会触发您的标头命令,那么您只需要修复您的代码,因为它已损坏。
@KrzysztofKalinowski 不,PHP 文件不需要进行 UTF-8 编码。输出必须是 UTF-8 编码的。这些错误的陈述并不能帮助没有经验的用户学习如何避免事情被破坏,但它有助于在他们身上增加神话,并且永远不会知道编码在流中扮演什么角色以及它们是如何工作的。
@timdev 不要忘记在 echo json_encode($data); 之后立即调用 die();exit();,否则脚本中的随机数据(例如分析)可能会附加到您的 json 响应中。
Á
Áxel Costas Pena

返回 JSON 的完整且清晰的 PHP 代码是:

$option = $_GET['option'];

if ( $option == 1 ) {
    $data = [ 'a', 'b', 'c' ];
    // will encode to JSON array: ["a","b","c"]
    // accessed as example in JavaScript like: result[1] (returns "b")
} else {
    $data = [ 'name' => 'God', 'age' => -1 ];
    // will encode to JSON object: {"name":"God","age":-1}  
    // accessed as example in JavaScript like: result.name or result['name'] (returns "God")
}

header('Content-type: application/json');
echo json_encode( $data );

您可能应该事先做:$option = isset($_GET['option']);
T
Timo Huovinen

根据 manual on json_encode,该方法可以返回非字符串 (false):

成功时返回 JSON 编码字符串,失败时返回 FALSE。

发生这种情况时,echo json_encode($data) 将输出空字符串,即 invalid JSON

例如,如果其参数包含非 UTF-8 字符串,json_encode 将失败(并返回 false)。

应该在 PHP 中捕获此错误情况,例如:

<?php
header("Content-Type: application/json");

// Collect what you need in the $data variable.

$json = json_encode($data);
if ($json === false) {
    // Avoid echo of empty string (which is invalid JSON), and
    // JSONify the error message instead:
    $json = json_encode(["jsonError" => json_last_error_msg()]);
    if ($json === false) {
        // This should not happen, but we go all the way now:
        $json = '{"jsonError":"unknown"}';
    }
    // Set HTTP response status code to: 500 - Internal Server Error
    http_response_code(500);
}
echo $json;
?>

那么接收端当然应该知道 jsonError 属性的存在表示错误情况,它应该相应地处理。

在生产模式下,最好只向客户端发送一般错误状态并记录更具体的错误消息以供以后调查。

PHP's Documentation 中阅读有关处理 JSON 错误的更多信息。


JSON 没有 charset 参数;请参阅 tools.ietf.org/html/rfc8259#section-11 末尾的注释:“没有为此注册定义 'charset' 参数。添加一个确实对合规收件人没有影响。” (JSON 必须按照 tools.ietf.org/html/rfc8259#section-8.1 以 UTF-8 传输,因此指定它被编码为 UTF-8 有点多余。)
感谢您强调这一点,@PatrickDark。从 HTTP 标头字符串中删除了冗余 charset 参数。
H
HumbleOne

尝试 json_encode 对数据进行编码并使用 header('Content-type: application/json'); 设置内容类型。


s
sonique

这个问题有很多答案,但没有一个涵盖返回干净 JSON 的整个过程,以及防止 JSON 响应格式错误所需的一切。


/*
 * returnJsonHttpResponse
 * @param $success: Boolean
 * @param $data: Object or Array
 */
function returnJsonHttpResponse($success, $data)
{
    // remove any string that could create an invalid JSON 
    // such as PHP Notice, Warning, logs...
    ob_clean();

    // this will clean up any previously added headers, to start clean
    header_remove(); 

    // Set the content type to JSON and charset 
    // (charset can be set to something else)
    header("Content-type: application/json; charset=utf-8");

    // Set your HTTP response code, 2xx = SUCCESS, 
    // anything else will be error, refer to HTTP documentation
    if ($success) {
        http_response_code(200);
    } else {
        http_response_code(500);
    }
    
    // encode your PHP Object or Array into a JSON string.
    // stdClass or array
    echo json_encode($data);

    // making sure nothing is added
    exit();
}

参考:

response_remove

ob_clean

Content-type JSON

HTTP Codes

http_response_code

json_encode


thnx 用于 ob_clean 参考。我有一条领先的线正在提升我的 fetch response.json() 调用。
B
Brad Mace

使用 header('Content-type: application/json'); 设置内容类型,然后回显您的数据。


D
Dr. Aaron Dishno

设置访问安全性也很好 - 只需将 * 替换为您希望能够访问它的域。

<?php
header('Access-Control-Allow-Origin: *');
header('Content-type: application/json');
    $response = array();
    $response[0] = array(
        'id' => '1',
        'value1'=> 'value1',
        'value2'=> 'value2'
    );

echo json_encode($response); 
?>

以下是更多示例:how to bypass Access-Control-Allow-Origin?


如果这不起作用,这意味着什么?例如,为了只限制来自 CodePen 的调用,我尝试了 header('Access-Control-Allow-Origin: https://cdpn.io');,但我仍然可以从自己的浏览器加载页面。
它用于阻止跨脚本(一个脚本调用另一个页面)。因此,您将能够直接从浏览器加载它,但不能使用脚本从另一个域加载它。
J
Joyal
<?php
$data = /** whatever you're serializing **/;
header("Content-type: application/json; charset=utf-8");
echo json_encode($data);
?>

在标题中说明字符集有什么区别?请解释一下,谢谢。
D
Dan

返回带有 HTTP 状态代码的 JSON 响应的简单函数。

function json_response($data=null, $httpStatus=200)
{
    header_remove();

    header("Content-Type: application/json");

    http_response_code($httpStatus);

    echo json_encode($data);

    exit();
}

header_remove,明确设置 http 响应是个好主意;虽然设置状态然后 http_response 似乎是多余的。可能还想在末尾添加一个 exit 语句。我将您的功能与@trincot 的功能结合起来:stackoverflow.com/a/35391449/339440
使用 JS FetchAPI,您能否扩展您对如何接收发送数据的回答?当响应为 200 时,fetch(...).then(res => res.json()).then(data => /* do smth */).catch(e => console.error(e)) 效果很好,但是如何在 500 上获取 $data 以显示在 JS 中的 .catch() 方法中 PHP 抛出的确切错误?
为此,您必须将代码包装在 try catch 中:try { /* code... */ json_response('Success!', 200); } catch (\Exception $e) { json_response($e->getMessage(), 500); }
T
Tom Ah

如上所述:

header('Content-Type: application/json');

将完成这项工作。但请记住:

即使不使用此标头,Ajax 读取 json 也没有问题,除非您的 json 包含一些 HTML 标记。在这种情况下,您需要将标头设置为 application/json。

确保您的文件未以 UTF8-BOM 编码。这种格式会在文件顶部添加一个字符,因此您的 header() 调用将失败。


C
Community

您的问题 is here 的答案,

它说。

JSON 文本的 MIME 媒体类型是 application/json。

因此,如果您将标头设置为该类型并输出您的 JSON 字符串,它应该可以工作。


j
jacr1614

如果您需要从 php 获取 json 发送自定义信息,您可以在打印任何其他内容之前添加此 header('Content-Type: application/json');,然后您可以打印您的自定义 echo '{"monto": "'.$monto[0]->valor.'","moneda":"'.$moneda[0]->nombre.'","simbolo":"'.$moneda[0]->simbolo.'"}';


N
Nev Stokes

是的,您需要使用 echo 来显示输出。模仿类型:应用程序/json


S
Sᴀᴍ Onᴇᴌᴀ

如果您查询数据库并需要 JSON 格式的结果集,可以这样做:

<?php

$db = mysqli_connect("localhost","root","","mylogs");
//MSG
$query = "SELECT * FROM logs LIMIT 20";
$result = mysqli_query($db, $query);
//Add all records to an array
$rows = array();
while($row = $result->fetch_array()){
    $rows[] = $row;
}
//Return result to jTable
$qryResult = array();
$qryResult['logs'] = $rows;
echo json_encode($qryResult);

mysqli_close($db);

?>

如需使用 jQuery 解析结果的帮助,请查看 this tutorial


A
Amr Aly

这是一个简单的 PHP 脚本,用于返回男性女性和用户 ID,因为 json 值将是您调用脚本 json.php 时的任何随机值。

希望这个帮助谢谢

<?php
header("Content-type: application/json");
$myObj=new \stdClass();
$myObj->user_id = rand(0, 10);
$myObj->male = rand(0, 5);
$myObj->female = rand(0, 5);
$myJSON = json_encode($myObj);
echo $myJSON;
?>

JSON 文本的 MIME 媒体类型是 application/json
N
Nono

每当您尝试返回 API 的 JSON 响应或确保您有正确的标头并确保您返回有效的 JSON 数据时。

这是帮助您从 PHP 数组或 JSON 文件返回 JSON 响应的示例脚本。

PHP脚本(代码):

<?php

// Set required headers
header('Content-Type: application/json; charset=utf-8');
header('Access-Control-Allow-Origin: *');

/**
 * Example: First
 *
 * Get JSON data from JSON file and retun as JSON response
 */

// Get JSON data from JSON file
$json = file_get_contents('response.json');

// Output, response
echo $json;

/** =. =.=. =.=. =.=. =.=. =.=. =.=. =.=. =.=. =.=. =.  */

/**
 * Example: Second
 *
 * Build JSON data from PHP array and retun as JSON response
 */

// Or build JSON data from array (PHP)
$json_var = [
  'hashtag' => 'HealthMatters',
  'id' => '072b3d65-9168-49fd-a1c1-a4700fc017e0',
  'sentiment' => [
    'negative' => 44,
    'positive' => 56,
  ],
  'total' => '3400',
  'users' => [
    [
      'profile_image_url' => 'http://a2.twimg.com/profile_images/1285770264/PGP_normal.jpg',
      'screen_name' => 'rayalrumbel',
      'text' => 'Tweet (A), #HealthMatters because life is cool :) We love this life and want to spend more.',
      'timestamp' => '{{$timestamp}}',
    ],
    [
      'profile_image_url' => 'http://a2.twimg.com/profile_images/1285770264/PGP_normal.jpg',
      'screen_name' => 'mikedingdong',
      'text' => 'Tweet (B), #HealthMatters because life is cool :) We love this life and want to spend more.',
      'timestamp' => '{{$timestamp}}',
    ],
    [
      'profile_image_url' => 'http://a2.twimg.com/profile_images/1285770264/PGP_normal.jpg',
      'screen_name' => 'ScottMili',
      'text' => 'Tweet (C), #HealthMatters because life is cool :) We love this life and want to spend more.',
      'timestamp' => '{{$timestamp}}',
    ],
    [
      'profile_image_url' => 'http://a2.twimg.com/profile_images/1285770264/PGP_normal.jpg',
      'screen_name' => 'yogibawa',
      'text' => 'Tweet (D), #HealthMatters because life is cool :) We love this life and want to spend more.',
      'timestamp' => '{{$timestamp}}',
    ],
  ],
];

// Output, response
echo json_encode($json_var);

JSON 文件(JSON 数据):

{
    "hashtag": "HealthMatters", 
    "id": "072b3d65-9168-49fd-a1c1-a4700fc017e0", 
    "sentiment": {
        "negative": 44, 
        "positive": 56
    }, 
    "total": "3400", 
    "users": [
        {
            "profile_image_url": "http://a2.twimg.com/profile_images/1285770264/PGP_normal.jpg", 
            "screen_name": "rayalrumbel", 
            "text": "Tweet (A), #HealthMatters because life is cool :) We love this life and want to spend more.", 
            "timestamp": "{{$timestamp}}"
        }, 
        {
            "profile_image_url": "http://a2.twimg.com/profile_images/1285770264/PGP_normal.jpg", 
            "screen_name": "mikedingdong", 
            "text": "Tweet (B), #HealthMatters because life is cool :) We love this life and want to spend more.", 
            "timestamp": "{{$timestamp}}"
        }, 
        {
            "profile_image_url": "http://a2.twimg.com/profile_images/1285770264/PGP_normal.jpg", 
            "screen_name": "ScottMili", 
            "text": "Tweet (C), #HealthMatters because life is cool :) We love this life and want to spend more.", 
            "timestamp": "{{$timestamp}}"
        }, 
        {
            "profile_image_url": "http://a2.twimg.com/profile_images/1285770264/PGP_normal.jpg", 
            "screen_name": "yogibawa", 
            "text": "Tweet (D), #HealthMatters because life is cool :) We love this life and want to spend more.", 
            "timestamp": "{{$timestamp}}"
        }
    ]
}

JSON 截图:

https://i.stack.imgur.com/0TYOJ.png


K
Kingson

将域对象格式化为 JSON 的一种简单方法是使用 Marshal Serializer。然后将数据传递给 json_encode 并根据您的需要发送正确的 Content-Type 标头。如果您使用的是 Symfony 之类的框架,则无需手动设置标头。在那里您可以使用 JsonResponse

例如,处理 Javascript 的正确 Content-Type 是 application/javascript

或者,如果您需要支持一些相当旧的浏览器,最安全的是 text/javascript

对于移动应用程序等所有其他用途,请使用 application/json 作为 Content-Type。

这是一个小例子:

<?php
...
$userCollection = [$user1, $user2, $user3];

$data = Marshal::serializeCollectionCallable(function (User $user) {
    return [
        'username' => $user->getUsername(),
        'email'    => $user->getEmail(),
        'birthday' => $user->getBirthday()->format('Y-m-d'),
        'followers => count($user->getFollowers()),
    ];
}, $userCollection);

header('Content-Type: application/json');
echo json_encode($data);

P
Paul F. Wood

如果您在 WordPress 中执行此操作,那么有一个简单的解决方案:

add_action( 'parse_request', function ($wp) {
    $data = /* Your data to serialise. */
    wp_send_json_success($data); /* Returns the data with a success flag. */
    exit(); /* Prevents more response from the server. */
})

请注意,这不在 wp_head 挂钩中,即使您立即退出,它也会始终返回大部分头部。 parse_request 在序列中出现得更早。


U
Umesh Bhutada

如果你想要 js 对象使用标题内容类型:

<?php
$data = /** whatever you're serializing **/;
header('Content-Type: application/json; charset=utf-8');
echo json_encode($data);

如果您只想要 json :删除标头内容类型属性,只需编码和回显。

<?php
$data = /** whatever you're serializing **/;
echo json_encode($data);

A
Alexis Paques

您可以使用此 little PHP library。它发送标题并为您提供一个对象以轻松使用它。

看起来像 :

<?php
// Include the json class
include('includes/json.php');

// Then create the PHP-Json Object to suits your needs

// Set a variable ; var name = {}
$Json = new json('var', 'name'); 
// Fire a callback ; callback({});
$Json = new json('callback', 'name'); 
// Just send a raw JSON ; {}
$Json = new json();

// Build data
$object = new stdClass();
$object->test = 'OK';
$arraytest = array('1','2','3');
$jsonOnly = '{"Hello" : "darling"}';

// Add some content
$Json->add('width', '565px');
$Json->add('You are logged IN');
$Json->add('An_Object', $object);
$Json->add("An_Array",$arraytest);
$Json->add("A_Json",$jsonOnly);

// Finally, send the JSON.

$Json->send();
?>