RESTful Services mit Java EE

Transkript

1 RESTful Services mit Java EE Thilo Frotscher Vorstellung Freiberuflicher Softwarearchitekt und Trainer Fachliche Schwerpunkte Java Plattform Services und Integration Kundenspezifische Inhouse-Schulungen (Co-)Autor von 2 Büchern & zahlreichen Artikeln Sprecher auf internationalen Konferenzen 1

2 Agenda Überblick JAX-RS 1.1 und Java EE 6 Ausblick JAX-RS 2.0 Zusammenfassung RESTful Services mit Java EE JAX-RS (Java API for RESTful Web Services) Bestandteil von Java EE seit Version 6 Referenzimplementierung: Jersey JAX-RS stark annotationsbasiert Entwicklung von Ressourcen/Services & Clients WADL Support 2

3 Containerauswahl Java EE 6 unterstützt XML Services durch JAX-WS 2.2 für SOAP-basierte Services JAX-RS 1.1 für RESTful Services Beide sind nicht Bestandteil des Web Profile Support für Java EE 6 Full Profile wird benötigt Java EE 7 erweitert das Web Profile um JAX-RS (aber nicht JAX-WS) Containerauswahl Application Server mit vollem Java EE 6-Support Glassfish 3.x, WebLogic 12.1, JBoss 7.x, Geronimo 3.0, WebSphere 8.x, WebSphere Community Edition 3.0, TMAX JEUS 7, Fujitsu Interstage 10.1 Web Container (Tomcat, Jetty, ) keine direkte Unterstützung von JAX-WS oder JAX-RS entsprechende Laufzeitumgebung selbst einrichten (ggf. unter Verwendung von OpenEJB bzw. TomEE) 3

4 Frameworkauswahl Referenzimplementierung: Jersey Open Source-Alternativen Restlet, Apache CXF, RESTEasy Wir betrachten heute: Jersey Grenzen & Alternativen Ressourcen Ressourcen sind Klassen mit mindestens auf Typ- oder dient der Deklaration der URL unter welcher die markierte Klasse bzw. Methode erreichbar ist von Parametern für die Methode (URL-Bestandteile oder HTTP-Formulardaten) 4

5 Beispiel: Root public class @Produces("text/xml") public List<Item> @Produces("text/xml") public Item listitem(@pathparam("item.id") String id) zeigt der JAX-RS Runtime an, in welches Format der Rückgabewert transformiert werden soll. Annotationen 5

6 @Path Relativer URI-Pfad Verwendung von Variablen in Zuweisung an Methodenparameter: public String getuser String username) Verwendung von regulären Ausdrücken MIME-Types möglicher Repräsentationen einer Ressource Methoden können mehrere "application/json") public String dogetasxmlorjson() {... Auswahl auf Basis des Request Headers Accept Accept: text/plain;q=0.9, text/html 6

7 @Consumes Konsumierbare MIME-Types einer @Consumes(MediaType.APPLICATION_XML) public void createneworder(order order) {... Typenumwandlung anhand des MIME-Types HTTP Response Codes Methode mit Rückgabewert: void HTTP Status Code: 204 (No Content) Rückgabewert vom public Response createneworder(order order) { String id = orderservice.createorder(order); URI uri = context.getabsolutepathbuilder().path(id).build(); return Response.created(uri).build(); 7

8 Transformation von Daten JAX-RS Entity Providers transformieren zwischen Java Typen und diversen Repräsentationen MessageBodyReader, MessageBodyWriter JAX-RS Implementierungen müssen unterstützen: String, byte[], InputStream, File, Reader, DataSource JAXB-Klassen HTTP-Formulardaten (MultivaluedMap<String,String>) Viele Frameworks unterstützen zudem JSON direkt, manche auch FastInfoset, Atom, YAML Services und Java EE-Infrastruktur JAX-RS Ressourcen lassen sich im Web- oder im EJB-Container als Dienst deployen jedoch ausschließlich Session Bean Zusätzlich den Zugriff auf Kontextinformationen des Web-Containers Servlet Context HttpServletRequest, HttpServletResponse Injection von Business Services mit CDI 8

9 JAX-RS 2.0 JAX-RS 2.0 (JSR-339) Bestandteil von Java EE 7 Aktueller Stand: Public Review (September 2012) Referenzimplementierung Jersey 2.0 Aktueller Stand: Milestone 9 (Ende Oktober) 9

10 Neuigkeiten in JAX-RS 2.0 Client-API Filters & Entity Interceptors Support für Asynchronität (Server & Client) Sonstiges Client API Standard-API ersetzt proprietäre Lösungen Einiges von serverseitiger API übernommen (z.b. Message Body Reader / Writer) Fluent API Client client = ClientFactory.newClient(); String balance = client.target(" "1234").request(MediaType.TEXT_PLAIN).get(String.class); Money balance = client.target(" "1234").request(MediaType.APPLICATION_JSON).post(Entity.text("50.0"), Money.class); 10

11 Client API Trennung von Request-Erzeugung/Versand Command-Pattern für Batch-Processing von Requests Invocation inv1 = client.target(" "1234").request("text/plain").buildGet(); Invocation inv2 = client.target(" "1234").request("application/json").buildPost(Entity.text("50.0"));... String strbalance = inv1.invoke(string.class); Money moneybalance = inv2.invoke(money.class); Filters & Entity Interceptors Implementierung von Querschnittsfunktionen Logging, Kompression, Security etc. Standard ersetzt bisherige proprietäre Lösungen Filter Non-wrapping Chain: Aufruf erfolgt durch Container Modifizieren/verarbeiten Request- & Response-Header Entity Interceptors Wrapping Chain: Handler ruft den jeweils nächsten auf Marshalling/Unmarshalling von HTTP Message Bodies 11

12 Server-Side Filters ContainerRequestFilter und ContainerResponseFilter Ausführung vor/nach Aufruf der Ressourcen-Methode Beispiel 1: class LoggingFilter implements ContainerRequestFilter, ContainerResponseFilter public void filter(containerrequestcontext ctx){ public void filter(containerresponsecontext ctx) { logresponse(ctx.getresponse()); Server-Side Filters Beispiel 2: Automat. Setzen des Cache-Control public class CacheControlFilter implements ContainerResponseFilter public void filter(containerrequestcontext req, ContainerResponseContext res) { String cachecontrol =...; if (req.getmethod().equals("get")) { req.getheaders().add("cache-control", cachecontrol); Analog: ClientRequestFilter & ClientResponseFilter 12

13 Entity Interceptors Implementieren ReaderInterceptor oder WriterInterceptor Wrapper für readto/writefrom Methoden der Klassen MessageBodyReader / -Writer Je eine Interceptor-Kette für jeden Typ Aufruf in Reihenfolge entsprechend ihrer Priorität Festlegen der Priorität (definiert diverse eingebaute class GzipInterceptor implements ReaderInterceptor, WriterInterceptor public Object aroundreadfrom(readerinterceptorcontext ctx) throws IOException, WebApplicationException { InputStream old = ctx.getinputstream(); ctx.setinputstream(new GZIPInputStream(old)); try { return ctx.proceed(); finally { public void aroundwriteto(writerinterceptorcontext ctx) throws IOException, WebApplicationException { OutputStream old = ctx.getoutputstream(); GZIPOutputStream gzipoutputstream = new GZIPOutputStream(old); ctx.setoutputstream(gzipoutputstream); try { ctx.proceed(); finally { gzipoutputstream.finish(); ctx.setoutputstream(old); 13

14 Asynchrone Verarbeitung (Server) Suspend/Resume der Verbindung zum public class MyResource { suspend client public void longrunningop(@suspended final AsyncResponse ar) { Executors.newSingleThreadExecutor().submit( new Runnable() { public void run() { executelongrunningop(); ar.resume("hello async world!"); ); fork (non-request) thread, optional timeout resume client connection, return result object Asynchrone Verarbeitung (Server) Stateless / Singleton public class public void longrunningop(@suspended AsyncResponse ar) { executelongrunningop(); ar.resume("hello async world!"); EJB Container allokiert Ressourcen für Methode automatisch kein Executor notwendig 14

15 Asynchroner Request (Client) Aufruf von get() nach async() ist nicht blockierend Typ-Parameter für InvocationCallback Client client = ClientFactory.newClient(); Target target = client.target(" target.pathparam("id", 123).request().async().get( new InvocationCallback<Customer>() public void completed(customer customer) { // Do public void failed(invocationexception error) { // Process error ); Validation Integration von JAX-RS mit Bean Validation API Support für Constraint-Annotationen in Fields / Properties, Parameter, Methoden, class public void @FormParam("category") String cat) {... Bei Verletzung eines Constraints wird Methode nicht aufgerufen (Response: 400 Bad Request) 15

16 Validation Validierung von Request bewirkt Aufruf zur Validierung des class Product class public void addproduct(@valid Product product) {... JAX-RS 2.0: Sonstiges Hypermedia (HATEOAS) Support nur für Transitional Links (in Headers) Verändern des Zustands einer Ressource Weiterhin kein Support für Structural Links Dependency Injection Integration von JSR-330 (DI for Java) mit JAX-RS soll abgelöst werden vorübergehend werden beide Wege unterstützt 16

17 Zusammenfassung JAX-RS 1.1 bietet bereits gute Unterstützung für RESTful Services in Java EE 6 Entwickler kommen schnell zu ersten Ergebnissen Client-API leider nicht standardisiert JAX-RS 2.0 mit umfangreichen Erweiterungen standardisierte Client-API Filter & Handler Support für Asynchronität Validierung Thilo Frotscher Kundenspezifisches Training und Beratung zu Java EE, Services und Integration thilo@frotscher.com 17