jquery的jsonp

 本帖转载于http://blog.csdn.net/zx13525079024/article/details/19474733

关于JSONP的概念和为什么要使用JSONP网上已经有很多教程，这一节主要演示下在JQUERY中的ajax方法怎样通过JSONP进行远程调用

                 首先介绍下$.ajax的参数

                   type：请求方式 GET/POST

                   url:请求地址

                   async:布尔类型，默认为true 表示请求是否为异步，如果为false表示为同步。

                   dataType：返回的数据类型

                   jsonp：传递给请求处理程序或页面的，用以获得jsonp回调函数名的参数名(一般默认为:callback)

                   jsonpCallback：自定义的jsonp回调函数名称，默认为jQuery自动生成的随机函数名，也可以写"?"，jQuery会自动为你处理数据

                  success：调用成功执行的函数

                  error：异常处理函数

            

             1.示例1

                服务器端我们采用MVC的ACTION来返回数据

 

                

[csharp]  view plain  copy

1. public class HomeController : Controller  
2.    {  
3.        //  
4.        // GET: /Home/  
5.   
6.        public ActionResult Index()  
7.        {  
8.            return View();  
9.        }  
10.   
11.        public ActionResult ReturnJson()  
12.        {  
13.            string callback = Request.QueryString["callback"];  
14.            string json = "{'name':'张三','age':'20'}";  
15.            string result = string.Format("{0}({1})", callback, json);  
16.            return Content(result);  
17.        }  
18.   
19.    }  

            客户端使用jsonp来传输数据

            

[html]  view plain  copy

1. @{  
2.     ViewBag.Title = "Index";  
3.     Layout = "~/Views/Shared/_Layout.cshtml";  
4. }  
5.   
6. <script src="~/Scripts/jquery-1.7.1.min.js" type="text/javascript"> </script>  
7.  <script type="text/javascript">  
8.      function SendData()  
9.      {  
10.          $.ajax({  
11.              type: "get",  
12.              async: false,  
13.              url: "/home/ReturnJson",  
14.              dataType: "jsonp",  
15.              success: function(data){  
16.                  alert(data.name);  
17.              },  
18.              error: function(){  
19.                  alert('fail');  
20.              }  
21.          });  
22.      }  
23.   
24.   
25.  </script>  
26.   
27. <input  type="button" value="提交" onclick="SendData();"/>  
28.    

            点击提交按钮后，发现服务器端的Request.QueryString["callback"]返回一个随机函数名。这样就被设置成JSONP格式来传递数据了

     2.自定义函数名

         可以在传递过程中自定义函数名，只要使用jsonpCallback参数就可以了。

      jsonp:表示传递的参数，默认为callback，我们也可以自定义，服务器段通过此参数，获取自定义的函数名称，服务器这样获取 Request.QueryString["callback"]

      jsonpCallback表示传递的参数值，也就是回调的函数名称，这是自定义的名称。

             

[html]  view plain  copy

1. <script type="text/javascript">  
2.     function SendData() {  
3.         $.ajax({  
4.             type: "get",  
5.             async: false,  
6.             url: "/home/ReturnJson",  
7.             dataType: "jsonp",  
8.             jsonp: "callback",//传递给请求处理程序或页面的，用以获得jsonp回调函数名的参数名(一般默认为:callback)  
9.             jsonpCallback: "receive",//自定义的jsonp回调函数名称，默认为jQuery自动生成的随机函数名，也可以写"?"，jQuery会自动为你处理数据  
10.             success: function (data) {  
11.                 alert(data.name);  
12.             },  
13.             error: function () {  
14.                 alert('fail');  
15.             }  
16.         });  
17.     }  
18.   
19.     function receive(data) {  
20.         alert(data.age);  
21.     }  
22. </script>  

23. jsonp是处理跨域问题的，其原理是html的<script>能够跨域访问js脚本，即后台返回一个字符串比如callback(xxx),并且前台正好定义了callback函数，那么就能被执行，里面的字符串可以解析成对象用。我们利用这个性质让后台返回一个String类型的回调函数让前台接收。这就要求我们在使用@responseBody时返回String，为了防止乱码，我们还得自定义消息转换器。不仅如此，当我们使用restful风格时，返回类型会在ResponseEntity<XXX>和String切换，当然返回类型为ResponseEntity<?>时也没问题。但本质上他还是要经过StringHttpMessageConverter，因为泛型会是String。为了能够使代码重用，以及只返回ResponseEntity<XXX>，不返回String。我们可以统一jsonp返回格式。

    做法：自定义一个类继承MappingJackson2HttpMessageConverter，重写writeInternal(Object object, Type type, HttpOutputMessage outputMessage)方法：

    HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.currentRequestAttributes()).getRequest();
    String callbackParam = request.getParameter(callbackName);
    if(StringUtils.isEmpty(callbackParam)){
    super.writeInternal(object, outputMessage);
    }else{
    JsonEncoding encoding = getJsonEncoding(outputMessage.getHeaders().getContentType());
    try {
    String result =callbackParam+"("+super.getObjectMapper().writeValueAsString(object)+");";
    IOUtils.write(result, outputMessage.getBody(),encoding.getJavaName());
    }
    catch (JsonProcessingException ex) {
    throw new HttpMessageNotWritableException("Could not write JSON: " + ex.getMessage(), ex);
    }
    }
    

    其中callbackName是成员变量，代表的是参数名。目的是可以通过配置文件来灵活定义。比如请求为http://a.com/rest/xxx?callback=abc时，后台callbackName的值就是callback，request.getParameter("callback")返回的值abc,它就是回调函数名（前台script中会定义一个名为abc的方法）。

    配置文件中的配置是：

    <mvc:annotation-driven>
    <mvc:message-converters >
    <bean class="xxx.MyMappingJackson2HttpMessageConverter" >
    <property name="callbackName" value="callback"></property><!-- 这个就是定义参数名，非参数值 -->
    </bean>
    <bean class="org.springframework.http.converter.StringHttpMessageConverter">
    <constructor-arg value="UTF-8" />
    </bean>
    </mvc:message-converters>
    </mvc:annotation-driven>
    

    StringHttpMessageConverter可以继续保留，有可能其它请求会返回String类型
    

    另外如果配合jquery的jsonp：

    jquery的jsonp是这样写的：

    $.ajax({  
                type: "get",  
                async: false,  
                url: "xxx",  
                dataType: "jsonp",  
                jsonp: "callback",//传递给请求处理程序或页面的，用以获得jsonp回调函数名的参数名(一般默认为:callback)  
                jsonpCallback: "receive",//自定义的jsonp回调函数名称，默认为jQuery自动生成的随机函数名，也可以写"?"，jQuery会自动为你处理数据 

    可以理解为 请求中是xxx?callback=receive
                success: function (data) {  
                    alert(data.name);  
                },  
                error: function () {  
                    alert('fail');  
                }  
            });  
    

    data就是类似ResponseEntity<xxx>中的xxx，用ResponseEntity.ok(xxx对象);返回的

    ----------------------------------------------------------------

    最近发现了另一种简单处理jsonp的方式，

    @RequestMapping(value = "/{loginname}", method = RequestMethod.GET)
    @ResponseBody
    

    public Object xxx(String callback){

    if(StringUtils.isEmpty(callback)){返回对象}

    else{

    MappingJacksonValue jacksonValue = new MappingJacksonValue(xxx);
    jacksonValue.setJsonpFunction(callback);
    

    return jacksonValue;

    }

    }

    只要请求带callback，就会返回js方法，否则就会返回对象