Возвращение JSON из PHP-скрипта

688

Я хочу вернуть JSON из PHP script.

Я просто повторяю результат? Должен ли я устанавливать заголовок Content-Type?

Теги:
header

15 ответов

1266
Лучший ответ

В то время как вы, как правило, без него, можете и должны устанавливать заголовок Content-Type:

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

Если я не использую определенную структуру, я обычно разрешаю некоторым параметрам запроса изменять поведение вывода. Может быть полезно, как правило, для быстрого устранения неполадок, чтобы не отправлять заголовок или иногда print_r полезную нагрузку данных для глазного яблока (хотя в большинстве случаев это не обязательно).

  • 8
    на всякий случай: вы должны использовать команды header () только в дополнение к буферизации вывода, чтобы избежать предупреждений «заголовки уже отправлены»
  • 1
    Хорошей практикой является всегда помещать операторы header () как можно выше в верхнюю часть страницы, чтобы при добавлении дополнительного кода у вас не возникало соблазна вставить код перед оператором header (), что может привести к поломке при запуске Выведение.
Показать ещё 8 комментариев
95

Полный кусок приятного и понятного 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 );
  • 0
    Более экономно, if ( $option == 1 ){ $data = $data1; } else { $data = $data2; } header('Content-type: application/json'); echo json_encode( $data ); Наличие условного ПОСЛЕ оператора заголовка не нужно и некрасиво.
35

Попробуйте json_encode для кодирования данных и установки типа содержимого с помощью header('Content-type: application/json');.

33

В соответствии с руководством по json_encode метод может возвращать нестроку (false):

Возвращает строку с кодировкой JSON при успешном FALSE или FALSE при сбое.

Когда это произойдет, echo json_encode($data) выведет пустую строку, что является недопустимым JSON.

Например, json_encode, например, fail (и возвращает 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.

  • 0
    Для JSON нет параметра charset ; см. примечание в конце tools.ietf.org/html/rfc8259#section-11 : «Для этой регистрации не определен параметр« charset ». Добавление одного действительно не влияет на совместимых получателей». (JSON должен передаваться как UTF-8 для tools.ietf.org/html/rfc8259#section-8.1 , поэтому указание того, что он закодирован как UTF-8, немного избыточно.)
  • 1
    Спасибо за выделение этого, @PatrickDark. Из строки заголовка HTTP удален избыточный параметр charset .
13

Задайте тип контента с помощью header('Content-type: application/json');, а затем выполните эховые данные.

6

Также полезно установить защиту доступа - просто замените * доменом, который вы хотите получить.

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

3

Ответ на ваш вопрос здесь,

Он говорит.

Тип мультимедиа MIME для текста JSON приложения /JSON.

поэтому, если вы установите заголовок этого типа и выведете строку JSON, она должна работать.

2

Это простой PHP script для возврата мужской и пользовательской идентификаторов, поскольку значение json будет любым случайным значением, когда вы вызываете script 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;
?>
2

Как указано выше:

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

выполнит задание. но имейте в виду, что:

  • У Ajax не будет проблемы с чтением json, даже если этот заголовок не используется, за исключением случаев, когда ваш json содержит некоторые теги HTML. В этом случае вам нужно установить заголовок как application/json.

  • Убедитесь, что ваш файл не закодирован в UTF8-спецификации. Этот формат добавляет символ в верхнюю часть файла, поэтому вызов header() не будет выполнен.

1

Если вам нужно получить json из php, отправляющего специальную информацию, вы можете добавить этот header('Content-Type: application/json'); прежде, чем распечатать любую другую вещь. Итак, вы можете распечатать custome echo '{"monto": "'.$monto[0]->valor.'","moneda":"'.$moneda[0]->nombre.'","simbolo":"'.$moneda[0]->simbolo.'"}';

0

Простым способом форматирования объектов домена в JSON является использование Маршал-сериализатора. Затем передайте данные в json_encode и отправьте правильный заголовок Content-Type для ваших нужд. Если вы используете фреймворк вроде Symfony, вам не нужно заботиться о настройке заголовков вручную. Там вы можете использовать JsonResponse.

Например, правильный Content-Type для работы с Javascript будет 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);
0

Если вы запрашиваете базу данных и нуждаетесь в результирующем наборе в формате 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 посмотрите этот учебник.

0

Да, просто установите соответствующий HTTP-заголовок, эхо-результат, а затем выйдите из script.

0

Вы можете использовать эту небольшую библиотеку 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();
?>
0

Да, вам нужно использовать эхо для вывода вывода. Mimetype: application/json

Ещё вопросы

Сообщество Overcoder
Наверх
Меню