Повернення JSON з PHP-скрипту


876

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

Я просто перегукуюся з результатом? Чи потрібно встановити Content-Typeзаголовок?

Відповіді:


1602

Незважаючи на те, що звичайно вам не вдається, ви можете і потрібно встановити заголовок типу вмісту:

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

Якщо я не використовую конкретний фреймворк, я зазвичай дозволяю деяким параметрам запиту змінити вихідну поведінку. Це, як правило, може бути корисним для швидкого усунення несправностей, щоб не надсилати заголовок або іноді роздруковувати дані з корисним навантаженням (хоча в більшості випадків це не повинно бути необхідним).


9
про всяк випадок: ви повинні використовувати команди header () лише на додаток до буферизації вихідних даних, щоб уникнути попереджень "заголовки вже надіслані"
Кевін

6
Файл php потрібно закодувати в UTF-8 без BOM :)
Кшиштоф Каліновський

217
header('Content-type:application/json;charset=utf-8');
Тімо Хуовінен

14
@mikepote Я насправді не думаю, що потрібно, щоб команда заголовка була у верхній частині файлу PHP. Якщо ви ненароком випльовуєте речі і це відключає команду заголовка, вам просто потрібно виправити код, оскільки він порушений.
півстоп

8
@KrzysztofKalinowski ні, файл PHP не потрібно кодувати UTF-8. вихід повинен бути кодованим UTF-8. Ці неправильні твердження не допомагають досвідченим користувачам дізнатися, як уникнути розбиття речей, але вони допомагають розробити міфи про них і ніколи не дізнатися, яку роль відіграє кодування в потоках і як вони працюють.
Аксель Костас Пена

124

Повний фрагмент приємного і зрозумілого 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 );

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 .


2
Для charsetJSON немає жодного параметра; див. примітку в кінці 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.
трінкот

38

Спробуйте json_encode, щоб кодувати дані та встановити тип вмісту header('Content-type: application/json');.


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

Яка різниця в тому, що вказується шапка в заголовку? Будь ласка, поясніть, дякую.
Санксофон

6

Як було сказано вище:

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

зроблять роботу. але майте на увазі, що:

  • У Ajax не буде проблем з читанням json, навіть якщо цей заголовок не використовується, за винятком випадків, коли ваш json містить деякі теги HTML. У цьому випадку потрібно встановити заголовок як application / json.

  • Переконайтесь, що ваш файл не закодований в UTF8-BOM. Цей формат додає символ у верхній частині файлу, тому виклик заголовка () не вдасться.


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 «S: stackoverflow.com/a/35391449/339440
Стівен R

Дякую за пропозицію. Я щойно оновив відповідь.
Ден

3

Відповідь на ваше запитання тут :

Він говорить.

Тип носія MIME для тексту JSON - це application / json.

тому якщо ви встановите заголовок цього типу та виведіть рядок JSON, він повинен працювати.


1

Так, вам потрібно буде використовувати ехо для відображення виводу. Міметик: застосування / json


1

Якщо вам потрібно отримати json від PHP, який надсилає власну інформацію, ви можете додати цю інформацію 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, щоб повернути чоловічий жіночий і ідентифікатор користувача, оскільки значення 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 - це використовувати маршальський серіалізатор . Потім передайте дані 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);

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:

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


-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();
?>
Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.