Deze workshop is deel van de OOSE DEA Course aan de Hogeschool Arnhem/Nijmegen. Onderwerp is het bekend raken met Jakarta EE en JAX-RS in het bijzonder.
In deze workshop wordt stap-voor-stap een RESTful API gemaakt, met behulp van JAX-RS. We zullen ingaan op het maken van REST Resources en het afhandelen van verschillende HTTP methodes. Ook zullen we werken met verschillende Media Types en zullen we automatisch JSON genereren en inlezen. Tot slot zullen we ook nette foutafhandeling toe voegen, met behulp van zogenaamde Exception Mappers.
Voor deze oefening moet WildFly 25.0.0.Final Preview EE 9.1 Distribution geïnstalleerd zijn. Download het zip-bestand en pak het uit.
- Maak met IntellJ een nieuw Java project aan: File->New->Project (Language: "Java", Build System: "Maven", JDK: 17).
- Pas de groupId aan naar
nl.han.oose.dea
en de artifactId aan naarsimplytherest
- Als default zal Maven de gecompileerde klassen samenbundelen tot een
.jar
bestand. Voor een Jakarta EE project moet dit echter een.war
bestand zijn. Lees op de website van Maven na hoe je dit aanpast - Voeg een build-sectie toe net onder de properties en voor de
</project
tag:
<build>
<finalName>${artifactId}</finalName>
<pluginManagement>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-war-plugin</artifactId>
<version>3.3.2</version>
<configuration>
<warSourceDirectory>src/main/webapp</warSourceDirectory>
<warName>${project.artifactId}</warName>
<failOnMissingWebXml>false</failOnMissingWebXml>
</configuration>
</plugin>
<plugin>
<artifactId>maven-clean-plugin</artifactId>
<version>3.1.0</version>
</plugin>
<plugin>
<artifactId>maven-resources-plugin</artifactId>
<version>3.0.2</version>
</plugin>
<plugin>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.8.0</version>
</plugin>
<plugin>
<artifactId>maven-surefire-plugin</artifactId>
<version>2.22.1</version>
</plugin>
<plugin>
<artifactId>maven-jar-plugin</artifactId>
<version>3.0.2</version>
</plugin>
<plugin>
<artifactId>maven-install-plugin</artifactId>
<version>2.5.2</version>
</plugin>
<plugin>
<artifactId>maven-deploy-plugin</artifactId>
<version>2.8.2</version>
</plugin>
<plugin>
<artifactId>maven-site-plugin</artifactId>
<version>3.7.1</version>
</plugin>
<plugin>
<artifactId>maven-project-info-reports-plugin</artifactId>
<version>3.0.0</version>
</plugin>
</plugins>
</pluginManagement>
</build>
Alleen de eerste plugin zou nieuw moeten zijn voor je, daarmee kun je met Maven op een goede manier een war-bestand maken.
- Om hier nu een Jakarta EE 9.1 project van te maken voeg je een dependency toe op Jakarta EE 9.1:
<dependencies>
<dependency>
<groupId>jakarta.platform</groupId>
<artifactId>jakarta.jakartaee-api</artifactId>
<version>9.1.0</version>
<scope>provided</scope>
</dependency>
</dependencies>
- Tot slot moeten we de klassen toevoegen die in de huidige repository te vinden zijn. Dit betreft de volledige
services
map, inclusief alle submappen en bestanden.- Kopieer de map
services
naar je project, naar een nieuwe packagenl.han.oose.dea.rest
. Zorg ervoor dat je je project kunt compileren met Maven op de command line. Probeer eerstmvn compile
en als dat goed gaatmvn package
en check of er uit die laatste stap een war-bestand komt.
- Kopieer de map
De klassen uit services
zullen we verderop gaan gebruiken.
Om snel te kunnen testen of de applicatie wel wil deployen is het raadzaam als eerste een REST-Resource te maken die daarvoor gebruik kan worden en die verder geen complexiteit toevoegt. Daarvoor zijn twee stappen nodig:
- Maak een nieuwe package
nl.han.oose.dea.rest.resources
en maak daarin de klasseSimplyTheRestApplication
met de volgende inhoud:
import jakarta.ws.rs.ApplicationPath;
import jakarta.ws.rs.core.Application;
@ApplicationPath("/")
public class SimplyTheRestApplication extends Application {
}
Zo'n Application
class heb je per project maar 1x nodig.
- Maak in dezelfde package een klasse
HealthCheckResource
met de volgende inhoud:
import jakarta.ws.rs.GET;
import jakarta.ws.rs.Path;
@Path("/health")
public class HealthCheckResource {
@GET
public String healthy() {
return "Up & Running";
}
}
Per REST-resource maak je doorgaans een aparte klasse zoals hierboven, we maken er straks nog een die de code uit de service package gaat gebruiken.
Deze applicatie heeft geen main-methode maar wordt gerund op een applicatieserver, de door jou gedownloade versie van WildFly. Deze applicatieserver implementeert de Jakarta EE specificatie en kan jouw REST-service starten en via HTTP aanbieden. Om WildFly aan IntelliJ te koppelen moet je per project de volgende handelingen 1x uitvoeren:
- Ga in IntelliJ naar Add Configuration (naast de Run en Debug knoppen bovenin het scherm).
- Klik links op het plusje
+
en kies voorJBoss/WildFly Server -> Local
. - Klik naast Application Server op Configure, klik op het plusje
+
en maak een nieuwe server-configuratie aan die verwijst naar de map waar je WildFly hebt geinstalleerd/uitgepakt en druk op OK. Onderin de dialoog staat een meldingWarning: No artifacts marked for deployment
, selecteer om dit probleem op te lossen in de Run-Configuratie van WildFly in IntelliJ onder het tabje Deployment de plus (+
, Artifact) en selecteer de bovenste (eindigt op:war
). - Klik op OK en sluit het dialoogvenster.
Run nu je applicatie in WildFly en navigeer via de browser naar de url http://localhost:8080/simplytherest/health. Je ziet nu als het goed is dat de applicatie werkt en in de browser "Up & Running" toont.
Merk op dat deze REST Resource een simpele, standaard Java-Klasse is. Ook wel een
POJO (Plain Old Java Object) genoemd. Boven de klasse
staat de annotatie die aangeeft via welk pad de Resource te benaderen is. De annotatie boven de methode
geeft aan welke HTTP-methode op welke Java methode gemapped wordt. Door de URL in de browser aan te roepen wordt er een HTTP GET gestuurd naar de applicatieserver en afgeleverd bij de methode healthy()
.
Zorg dat dit werkt!
Indien je niet de tekst Up & Running
ziet in je browser, kan dit verschillende oorzaken hebben.
Het kunnen fouten zijn bij de configuratie van WildFly, fouten in je project of de code en fouten bij het
deployen. Begin dus eerst eens opnieuw met stap 1 en 2 en lees de stappen nog eens goed. Als dat ook niets op lost kun
je een van onderstaande tips proberen:
- Andere installaties van WildFly kunnen ervoor zorgen dat je niet de juiste container op start of dat je
een verkeerde configuratie gebruikt. Zorg dus dat je alleen
WildFly 25.0.0.Final Preview EE 9.1 Distribution
hebt geïnstalleerd, deze versie ondersteunt Jakarta EE 9.1 en werkt samen met JDK 17.
Als je bovenstaande tips hebt toegepast en je ziet (nog steeds) foutmeldingen die wijzen op iets niet kunnen deployen, dan is er vermoedelijk sprake van een rechtenprobleem: herstart IntelliJ als Administrator en bekijk of de map waarin je WildFly geinstalleerd hebt schrijfbaar is.
Voeg een nieuwe REST Resource klasse toe voor het ophalen van Items. Deze moet aan de volgende eigenschappen voldoen:
- De Resource is te bereiken via het pad
/items
- De Resource wordt aangesproken middels een
GET
request. - De volgende String wordt geretourneerd:
"bread, butter"
- De Resource produceert
text/plain
Deploy je applicatie op WildFly en test of deze nieuwe Resource via de browser te bereiken is. Je hoeft WildFly niet elke keer opnieuw op te starten, je applicatie builden en "Deploy all" in de Services tab waarin WildFly draait is doorgaans voldoende.
4: Het retourneren van de Items als JSON
Voeg een nieuwe methode toe die het ook mogelijk maakt de twee items als een lijst te retourneren. Voor nu doen we dit nog steeds als een String, maar dan in het JSON formaat. Later zullen we dit dan eenvoudiger kunnen omzetten naar een daadwerkelijke lijst van items. De Resource moet aan de volgende eigenschappen voldoen:
- De Resource is te bereiken via hetzelfde pad
/items
- De Resource wordt aangesproken middels een
GET
request. - De volgende String wordt geretourneerd:
"["bread", "butter"]"
- De Resource produceert
application/json
Merk op dat je nu dus hardcoded JSON retourneert. De dubbele quotes zul je moeten escapen. Dit doe je op de volgende manier:
"[\"bread\", \"butter\"]";
Deploy je applicatie op WildFly en test of deze nieuwe Resource via de browser te bereiken is. Welke representatie
ontvang je nu terug? De text/plain
of de application/json
?
Via de browser is het lastig om nu te kunnen kiezen tussen de twee representaties van de Items. Om dit
te doen moeten we de HTTP-Header Accept
toevoegen en daar de gewenste representatie invullen.
Een veel gebruikte tool hiervoor is Postman. Dit is een applicatie waarmee je
eenvoudig client requests kan versturen en analyseren. Download en installeer deze en gebruik hem voor het handmatig
verzenden van het request en het zetten van de Accept
HTTP-Header. Test of het lukt om beide representaties op te vragen.
Test vervolgens of je dit ook met één enkele Resource kunt doen. Pas daarvoor de Resource zo aan dat je meerdere
Media-Types accepteert. Onderzoek ook de volgorde effecten van de @Produces
annotatie:
- Gebruik
Accept = */*
. Gebruik@Produces({ MediaType.APPLICATION_JSON, MediaType.TEXT_PLAIN })
en varieer de volgorde - Gebruik
Accept = */*
en@Produces({ "application/*", MediaType.TEXT_PLAIN })
, wat valt op?
Wij gaan voor de rest van de workshop alleen JSON consumeren (i.e. requests) en produceren
(i.e. responses), dus zorg dat je hiervoor een juiste /items
Resource hebt.
6: Automatisch JSON genereren van Java-Objecten
Om van onze String return-waarde nu een echte lijst te kunnen maken kunnen we Jakarta EE functionaliteit gebruiken. Het is met
Jakarta EE namelijk mogelijk om automatisch JSON te genereren van Java-Objecten. Wanneer je methode een Java-Object retourneert,
dan zal Jakarta EE (specifiek: de JSON-B API) automatisch proberen
het Object te converteren naar het Media Type
dat je via @Produces(MediaType.APPLICATION_JSON)
hebt aangegeven.
Spelregels hiervoor zijn dat de betreffende class moet voldoen aan de zgn. "bean specificatie":
- De class heeft een parameterloze constructor
- Alle properties zijn private
- Alle properties hebben een getter en setter (zie 6.2.2 van bovenstaande bean specificatie)
Pas de voorgaande methode aan die JSON retourneert:
- Declareer in je Resource-klasse een variabele van het type
ItemService
en gebruik vervolgens een constructor om deze te instantiëren. - Gebruik in de gegeven Klasse
ItemService
de methode die eenList<ItemDTO>
retourneert. - Het return type van je methode is niet langer een String, maar wordt nu een
List<ItemDTO>
.
Test je Resource met Postman en bekijk hoe de JSON in je response er nu uit ziet. Kan je de structuur verklaren als je kijkt naar het Java object?
In de vorige opdracht heb je het return-type van de methode aangepast naar een List<ItemDTO
. De inhoud van deze lijst
wordt door JSON-B automatisch omgezet naar JSON en vervolgens aan de body van het HTTP-response
toegevoegd. De inhoud van de headers en de statuscode wordt automatisch ingevuld. Wil je hier meer invloed op hebben,
dan kun je ook een Response
object retourneren van de Jersey library van JAX-RS. Bij een dergelijk Object kun je ook
zelf aangeven welke Http-headers en -statuscode je wilt retourneren. Pas je Resource op de volgende manier aan:
- Het return type is niet langer een
List<ItemDTO>
, maar eenResponse
. Let hierbij op dat je de juisteResponse
importeert. Het betreft deze:jakarta.ws.rs.core.Response
. - Creëer een
Response
metList<ItemDTO>
als entity en een statuscode 200 (OK). Gebruik deze Resource om te achterhalen hoe je een dergelijk Object moet maken: Jersey 3.0.0 User Guide -> Building Responses
Controleer dat het retourneren van verschillende statuscodes naar je client werkt.
Voeg aan je klasse een nieuwe methode getItem
toe die het mogelijk maakt om een enkel item op basis van het id te retourneren.
Pas de ItemResource klasse aan:
- De Resource is te bereiken via het pad
/items/{id}
- De Resource wordt aangesproken via een GET request
- Het volledige item wordt geretourneerd
- De Resource produceert
application/json
- Implementeer enkel de happy-flow
De vraag is nu vooral hoe om te gaan met de id
uit het pad. Raadpleeg daarvoor deze bron:
Creating a REST API With Jakarta EE 9, in het bijzonder de paragraaf "Reading URL Information".
Om erachter te komen welke id's geldig zijn kan je alle items ophalen en deze response bekijken, om te voorkomen dat je een ItemNotAvailableException
krijgt op je nieuwe Resource.
Voeg aan je klasse een nieuwe REST Resource toe die het mogelijk maakt om een item via de ItemService
toe
te voegen.
- De Resource is te bereiken via het pad
/items
- De Resource wordt aangesproken middels een
POST
request - De methode zal nu een
ItemDTO
als parameter hebben. Wanneer je een correcte JSON in de body van je request meestuurt, zal JAX-RS dit automatisch omzetten naar een correct Java-Object - De Resource consumeert
application/json
- Er wordt een HTTP-Status Created geretourneerd. Zoek op welke code dat is
- Implementeer enkel de happy-flow
- Gebruik Postman voor het testen van je nieuwe Resource. Bekijk goed hoe je JSON eruit moet zien
Na het toevoegen van een POST kun je via een GET naar /items
bekijken of het nieuwe item is toegevoegd. De kans is groot dat dat niet zo zal zijn. Dit komt omdat WildFly voor ieder request een nieuwe instantie van de ItemResource
klasse maakt. En daarmee ook van de klasse ItemService
, waarmee de lijst van items weer op zijn default waarde wordt geïnitialiseerd.
In een normale applicatie zul je dan ook een database gebruiken voor het bijhouden en managen (= persisteren) van je data en je web-applicatie "stateless" maken. In dit geval doen we dat niet en kun je het probleem oplossen door @ApplicationScoped
boven je ItemResource
-klasse te zetten. Daarmee maakt JAX-RS maar één instantie aan, die over verschillende requests wordt hergebruikt. Merk op dat je nu wél je nieuwe Item
terug krijgt als je deze aan maakt en vervolgens ophaalt.
In voorgaande twee onderdelen heb je enkel de happy-flow geïmplementeerd. Er zijn echter twee situaties waar het mis kan
gaan. Kijk maar naar de code van ItemService
. In beide gevallen wordt een unchecked Exception
gegooid, welke
uiteindelijk bij je REST-Resource van JAX-RS uitkomt. JAX-RS handelt dit verder af en stuurt een standaard HTTP-Response
terug met een foutcode. Het resultaat is een Internal Server Error
(statuscode 500
). Deze statuscode is bedoeld voor
kritieke applicatie fouten. In deze opdracht gaan we dit netter oplossen, omdat we dat kunnen.
Zorg ervoor dat je zelf een specifieke foutcode teruggeeft in beide situaties:
- In het geval van een
ItemNotAvailableException
behoor je een HTTP-Statuscode 404 terug te geven - In het geval van een
IdAlreadyInUseException
behoor je een HTTP-Statuscode 409 terug te geven
Misschien is je eerste gedachte dit met een try...catch
op te lossen. In de try
roep je de ItemService
aan en in de catch
retourneer je een Response
-object met de juiste status-code. Dat zal zeker werken, maar heeft tot gevolg dat je overal try...catch
constructies in je code krijgt. Het kan aanzienlijk eleganter.
Gebruik deze informatie voor het correct implementeren van de foutafhandeling: Jersey 3.0.0 User Guide -> WebApplicationException and Mapping Exceptions to Responses, in het bijzonder het voorbeeld "Mapping generic exceptions to responses". N.B. IntelliJ kan jouw eigen exception mappers als "grijs" markeren waardoor het lijkt alsof de class niet gebruikt wordt, WildFly vindt ze echter wel!
Implementeer tot slot ook het verwijderen van een item. De ItemService
bevat hier al de benodigde methode voor.
- Bedenk zelf via welk pad de Resource te bereiken is
- Bedenk welke HTTP-Methode er gebruikt moet worden
- Vergeet ook de foutafhandeling niet te implementeren (of is dat al gedaan??)