tworzenie usług w Javie, w tym REST API, nie zawsze było łatwe i produktywne, dopóki nie przyszła wiosna i nie zmieniła krajobrazu. Od tego czasu minęło wiele lat, a w społeczności pojawiły się nowe ramy.

jednym z tych frameworków był Micronaut. Jest rozwijany przez OCI, tę samą firmę, która stoi za Grails, a ich celem jest pomoc programistom w tworzeniu mikroserwisów i aplikacji bezserwerowych.

istnieje również Quarkus, kolejny framework, który zyskał popularność w ciągu ostatniego roku. Opracowany przez RedHat, Quarkus obiecuje zapewnić szybki Start i mniejsze zużycie pamięci, dwa typowe problemy podczas tworzenia usług REST w Javie.

z tymi wszystkimi wyborami, istnieje bardzo ważne pytanie: jak łatwo jest stworzyć usługę z każdym z tych trzech frameworków?

w tym samouczku stworzysz bezpieczną aplikację REST, używając Spring, Micronaut i Quarkus, aby zobaczyć, jak się różnią i która najlepiej odpowiada twoim potrzebom.

spis treści

• wymagania wstępne dla Java REST API
  • Utwórz konto Okta do zarządzania użytkownikami
  • Generuj tokeny za pomocą debugera OpenID Connect
• Zbuduj Java REST API za pomocą Micronaut
  • Rozwijaj swoją usługę Java
• Zbuduj Java REST API za pomocą Quarkus
• Zbuduj Java REST API REST API z wiosennym rozruchem
• ostatnie przemyślenia na temat REST API z Javą: Micronaut, quarkus i Spring Boot

Jeśli chcesz, możesz obejrzeć ten samouczek jako Screencast. 👇

wymagania wstępne dla Java REST API

Ten samouczek używa Maven 3+. Przed kontynuowaniem upewnij się, że jest zainstalowany i dostępny do użycia. Z pewnością można również użyć Gradle, ale YMMV.

masz zamiar zbudować aplikacje, które uwierzytelniają żądania za pomocą OAuth 2.0, zabezpieczone przez aplikację Okta. Nie masz konta Okta? Nie martw się, stworzenie nowego zajmuje mniej niż minutę. Nie tylko to, ale Okta obsługuje standardy takie jak JWT, OAuth 2.0 i OIDC. Zapewniamy wsparcie dla dobrze znanych frameworków, takich jak Java EE, Spring Boot i Spring Security. Heck, mamy nawet wtyczkę Maven, która automatyzuje wszystko dla ciebie.

nie ma potrzeby odkrywania koła na nowo!

Utwórz konto Okta do zarządzania użytkownikami

Otwórz swój terminal i wykonaj następujące polecenie:

mvn com.okta:okta-maven-plugin:register

zostaniesz poproszony o wprowadzenie następujących informacji:

• Imię
• nazwisko
• e-mail
• firma

Po udzieleniu odpowiedzi na pytania otrzymasz wiadomość e-mail z prośbą o aktywację nowego konta. Po aktywacji konta Uruchom następujące polecenie:

mvn com.okta:okta-maven-plugin:spring-boot

To polecenie tworzy dla Ciebie aplikację z przepływem kodu auth i URI przekierowania Spring Security dla Okta.

aby lepiej ją zapamiętać, możesz utworzyć tę samą aplikację ręcznie:

• przejdź do strony głównej dewelopera Okta i zaloguj się na swoje konto.
• kliknij Aplikacje> Dodaj aplikację> Web> następny.

zobaczysz następujący ekran:

zanim przejdziesz dalej, wprowadź następujące zmiany w aplikacji:

• Zaloguj się Przekieruj Uri:
  • http://localhost:8080/login/oauth2/code/okta
  • https://oidcdebugger.com/debug
• Typ dotacji dozwolony
  • kod autoryzacji
  • Implicit (Hybrydowy)

Typ dotacji implicit (z identyfikatorem i dostępem Token allowed checked) jest konieczne, aby pobrać token dostępu w przeglądarce.

pola Nie wymienione powyżej mogą zachować swoje wartości domyślne.

Po zakończeniu kliknij Gotowe. Twoja aplikacja jest gotowa!

następnym krokiem jest nauczenie się, jak wygenerować prawidłowy token za jego pomocą.

generowanie tokenów za pomocą debuggera OpenID Connect

Okta pozwala zarządzać użytkownikami w chmurze za pomocą swoich API. Pozwala również zabezpieczyć aplikacje za pomocą OAuth 2.0 i OpenID Connect (Alias OIDC). OAuth 2.0 zapewnia mechanizm autoryzacji delegowanej, co oznacza, że nie musisz przechowywać poświadczeń użytkownika w aplikacji. Zamiast tego możesz przekazać to dostawcy OAuth 2.0 (w tym przypadku Okta). OIDC zapewnia warstwę tożsamości na bazie OAuth 2.0 i dlatego firmy takie jak Okta nazywane są „dostawcami tożsamości” lub IDP.

zarejestrowałeś swoją aplikację w Okta i możesz teraz wygenerować token, aby uzyskać do niej dostęp. Jeden z zarejestrowanych URI przekierowania logowania jest dla strony OpenID Connect.

Twoje żądania zostaną zweryfikowane za pomocą tokena. Aby wygenerować ten token, użyjesz debuggera OpenID Connect. Ta strona internetowa zapewni Ci łatwy sposób na wygenerowanie poświadczeń dla użytkowników aplikacji Okta.

przejdź do https://oidcdebugger.com I wypełnij następujące informacje:

• Autoryzuj URI: https://{yourOktaDomain}/oauth2/default/v1/authorize
• Przekieruj URI: https://oidcdebugger.com/debug
• ID klienta: {yourOktaClientId}
• zakres: openid email profile
• Stan: dev
• Nonce
• Typ odpowiedzi: token

Możesz znaleźć wartość dla {yourOktaDomain} w prawym górnym rogu strony głównej Twojego konta:

aby znaleźć swój identyfikator klienta okta, wykonaj poniższe czynności:

• przejdź do aplikacji
• Wybierz moją aplikację internetową
• kliknij Ogólne

identyfikator klienta będzie dostępny w sekcji poświadczenia klienta:

Po wypełnieniu wszystkich pól kliknij Wyślij zapytanie. Zostaniesz przekierowany na stronę logowania Okta.

Po pomyślnym uwierzytelnieniu zostaniesz ponownie przekierowany do debuggera OIDC, gdzie możesz zobaczyć wygenerowany token:

użyjesz tego tokena do bezpiecznego dostępu do usług, które zamierzasz zbudować.

teraz, gdy masz konto Okta i wiesz, jak generować tokeny za pomocą aplikacji Okta, zacznijmy porównywać frameworki!

Zbuduj Java REST API z Micronaut

pierwszym krokiem do rozwoju usługi Micronaut jest pobranie SDKMANA!. SDKMAN! to narzędzie do zarządzania równoległymi wersjami wielu zestawów SDK, których użyjesz do zainstalowania klienta Micronaut.

możesz pobrać SDKMAN! uruchamiając następujące polecenie:

curl -s https://get.sdkman.io | bash

teraz możesz zainstalować sam Micronaut. Po prostu uruchom następujące polecenie w terminalu:

sdk install micronaut

Po zakończeniu wykonywania polecenia będziesz mieć najnowszą wersję Micronaut dostępną na komputerze.

jesteś gotowy do rozpoczęcia tworzenia aplikacji!

Rozwiń swoją usługę Java

przejdź do katalogu, w którym chcesz utworzyć aplikację i wykonaj następujące polecenie:

mn create-app com.okta.rest.app --build maven

To polecenie utworzy projekt o podstawowej strukturze projektu Micronaut. Micronaut domyślnie używa Gradle, ale ponieważ używasz --build maven, zamiast tego użyje Mavena.

następnym krokiem jest dodanie bibliotek bezpieczeństwa wewnątrz projektu. Edytuj plik pom.xml I dodaj następujące zależności:

<dependency> <groupId>io.micronaut</groupId> <artifactId>micronaut-security</artifactId></dependency><dependency> <groupId>io.micronaut</groupId> <artifactId>micronaut-security-jwt</artifactId></dependency>

te zależności umożliwią bezpieczeństwo – w szczególności OAuth 2.0 z JWT – w Twoim projekcie. Teraz, gdy masz już wszystkie zależności, możesz rozpocząć tworzenie punktu końcowego.

Utwórz następującą klasę wsrc/main/java/com/okta/rest/controller:

package com.okta.rest.controller;import io.micronaut.http.MediaType;import io.micronaut.http.annotation.Controller;import io.micronaut.http.annotation.Get;import io.micronaut.http.annotation.Produces;import io.micronaut.security.annotation.Secured;import io.micronaut.security.rules.SecurityRule;import java.security.Principal;@Controller("/hello")public class HelloController { @Get @Secured(SecurityRule.IS_AUTHENTICATED) @Produces(MediaType.TEXT_PLAIN) public String hello(Principal principal) { return "Hello, " + principal.getName() + "!"; }}

adnotacja @Controllerwskazuje na Micronaut, że ten komponent będzie odbierał żądania w /hello ścieżka.

Klasa posiada tylko jedną metodę o nazwiehello(). Adnotacja@Get pokazuje, że metoda będzie otrzymywać żądania HTTP GET. Potrzebujesz @Produces, ponieważ domyślnym typem zwracanym przez Micronaut jest obiekt JSON. Ponieważ zwracasz prosty tekst, musisz jawnie zdefiniować te informacje w metodzie.

ostatnia adnotacja to@Secured. Po prostu informuje Micronaut, że ta metoda jest dostępna tylko dla uwierzytelnionych użytkowników.

masz teraz kontroler, który jest zabezpieczony, ale nie zdefiniowałeś jeszcze konfiguracji zabezpieczeń. Skonfigurujmy Micronaut tak, aby łączył się z Twoją aplikacją Okta.

Zmień nazwęsrc/main/resources/application.yml naapplication.properties I dodaj następującą konfigurację zabezpieczeń:

micronaut.security.enabled=truemicronaut.security.token.jwt.enabled=truemicronaut.security.token.jwt.signatures.jwks.okta.url=https://{yourOktaDomain}/oauth2/default/v1/keys

./mvnw mn:run

curl -X GET -I http://localhost:8080/hello

HTTP/1.1 401 UnauthorizedDate: Tue, 8 Jan 2019 15:47:36 GMTtransfer-encoding: chunkedconnection: close

TOKEN=eyJraWQiOiJxOE1QMjFNNHZCVmxOSkxGbFFWNlN...

curl -H "Authorization: Bearer $TOKEN" http://localhost:8080/hello

Hello, [email protected]!

mvn io.quarkus:quarkus-maven-plugin:1.8.1.Final:create \ -DprojectGroupId=com.okta.rest \ -DprojectArtifactId=quarkus \ -DclassName="com.okta.rest.quarkus.HelloResource" \ -Dpath="/hello" \ -Dextensions="jwt"

package com.okta.rest.quarkus;import io.quarkus.security.Authenticated;import javax.ws.rs.GET;import javax.ws.rs.Path;import javax.ws.rs.Produces;import javax.ws.rs.core.Context;import javax.ws.rs.core.MediaType;import javax.ws.rs.core.SecurityContext;import java.security.Principal;@Path("/hello")public class HelloResource { @GET @Path("/") @Authenticated @Produces(MediaType.TEXT_PLAIN) public String hello(@Context SecurityContext context) { Principal userPrincipal = context.getUserPrincipal(); return "Hello, " + userPrincipal.getName() + "!"; }}

mp.jwt.verify.publickey.location=https://{yourOktaDomain}/oauth2/default/v1/keysmp.jwt.verify.issuer=https://{yourOktaDomain}/oauth2/default

./mvnw compile quarkus:dev

curl -X GET -I http://localhost:8080/hello

HTTP/1.1 401 Unauthorizedwww-authenticate: Bearer {token}Content-Length: 0

curl -H "Authorization: Bearer $TOKEN" http://localhost:8080/hello

Hello, [email protected]!

curl https://start.spring.io/starter.zip -d language=java \ -d bootVersion=2.3.4.RELEASE \ -d dependencies=web,okta \ -d packageName=com.okta.rest \ -d name=spring-boot \ -d type=maven-project \ -o spring-boot.zip

unzip spring-boot.zip -d spring-boot

package com.okta.rest.controller;import org.springframework.security.core.annotation.AuthenticationPrincipal;import org.springframework.web.bind.annotation.GetMapping;import org.springframework.web.bind.annotation.RestController;import java.security.Principal;@RestControllerpublic class HelloController { @GetMapping("/hello") public String hello(@AuthenticationPrincipal Principal principal) { return "Hello, " + principal.getName() + "!"; }}

okta.oauth2.issuer=https://{yourOktaDomain}/oauth2/default

./mvnw spring-boot:run

curl -X GET -I http://localhost:8080/hello

HTTP/1.1 401Set-Cookie: JSESSIONID=316DCFD55C302A8D69EFD865411DFA77; Path=/; HttpOnlyWWW-Authenticate: BearerX-Content-Type-Options: nosniffX-XSS-Protection: 1; mode=blockCache-Control: no-cache, no-store, max-age=0, must-revalidatePragma: no-cacheExpires: 0X-Frame-Options: DENYContent-Length: 0Date: Thu, 09 Jan 2020 15:46:34 GMT

curl -H "Authorization: Bearer $TOKEN" http://localhost:8080/hello

Hello, [email protected]!