Dieser Artikel wurde maschinell übersetzt.
.jpg "Julie Lerman")
In meinem Artikel vom Juni "Daten binden promoveaza im Web Apps mit Knockout.js" (msdn.microsoft.com/magazine/jj133816), ich hatte Spaß mit Knockout.js und promoveaza.
Als ich erfuhr wie an Daten binden Knockout zu den Ergebnissen des promoveaza Service, fand ich auch mehr über promoveaza und JSON als ich vorher gewußt hätte.
Im Artikel dieses Monats werde ich mein Schwerpunkt verlagern, auf JSON aus promoveaza konsumieren und JSON-freundliche WCF Data Services erstellen.
Ich zeige Ihnen, wie JSON direkt aus JavaScript zu nutzen, wie das promoveaza JavaScript SDK (genannt Datajs) nutzen und so stellen Sie sicher, Ihren Feed ist flexibel genug, um jede Art von clientseitigen Programmierung zu unterstützen, die JSON benötigen.
Promoveaza ist eine Spezifikation dafür, dass Daten-Service-Consumern auf ein konsistentes Verhalten von den Diensten verlassen können, die sie verzehren. Eine der Regeln der Spezifikation ist, dass promoveaza Ergebnisse Ausgabe standardmäßig im ATOM-Format (die eine bestimmte Art der Formatierung XML), und dass es auch ausgeben kann im JSON-Format Ergebnisse.
Wie die promoveaza-Spezifikation entwickelt, stellt es neue Features, die Sie Benutzer Ihres Dienstes nutzen können. Nachdem ich die verschiedenen Möglichkeiten um zu konsumieren und JSON in promoveaza-Feeds zu erstellen diskutieren, ich werde dafür sorgen, dass Sie verstehen, wie bevorstehende Änderungen an den promoveaza Spezifikation Willen beeinflussen promoveaza und was Sie heute tun können, um vorbereitet zu sein. Verfügbarmachen ein Kunden mit dem folgenden Schema in meinen Dienst zunächst:
public class Customer { public int Id { get; set; } public string FirstName { get; set; } public string LastName { get; set; } public string AccountNumber { get; set; } }
Standardmäßig ein Kunden-Ergebnis von meinem Service wäre ATOM-Daten und Aussehen (wie von einem Browser formatiert), wie in Abbildung 1.
.jpg)
Abbildung 1 Ergebnisse als ATOM
Das gleiche Ergebnis ausgeben wie JSON wäre:
{"d":[
{"__metadata":{"id":"http://localhost:43447/DataService.svc/Customers(1)",
"uri":"http://localhost:43447/DataService.svc/Customers(1)",
"type":"DataAccessMSDNJuly2012.Customer"},
"Id":1,
"FirstName":"Julie",
"LastName":"Lerman",
"AccountNumber":"A123"}
]}
Wenn Sie mit dem raw ATOM oder JSON-Ergebnisse arbeiten, kann das Format der Ausgabe einen großen Unterschied in der Leichtigkeit der Codierung machen. Beispielsweise, wenn Sie den Feed in JavaScript verbraucht sind, ist es viel einfacher direkt mit ein JSON-Objekt zu arbeiten, als zu analysieren von XML.
Es gibt zwei Möglichkeiten, um sicherzustellen, Ihre Ergebnisse zurückkommen im JSON-Format: Sie können im Anforderungsheader Anwendung/Json angeben oder Sie können einen promoveaza-Abfrageparameter hinzufügen. Beim Verfassen Anfragen im Fiddler testen es ist ziemlich leicht um eine Kopfzeile hinzuzufügen, wie im Abbildung 2.
.jpg)
Abbildung 2 Angabe von JSON in der Anfrage-Header
Sie können auch einen Header in JQuery hinzufügen, wenn Sie Ihre Anfrage erstellen, aber dank ein paar andere Optionen, Sie nicht auf diese Länge zu gehen müssen. Eine dieser Optionen ist Datajs, die JavaScript-Bibliothek für promoveaza, zu verwenden, die viele andere Vorteile bietet für Programmieren mit promoveaza auch. Eine weitere Möglichkeit ist die Verwendung den promoveaza-Query-Parameter, $Format.
JSON standardmäßig mit Datajs zu erhalten
Sie können Datajs von datajs.codeplex.com. Seit der Zeit des Schreibens ist die aktuelle Version 1.0.3.
Wenn Sie Visual Studio verwenden, können Sie Datajs direkt an das Projekt mit Hilfe des NuGet Package Managers hinzufügen. NuGet fügen einen Ordner "Scripts" zu Ihrem Projekt und setzen Sie die aktuelle Version des Datajs (Datajs-1.0.3.js) und seine Verwandten min-Script-Dateien in diesem Ordner.
Skript-Bibliothek enthält eine Klasse namens promoveaza, das erleichtert das Lesen und Schreiben von promoveaza richtlinienkonformen Feeds und andere Features bietet. Obwohl Sie leicht einen Header in der Anforderung über die OData.read-Funktion einfügen können, ist es nicht notwendig. Standardmäßig werden Datajs automatisch Header hinzufügen, denn wenn Sie diese Bibliothek verwenden, es wahrscheinlich ist, Sie wollen JSON.
Hier ist einige JavaScript, die OData.read aufruft, übergibt die Uri, die meine Datendienstabfrage darstellt, und gibt an, was mit den Ergebnissen zu tun (in diesem Fall ich bin speichern die Ergebnisse in einer Variablen mit dem Namen Customer):
<script src="Scripts/datajs-1.0.2.js" type="text/javascript"></script>
<script type="text/javascript" charset="utf-8">
var customer;
OData.read({ requestUri:"http://localhost:43447/DataService.svc/Customers?$top=1"
},
function (data, response) {
customer = data.results[0];
},
function (err) {
alert("Error occurred: " + err.message);
});
</script>
Wie ich durch dieses Skript Debuggen, ich kann sehen, dass das Ergebnis der Abfrage ein Objekt, wie im Abbildung 3.
.jpg)
Abbildung 3 Debug View von JSON-Ergebnis
Mit Fiddler ausgeführt, um HTTP-Datenverkehr zu erfassen kann ich sehen, dass der Accept-Header angeben Anwendung/Json, Teil dieser Anforderung war.
Wenn Sie ein PHP-Entwickler sind, sollten Sie die zugehörige Bibliothek, promoveaza SDK für PHP Auschecken (odataphp.codeplex.com). Ebenso wie die Datajs-Bibliothek für JavaScript-Entwickler, sichert die PHP-SDK die Ergebnisse relevant sind. Aber in diesem Fall es tut dies durch ATOM-Format anfordern und dann die resultierenden ATOM-Daten in PHP Objekte materialisieren.
JSON mit dem $Format Parameter anfordern
Nicht jeder braucht JSON wird die Datajs-Bibliothek nutzen. Aber das bedeutet nicht notwendigerweise, dass Sie zu den Anfrage-Header verwenden, um JSON bitten. Die promoveaza Spec hat auch ein Query-Parameter, $Format, die Json als einen seiner Werte akzeptiert.
Hier ist die geänderte Uri, die JSON direkt Anfragen:
http://localhost:43447/DataService.svc/Customers (1)?$ Format = Json
http://localhost:43447/DataService.svc/Customers?$Filter=FirstName Eq 'Julie' &$ Format = Json
[JSONPSupportBehavior] public class DataService : DataService<SalesContext> { public static void InitializeService(DataServiceConfiguration config) { config.SetEntitySetAccessRule("Customers", EntitySetRights.All); config.SetEntitySetAccessRule("Orders", EntitySetRights.All); }
public static void InitializeService(DataServiceConfiguration config) { config.SetEntitySetAccessRule("Customers", EntitySetRights.All); config.SetEntitySetAccessRule("Orders", EntitySetRights.All); config.SetEntitySetPageSize("Customers", 3); }
public static void InitializeService(DataSeviceConfiguration config) { config.SetEntitySetAccessRule("Customers", EntitySetRights.All); config.SetEntitySetAccessRule("Orders", EntitySetRights.All); config.SetEntitySetPageSize("Customers", 3); config.DataServiceBehavior.MaxProtocolVersion = DataServiceProtocolVersion.V2; }
Akzeptieren: Anwendung/Json; promoveaza = verbose
Akzeptieren: Anwendung/json
MaxDataServiceVersion: 2.0
.png "Subscribe to the MSDN Flash newsletter")
Subscribe to MSDN Flash newsletter
Receive the MSDN Flash e-mail newsletter every other week, with news and information personalized to your interests and areas of focus.