从PHP脚本返回JSON


Answers:


1602

通常,没有它会没事,但是您可以并且应该设置Content-Type标头:

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

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


9
以防万一:您仅应在输出缓冲之外使用header()命令,以避免出现“已发送标题”警告
凯文

6
该php文件必须使用UTF-8编码,且不带BOM :)
Krzysztof Kalinowski

217
header('Content-type:application/json;charset=utf-8');
Timo Huovinen

14
@mikepote实际上,我认为没有必要在PHP文件的顶部具有标头命令。如果您不经意间吐出了东西,而这又使您的标头命令崩溃了,您只需要修复代码,因为它已损坏。
2015年

8
@KrzysztofKalinowski不,PHP文件不需要UTF-8编码。输出必须是UTF-8编码的。这些错误的陈述并没有帮助没有经验的用户学习如何避免事物破损,但是有助于在他们身上形成神话,而从不学习编码在流中扮演哪个角色以及它们如何工作。
阿谢尔·科斯塔斯·佩纳

124

返回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 );

44

根据手册上json_encode的方法可以返回一个非字符串(false):

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

发生这种情况时,echo json_encode($data)将输出空字符串,这是无效的JSON

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

应该在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的文档中阅读有关处理JSON错误的更多信息


2
charsetJSON 没有参数;请参阅tools.ietf.org/html/rfc8259#section-11末尾的注释:“没有为该注册定义'charset'参数。添加一个对合规接收者实际上没有影响。” (JSON必须按照tools.ietf.org/html/rfc8259#section-8.1作为UTF-8进行传输,因此指定将其编码为UTF-8有点多余。)
Patrick Dark

1
感谢您强调@PatrickDark。charset从HTTP标头字符串中删除了冗余参数。
特里科特

38

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



12

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

<?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); 
?>

这里有更多示例:如何绕过Access-Control-Allow-Origin?


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

在标头中说明字符集有什么区别?请解释,谢谢。
桑索芬

6

如上所述:

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

将工作。但请记住:

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

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


4

一个简单的函数,返回带有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();
}

1
header_remove,并明确设置http响应是一个好主意;虽然先设置状态再设置http_response似乎是多余的。可能还想exit在末尾添加一条语句。我将您的函数与@trincot结合在一起:stackoverflow.com/a/35391449/339440
Stephen R

谢谢你的建议。我刚刚更新了答案。

3

您问题的答案在这里

它说。

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

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



1

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


1

如果查询数据库并需要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解析结果,请看一下本教程


1

这是一个简单的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
AA

0

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

例如,用于处理Javascript的正确Content-Type将为application/javascript

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

出于其他目的(例如移动应用),请使用application/jsonContent-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);

0

每当您尝试返回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 Screeshot:

在此处输入图片说明


-1

您可以使用这个小的PHP库。它发送标题,并给您一个易于使用的对象。

看起来像 :

<?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();
?>
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.