JavaScript：如何创建 JSONP？

Question

我有两个域，example1.com 和 example2.com

从 example1.com，我想调用 example2.com 上的 JSON API。我知道这是不允许的，这正是创建 JSONP 的原因。

问题是，如何修改 JSON API 以使其支持 JSONP？

基本上，我如何创建回调 api？

更新

我的服务器端语言是 PHP

Answer 1

这很简单。只需在 GET 中接受一个名为 callback 的参数即可。

然后将回调 JavaScript 函数包装在您的数据周围。

PHP 中的示例：

<?php

$data = '{}'; // json string

if(array_key_exists('callback', $_GET)){

    header('Content-Type: text/javascript; charset=utf8');
    header('Access-Control-Allow-Origin: http://www.example.com/');
    header('Access-Control-Max-Age: 3628800');
    header('Access-Control-Allow-Methods: GET, POST, PUT, DELETE');

    $callback = $_GET['callback'];
    echo $callback.'('.$data.');';

}else{
    // normal JSON string
    header('Content-Type: application/json; charset=utf8');

    echo $data;
}

其想法是简单地返回一个 JavaScript 文件，该文件调用回调函数，并将 JSON 对象作为 JavaScript 回调函数的第一个参数。

您可以使用内置的 json_encode() 函数从 PHP 中的数组和对象创建 JSON 字符串（上面示例中的 $data 包含该字符串）。

要使用 JSONP 服务，可以使用

<script>
    function receiver(data){
        console.log(data);
    }
</script>
<script src="data-service.php?callback=receiver"></script>

Answer 2

您需要一种服务器端语言，回调参数只是一个 GET 参数，您读取参数，然后将 JSON 响应包装到函数调用中，然后像这样打印它 callback(jsonResponse); 。

我给你留下了一个使用 Python 的极简示例，因为你没有提到任何服务器端语言：

import os
import cgi

form = cgi.FieldStorage()
callback = form.getvalue('callback','')

address = cgi.escape(os.environ["REMOTE_ADDR"])

json = '{"ip": "'+address+'", "address":"'+address+'"}'

#Allow cross domain XHR
print 'Access-Control-Allow-Origin: *'
print 'Access-Control-Allow-Methods: GET'

if callback != '':
  print 'Content-Type: application/javascript'
  result = callback+'('+json+');'
else:
  print 'Content-Type: application/json'
  result = json

print ''
print result

这是一个小的 JSONP 服务 用于检索 Zach ，它托管在 Google App Engine。

Answer 3

莫里斯已经给了你一个可行的例子。我只想补充一点，您应该检查回调参数是否存在且非空，如果不存在，则按原样返回不带括号的 json 数据。所以基本上你的 api 将是 JSON，并在给出回调时提供 JSON-P。

要使用 JSON-P Web 服务，除非您使用 YUI 或 jQuery 等框架，否则您只需动态创建一个脚本节点并将其 src 属性设置为指向 Web 服务即可。请记住在再次重复之前从 dom 中删除该节点，因为该动态脚本节点仅供一次性使用。

Answer 4

我知道我参加聚会迟到了，并且其中一个答案中有关于代码安全性的评论。这是一篇关于此的好文章：

http://www.geekality.net/2010/06/27/php-how-to-easily-provide-json-and-jsonp/

这是您应该运行的代码：

<?php header('content-type: application/json; charset=utf-8');

function is_valid_callback($subject)
{
    $identifier_syntax
      = '/^[$_\p{L}][$_\p{L}\p{Mn}\p{Mc}\p{Nd}\p{Pc}\x{200C}\x{200D}]*+$/u';

    $reserved_words = array('break', 'do', 'instanceof', 'typeof', 'case',
      'else', 'new', 'var', 'catch', 'finally', 'return', 'void', 'continue', 
      'for', 'switch', 'while', 'debugger', 'function', 'this', 'with', 
      'default', 'if', 'throw', 'delete', 'in', 'try', 'class', 'enum', 
      'extends', 'super', 'const', 'export', 'import', 'implements', 'let', 
      'private', 'public', 'yield', 'interface', 'package', 'protected', 
      'static', 'null', 'true', 'false');

    return preg_match($identifier_syntax, $subject)
        && ! in_array(mb_strtolower($subject, 'UTF-8'), $reserved_words);
}

$data = array(1, 2, 3, 4, 5, 6, 7, 8, 9);
$json = json_encode($data);

# JSON if no callback
if( ! isset($_GET['callback']))
    exit($json);

# JSONP if valid callback
if(is_valid_callback($_GET['callback']))
    exit("{$_GET['callback']}($json)");

# Otherwise, bad request
header('status: 400 Bad Request', true, 400);

Answer 5

// Adds script tag to head of the page
function addScriptToHead(source, code, type) {
    var script = document.createElement('script');
    if (type === 'js') {
        script.setAttribute('type', 'text/javascript');
    }
    if (source !== '') {
        script.setAttribute('src', source);
    }
    if (code !== '') {
        if (document.all && !window.opera)  {
            script.text = code;
        } else {
            script.innerHTML = code;
        }
    }
    document.getElementsByTagName('head')[0].appendChild(script);
}


// Callback function
function addScriptToHead(any_param) {

// do whatever needs to be done

}

//call example

addScriptToHead('http://url_to_receiver_script/index.php¶m=anything', '', 'js');

/// 回调脚本应该返回回调函数的名称，即如果您在浏览器中输入

http://url_to_receiver_script /index.php¶m=anything

它应该只返回一个文本（现有处理函数的名称）：addScriptToHead(any_param)

就像任何浏览器中的时钟一样工作。

Answer 6

使用 jQuery 很容易，
那是客户端：

  $.ajax({
        dataType: 'jsonp',
        data: "somedata="+somevalue,
        //this is very important since it's the callback we will and that allow cross domain
        jsonp: 'jsonp_callback',
        url: 'http://example2.com',
        //function we trigger on success
        success: ParseJson
         //error handling not working with jsonP
         //error: handleError
        });

function ParseJson(data)
{
for (var key in data) {
  if (data.hasOwnProperty(key)) {
    alert(key + " -> " + data[key]);
  }
}
}

并确保从服务器端获得正确的 json；
并且不要忘记返回 jsonp_callback 参数，否则它将无法工作！！！！！
确实如此。

Answer 7

您可以使用 Simple JSON for PHP 来伪造它！它简化了一切！

<?php

  include('../includes/json.php');

  $json = new json('callback', 'myCallback');

  $object = new stdClass();
  $object->FirstName = 'John';
  $object->LastName = 'Doe';
  $array = array(1,'2', 'Pieter', true);
  $jsonOnly = '{"Hello" : "darling"}';
  // Add objects to send
  $json->add('status', '200');
  $json->add("worked");
  $json->add("things", false);
  $json->add('friend', $object);
  $json->add("arrays", $array);
  $json->add("json", $jsonOnly, false);

  /*
  Expected result : 
  myCallback({
    "status": "200",
    "worked": true,
    "things": false,
    "friend": {
        "FirstName": "John",
        "LastName": "Doe"
    },
    "arrays": [
        1,
        "2",
        "Pieter",
        true
    ],
    "json": {
        "Hello": "darling"
    }
  });

  */
  $json->send();
?>

Answer 8

例子在这里
http://www.insideria。 com/2009/03/what-in-the-heck-is-jsonp-and.html
基本上

<script src=".../example2...?output=json;callback=loadit"></script>
<script>
alert( "I got this from example2 " + loadit);
</script>