【问题标题】:Using PUT/POST/DELETE with JSONP and jQuery将 PUT/POST/DELETE 与 JSONP 和 jQuery 一起使用
【发布时间】:2011-03-17 21:28:34
【问题描述】:

我正在创建一个支持跨域请求、JSON/JSONP 支持和主要 HTTP 方法 (PUT/GET/POST/DELETE) 的 RESTful API。现在虽然通过服务器端代码访问这个 API 很容易,但最好将它暴露给 javascript。据我所知,当使用 jQuery 进行 JSONP 请求时,它只支持 GET 方法。有没有办法使用 POST/PUT/DELETE 执行 JSONP 请求?

理想情况下,我想要一种在 jQuery 中执行此操作的方法(如果核心不支持,则通过插件),但我也会采用普通的 javascript 解决方案。任何指向工作代码或如何编写代码的链接都会有所帮助,谢谢。

【问题讨论】:

  • 检查我在下面给出的回复。它相当长 - 但它包含了您需要了解的所有内容,以了解它是如何完成的 - 从概念级别到低级别。

标签: javascript jquery web-services rest


【解决方案1】:

实际上 - 有一种方法可以支持 POST 请求。 在 PROXI 服务器中也不需要 - 只需一个小的实用 HTML 页面,如下所述。

这是您如何有效地获得 POST 跨域调用,包括附加文件和多部分以及所有 :)

这里首先是理解这个想法的步骤,然后 - 找到一个实现示例。

jQuery的JSONP是如何实现的,为什么不支持POST请求?

虽然传统的 JSONP 是通过创建一个脚本元素并将其附加到 DOM 中来实现的 - 这会导致浏览器触发 HTTP 请求以检索标记的源,然后将其作为 JavaScript 执行,而 HTTP 请求浏览器触发是简单的 GET。

什么不限于 GET 请求?

一个表格。提交表格,同时指定action 跨域服务器。 可以使用脚本完全创建 FORM 标签,使用脚本填充所有字段,设置所有必要的属性,注入 DOM,然后提交 - 全部使用脚本。

但是如何在不刷新页面的情况下提交 FORM?

我们将target 表单指定到同一页面中的 IFRAME。 也可以使用脚本创建、设置、命名和注入 IFRAME。

但是我们如何才能对用户隐藏这项工作呢? 我们将使用 style="display:none" 将 FORM 和 IFRAME 包含在隐藏的 DIV 中

(这是该技术中最复杂的部分,请耐心等待)

但来自其他域的 IFRAME 无法调用其顶级文档的回调。如何克服?

确实,如果来自 FORM 提交的响应是来自另一个域的页面,则顶级页面与 IFRAME 中的页面之间的任何脚本通信都会导致“访问被拒绝”。所以服务器不能使用脚本回调。服务器能做什么? 重定向。服务器可以重定向到任何页面 - 包括与顶级文档在同一域中的页面 - 可以为我们调用回调的页面。

服务器如何重定向?

两种方式:

  1. 使用像<Script>location.href = 'some-url'</script>这样的客户端脚本
  2. 使用 HTTP 标头。见:http://www.webconfs.com/how-to-redirect-a-webpage.php

所以我最终得到了另一个页面?它对我有什么帮助?

这是一个简单的实用程序页面,将用于所有跨域调用。实际上,这个页面实际上是一种代理,但它不是服务器,而是一个简单的静态 HTML 页面,任何有记事本和浏览器的人都可以使用。

此页面所要做的就是使用来自服务器的响应数据调用顶级文档上的回调。客户端脚本可以访问所有 URL 部分,服务器可以将它的响应编码为其中的一部分,以及必须调用的回调的名称。意味着 - 此页面可以是静态和 HTML 页面,而不必是动态服务器端页面 :)

此实用程序页面将从它运行的 URL 中获取信息 - 特别是在我下面的实现中 - Query-String 参数(或者您可以使用锚 ID 编写自己的实现 - 即 url 的一部分“#“ 标志)。由于这个页面是静态的 - 它甚至可以被缓存:)

不会为每个 POST 请求添加 DIV、SCRIPT 和 IFRAME 最终会泄漏内存吗?

如果您将其留在页面中 - 它会。如果你在你之后清洁 - 它不会。我们所要做的就是为 DIV 提供一个 ID,当响应从服务器到达或超时时,我们可以使用它来定位 DIV 以及其中的 FORM 和 IFRAME。

我们得到了什么?

实际上是一个 POST 跨域调用,包括附加文件和多部分和所有 :)

有什么限制?

  • 服务器响应仅限于适合重定向的任何内容。
  • 服务器必须始终向 POST 请求返回 REDIRECT。其中包括 404 和 500 错误。 或者 - 在触发请求之前在客户端上创建一个超时,这样您就有机会检测到尚未返回的请求。
  • 并不是每个人都能理解这一切以及所涉及的所有阶段。这是一种基础设施级别的工作,但一旦你开始运行 - 它就会摇摆不定:)

我可以将它用于 PUT 和 DELETE 调用吗?

FORM 标签不会 PUT 和 DELETE。 但这总比没有好:)

好的,明白了。技术上是如何做到的?

我做的是:

我创建了 DIV,将其设置为不可见,并将其附加到 DOM。我还给它一个 ID,我可以在服务器响应到达后从 DOM 中清除它(与 JQuery 清除它的 JSONP SCRIPT tasgs 相同的方式 - 但 DIV)。

然后我编写一个包含 IFRAME 和 FORM 的字符串 - 包含所有属性、属性和输入字段,并将其注入到不可见的 DIV 中。 只有在 div 位于 DOM 之后才将此字符串注入到 DIV 中很重要。 如果不是 - 它将不适用于所有浏览器。

之后 - 我获得了对表格的引用并提交了它。 只需记住之前的一行 - 设置 超时回调 以防服务器不响应或以错误的方式响应。

回调函数包含清理代码。它也会在响应超时的情况下由计时器调用(并在服务器响应到达时清除它的超时计时器)。

给我看代码!

下面的代码 sn-p 在“纯”javascript 上是完全“中立的”,并声明了它需要的任何实用程序。只是为了简化解释这个想法 - 它都在全局范围内运行,但是它应该更复杂一点......

按照你的需要组织它并参数化你需要的东西 - 但要确保所有需要看到彼此的部分都在同一个范围内运行:)

对于此示例 - 假设客户端在 http://samedomain.com 上运行,而服务器在 http://crossdomain.com 上运行。

顶级文档上的脚本代码

//declare the Async-call callback function on the global scope
function myAsyncJSONPCallback(data){
    //clean up 
    var e = document.getElementById(id);
    if (e) e.parentNode.removeChild(e);
    clearTimeout(timeout);

    if (data && data.error){
        //handle errors & TIMEOUTS
        //...
        return;
    }

    //use data
    //...
}

var serverUrl          = "http://crossdomain.com/server/page"
  , params = { param1  : "value of param 1"      //I assume this value to be passed
             , param2  : "value of param 2"      //here I just declare it...
             , callback: "myAsyncJSONPCallback" 
             }
  , clientUtilityUrl   = "http://samedomain.com/utils/postResponse.html"
  , id     = "some-unique-id"// unique Request ID. You can generate it your own way
  , div    = document.createElement("DIV")       //this is where the actual work start!
  , HTML   = [ "<IFRAME name='ifr_",id,"'></IFRAME>"  
             , "<form target='ifr_",id,"' method='POST' action='",serverUrl 
             , "' id='frm_",id,"' enctype='multipart/form-data'>"
             ]
  , each, pval, timeout;

//augment utility func to make the array a "StringBuffer" - see usage bellow
HTML.add = function(){
              for (var i =0; i < arguments.length; i++) 
                  this[this.length] = arguments[i];
           }

//add rurl to the params object - part of infrastructure work
params.rurl = clientUtilityUrl //ABSOLUTE URL to the utility page must be on
                               //the SAME DOMAIN as page that makes the request

//add all params to composed string of FORM and IFRAME inside the FORM tag  
for(each in params){
    pval = params[each].toString().replace(/\"/g,"&quot;");//assure: that " mark will not break
    HTML.add("<input name='",each,"' value='",pval,"'/>"); //        the composed string      
}
//close FORM tag in composed string and put all parts together
HTML.add("</form>");
HTML = HTML.join("");   //Now the composed HTML string ready :)

//prepare the DIV
div.id = id; // this ID is used to clean-up once the response has come, or timeout is detected
div.style.display = "none"; //assure the DIV will not influence UI

//TRICKY: append the DIV to the DOM and *ONLY THEN* inject the HTML in it
//        for some reason it works in all browsers only this way. Injecting the DIV as part 
//        of a composed string did not always work for me
document.body.appendChild(div);
div.innerHTML = HTML;

//TRICKY: note that myAsyncJSONPCallback must see the 'timeout' variable
timeout = setTimeout("myAsyncJSONPCallback({error:'TIMEOUT'})",4000);
document.getElementById("frm_"+id+).submit();

跨域服务器 来自服务器的响应应该是 REDIRECTION,通过 HTTP-Header 或通过编写 SCRIPT 标记。 (重定向更好,SCRIPT 标记更容易用 JS 断点调试)。 这是标题的示例,假设上面的 rurl 值

Location: http://samedomain.com/HTML/page?callback=myAsyncJSONPCallback&data=whatever_the_server_has_to_return

注意

  • data 参数的值可以是 JavaScript Object-Literal 或 JSON 表达式,但最好是 url 编码。
  • 服务器响应的长度限制为浏览器可以处理的 URL 长度。

另外——在我的系统中,服务器有一个默认值rurl,所以这个参数是可选的。但只有当您的客户端-应用程序和服务器-应用程序耦合时,您才能做到这一点。

发出重定向标头的 API:

http://www.webconfs.com/how-to-redirect-a-webpage.php

或者,您可以让服务器写入以下内容作为响应:

<script>
   location.href="http://samedomain.com/HTML/page?callback=myAsyncJSONPCallback&data=whatever_the_server_has_to_return"
</script>

但 HTTP-Headers 会被认为更干净;)

与顶级文档位于同一域的实用程序页面

对于我的所有发布请求,我使用与rurl 相同的实用程序页面:它所做的只是使用客户端代码从查询字符串中获取回调的名称和参数,然后在父文档上调用它。 仅当此页面在与触发请求的页面完全相同的域中运行时,它可以做到这一点! 重要提示: 与 cookie 不同 - 子域不计算在内!它必须与他完全相同的域。

如果此实用程序页面不包含对其他资源(包括 JS 库)的引用,也会提高效率。所以这个页面是纯 JavaScript。但你可以随心所欲地实现它。

这是我使用的响应者页面,在 POST 请求的 rurl 中找到了谁的 URL(在示例中:http://samedomain.com/utils/postResponse.html)

<html><head>
<script type="text/javascript">
//parse and organize all QS parameters in a more comfortable way
var params = {};
if (location.search.length > 1) {
    var i, arr = location.search.substr(1).split("&");
    for (i = 0; i < arr.length; i++) {
        arr[i] = arr[i].split("=");
        params[arr[i][0]] = unescape(arr[i][1]);
    }
}

//support server answer as JavaScript Object-Literals or JSON:
//  evaluate the data expression
try { 
    eval("params.data = " + params.data); 
} catch (e) { 
    params.data = {error: "server response failed with evaluation error: " + e.message
                  ,data : params.data
                  }
}

//invoke the callback on the parent
try{
     window.parent[ params.callback ](params.data || "no-data-returned");
}catch(e){
     //if something went wrong - at least let's learn about it in the
     //      console (in addition to the timeout)
     throw "Problem in passing POST response to host page: \n\n" + e.message;
}
</script>
</head><body></body></html>

它不像 jQuery 那样自动化和“现成”库,并涉及一些“手动”工作 - 但它有魅力:)

如果您是现成库的忠实粉丝 - 您还可以查看 Dojo Toolkit,我上次查看时(大约一年前) - 有自己的实现相同的机制. http://dojotoolkit.org/

祝你好运,我希望它可以帮助......

【讨论】:

  • “4.将页面发布到服务器”——哪个服务器?我不太明白你对这种方法的描述。
  • 正如我所承诺的,我添加了代码示例。我不得不从中剔除所有我从事的项目的“秘密武器”部分,并提供最简单的方式来解释这个想法。如果您仍然认为需要进一步澄清,请告诉我:)
  • 您能说出哪些支持第 4 步的现有 API? "处理请求后,服务器...返回一个重定向到rurl参数"
  • @Radagast:不,什么 JSONP api 是为第 4 步设计的?
  • 这真的是对想象力和技术诀窍的一次精彩运用。太棒了!
【解决方案2】:

有没有办法使用 POST/PUT/DELETE 执行 JSONP 请求?

没有。

【讨论】:

  • @Darin Dimitrov,也许他正在寻找除了答案之外他应该尝试什么的建议。
  • @Nick,他询问有关使用 jQuery 执行此操作的问题,并解释说他也会采用 javascript 解决方案,并且正在寻找可行解决方案的代码示例。我认为我的答案适用于这种情况。
  • 那我给你个惊喜。见下文:)
  • @Radagast the Brown,他也询问了 DELETE 和 PUT。我在您的回答中看不到有关这些动词的任何提及,而我的回答是:-) +1 顺便说一句。这是一个很好的。
【解决方案3】:

没有。考虑一下 JSONP 是什么:在文档中注入新的 &lt;script&gt; 标签。浏览器执行GET 请求以拉取src 属性指向的脚本。执行此操作时无法指定任何其他 HTTP 动词。

【讨论】:

    【解决方案4】:
    • 与其用 JSONP 方法敲我们的脑袋,那实际上不会 默认支持 POST 方式,我们可以选择 CORS 。这不会对传统的编程方式带来太大的改变。通过简单的 Jquery Ajax 调用,我们可以使用跨域。
    • 在 CORS 方法中,您必须在服务器端脚本文件或服务器本身(在远程域中)中添加标头,以启用此访问。这是非常可靠的,因为我们可以防止/限制域发出不需要的调用。
    • 详细可以在wikipedia页面找到。

    【讨论】:

    • 是的。这就是您现在可以控制两个域时所做的事情。我的帖子中描述的方法在 CORS 可用之前已经发展了很多次。
    猜你喜欢
    • 1970-01-01
    • 2019-07-31
    • 2015-07-30
    • 2011-06-24
    • 2015-01-21
    • 1970-01-01
    • 2019-07-18
    • 2016-03-23
    • 2015-12-20
    相关资源
    最近更新 更多