Inhaltsvereinbarung für Bereitstellung mehrerer Inhaltstypen in JAX-RS-Anwendungen nutzen

Einer der Vorteile von RESTful-Anwendungen besteht darin, dass verschiedene Ressourcendarstellungen zurückgegeben werden können. Mit Representational State Transfer (REST) können Clients und Server Ressourcen desselben Medientyps austauschen oder aber verschiedene Medientypen verwenden. Die Inhaltsvereinbarung ermöglicht Clients und Servern, das Inhaltsformat für den Datenaustausch zu vereinbaren.

Informationen zu diesem Vorgang

Ressourcen werden in vielen verschiedenen Formaten dargestellt. XML, JavaScript Object Notation (JSON), Atom, Klartext, PNG, JPEG, GIF und angepasste oder proprietäre Formate werden für die Darstellung von Ressourcen verwendet. Representational State Transfer (REST) bietet die Flexibilität, eine einzelne Ressource in vielen Formaten darzustellen.

Je nach Anforderungen Ihrer Anwendung können Ressourcen Darstellungen in einem einzigen Format oder in mehreren Formaten zurückgeben. Es ist beispielsweise möglich, dass Ressourcen, die mit JavaScript-Clients aufgerufen werden, JSON-Darstellungen bevorzugen, weil JSON einfach zu lesen ist. Andere Clients bevorzugen jedoch XML.

Verwenden Sie die Inhaltsvereinbarung, wenn Sie Clients mehrere Formate bereitstellen möchten. Die Inhaltsvereinbarung ist die Methode, bei der der Client und der Server den zu verwendenden Inhaltstyp vereinbaren. Es gibt drei Typen der Inhaltsvereinbarung, die Einfluss auf die Antwort haben. Sie können eine Inhaltsvereinbarung auf der Basis von URLs, von Anforderungsparametern oder von HTTP-Headern verwenden.

Vorgehensweise

  1. Konfigurieren Sie die Entwicklungsumgebung.
    1. Bevor Sie beginnen, JAX-RS-Anwendungen zu entwickeln, müssen Sie Ihre Entwicklungsumgebung einrichten, indem Sie die JAX-RS-Bibliotheken im Klassenpfad hinzufügen.
  2. Definieren Sie die Ressourcen in den JAX-RS-Webanwendungen.
    1. Ressourcen sind die Grundbausteine eines RESTful-Service. Ressourcen können statische oder dynamisch aktualisierte Daten enthalten. Im Falle einer Onlinebuchhandlung sind Ressourcen beispielsweise ein Buch, eine Bestellung von einem Geschäft, ein Benutzerverbund. Wenn Sie die Ressourcen in Ihrer Anwendung definieren, können Sie den Service effizienter machen und so gestalten, dass er einfacher entwickelt werden kann.
  3. Konfigurieren Sie die JAX-RS-Anwendung.

    Sie können JAX-RS-Anwendungen je nach Anforderungen auf unterschiedliche Weise konfigurieren. Um die Funktionen von Java™ Platform, Enterprise Edition (Java EE) 6 zu nutzen, können Sie die Scanfunktionen für Annotationen verwenden. Wenn Sie die Scanfunktionen für Annotationen verwenden, können Sie eine JAX-RS-Unterklasse vom Typ "javax.ws.rs.core.Application" ausschließen oder eine minimal definierte Unterklasse "javax.ws.rs.core.Application" verwenden. Alternativ können Sie das IBM® JAX-RS-Servlet bzw. den IBM JAX-RS-Filter angeben, wenn Sie die im IBM JAX-RS-Servlet bzw. -Filter enthaltenen Funktionen verwenden möchten.

    Wenn Sie eine der Konfigurationsmethoden der JAX-RS Version 1.1 verwenden, können Sie eine Unterklasse "javax.ws.rs.core.Application" in Ihrer Anwendung ausschließen oder eine Unterklasse "javax.ws.rs.core.Application" verwenden, die einen leeren Satz von Klassen zurückgibt, um die JAX-RS-Laufzeitumgebung anzuweisen, alle JAX-RS-Klassen in der Anwendung zu suchen und zu verwenden. Sie können diese Methode verwenden, wenn Sie beim Entwickeln der Anwendung nicht jede relevante JAX-RS-Klasse manuell einer Unterklasse "javax.ws.rs.core.Application" hinzufügen möchten.

    Durch die Angabe des speziellen IBM JAX-RS-Servlets und -Filters können Sie bestimmte IBM JAX-RS-Verhalten nutzen und sicherstellen. Die Verwendung des IBM JAX-RS-Filters kann beispielsweise bei der Entwicklung einer Webanwendung mit einer Mischung von JAX-RS-Ressourcen und JSP-Dateien (JavaServer Pages) mit denselben URL-Mustern hilfreich sein.

    Obwohl es eine Konfigurationsmethode der JAX-RS Version V1.1 gibt, die die Verwendung einer optionalen Datei "web.xml" unterstützt, müssen Sie Integritätsbedingungen für die Sicherheit oder Rollen und andere Features, die Sie verwenden möchten und die über eine Datei "web.xml" aktiviert werden, in einer Datei "web.xml" angeben.

    Wählen Sie eine der folgenden drei Methoden aus, um Ihre JAX-RS-Anwendung zu konfigurieren:

    • JAX-RS-Anwendungen mithilfe von Methoden der JAX-RS Version 1.1 konfigurieren

      Verwenden Sie diese Methode, wenn Sie die Scanfunktionen für Annotationen oder die Konfigurationsmethoden der JAX-RS Version 1.1 verwenden möchten. Sie können die Scanfunktionen für Annotationen verwenden, um die Portierbarkeit von Anwendungen zu fördern, das Konfigurationscodevolumen zu minimieren oder die Anwendung dynamisch zu ändern, ohne Änderungen am Anwendungscode vorzunehmen.

    • Datei "web.xml" für JAX-RS-Servlets konfigurieren

      Verwenden Sie diese Methode, wenn Sie Features, die über Initialisierungsparameter für Servlets aktiviert werden, angeben möchten, um das Verhalten zu ändern und um sicherzustellen, dass Sie das IBM JAX-RS-Servlet erhalten. Wenn Sie Servlets verwenden möchten, können Sie einen Servletpfad in der Datei "web.xml" definieren, der an den Basis-URL angefügt wird.

    • Datei "web.xml" für JAX-RS-Filter konfigurieren

      Verwenden Sie diese Methode, um den Filter zu verwenden, wenn Sie JSPs, andere Servlets und Filter sowie JAX-RS-Ressourcen mit verschiedenen URL-Mustern haben. Sie können die Datei "web.xml" konfigurieren, um Filter zu definieren, die die möglichen URLs angeben, unter denen der Filter aufgerufen werden kann.

  4. Implementieren Sie die Inhaltsvereinbarung für die Bereitstellung mehrerer Inhaltstypen. Nutzen Sie die Inhaltsvereinbarung, um für den Server die beste Ressourcendarstellung festzulegen, die dieser an den Client zurückgeben kann. Sie können die Inhaltsvereinbarung auf der Basis von URL-Mustern, Anforderungsparametern oder HTTP-Headern implementieren.
  5. Assemblieren Sie JAX-RS-Webanwendungen.
    1. Nachdem Sie die Java-Klassendateien für Ihre JAX-RS-Webanwendung entwickelt und die Datei "web.xml" bearbeitet haben, um das JAX-RS-Servlet zu aktivieren, können Sie die Anwendung assemblieren. Assemblieren Sie die Webanwendung in einem WAR-Paket (Webarchiv). Sie können das WAR-Paket in einem EAR-Paket (Unternehmensarchiv) assemblieren, falls dies erforderlich ist.
  6. Implementieren Sie JAX-RS-Webanwendungen.
    1. Wenn Sie die JAX-RS-Webanwendung assembliert haben, müssen Sie das WAR-Paket oder das EAR-Paket auf dem Anwendungsserver implementieren.

Ergebnisse

Sie haben die Inhaltsvereinbarung implementiert, um die Formate der Ressourcen für die Datendarstellung festzulegen.


Symbol, das den Typ des Artikels anzeigt. Taskartikel



Symbol für Zeitmarke Letzte Aktualisierung: 25.05.2016
http://www14.software.ibm.com/webapp/wsbroker/redirect?version=cord&product=was-nd-mp&topic=twbs_jaxrs_contentnegotiation
Dateiname:twbs_jaxrs_contentnegotiation.html