Quarkus が MicroProfile と Spring を組み合わせる方法

皆さんこんにちは。Quarkus シリーズの XNUMX 番目の投稿です。

Java マイクロサービスを開発する場合、次のように考えられることがよくあります。 Eclipse マイクロプロファイル и 春のブーツ は別個の独立した API です。 新しいフレームワークやランタイム コンポーネントを学習するには時間がかかるため、プログラマはデフォルトで使い慣れた API を使用する傾向があります。 今日は、いくつかの人気のある開発を簡素化してみます。 Spring 開発者向け MicroProfile API Spring API と新しい便利な機能を同時に使用する方法を示します。 クォークス.

もう少し詳しく説明すると、まず、Quarkus が Spring API をサポートする範囲と詳細を見て、Spring 開発者に日常の作業で MicroProfile API を使用する方法を示します。 次に、Spring 開発者がマイクロサービスを作成するときに役立つ MicroProfile API を紹介します。

なぜクォーカスなのか？ まず、これはライブ コーディングです。つまり、MicroProfile API、Spring API、およびその他の Java API の変更を自動的に再ロードします。これは、mvn quarkus:dev という XNUMX つのコマンドだけで実行されます。 第二に、で議論されている 私たちの例では Personal サービス (Spring、MicroProfile、および JPA API をネイティブ GraalVM イメージを使用してバイナリにコンパイルする) はわずか 0.055 秒で開始され、RESTful アプリケーション エンドポイントで約 90 MB の RAM (RSS) を占有します。 さらに、そのコンパイル自体は、mvn package -Pnative という XNUMX つのコマンドだけで実行されます。

Spring 開発者が Quarkus の MicroProfile API で Spring API を使用する方法を理解することを目的として、MicroProfile については詳しく説明しません。

コンテナとKubernetes

この記事を簡潔にするために、ここではサポートの高レベルの側面のみを説明します。 Kubernetesを理解することが重要だからです。 Quarkus は Kubernetes の Java スタックとして位置付けられており、Java アプリケーションとサービスのメモリ消費と起動時間を最小限に抑え、その結果、ホスト上のそれらの密度を高め、全体的なコストを削減するように設計されています。

クォーカスも 自動生成をサポート Kubernetes のリソースとオファー ガイド Kubernetes および Red Hat OpenShift プラットフォームでのデプロイメント用。 さらに、Quarkus は、コンテナーの作成に必要な Dockerfile.jvm (JVM パッケージ化) ファイルと Dockerfile.native (ネイティブ バイナリ パッケージ化) ファイルを自動的に生成します。

最後に、Quarkus はターゲット デプロイメント環境として Kubernetes に焦点を当てているため、同様の機能が Kubernetes プラットフォーム自体のレベルで実装される場合には Java フレームワークを使用しません。 表 1 は、Kubernetes と Spring 開発者が使用する典型的な Java フレームワーク間の機能的対応関係のマップを示しています。

表 1. Java フレームワークと Kubernetes の間の機能の対応関係のマップ。

機能的
伝統的なスプリングブーツ
Kubernetes

サービスの発見
Eureka
DNS

　
春のクラウド構成
構成マップ/シークレット

ロードバランシング
リボン（クライアント側）
サービス、レプリケーション コントローラー (サーバー側)

サンプルのコードをコンパイルして実行する

この記事で参照するのは、 プロジェクト例ここでは、Spring API と MicroProfile API、さらには同じ Java クラスが一緒に使用されます。 この例のコードはコマンド ラインからコンパイルして実行できます。詳細については、README.md ファイルを参照してください。

Spring フレームワーク API

依存性注入

Quarkus はさまざまな機能をサポートしています コンテキストと依存性注入 (CDI) API Spring dependency Injection (Spring DI) API。 MicroProfile を使用している場合は、 Java EE とジャカルタ EEであれば、あなたはすでに CDI に精通していることになります。 一方、Spring 開発者は、Spring DI API の Quarkus 拡張機能を使用して、Spring DI との互換性を実現できます。 サポートされている Spring DI API の使用例を表 2 に示します。

В 私たちの例からのプロジェクト CDI と Spring 依存関係インジェクションの両方を使用します。 このトピックに関する詳細と例は、Quarkus ガイドにあります。 スプリングDIガイド.

表 2. サポートされている Spring DI API の使用例。

サポートされている Spring DI 機能
例

コンストラクターのインジェクション

public PersonSpringController(
   PersonSpringRepository personRepository,  // injected      
   PersonSpringMPService personService) {    // injected
      this.personRepository = personRepository;
      this.personService = personService;
}

フィールドインジェクション
自動配線
値

@Autowired
@RestClient
SalutationRestClient salutationRestClient;

@Value("${fallbackSalutation}")
String fallbackSalutation;

ビーン
@構成

@Configuration
public class AppConfiguration {
   @Bean(name = "capitalizeFunction")
   public StringFunction capitalizer() {
      return String::toUpperCase;
   }
}

成分

@Component("noopFunction")
public class NoOpSingleStringFunction implements StringFunction {
   @Override
   public String apply(String s) {
      return s;
   }
}

カスタマーサービス

@Service
public class MessageProducer {
   @Value("${greeting.message}")
   String message;

   public String getPrefix() {
      return message;
   }
}

Webフレームワーク

MicroProfile ユーザーは、Quarkus が主要な Web プログラミング モデルとして JAX-RS、MicroProfile Rest Client、JSON-P、および JSON-B をサポートしていることを気に入るはずです。 Spring 開発者は、Quarkus による Spring Web API、特に REST インターフェイスの最近のサポートに満足するでしょう。 Spring DI と同様に、Spring Web API サポートの主な目標は、Spring 開発者が Spring Web API を MicroProfile API と組み合わせて使用​​できるようにすることです。 サポートされている Spring Web API の使用方法の例を表 3 に示します。このトピックに関する詳細と例は、Quarkus チュートリアルで参照できます。 春のウェブガイド.

表 3. サポートされている Spring Web API の使用例。

サポートされている Spring Web 機能
例

@RestController
@RequestMapping

@RestController
@RequestMapping("/person")
public class PersonSpringController {
   ...
   ...
   ...
}

@GetMapping
@PostMapping
@PutMapping
@DeleteMapping
@PatchMapping
@RequestParam
@リクエストヘッダー
@MatrixVariable
@パス変数
@CookieValue
@RequestBody
@ResponseStatus
@ExceptionHandler
@RestControllerAdvice (部分的)

@GetMapping(path = "/greet/{id}",
   produces = "text/plain")
   public String greetPerson(
   @PathVariable(name = "id") long id) {
   ...
   ...
   ...
}

春のデータJPA

MicroProfile ユーザーは、Quarkus が Hibernate ORM を使用して JPA をサポートしていることも高く評価するでしょう。 Spring 開発者にとっては朗報もあります。Quarkus は一般的な Spring Data JPA アノテーションと型をサポートしています。 サポートされている Spring Data JPA API の使用例を表 4 に示します。
В 私たちの例からのプロジェクト Spring Data JPA API が使用されており、詳細については、Quarkus チュートリアルで参照できます。 Spring Data JPA ガイド.

表 4. サポートされている Spring Data JPA API の使用例。

サポートされている Spring Data JPA 機能
例

Crudリポジトリ

public interface PersonRepository
         extends JpaRepository,
                 PersonFragment {
   ...
}

倉庫
Jpaリポジトリ
ページングとソートリポジトリ

public class PersonRepository extends 

    Repository {

    Person save(Person entity);

    Optional findById(Person entity);
}

リポジトリのフラグメント

public interface PersonRepository
         extends JpaRepository,
                 PersonFragment {
   ...
}

派生クエリメソッド

public interface PersonRepository extends CrudRepository {

    List findByName(String name);
    
    Person findByNameBySsn(String ssn);
    
    Optional 
       findByNameBySsnIgnoreCase(String ssn);

    Boolean existsBookByYearOfBirthBetween(
            Integer start, Integer end);
}

ユーザー定義クエリ

public interface MovieRepository
         extends CrudRepository {

    Movie findFirstByOrderByDurationDesc();

    @Query("select m from Movie m where m.rating = ?1")
    Iterator findByRating(String rating);

    @Query("from Movie where title = ?1")
    Movie findByTitle(String title);
}

マイクロプロファイル API

フォールトトレランス

フォールト トレランス構造は、連鎖的な障害を防止し、信頼性の高いマイクロサービス アーキテクチャを作成するために非常に重要です。 Spring 開発者は長年にわたりフォールト トレランスのためにサーキット ブレーカーを使用してきました。 ヒステリック。 ただし、Hystrix は長い間更新されていませんでしたが、MicroProfile の Fault Tolerance は現在積極的に開発されており、数年間実稼働環境で使用されています。 したがって、Quarkus のサービスの信頼性を向上させるには、MicroProfile Fault Tolerance API を使用することをお勧めします。その例を表 5 に示します。詳細については、Quarkus マニュアルを参照してください。 フォールト トレランス ガイド.

表 5. サポートされている MicroProfile Fault Tolerance API の使用例。

MicroProfile フォールト トレランス機能
説明
例

@非同期

別のスレッドでロジックを実行する

@Asynchronous
@Retry
public Future<String> getSalutation() {
   ...
   return future;
}

@バルクヘッド

同時リクエストの数を制限する

@Bulkhead(5)
public void fiveConcurrent() {
   makeRemoteCall(); //...
}

@CircuitBreaker

スマートな障害処理と障害からの回復

@CircuitBreaker(delay=500   // milliseconds
   failureRatio = .75,
   requestVolumeThreshold = 20,
   successThreshold = 5)
@Fallback(fallbackMethod = "fallback")
public String getSalutation() {
   makeRemoteCall(); //...
}

@後退する

失敗した場合の代替ロジックの呼び出し

@Timeout(500) // milliseconds
@Fallback(fallbackMethod = "fallback")
public String getSalutation() {
   makeRemoteCall(); //...
}

public String fallback() {
   return "hello";
}

リトライ

リクエスト失敗時の再試行

@Retry(maxRetries=3)
public String getSalutation() {
   makeRemoteCall(); //...
}

タイムアウト

障害制御タイムアウト

@Timeout(value = 500 )   // milliseconds
@Fallback(fallbackMethod = "fallback")
public String getSalutation() {
   makeRemoteCall(); //...
}

サービスの確認 (Service Health)

Kubernetes プラットフォームは、特別なサービスを使用してコンテナーの状態を監視します。 基盤となるプラットフォームがサービスを監視できるようにするために、Spring 開発者は通常、カスタムの HealthIndicator と Spring Boot Actuator を使用します。 Quarkus では、これは MicroProfile Health を使用して実行できます。MicroProfile Health はデフォルトで活性チェックを実行しますが、活性と準備状況を同時にチェックするように構成できます。 サポートされている MicroProfile Health API の使用方法の例を表 6 に示します。追加情報は Quarkus マニュアルに記載されています。 健康ガイド.

表 6: サポートされている MicroProfile Health API の使用例。

MicroProfile Health 機能
説明
例

@Liveness

プラットフォームは失敗したコンテナ化アプリケーションを再起動します
終点：
ホスト:8080/健康/ライブ

@Liveness
public class MyHC implements HealthCheck {
  public HealthCheckResponse call() {

   ...
   return HealthCheckResponse
     .named("myHCProbe")
     .status(ready ? true:false)
     .withData("mydata", data)
     .build();  
}

@準備完了

プラットフォームは、準備ができていない場合、コンテナ化されたアプリケーションにトラフィックを送信しません。
終点：
ホスト:8080/health/ready

@Readiness
public class MyHC implements HealthCheck {
  public HealthCheckResponse call() {

   ...
   return HealthCheckResponse
     .named("myHCProbe")
     .status(live ? true:false)
     .withData("mydata", data)
     .build();  
}

メトリクス

アプリケーションは、運用目的 (パフォーマンス SLA を監視するため) または非運用目的 (ビジネス SLA) のいずれかのメトリックを提供します。 Spring 開発者は、Spring Boot Actuator と Micrometer を使用してメトリクスを提供します。 次に、Quarkus は MicroProfile メトリクスを使用して、ベースライン メトリクス (JVM およびオペレーティング システム)、ベンダー メトリクス (Quarkus)、およびアプリケーション メトリクスを提供します。 MicroProfile Metrics では、実装が JSON および OpenMetrics (Prometheus) 出力形式をサポートしている必要があります。 MicroProfile Metrics API の使用例を表 7 に示します。

В 私たちの例からのプロジェクト MicroProfile メトリックは、アプリケーション メトリックを提供するために使用されます。 詳細については、Quarkus マニュアルを参照してください。 メトリクスガイド.

表 7. MicroProfile Metrics API の使用例。

MicroProfile メトリクスの機能
説明
例

@カウントされました

注釈付きオブジェクトが呼び出された回数をカウントするカウンターを表します。

@Counted(name = "fallbackCounter", 
  displayName = "Fallback Counter", 
  description = "Fallback Counter")
public String salutationFallback() {
   return fallbackSalutation;
}

@ConcurrentGauge

注釈付きオブジェクトへの同時呼び出しの数をカウントするゲージを示します。

@ConcurrentGuage(
  name = "fallbackConcurrentGauge", 
  displayName="Fallback Concurrent", 
  description="Fallback Concurrent")
public String salutationFallback() {
   return fallbackSalutation;
}

@ゲージ

注釈付きオブジェクトの値を測定するゲージ センサーを示します

@Metered(name = "FallbackGauge",
   displayName="Fallback Gauge",
   description="Fallback frequency")
public String salutationFallback() {
   return fallbackSalutation;
}

@Metered

注釈付きオブジェクトの呼び出し頻度を監視するメーターセンサーを示します

@Metered(name = "MeteredFallback",
   displayName="Metered Fallback",
   description="Fallback frequency")
public String salutationFallback() {
   return fallbackSalutation;
}

メトリック

メトリックの入力または生成のリクエストを受信したときのメタデータに関する情報を含むアノテーション

@Metric
@Metered(name = "MeteredFallback",
   displayName="Metered Fallback",
   description="Fallback frequency")
public String salutationFallback() {
   return fallbackSalutation;
}

Timed

注釈付きオブジェクトの継続時間を追跡するタイマーを示します。

@Timed(name = "TimedFallback",
   displayName="Timed Fallback",
   description="Fallback delay")
public String salutationFallback() {
   return fallbackSalutation;
}

メトリクスエンドポイント

アプリケーションのメトリクス ローカルホスト:8080/メトリクス/アプリケーション
基本的な指標 ローカルホスト:8080/メトリクス/ベース
ベンダーメトリクス ローカルホスト:8080/メトリクス/ベンダー
すべての指標 ローカルホスト:8080/メトリクス

MicroProfile Rest クライアント

マイクロサービスは、多くの場合、対応するクライアント API の操作を必要とする RESTful エンドポイントを提供します。 RESTful エンドポイントを使用するには、Spring 開発者は通常、RestTemplate を使用します。 Quarkus は、この問題を解決するために MicroProfile Rest Client API を提供しています。その使用例を表 8 に示します。

В 私たちの例からのプロジェクト RESTful エンドポイントの使用は、MicroProfile Rest Client を使用して行われます。 このトピックに関する詳細と例については、Quarkus マニュアルを参照してください。 RESTクライアントガイド.

表 8. MicroProfile Rest クライアント API の使用例。

MicroProfile Rest クライアントの機能
説明
例

@RegisterRestClient

型指定された Java インターフェイスを REST クライアントとして登録します

@RegisterRestClient
@Path("/")
public interface MyRestClient {
    @GET
    @Produces(MediaType.TEXT_PLAIN)
    public String getSalutation();
}

@RestClient

型指定された REST クライアント インターフェイスのインスタンスの実装をマークします。

@Autowired // or @Inject
@RestClient
MyRestClient restClient;

呼び出し

RESTエンドポイントを呼び出します

System.out.println(
   restClient.getSalutation());

mp-rest/url

RESTエンドポイントを指定します

application.properties:
org.example.MyRestClient/mp-rest/url=
   http://localhost:8081/myendpoint

結果

このブログでは主に Spring 開発者を対象として、Spring API と Quarkus の MicroProfile API を使用して Java マイクロサービスを開発し、それをネイティブ バイナリ コードにコンパイルして数百メガバイトの RAM を節約し、数ミリ秒の問題です。

すでに理解されているように、Spring および MicroProfile API のサポートに関する詳細情報、およびその他の多くの役立つ情報については、次の URL を参照してください。 Quarkus マニュアル.

出所： habr.com