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

879

Я хочу вернуть JSON из скрипта PHP.

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

Скотт Николь
источник

Ответы:

1607

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

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

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

timdev
источник
9
на всякий случай: вы должны использовать команды header () только в дополнение к буферизации вывода, чтобы избежать предупреждений «заголовки уже отправлены»
Кевин
6
Файл php должен быть закодирован в UTF-8 без спецификации :)
Кшиштоф Калиновский
217
header('Content-type:application/json;charset=utf-8');
Тимо Хуовинен
14
@mikepote Я на самом деле не думаю, что нужно иметь команду header в верхней части PHP-файла. Если вы непреднамеренно выплевываете что-то, и это запускает команду заголовка, вам просто нужно исправить код, потому что он не работает.
Halfstop
8
@KrzysztofKalinowski нет, файл PHP не обязательно должен быть в кодировке UTF-8. выход ДОЛЖЕН быть в кодировке UTF-8. Эти неправильные утверждения не помогают неопытным пользователям узнать, как избежать поломок, но помогают накапливать мифы о них и никогда не узнавать, какую роль играют кодировки в потоках и как они работают.
Аксель Костас Пена
125

Полный фрагмент красивого и понятного 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 );
aesede
источник
44

Согласно руководству по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(["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 .

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

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

thejh
источник
15

Установите тип контента с помощью, 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);
?>
Joyal
источник
В чем разница с указанием кодировки в заголовке? Пожалуйста, объясните, спасибо.
Sanxofon
6

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

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

сделаю работу. но имейте в виду, что:

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

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

Том А
источник
4

Простая функция для возврата ответа JSON с кодом состояния HTTP .

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
Стивен Р
Спасибо за предложение. Я только что обновил ответ.
Дан,
3

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

Это говорит.

Тип мультимедиа MIME для текста JSON - это application / json.

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

Codemwnci
источник
1

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

Нев Стокс
источник
1

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

jacr1614
источник
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, взгляните на этот учебник .

Eyece
источник
1

Это простой PHP-скрипт, который возвращает мужской женский и идентификатор пользователя, так как значение 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;
?>
Бидяшиш Кумар
источник
Тип мультимедиа MIME для текста JSON: application / json
AA,
0

Простой способ отформатировать ваши доменные объекты в JSON - это использовать Marshal Serializer . Затем передайте данные 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);
Kingson
источник
0

Всякий раз, когда вы пытаетесь вернуть ответ 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:

введите описание изображения здесь

Нирадж Сингх
источник
-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();
?>
Алексис Пакес
источник