Utilizar JSONP

  • Artículo

El relleno de JSON (JSONP) es un mecanismo que habilita el soporte de script entre sitios en exploradores web. JSONP está diseñado basándose en la capacidad de los exploradores web de cargar scripts desde un sitio diferente de aquel en el que se recuperó el documento cargado actualmente. El mecanismo funciona rellenando la carga útil de JSON con un nombre de la función de devolución de llamada definido por el usuario, como se muestra en el siguiente ejemplo.

callback({"a" = \"b\" });

En el ejemplo anterior, la carga de JSON, {"a" = \"b\"}, se ajusta a una llamada de función, callback. La función de devolución de llamada ya debe estar definido en la página web actual. El tipo de contenido de una respuesta JSONP es "aplicación/javascript".

Utilizar JSONP

JSONP no está habilitado automáticamente. Para habilitarlo, establezca el atributo javascriptCallbackEnabled como true en uno de los extremos estándar HTTP (WebHttpEndpoint o WebScriptEndpoint), como se muestra en el siguiente ejemplo.

<system.serviceModel>
    <standardEndpoints>
      <webHttpEndpoint>
        <standardEndpoint name="" javascriptCallbackEnabled="true"/>
      </webHttpEndpoint>
    </standardEndpoints>   
  </system.serviceModel>

El nombre de la función de devolución de llamada se puede especificar en una variable de consulta denominada devolución de llamada, tal y como se muestra en la siguiente dirección URL.

http://baseaddress/Service/RestService?callback=functionName

Cuando se invoca, el servicio envía una respuesta como la siguiente.

functionName({"root":"Something});

También puede especificar el nombre de la función de devolución de llamada aplicando JavascriptCallbackBehaviorAttribute a la clase de servicio, como se muestra en el siguiente ejemplo.

[ServiceContract]
[JavascriptCallbackBehavior(ParameterName = "$callback")]
public class Service1
{
    [OperationContract]
    [WebGet(ResponseFormat=WebMessageFormat.Json)]
    public string GetData()
    {            
    }
}

En el servicio mostrado previamente, la solicitud tiene el aspecto siguiente.

http://baseaddress/Service/RestService?$callback=anotherFunction

Cuando se invoca, el servicio responde del modo siguiente.

anotherFunction ({"root":"Something});

Códigos de estado HTTP

Las respuestas JSONP con códigos de estado HTTP distintos de 200 incluyen un segundo parámetro con la representación numérica del código de estado HTTP, como se muestra en el siguiente ejemplo.

anotherFunction ({"root":"Something}, 201);

Validaciones

Se realizan las siguientes validaciones cuando JSONP está habilitado:

  • La infraestructura de WCF produce una excepción si javascriptCallback está habilitado, existe un parámetro de cadena de consulta de devolución de llamada en la solicitud, y el formato de la respuesta está establecido en JSON.

  • Si la solicitud contiene el parámetro de cadena de consulta de devolución de llamada, pero la operación no es un HTTP GET, se omite el parámetro de devolución de llamada.

  • Si el nombre de devolución de llamada es null o una cadena vacía, la respuesta no obtiene el formato JSONP.

Vea también

Conceptos

Información general del modelo de programación web HTTP de WCF