JAX-RS-Web-Service erstellen

Vorbereitende Schritte

Zum Implementieren des Web-Service muss ein Server mit JVM-Unterstützung für Java™ Version 5.0 oder höher definiert und gestartet sein. Dies umfasst Folgendes:
  • Bei WebSphere Application Server Version 7.0 oder Version 8.0 wählen Sie aus, dass das Feature Pack for Web 2.0 AND MOBILE und die WebSphere Application Server-Entwicklungstools installiert werden sollen.
Standardmäßig wird bei der Installation von WebSphere Application Server automatisch ein Server erstellt. Dieser Server wird in der Ansicht "Server" angezeigt.

Wenn Sie auswählen, dass die Implementierung auf einem anderen Server als dem WebSphere Application Server erfolgen soll, können Sie die IBM JAX-RS-Bibliothek nicht verwenden und müssen Ihre eigenen JAX-RS-Bibliotheken über die Seite mit den Benutzervorgaben für Projektfacetten > JAX-RS konfigurieren.

Detaillierte Informationen zur Verwendung von JAX-RS-Web-Services in WebSphere Application Server finden Sie im WebSphere Application Server Information Center.

JAX-RS-fähiges Webprojekt erstellen

Informationen zu diesem Vorgang

Der JAX-RS-Web-Service muss sich in einem Projekt befinden, bei dem die JAX-RS-Facette aktiviert ist.

Vorgehensweise

  1. Klicken Sie in der Java-EE-Perspektive mit der rechten Maustaste auf Ihr Unternehmensanwendungsprojekt und wählen Sie Neu > Webprojekt aus, um den Webprojektassistenten zu öffnen.
  2. Geben Sie im Feld Name einen Namen für Ihr neues Webprojekt ein.
  3. Wählen Sie im Abschnitt "Projektschablonen" den gewünschten Webschablonentyp aus. Wählen Sie Einfach aus, wenn Sie ein einfaches Webprojekt erstellen möchten.
  4. Wählen Sie im Abschnitt "Programmiermodell" das gewünschte Programmiermodell aus. Wählen Sie Java-EE-Programmiermodell aus. Klicken Sie auf Weiter, um Ihr neues Webprojekt zu konfigurieren.
  5. Klicken Sie auf der Implementierungsseite in der Liste der verfügbaren Konfigurationsoptionen auf Implementierung, um die Seite "Implementierungskonfiguration" zu öffnen.
    • Sie können die Ziellaufzeit ändern, indem Sie in der Dropdown-Liste eine andere Laufzeit auswählen. Klicken Sie auf Feature wechseln, um das Fenster Projektfacetten zu öffnen. Wählen Sie auf der Seite "Projektfacetten" JAX-RS (REST Web Services) aus und klicken Sie auf OK.
    • Klicken Sie auf Support für WebSphere-Bindings und -Erweiterungen hinzufügen oder wählen Sie dieses Feld ab.
    • Wählen Sie im Feld Webmodulversion die gewünschte Webmodulversion aus.
    • Klicken Sie im Feld EAR-Zugehörigkeit auf Projekt einer EAR hinzufügen, wenn Sie die EAR-Zugehörigkeit aufnehmen möchten. Wählen Sie dieses Feld ab, wenn das Webprojekt nicht zu einer EAR-Datei hinzugefügt werden soll.
    • Im Feld Name des EAR-Projekts erscheint der Name Ihrer vorhandenen EAR-Datei. Sie können auf Durchsuchen klicken, um eine andere EAR-Datei auszuwählen.
    Anmerkung: Die Implementierungsoption ist nicht verfügbar, wenn Sie für Ihr neues Webprojekt das nur clientseitige Programmiermodell ausgewählt haben.
  6. Klicken Sie in der Liste verfügbarer Konfigurationsoptionen auf REST-Services.
    1. Wählen Sie im Feld JAX-RS-Implementierungsbibliothek die Bibliothek für Ihre Serverversion aus. Beispiel: IBM WebSphere Application Server v8.0 JAX-RS Library oder IBM WebSphere Application Server 8.5 JAX-RS Library.
      Weitere Informationen zu Bibliotheken: Die JAX-RS-Bibliotheken der von Ihnen installierten WebSphere-Testumgebungen sind in dieser Dropdown-Liste aufgeführt. Falls Sie eine Nicht-WebSphere-Bibliothek verwenden möchten, kann diese mithilfe der Vorgabenseite für Benutzerbibliotheken importiert werden. Falls Sie "Benutzerbibliothek" auswählen, können Sie die Vorgabenseite für Benutzerbibliotheken aufrufen und eine Bibliothek hinzufügen. Sobald ein Projekt erstellt wurde, können Sie die Bibliothek ändern, indem Sie mit der rechten Maustaste auf Ihr Projekt klicken und Benutzervorgaben > Projektfacetten > JAX-RS auswählen. Sie können auch auswählen, dass der Assistent die Bibliothek nicht für Sie konfiguriert. In diesem Fall müssen Sie den Klassenpfad manuell konfigurieren.
    2. Falls Sie eine Version von WebSphere Application Server verwenden, die älter als Version 8 ist, markieren Sie Bibliothek in diese Anwendung einbeziehen und wählen danach aus, dass die Bibliothek als gemeinsam genutzte Bibliothek einbezogen wird. Wählen Sie dazu die Option Gemeinsam genutzte Bibliothek aus. Dadurch werden JAX-RS-JAR-Dateien zum Klassenpfad hinzugefügt und ein Eintrag über die gemeinsam genutzte Bibliothek wird in der erweiterten EAR-Datei hinzugefügt.
    3. Implementierungsdeskriptor aktualisieren ist standardmäßig ausgewählt, weil Sie eine Datei web.xml verwenden müssen, um Integritätsbedingungen für die Sicherheit und ein anderes Verhalten zu konfigurieren. Eine Datei web.xml wird auch dann generiert und mit JAX-RS-Servletinformationen aktualisiert, wenn Sie im Assistenten zuvor ausgewählt haben, dass kein Implementierungsdeskriptor generiert werden soll. Diese Option ist nur verfügbar, wenn die ausgewählte Web Modules-Facette eine Version ab Version 3.0 aufweist.
    4. Falls Sie ausgewählt haben, dass der Implementierungsdeskriptor aktualisiert werden soll, können Sie den Servletnamen und den Servletklassennamen sowie die URL-Zuordnungsmuster ändern.
  7. Sie können die Ziellaufzeit ändern, indem Sie in der Dropdown-Liste eine andere Laufzeit auswählen. Klicken Sie auf Feature wechseln, um das Fenster Projektfacetten zu öffnen.
    • Übernehmen Sie im Feld Quellenordner im Buildpfad das Standardverzeichnis src. Sie können auch auf Ordner hinzufügen, Bearbeiten... oder Entfernen klicken, um einen Ordner für Ihre Quellendateien anzugeben.
    • Geben Sie im Feld Standardausgabeordner: einen Ordner für Ihre Ausgabedateien an oder übernehmen Sie den Standardwert (WebContent\WEB-INF\classes).
  8. Klicken Sie in der Liste der verfügbaren Konfigurationsoptionen auf Webmodul. Gehen Sie auf der Seite Webmodulkonfiguration wie folgt vor:
    • Geben Sie im Feld Kontextstammverzeichnis den Namen des Stammelements Ihres Webprojekts ein oder übernehmen Sie den Standardwert (d. h. den Namen Ihres Webprojekts).
    • Geben Sie im Feld Inhaltsverzeichnis den Namen Ihres Verzeichnisses mit Inhalten ein oder übernehmen Sie den Standardwert (WebContent).
    • Wählen Sie Implementierungsdeskriptor web.xml generieren aus, wenn Sie einen Implementierungsdeskriptor erstellen möchten. Sie können auch später einen Implementierungsdeskriptor zu Ihrem Webmodul hinzufügen.
  9. Klicken Sie auf Fertigstellen.

JAX-RS-Web-Service erstellen

Vorgehensweise

  1. Erstellen Sie in Ihrem Webprojekt ein Paket (klicken Sie mit der rechten Maustaste auf Java-Ressourcen > src und wählen Sie Neu > Paket aus). Importieren Sie die Klassen für den Web-Service in das Paket.
  2. Öffnen Sie die Datei WebContent/WEB-INF/web.xml. In der Entwurfsansicht wählen Sie das JAX-RS-Servlet aus und klicken auf Hinzufügen. Fügen Sie einen Initialisierungsparameter zum JAX-RS-Servlet hinzu und lassen Sie die Felder für Name und Wert leer. Speichern Sie die Datei web.xml und ignorieren Sie alle Fehler, die möglicherweise angezeigt werden.
  3. Wählen Sie in der Ansicht mit den Markierungen den web.xml-Fehler bei param-name aus, klicken Sie mit der rechten Maustaste und wählen Sie Schnellkorrektur aus. Blättern Sie zu der Anwendung und treffen Sie Ihre Auswahl.
  4. Fügen Sie die EAR-Datei mit dem JAX-RS-Projekt zum Server hinzu und starten Sie den Server.

Ergebnisse

Jede Webanwendung muss ein Kontextstammverzeichnis haben, damit die Webanwendung erfolgreich implementiert werden kann. Ein Kontextstammelement für jedes Webmodul wird während der Anwendungsassemblierung oder der Anwendungsimplementierung im Anwendungsimplementierungsdeskriptor definiert. Das Kontextstammverzeichnis wird mit der definierten Servlet-Zuordnung (aus der WAR-Datei) zum vollständigen URL kombiniert, den die Benutzer eingeben müssen, um auf das Servlet zugreifen zu können. Die Kontextstammverzeichnis aller implementierten Webanwendungen müssen auf dem Server eindeutig sein. Das Kontextstammelement kann auch leer sein.

Falls zum Beispiel eine Webanwendung das Kontextstammelement sample/application/ verwendet hat, beginnt die Anforderungs-URL der Webanwendung mit http://<hostname>:<port>/sample/application/. Das URL-Muster eines Servlets wird an das Kontextstammelement der Webanwendung angehängt. Falls das Kontextstammelement sample/application/ lautet und die Servlet-URL-Zuordnung rest/api/* lautet, so ist der Basis-URI für die JAX-RS-Webanwendung http://<Hostname>:<Port>/sample/application/rest/api.

JAX-RS-Projekt bearbeiten

Sobald Sie einen JAX-RS-Web-Service erstellt haben, können Sie ihn bearbeiten, indem Sie mit der rechten Maustaste auf das Projekt klicken und Eigenschaften > Projektfacetten > JAX-RS auswählen. Auf dieser Seite können Sie Folgendes ändern:
  • Bibliothekstyp
  • JAX-RS-Servletname
  • JAX-RS-Servletklassenname
  • URL-Zuordnungsmuster
Wenn Sie Ihr Projekt beispielsweise auf einen anderen Server migrieren, können Sie den Bibliotheksprovider in einen anderen Provider ändern, der vom neuen Server unterstützt wird.
Symbol das den Typ des Artikels anzeigt. Taskartikel
Nutzungsbedingungen für Information Center | Feedback

Symbol für Zeitmarke Letzte Aktualisierung: 29.04.2014

Dateiname: tjaxrswebservcreate.html