我有两个域名,example1.com和example2.com
来自example1.com,我想在example2.com上调用我的JSON API。知道这是不允许的,我想到了 - 这就是为什么创建了JSON P 的原因。
问题是,如何修改我的JSON API以使其具备JSONP功能?
基本上,我如何创建回调API?
更新
我的服务器端语言是PHP
答案 0 :(得分:76)
很简单。只需在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>
标记:
<script>
function receiver(data){
console.log(data);
}
</script>
<script src="data-service.php?callback=receiver"></script>
答案 1 :(得分:26)
你需要一个服务器端语言,callback参数只是一个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 service制作的客户端IP地址的小Zach代码,它托管在Google App Engine上。
答案 2 :(得分:6)
Mauris已经给你一个有效的例子。我只想补充一点,你应该检查一个callback
param是否存在且非空,如果不存在,则返回json数据,不带括号。所以基本上你的api将是JSON,在给出callback
时提供JSON-P。
要使用JSON-P Web服务,除非使用YUI或jQuery之类的框架,否则您可以简单地动态创建脚本节点并将其src
属性设置为指向Web服务。请记住从dom中删除该节点,然后再重复该节点,因为此动态脚本节点仅供一次使用。
答案 3 :(得分: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);
答案 4 :(得分:3)
// 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');
///回调脚本应返回Callback函数的名称,即如果您在浏览器中键入
http://url_to_receiver_script/index.php¶m=anything
它应该只返回一个文本(现有处理函数的名称):addScriptToHead(any_param)
在任何浏览器中都像时钟一样工作。
答案 5 :(得分:2)
使用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参数,否则它将无效!!!!!
这就是它。
答案 6 :(得分:0)
这里的例子 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>
答案 7 :(得分:0)
您可以使用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();
?>