RESTful Web Services (JAX-RS) mit Jersey

Durch das Jersey Projekt existieren Bibliotheken die es Java Entwicklern besonders einfach machen REST Web Services zu entwickeln. In diesem Tutorial werde ich zeigen wie einfach es ist eine Web Service zu schreiben der uns einfache Mathematische Berechnung zurückliefert. 1.) Wir erstellen in unserer Entwicklungsumgebung, in meinem Beispiel Eclipse, ein Web Projekt.  In das WEB-INF/lib Verzeichnis packen wir alle für Jersey benötigten JARs die es bei Jersey/Downloads runterzuladen gibt.  Für dieses Tutorial benötigen wir folgende Bibliotheken: jersey-server.jar, jersey-core.jar, jsr311-api.jar, asm.jar, jaxb-impl.jar, jaxb-api.jar, activation.jar, stax-api.jar 2.) In unserer WEB-INF/web.xml fügen wir folgendes hinzu:
  <servlet>
  	<display-name>JAX-RS REST Servlet</display-name>
  	<servlet-name>REST-Servlet</servlet-name>
  	<servlet-class>
  		com.sun.jersey.spi.container.servlet.ServletContainer
  	</servlet-class>
  	<load-on-startup>1</load-on-startup>
  </servlet>
  <servlet-mapping>
  	<servlet-name>REST-Servlet</servlet-name>
  	<url-pattern>/services/*</url-pattern>
  </servlet-mapping>
3.) Wir erstellen zwei Klassen die wir für unser Ergebniss benötigen. Die erste Klasse MathResults kapselt unsere Mathematischen Ergebnisse.
package de.wstest;
 
public class MathResults {
	private String formel;
	private Integer ergebniss;
	public String getFormel() {
		return formel;
	}
	public void setFormel(String formel) {
		this.formel = formel;
	}
	public Integer getErgebniss() {
		return ergebniss;
	}
	public void setErgebniss(Integer ergebniss) {
		this.ergebniss = ergebniss;
	}
}
Und die zweite Klasse ServiceResult ist das Result unseres WebService
package de.wstest;
 
import java.util.List;
 
import javax.xml.bind.annotation.XmlRootElement;
 
@XmlRootElement
public class ServiceResult {
	private String message;
	private Integer returncode;
	private List<MathResults> ergebnisse;
 
	public Integer getReturncode() {
		return returncode;
	}
	public void setReturncode(Integer returncode) {
		this.returncode = returncode;
	}
	public String getMessage() {
		return message;
	}
	public void setMessage(String message) {
		this.message = message;
	}
 
	public List<MathResults> getErgebnisse() {
		return ergebnisse;
	}
	public void setErgebnisse(List<MathResults> ergebnisse) {
		this.ergebnisse = ergebnisse;
	}
}
4.) Jetzt erstellen wir eine weitere Klasse CalculatorService, diese ist unser eigentlicher Webservice und wird durch Annotions als dieser gekennzeichnet. Ein gute Übersicht über zulässige Annotions findet Ihr im Wiki von Jersey.
package de.wstest;
 
import java.util.LinkedList;
import java.util.List;
 
import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.QueryParam;
 
@Produces("application/xml")
@Path("calculator")
public class CalculatorService {
 
	@GET
	@Path("calc")
	@Produces("application/xml")
	public ServiceResult add(@QueryParam("a") Integer a, @QueryParam("b") Integer b) {
 
		ServiceResult r = new ServiceResult();
		List<MathResults> ergs = new LinkedList<MathResults>();
 
		if(a == null || b == null)
		{
			r.setMessage("No Values!");
			r.setReturncode(8);
			r.setErgebnisse(ergs);
			return r;
		}
 
		r.setMessage("Results for Value a = "+a+", Value b = "+b);
		r.setReturncode(0);
		MathResults e1 = new MathResults();
		e1.setFormel("a + b");
		e1.setErgebniss(a+b);
		MathResults e2 = new MathResults();
		e2.setFormel("a - b");
		e2.setErgebniss(a-b);
		MathResults e3 = new MathResults();
		e3.setFormel("a * b");
		e3.setErgebniss(a*b);
 
		ergs.add(e1);
		ergs.add(e2);
		ergs.add(e3);
 
 
		r.setErgebnisse(ergs);
		return r;
	}
}
Fertig ist unsere RESTFull Webservice. Nach dem deployen in einem ServletContainer wie Tomcat erhalten wir nach einem Aufruf des Webservices im Browser http://localhost:8080/wstest/services/calculator/calc?a=234&b=456 folgendes Ergebniss:
<serviceResult>
	<ergebnisse>
		<ergebniss>690</ergebniss>
		<formel>a + b</formel>
	</ergebnisse>
	<ergebnisse>
		<ergebniss>-222</ergebniss>
		<formel>a - b</formel>
	</ergebnisse>
	<ergebnisse>
		<ergebniss>106704</ergebniss>
		<formel>a * b</formel>
	</ergebnisse>
	<message>Value a = 234, Value b = 456</message>
	<returncode>0</returncode>
</serviceResult>
Durch einen Aufruf der URL http://localhost:8080/wstest/services/application.wadl erhalten wir eine Übersicht über unsere Services und deren Parameter.
<application xmlns="http://research.sun.com/wadl/2006/10">
    <doc xmlns:jersey="http://jersey.dev.java.net/" jersey:generatedBy="Jersey: 1.0 10/13/2008 12:27 PM"/>
    <resources base="http://localhost:8080/wstest/services/">
        <resource path="calculator">
            <resource path="calc">
                <method name="GET" id="add">
                    <request>
                        <param xmlns:xs="http://www.w3.org/2001/XMLSchema" type="xs:int" style="query" name="a"/>
                        <param xmlns:xs="http://www.w3.org/2001/XMLSchema" type="xs:int" style="query" name="b"/>
 
                    </request>
                    <response>
                        <representation mediaType="application/xml"/>
                    </response>
                </method>
            </resource>
        </resource>
    </resources>
</application>
Fertig ist in wenigen Schritten unser REST Web Service der uns eine Liste von Berechnungen für einen Eingabe zurückliefert.

22 Comments

  1. Hegel

    Sehr gutes Tutorial.

    Reply
  2. jogep (Post author)

    Und hier gibt es den passenden PHP Client:

    http://www.jgeppert.com/2009/05/php-client-rest-webservice/

    Reply
  3. Pingback: Java, Webprogrammierung, Linux und mehr

  4. jogep (Post author)

    Den Client um den WebService mit Java abzufragen gibt es hier:
    http://www.jgeppert.com/2009/05/java-client-fuer-restful-web-services/

    Reply
  5. RestWebServicePadawan

    Zitat: “Nach dem deployen in einem ServletContainer wie Tomcat….”, wie schaut dieser Deployvorgang aus? bzw. wie deployt man diesen WebService im Glassfish?

    lg

    Reply
    1. jogep (Post author)

      Deine Entwicklungsumgebung sollte dir eine WAR-Datei oder eine EAR Datei erstellen können. Das kommt auf dein Projekt an. Wie man dann deployed hängt vom ServletContainer/Applicationserver ab.

      Beim Tomcat einfach die Datei in den TOMCAT_HOME/webapps Ordner ablegen.
      http://tomcat.apache.org/tomcat-5.5-doc/deployer-howto.html

      Beim Classfish gibt es da verschiedene Wege:
      https://glassfish.dev.java.net/javaee5/deployment/index.html

      Reply
    2. auch ein Padawan

      Könntest du mir auch noch einmal sagen, wie ich das dann deploye?
      danke =)

      Reply
      1. auch ein Padawan

        ach so ein mist – hier gibt es ja das +-Zeichen *gg*
        danke dann lese ich mir das mit dem deployen durch – danke

        Reply
      2. jogep (Post author)

        Exportiere dein Anwendung die du z.B. in Eclipse erstellt hast einfach als WAR-Datei (in Eclipse –> Export… –> Web –> WAR file) und kopiere die WAR Datei in den Deploy Pfad deines Anwendungsservers, bei Tomcat ist das dann das Verzeichnis webapps.

        Reply
  6. RestWebServicePadawan

    Hi danke für die schnelle Antwort und ja das mitn deploy-Vorgang ist auch kein Problem, eine Frage hätt ich noch, wie ist es möglich, dass ich dem WebService Objekte von eigenen definierten Klassen übergebe? also keine Longs Strings etc…

    Reply
    1. jogep (Post author)

      Meines Wissens kannst du bei REST WebServices nur mit einfachen Datentypen wie String, Integer und Long arbeiten. Wenn du komplexe Parameter brauchst solltest du dir die SAOP basierten WebServices ansehen.

      Reply
  7. david

    Cooles Tutorial! Danke!

    Reply
  8. Niels

    wollte das ganze gerne über Glassfish starten – er findet aber irgendwie den service nicht 🙁
    gibts da irgendwas besonderes zu beachten?

    Reply
    1. Christian

      @Niels
      Du musst aufpassen, daß die URI richtig/komplett ist
      bspw.
      http://localhost:{port}/{contextPath}/resources/{ResourcePath}
      context Deiner App sei beispielsweise TestWeb und im @Path der ResourceKlasse steht @Path(“myTest”)
      http://localhost:8080/TestWeb/resources/myTest

      Bei Vista und Win7 sollte Glassfish zudem nicht unter C:Program Files installiert sein (was er standardmäßig tut), da hier die Zugriffsrechte vom Betriebssystem eingeschränkt sind.

      Reply
  9. freak

    ich habs mit eclipse probiert, das war file zu erstellen und im tomcat deployed. ich hab das gleiche problem, er findet den service nicht,

    http://localhost:8080/RESTServlet/calculator/calc?a=234&b=456
    oder http://localhost:8080/calculator/calc?a=234&b=456
    funktioniert es nicht, das war file heißt RESTServlet.war
    kann mir wer helfen?

    mfg freak

    Reply
    1. jogep (Post author)

      Und funktioniert es mit dieser URL?

      http://localhost:8080/RESTServlet/services/calculator/calc?a=234&b=456

      Kannst du die Übersicht der Services aufrufen?

      http://localhost:8080/RESTServlet/services/application.wadl

      Reply
      1. stefan

        hey,

        danek für das tutorial. Leider funktioniert es allerdings bei mir auch nicht wirklich. Ich kann die Übersicht auch nicht aufrufen.

        ich erhalte den fehler
        The requested resource (/wstest/services/calculator/calc) is not available

        währe cool wenn du vielleicht eine idee hättest was da noch faul sein kann.

        lg

        Reply
  10. freak

    ah cool danke, geht

    da war mein fehler 😉

    Reply
  11. freak

    hallo,

    statt: @QueryParam(“a”) Integer a
    vllt: @QueryParam(“obj”) Objekt o

    gibs eine möglichkeit objekte zu übergeben, oder muesste man da @GET vllt nehmen, hat da wer vielleicht ein bsp, wäre super 🙂

    mfg freak

    Reply
    1. jogep (Post author)

      Siehe weiter oben, REST kann nur mit einfache Datentypen arbeiten.

      Reply
      1. freak

        ja, das hab ich gelesen, das kann ich mir aber nicht vorstellen? Irgendeine art Serialisation muesste es doch geben, oder hier: Bei
        “Extracting Request Parameters” http://wikis.sun.com/display/Jersey/Overview+of+JAX-RS+1.0+Features

        ist das nicht so ein bsp?
        ich bekomms nur nicht zum laufen ;(

        Reply
  12. Rookie

    Danke für das Tutorial, hat auf anhieb geklappt.

    Reply

Leave a Reply