Возвращение JSON из PHP-скрипта
Я хочу вернуть JSON из скрипта PHP.
Я просто повторяю результат? Должен ли я установить Content-Type заголовок?
21 ответ
Хотя обычно с этим у вас все нормально, вы можете и должны установить заголовок Content-Type:
<?PHP
$data = /** whatever you're serializing **/;
header('Content-Type: application/json');
echo json_encode($data);
Если я не использую конкретную платформу, я обычно позволяю некоторым параметрам запроса изменять поведение вывода. Это может быть полезно, как правило, для быстрого устранения неполадок, чтобы не отправлять заголовок или иногда print_r полезную нагрузку данных, чтобы увидеть его (хотя в большинстве случаев это не должно быть необходимо).
Полный фрагмент красивого и понятного PHP-кода, возвращающего JSON:
$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 );
Согласно руководству по json_encode метод может вернуть не строковое значение (false):
Возвращает JSON-кодированную строку в случае успеха или
FALSEна провал.
Когда это произойдет 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(array("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 указывает на состояние ошибки, которое оно должно обрабатывать соответствующим образом.
В рабочем режиме может быть лучше отправлять клиенту только общий статус ошибки и регистрировать более конкретные сообщения об ошибках для дальнейшего изучения.
Узнайте больше о работе с ошибками JSON в документации PHP.
Попробуйте json_encode для кодирования данных и установите тип содержимого с помощью header('Content-type: application/json');,
На этот вопрос было дано много ответов, но ни один из них не охватывает весь процесс возврата чистого 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();
}
Ссылки:
Установите тип контента с помощью header('Content-type: application/json'); а затем повторить ваши данные.
Также полезно установить безопасность доступа - просто замените * доменом, к которому вы хотите иметь доступ.
<?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?
Простая функция для возврата ответа JSON с кодом состояния HTTP.
function json_response($data=null, $httpStatus=200)
{
header_remove();
header("Content-Type: application/json");
header('Status: ' . $httpStatus);
http_response_code($httpStatus);
echo json_encode($data);
}
<?php
$data = /** whatever you're serializing **/;
header("Content-type: application/json; charset=utf-8");
echo json_encode($data);
?>
Как сказано выше:
header('Content-Type: application/json');
сделаю работу. но имейте в виду, что:
У Ajax не возникнет проблем с чтением json, даже если этот заголовок не используется, за исключением случаев, когда ваш json содержит некоторые HTML-теги. В этом случае вам нужно установить заголовок как application/json.
Убедитесь, что ваш файл не закодирован в UTF8-BOM. В этом формате добавляется символ в верхней части файла, поэтому ваш вызов header() не будет выполнен.
Если вы хотите, чтобы объект 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);
Если вам нужно получить json от php при отправке пользовательской информации, вы можете добавить это header('Content-Type: application/json'); прежде чем напечатать любую другую вещь, так что тогда вы можете распечатать echo '{"monto": "'.$monto[0]->valor.'","moneda":"'.$moneda[0]->nombre.'","simbolo":"'.$moneda[0]->simbolo.'"}';
Ответ на ваш вопрос здесь,
Это говорит.
Тип носителя MIME для текста JSON - это application / json.
так что если вы установите заголовок для этого типа и выведите строку JSON, он должен работать.
Да, вам нужно использовать эхо для отображения вывода. Mimetype: приложение / JSON
Это простой PHP-скрипт, который возвращает мужской женский и идентификатор пользователя, так как значение json будет любым случайным значением при вызове скрипта json.php .
Надеюсь, это поможет, спасибо
<?php
header("Content-type: text/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, это можно сделать так:
<?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, взгляните на этот учебник.
Всякий раз, когда вы пытаетесь вернуть ответ JSON для API или убедитесь, что у вас есть правильные заголовки, а также убедитесь, что вы возвращаете действительные данные JSON.
Вот пример сценария, который поможет вам вернуть ответ JSON из массива PHP или из файла 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 DATA):
{
"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:
Если вы делаете это в 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 приходит намного раньше в последовательности.
Простой способ отформатировать ваши доменные объекты в JSON - это использовать Marshal Serializer. Затем передайте данные json_encode и отправьте правильный заголовок Content-Type для ваших нужд. Если вы используете фреймворк, такой как Symfony, вам не нужно заботиться об установке заголовков вручную. Там вы можете использовать JsonResponse.
Например, правильный Content-Type для работы с Javascript будет application/javascript,
Или, если вам нужно поддерживать несколько довольно старых браузеров, самым безопасным будет text/javascript,
Для всех других целей, таких как использование мобильного приложения application/json как тип контента.
Вот небольшой пример:
<?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);
Да, просто установите соответствующий заголовок HTTP, просмотрите результат и выйдите из сценария.
Вы можете использовать эту маленькую библиотеку 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();
?>