Denkt man an Web-APIs, dann verbindet man das zugehörige Kommunikationsmodell meist mit RESTful Requests und Responses. Dies ergibt in vielen Fällen sicherlich auch Sinn, aber eben nicht in allen! Was ist z.B., wenn auf Seiten des Clients komplexe Abfragen anstehen, die sich nicht so einfach über simple “Ressourcen” abbilden lassen. Wie geht man damit um, wenn auf dem Server lang laufende Aktionen angestoßen werden, auf deren Abarbeitung der Client nicht unbedingt warten möchte? Und muss es eigentlich immer clientseitiges “Pull” sein oder ergibt nicht serverseitiges “Push” via WebSocket in vielen Anwendungsfällen mehr Sinn? Die Session zeigt anhand ausgewählter praxisnaher Use Cases, wie man durch verschiedene Patterns das klassische RESTful Request-/Response-Modell seines Web-API sinnvoll erweitern kann, und so zu deutlich eleganteren und performanteren Lösungen kommt.

1. Lars Röwekamp | CIO New Technologies | open knowledge GmbH
#WISSENTEILEN
@_openKnowledge
@mobileLarson
Web APIs
jenseits von REST & Request/Response

2. ÜBER OPEN KNOWLEDGE
Branchenneutrale Softwareentwicklung und IT-Beratung
#WISSENTEILEN

3. ÜBER MICH
Wer bin ich - und wen ja, wie viele?
• CIO New Technologies
• Enterprise & Mobile
• Autor, Speaker, Coach & Mentor
• Snowboard & MTB Enthusiast
• Mehrfacher Vater, einfacher Ehemann
Lars Röwekamp (a.k.a. @mobileLarson)
#WISSENTEILEN
LR

4. Living in a
RESTful World

6. #WISSENTEILEN
lang laufende Anfragen
serverseitige Ereignisse
komplexe Abfragen
„Sorry, ich bin leider
nicht so gut in ...“*
*REST @work

7. „But it‘s not
REST if you
do (not) ...“

8. Mein Server
und ich ...
#WISSENTEILEN
„WT#!?“ *
(*a.k.a. „i don‘t care as long as it works for me.“)

9. #WISSENTEILEN
lang laufende
Anfragen

10. #WISSENTEILEN
Request-Response Modell

11. #WISSENTEILEN
Request-Response Modell

12. #WISSENTEILEN
Request-Response Modell

13. #WISSENTEILEN
I had a
Dream

14. #WISSENTEILEN
Reactive-Flow Modell

15. #WISSENTEILEN
public interface ReactiveMongoDBOperations {
<T> Mono<T> find (Query query, Class<T> entityClass);
<T> Flux<T> findAll(Query query, Class<T> entityClass);
<T> Mono<T> insert(T objectToSave, String collectionName);
<T> Mono<T> insert(Mono<? extends T> objectToSave);
}

16. #WISSENTEILEN
RouterFunction<?> route = route(GET("/persons/{id}"), request -> {
Mono<Person> person = Mono.justOrEmpty(request.pathVariable("id"))
.map(Integer::valueOf)
.then(repository::find);
return Response.ok().body(fromPublisher(person, Person.class));
}));

17. #WISSENTEILEN
RouterFunction<?> route = route(GET("/persons/{id}"), request -> {
Mono<Person> person = Mono.justOrEmpty(request.pathVariable("id"))
.map(Integer::valueOf)
.then(repository::find);
return Response.ok().body(fromPublisher(person, Person.class));
}).and(route(GET("/persons"), request -> {
Flux<Person> people = repository.findAll();
return Response.ok().body(fromPublisher(people, Person.class));
}));

18. #WISSENTEILEN
RouterFunction<?> route = route(GET("/persons/{id}"), request -> {
Mono<Person> person = Mono.justOrEmpty(request.pathVariable("id"))
.map(Integer::valueOf)
.then(repository::find);
return Response.ok().body(fromPublisher(person, Person.class));
}).and(route(GET("/persons"), request -> {
Flux<Person> people = repository.findAll();
return Response.ok().body(fromPublisher(people, Person.class));
}).and(route(POST("/persons"), request -> {
Mono<Person> person = request.body(toMono(Person.class));
return Response.ok().build(repository.insert(person));
}));

19. #WISSENTEILEN
„Are u kidding?“
?

20. #WISSENTEILEN
HTTP /1.0 202 Accepted
Location: http://....

21. #WISSENTEILEN
Fire & Forget*

22. #WISSENTEILEN
Polling Modell

23. #WISSENTEILEN
@PUT
@Consumes(MediaType.APPLICATION_JSON)
public Response processOrder(Order order) throws ... {
UUID orderId = orderService.process(order);
return Response
.accepted(). // HTTP accepted 202
.location(new URI(„orders/“ + orderId + „/status“))
.build();
}
Fire & Forget* mit JAX-RS
(* eigentlich Polling!)

24. #WISSENTEILEN
@GET
@Path("/{orderNo}")
@Produces(MediaType.APPLICATION_JSON)
public Response getOrder(@PathParam("orderNo") UUID orderNo) {
Order order = orderService.getOrder(orderNo);
if (order.isEmpty()) {
return Response.noContent().build();
} else {
return Response.ok().entity(order).build();
}
}
Polling mit JAX-RS

25. #WISSENTEILEN
Long-Polling

26. #WISSENTEILEN
Long Polling Modell

27. #WISSENTEILEN
@POST
public void createCustomer(Customer customer,
@Suspended AsyncResponse asyncResponse) {
Response response = createCustomer(customer);
asyncResponse.resume(response);
}
asynchronous JAX-RS 2.0

28. #WISSENTEILEN
@POST
public void createCustomer(Customer customer,
@Suspended AsyncResponse asyncResponse) {
asyncResponse.setTimeout(10, TimeUnit.SECONDS);
asyncResponse.setTimeoutHandler(ar -> ar.resume(
Response.status(Status.SERVICE_UNAVAILABLE)
.entity("Operation timed out").build()));
Response response = createCustomer(customer);
asyncResponse.resume(response);
}
asynchronous JAX-RS 2.0

29. #WISSENTEILEN
@POST
public void createCustomer(final Customer customer,
@Suspended final AsyncResponse asyncResponse) {
asyncResponse.setTimeout(10, TimeUnit.SECONDS);
asyncResponse.setTimeoutHandler(...);
executor.execute(() -> {
Response response = createCustomer(customer);
asyncResponse.resume(response);
});
}
asynchronous JAX-RS 2.0

30. #WISSENTEILEN
@POST
public void createCustomer(final Customer customer,
@Suspended final AsyncResponse asyncResponse) {
asyncResponse.register(throwable -> {
if (throwable != null) {
LOG.error("Operation failed.", t);
return;
}
LOG.info("Operation successful.");
});
...
}
asynchronous JAX-RS 2.0

31. #WISSENTEILEN
Client client = ClientBuilder
.newBuilder().build()
.target("https://...")
.request().async()
.get(new InvocationCallback<Result>() {
public void completed(Result result) {
...
}
public void failed(Throwable error) {
...
}
});
asynchronous JAX-RS 2.0

32. #WISSENTEILEN
Piggy-Back

33. #WISSENTEILEN
Piggy Bag Modell

34. #WISSENTEILEN
HTTP/1.0 200 OK
Server: ...
MIME-Version: 1.0
Content-Type: multipart/x-mixed-replace;boundary=EOM
--EOM
Content-Type application/json
{...}
--EOM
Content-Type application/octet-stream
{...}
--EOM
Piggy Back mit REST

35. #WISSENTEILEN
Piggy Back mit JAX-RS 2.0
(*nur via eigenem MessageBodyWriter)

36. #WISSENTEILEN
public class BooksResource {
@Produces("multipart/mixed")
public Map<String, Object> getBooks() {
Map<String, Object> map
= new LinkedHashMap<String, Object>();
map.put("text/xml", new JaxbBook());
map.put("application/json", new JSONBook());
map.put("application/octet-stream", imageInputStream);
return map;
}
...
}
Piggy Back mit APACHE CXF

37. #WISSENTEILEN
serverseitige
Ereignisse

38. #WISSENTEILEN
serverseitige
Ereignisse

39. #WISSENTEILEN

40. #WISSENTEILEN

41. #WISSENTEILEN

42. #WISSENTEILEN
Was steckt dahinter?
• Paradigmenwechsel in der Kommunikation
• Abkehr vom klassischen Request/Response
• Client meldet sich am Server an
• Server kann Client jederzeit “Daten“ schicken
• Session kann von beiden Seiten beendet werden
Serverseitige Ereignisse

43. #WISSENTEILEN
Server-Sent Events

44. #WISSENTEILEN
Server-Sent Event Modell

45. #WISSENTEILEN
Was sind Server-Sent Events?
• senden von Daten vom Server zum Client
• nutzt normales HTTP Protokoll
• built-in Support für Reconnection
• via JS, falls kein Browser Support vorhanden
• lediglich UTF-8 Daten (keine Binärdaten)
• Limitierung der offenen Connections
Server-Sent Event 1x1

46. #WISSENTEILEN
HTTP/1.0 202 Accepted
Content-Type: text/event-stream
event: event-name
id: unique id
data: custom data
Server-Sent Event Protokoll

47. #WISSENTEILEN
var eventSource = new EventSource(url);
eventSource.addEventListener("event-name", function(e) {
...
});
Server-Sent Event JS Client

48. #WISSENTEILEN
@WebServlet(urlPatterns = "/status", asyncSupported = true)
public class SseServlet extends HttpServlet {
...
protected void doGet(HttpServletRequest req, HttpServletResponse res)
throws IOException {
AsyncContext context = req.startAsync();
... // put context to queue and finish doGet (connect)
}
protected void asyncProcessing() {
context.getResponse().getWriter();
}
}
Server-Sent Event mit AsyncServlet*
(*SSE „hand-made“ Edition)

49. #WISSENTEILEN
// register process
...
private SseBroadcaster channel;
@GET
@Path("subscribe")
@Produces(MediaType.SERVER_SENT_EVENTS) // "text/event-stream"
public void subscribe(@Context Sse sse, @Context SseEventSink eventSink) {
String uuid = UUID.randomUUID().toString();
OutboundSseEvent event = sse.newEventBuilder()
.id(uuid).data(“Subscription accepted. ID – “+ uuid).build();
eventSink.send(event).
channel.register(eventSink);
}
Server-Sent Event mit Java EE 8*
(*SSE „Standard“ Edition)

50. #WISSENTEILEN
// broadcast to registerd client
...
private SseBroadcaster channel;
public void update() {
OutboundSseEvent event = sse.newEventBuilder()
.name(...).data(myJsonObject).mediaType(APPLICATION_JSON_TYPE).build();
channel.broadcast(event);
}
Server-Sent Event mit Java EE 8*
(*SSE „Standard“ Edition)

51. #WISSENTEILEN
WebSockets

52. #WISSENTEILEN
Websocket Modell

53. #WISSENTEILEN
Was ist WebSockets?
• Full-Duplex Real-Time Kommunikation
• extrem leichtgewichtig dank HTTP Upgrade
• breiter Browser-Support
• Client eröffnet die Session
• Client und/oder Server sendet Nachricht(en)
• Client und/oder Server beendet Session
WebSockets 1x1

54. #WISSENTEILEN

55. #WISSENTEILEN
var socket = new WebSocket("ws://host:8080/path/");
socket.onopen = function(event) {...}
socket.onmessage = function(event) {...}
socket.onclose = function(event) {...}
socket.onerror = function(event) {...}
socket.send("Message-Inhalt");
WebSocket JS Client

56. #WISSENTEILEN
@ServerEndpoint("/socket")
public class MySocketEndpoint {
@OnOpen
public void open(Session newSession) {
try {
newSession.getBasicRemote().sendText("hello, thx for connecting");
} catch (IOException | EncodeException e) {...}
}
@OnMessage
public void receive(String message) { ... }
}
WebSocket mit Java EE 7+

57. #WISSENTEILEN
komplexe
Abfragen

58. #WISSENTEILEN
// Bestellungen: Kaffee mit Milch zu 2 €
GET /orders?type=coffee&ingredient=milk&price=2
Komplexe Abfragen mit REST
btw: UND oder ODER oder UND/ODER?

59. #WISSENTEILEN
// Bestellungen: Kaffee mit Milch oder günstiger als 2 €
GET /orders?type=coffee;ingredient=milk,price<=2
Komplexe Abfragen mit REST
btw: Klammerung?

60. #WISSENTEILEN
// Bestellungen: Kaffee mit Milch oder günstiger als 2 €
// RQL query ... (must possibly be encoded!)
GET /orders?query=
and(eq(type,coffee),
or(eq(ingredients,MILK),lt(price,2))
// RQL alternative query – FIQL (URI friendly) - ...
GET /orders?query=
type==coffee;(ingredients==MILK,price=lt=2)
Komplexe Abfragen mit RQL*
*https://github.com/persvr/rql

61. #WISSENTEILEN
Resource Query Language
• Object-Style Query Language
• FIQL Superset (erweiterbar)
• Spezifikation & JS Parser (Client & Server)
• JS Array, SQL, MongoDB, Elastic Search
• Java Parser + JPA Criteria Builder
Komplexe Abfragen mit RQL*
*https://github.com/persvr/rql

62. #WISSENTEILEN
Komplexe Abfragen mit REST

63. #WISSENTEILEN
Wer genau ist eigentlich dieser „Luke“?
GET /people/1
Komplexe Abfragen mit REST

64. #WISSENTEILEN
Wer genau ist eigentlich dieser „Luke“ und in welchen Filmen
hat er mitgespielt?
GET /people/1/films (falls es der Endpoint anbietet)
GET /films/1
GET /films/2
GET /films/3
Komplexe Abfragen mit REST

65. #WISSENTEILEN
Wer genau ist eigentlich dieser „Luke“ und in welchen Filmen
hat er mitgespielt und auf welchen Raumschiffen ist er darin gefahren?
GET /people/1/starships (falls es der Endpoint anbietet)
GET /starships/12
GET /starships/22
Komplexe Abfragen mit REST

66. #WISSENTEILEN
Wie alt ist Luke und welche Haarfarbe hat er?
Mit welchem Spruch wurden die Filme eröffnet, in denen er mitgespielt hat?
Und wie teuer waren überhaupt die Raumschiffe auf denen er gefahren ist?
GET /?F#CKING/detail (n+1 problem)
GET /?F#CKING/all (job problem)
Komplexe Abfragen mit REST

67. #WISSENTEILEN
Umdenken, du musst!

68. #WISSENTEILEN
Motivation:
„ We see a conflict between the desire to load all
information in a single round trip while keeping REST
resources well isolated.”
Komplexe Abfragen: „Umdenken du musst!“
(Facebook, 2012)

69. #WISSENTEILEN
Motivation:
Komplexe Abfragen: „Umdenken du musst!“
(Facebook, 2012)

70. #WISSENTEILEN
GraphQL Idee:
• Beliebige Abfragen via Objekt-Graph
auf dem ich navigieren kann.
• Lieferung des Abfrage-Results in einem
einzigen Round-Trip.
Komplexe Abfragen: „Umdenken du musst!“

71. #WISSENTEILEN

72. #WISSENTEILEN

73. #WISSENTEILEN

74. #WISSENTEILEN
Was zeichnet GraphQL aus?
• hierarchicial
• product centric
• strongly typed & instrospective
• client specific queries
• application-layer protokol
GraphQL Charakteristika

75. #WISSENTEILEN
Fragen, was du willst,
du musst!

76. #WISSENTEILEN

77. #WISSENTEILEN
Komplexe Abfragen mit GraphQL
Wie alt ist Luke und welche
Haarfarbe hat er?
Mit welchem “Spruch“ wurden
die Filme eröffnet in denen er
mitgespielt hat?
Und wie teuer waren
überhaupt die Schiffe auf
denen er gefahren ist?

78. #WISSENTEILEN
{
person(name:„Luke“) {
haircolor,
age
films {
name,
openiningCrawl
}
starships {
name,
price
}
}
}
Komplexe Abfragen mit GraphQL
Wie alt ist Luke und welche
Haarfarbe hat er?
Mit welchem “Spruch“ wurden
die Filme eröffnet in denen er
mitgespielt hat?
Und wie teuer waren
überhaupt die Schiffe auf
denen er gefahren ist?

79. #WISSENTEILEN
{
person(name:„Luke“) {
haircolor,
age
films {
name,
openiningCrawl
}
starships {
name,
price
}
}
}
Komplexe Abfragen mit GraphQL
Wie alt ist Luke und welche
Haarfarbe hat er?
Mit welchem “Spruch“ wurden
die Filme eröffnet in denen er
mitgespielt hat?
Und wie teuer waren
überhaupt die Schiffe auf
denen er gefahren ist?

80. #WISSENTEILEN
{
person(name:„Luke“) {
haircolor,
age
films {
name,
openiningCrawl
}
starships {
name,
price
}
}
}
Komplexe Abfragen mit GraphQL
Wie alt ist Luke und welche
Haarfarbe hat er?
Mit welchem “Spruch“ wurden
die Filme eröffnet in denen er
mitgespielt hat?
Und wie teuer waren
überhaupt die Schiffe auf
denen er gefahren ist?

81. #WISSENTEILEN
{
person(name:„Luke“) {
haircolor,
age
films {
name,
openiningCrawl
}
starships {
name,
price
}
}
}
Komplexe Abfragen mit GraphQL
Wie alt ist Luke und welche
Haarfarbe hat er?
Mit welchem “Spruch“ wurden
die Filme eröffnet in denen er
mitgespielt hat?
Und wie teuer waren
überhaupt die Schiffe auf
denen er gefahren ist?

82. #WISSENTEILEN
{
person(name:„Luke“) {
haircolor,
age
films {
name,
openiningCrawl
}
starships {
name,
price
}
}
}
Komplexe Abfragen mit GraphQL
Wie alt ist Luke und welche
Haarfarbe hat er?
Mit welchem “Spruch“ wurden
die Filme eröffnet in denen er
mitgespielt hat?
Und wie teuer waren
überhaupt die Schiffe auf
denen er gefahren ist?

83. #WISSENTEILEN
{
person(name:„Luke“) {
haircolor,
age
films {
name,
openiningCrawl
}
starships {
name,
price
}
}
}
Komplexe Abfragen mit GraphQL
Wie alt ist Luke und welche
Haarfarbe hat er?
Mit welchem “Spruch“ wurden
die Filme eröffnet in denen er
mitgespielt hat?
Und wie teuer waren
überhaupt die Schiffe auf
denen er gefahren ist?

84. #WISSENTEILEN

85. #WISSENTEILEN

86. #WISSENTEILEN
Woher weiß das Backend was ich will?
• API Schema als gemeinsame Basis
• Query als Anfrage vom Client
• Step 1: parse (Query into an abstract syntax tree)*
• Step 2: validate (against Schema)**
• Step 3: execute (Resolve Functions)
GraphQL und das Backend
(*syntaktisch korrekt , **semantisch korrekt)

87. #WISSENTEILEN
// A very simple GraphQL schema example
type Character {
name: String! // non nullable
appearsIn: [Episode]! // array of ..., non nullable
}
type Starship {
id: ID! // unique ID
name: String!
length(unit: LengthUnit = METER): Float // parameter
}
GraphQL und das Backend

88. #WISSENTEILEN
GraphQL
vs.
REST Aggregation?
Aggregation?
Aggregation?

89. #WISSENTEILEN
GraphQL
vs.
REST
Aggregation!

90. #WISSENTEILEN
Der GraphQL Server
• Query Parser
• Data Fetcher
• Data Aggregator
• Chaching von Result Graphs
• Aktuallisierung von Result Graphs
GraphQL und das Backend

91. #WISSENTEILEN
Muss ich das alles selber bauen?
• Nein! Es gibt ...
• Clients, Server, DB, Libraries, Tools ...
für Java, JavaScript, Python, Ruby, PHP, C/C++, GO, Scala, .Net,
SQL, ...
> http://graphql.org
> https://github.com/chentsulin/awesome-graphql
GraphQL und das Backend

92. #WISSENTEILEN
Cool, ist das wirklich alles so einfach?
• relative neue Technologie (im Fluss)
• Chaching?
• Dupletten?
• Information Hiding?
• Versionierung? (vs. deprecated)
GraphQL und Ich

93. #WISSENTEILEN

94. ? ? ?
FRAGEN
#WISSENTEILEN

95. Kontakt
LARS RÖWEKAMP
CIO NEW TECHNOLOGIES
lars.roewekamp@openknowledge.de
+49 (0)441 4082 – 101
@mobileLarson
@_openknowledge
OFFENKUNDIGGUT
#WISSENTEILEN

96. Bildnachweise
#01: © kenishirotie – shutterstock.com
#13: © RichVintage – istockphoto.com
#18: © pathdoc – shutterstock.com
#67: © jpgfactory – istockphoto.com
All other pictures inside this presentation orginate from
pixabay.com.
#WISSENTEILEN