Quarkusフレームワーク：クリーンなアーキテクチャの実装方法

こんにちは、Habr！



新しいJavaフレームワークの調査と、Spring Bootブックへの関心を継続する中で、Java用の新しいQuarkusフレームワークを検討しています。詳細な説明はここにあります。今日は、Quarkusを使用してクリーンなアーキテクチャに準拠することがいかに便利であるかを示す簡単な記事の翻訳を読むことを提案します。



Quarkusは、避けられないフレームワークのステータスを急速に獲得しています。したがって、私はもう一度それを調べて、純粋なアーキテクチャの原則に準拠するためにそれがどの程度処理されるかを確認することにしました。



出発点として、クリーンなアーキテクチャの原則に従ってCRUD RESTアプリケーションを作成するために、5つの標準モジュールを持つ単純なMavenプロジェクトを採用しました。

• domain：ドメインオブジェクトとこれらのオブジェクトのゲートウェイインターフェイス
• app-api：実際のケースに対応するアプリケーションインターフェイス
• app-impl：サブジェクトエリアによるこれらのケースの実装。依存app-apiしてdomain。
• infra-persistence：ドメインがデータベースAPIと対話できるようにするゲートウェイを実装します。に依存しdomainます。
• infra-web：RESTを使用して外界と対話するための考慮されたケースを開きます。に依存しapp-apiます。

さらにmain-partition、デプロイ可能なアプリケーションアーティファクトとして機能するモジュールを作成します。



Quarkusでの作業を計画する場合、最初のステップは、プロジェクトのPOMファイルにBOM仕様を追加することです。このBOMは、使用する依存関係のすべてのバージョンを管理します。また、surefireプラグインなど、プラグイン管理ツールでmavenプロジェクトの標準プラグインを構成する必要があります。 Quarkusを使用する場合は、ここで同じ名前のプラグインも構成します。最後になりましたが、ここでは、各モジュール（<build> <plugins> ... </ plugins> </ build>内）で動作するようにプラグイン、つまりJandexプラグインを構成する必要があります。..。 QuarkusはCDIを使用するため、Jandexプラグインは各モジュールにインデックスファイルを追加します。このファイルには、このモジュールで使用されているすべての注釈のレコードと、どの注釈が使用されているかを示すリンクが含まれています。その結果、CDIの処理がはるかに簡単になり、後で実行する作業がはるかに少なくなります。



基本構造の準備ができたので、完全なアプリケーションの構築を開始できます。これを行うには、メインパーティションがQuarkus実行可能アプリケーションを作成することを確認する必要があります。このメカニズムは、Quarkusで提供されている「クイックスタート」の例に示されています。



まず、Quarkusプラグインを使用するようにビルドを構成します。

<build>
  <plugins>
    <plugin>
      <groupId>io.quarkus</groupId>
      <artifactId>quarkus-maven-plugin</artifactId>
      <executions>
        <execution>
          <goals>
            <goal>build</goal>
          </goals>
        </execution>
      </executions>
    </plugin>
  </plugins>
</build>

次に、各アプリケーションモジュールに依存関係を追加しましょう。ここで、依存関係quarkus-resteasyとが一緒になりquarkus-jdbc-mysqlます。最後の依存関係では、データベースを最も適切なものに置き換えることができます（後でネイティブ開発パスに従うため、H2などの組み込みデータベースを使用できないことを考慮してください）。



または、プロファイルを追加して、後でネイティブアプリケーションをビルドできるようにすることもできます。これを行うには、追加の開発スタンド（GraalVM、native-imageおよびOSXを使用している場合はXCode ）が本当に必要です。

<profiles>
  <profile>
    <id>native</id>
    <activation>
      <property>
        <name>native</name>
      </property>
    </activation>
    <properties>
      <quarkus.package.type>native</quarkus.package.type>
    </properties>
  </profile>
</profiles>

これでmvn package quarkus:dev、プロジェクトルートから実行すると、Quarkusアプリが機能します。コントローラーやコンテンツがまだないので、まだ見るものはあまりありません。

RESTコントローラーの追加

この演習では、周辺からコアに移動しましょう。まず、ユーザーデータを返すRESTコントローラーを作成しましょう（この例では、これは単なる名前です）。



JAX-RS APIを使用するには、依存関係をインフラWebPOMに追加する必要があります。

<dependency>
  <groupId>io.quarkus</groupId>
  <artifactId>quarkus-resteasy-jackson</artifactId>
</dependency>

最も単純なコントローラーコードは次のようになります。

@Path("/customer")
@Produces(MediaType.APPLICATION_JSON)
public class CustomerResource {
    @GET
    public List<JsonCustomer> list() {
        return getCustomers.getCustomer().stream()
                .map(response -> new JsonCustomer(response.getName()))
                .collect(Collectors.toList());
    }

    public static class JsonCustomer {
        private String name;

        public JsonCustomer(String name) {
            this.name = name;
        }

        public String getName() {
            return name;
        }
    }

ここでアプリケーションを実行すると、localhost：8080 / customerを呼び出してJoe、JSON形式で表示できます。

特定のケースを追加する

次に、この実用的なケースのケースと実装を追加しましょう。app-api次の場合を定義しましょう。

public interface GetCustomers {
    List<Response> getCustomers();

    class Response {
        private String name;

        public Response(String name) {
            this.name = name;
        }

        public String getName() {
            return name;
        }
    }
}

app-implこのインタフェースの簡単な実装を作成します。

@UseCase
public class GetCustomersImpl implements GetCustomers {
    private CustomerGateway customerGateway;

    public GetCustomersImpl(CustomerGateway customerGateway) {
        this.customerGateway = customerGateway;
    }

    @Override
    public List<Response> getCustomers() {
        return Arrays.asList(new Response("Jim"));
    }
}

CDIがコンポーネントを表示するには、以下に定義されてGetCustomersImplいるカスタム注釈が必要UseCaseです。標準のApplicationScopedとannotationを使用することもできTransactionalますが、独自の注釈を作成することで、コードをより論理的にグループ化し、CDIなどのフレームワークから実装コードを切り離すことができます。

@ApplicationScoped
@Transactional
@Stereotype
@Retention(RetentionPolicy.RUNTIME)
public @interface UseCase {
}

CDIアノテーションを使用app-implするには、app-apiおよび依存関係に加えて、次の依存関係をPOMファイルに追加する必要がありdomainます。

<dependency>
  <groupId>jakarta.enterprise</groupId>
  <artifactId>jakarta.enterprise.cdi-api</artifactId>
</dependency>
<dependency>
  <groupId>jakarta.transaction</groupId>
  <artifactId>jakarta.transaction-api</artifactId>
</dependency>

次に、RESTコントローラーを変更してケースで使用する必要がありapp-apiます。

...
private GetCustomers getCustomers;

public CustomerResource(GetCustomers getCustomers) {
    this.getCustomers = getCustomers;
}

@GET
public List<JsonCustomer> list() {
    return getCustomers.getCustomer().stream()
            .map(response -> new JsonCustomer(response.getName()))
            .collect(Collectors.toList());
}
...

ここでアプリケーションを実行し、localhost：8080 / customerを呼び出すとJim、JSON形式で表示されます。

ドメインの定義と実装

次に、ドメインに焦点を当てます。ここでの本質はdomain非常に単純で、Customer消費者を受け入れるゲートウェイインターフェイスで構成されています。

public class Customer {
	private String name;

	public Customer(String name) {
		this.name = name;
	}

	public String getName() {
		return name;
	}
}
public interface CustomerGateway {
	List<Customer> getAllCustomers();
}

また、ゲートウェイの使用を開始する前に、ゲートウェイの実装を提供する必要があります。このようなインターフェイスはで提供されinfra-persistenceます。



この実装では、Quarkusで利用可能なJPAサポートを使用し、Panacheフレームワークも使用します。これにより、作業が少し楽になります。ドメインに加えて、infra-persistence次の依存関係を追加する必要があります。

<dependency>
  <groupId>io.quarkus</groupId>
  <artifactId>quarkus-hibernate-orm-panache</artifactId>
</dependency>

まず、消費者に対応するJPAエンティティを定義します。

@Entity
public class CustomerJpa {
	@Id
	@GeneratedValue
	private Long id;
	private String name;

	public String getName() {
		return name;
	}

	public void setName(String name) {
		this.name = name;
	}
}

Panacheを使用する場合、エンティティがPanacheEntityを継承するか、リポジトリ/ DAOパターンを使用するかの2つのオプションのいずれかを選択できます。私はActiveRecordパターンのファンではないので、私自身はリポジトリに立ち寄りますが、どのように作業するかはあなた次第です。

@ApplicationScoped
public class CustomerRepository implements PanacheRepository<CustomerJpa> {
}

JPAエンティティとリポジトリができたので、ゲートウェイを実装できますCustomer。

@ApplicationScoped
public class CustomerGatewayImpl implements CustomerGateway {
	private CustomerRepository customerRepository;

	@Inject
	public CustomerGatewayImpl(CustomerRepository customerRepository) {
		this.customerRepository = customerRepository;
	}

	@Override
	public List<Customer> getAllCustomers() {
		return customerRepository.findAll().stream()
				.map(c -> new Customer(c.getName()))
				.collect(Collectors.toList());
	}
}

これで、ゲートウェイを使用するように、ケースの実装でコードを変更できます。

...
private CustomerGateway customerGateway;

@Inject
public GetCustomersImpl(CustomerGateway customerGateway) {
    this.customerGateway = customerGateway;
}

@Override
public List<Response> getCustomer() {
    return customerGateway.getAllCustomers().stream()
            .map(customer -> new GetCustomers.Response(customer.getName()))
            .collect(Collectors.toList());
}
...

Quarkusアプリケーションは、必要な永続性パラメーターを使用して構成する必要があるため、まだアプリケーションを開始できません。ではsrc/main/resources/application.propertiesモジュール、main-partition次のパラメータを追加します。

quarkus.datasource.url=jdbc:mysql://localhost/test
quarkus.datasource.driver=com.mysql.cj.jdbc.Driver
quarkus.hibernate-orm.dialect=org.hibernate.dialect.MySQL8Dialect
quarkus.datasource.username=root
quarkus.datasource.password=root
quarkus.datasource.max-size=8
quarkus.datasource.min-size=2
quarkus.hibernate-orm.database.generation=drop-and-create
quarkus.hibernate-orm.sql-load-script=import.sql

元のデータを表示するためにimport.sql、データが追加されたのと同じディレクトリにファイルを追加します。

insert into CustomerJpa(id, name) values(1, 'Joe');
insert into CustomerJpa(id, name) values(2, 'Jim');

ここでアプリケーションを実行し、localhost：8080 / customerを呼び出すJoeとJim、JSON形式でも表示されます。つまり、RESTからデータベースまでの完全なアプリケーションがあります。

ネイティブオプション

ネイティブアプリケーションを構築する場合は、コマンドを使用してこれを行う必要がありますmvn package -Pnative。開発スタンドの内容にもよりますが、これには数分かかる場合があります。Quarkusは起動時に非常に高速で、ネイティブサポートなしで、2〜3秒で起動しますが、GraalVMを使用してネイティブ実行可能ファイルにコンパイルすると、対応する時間は100ミリ秒未満に短縮されます。Javaアプリケーションの場合、これは非常に高速です。

テスト

対応するQuarkusテストフレームワークを使用して、Quarkusアプリケーションをテストできます。テスト@QuarkusTestに注釈を付けると、JUnitは最初にQuarkusコンテキストを起動してから、テストを実行します。のアプリケーション全体のテストはmain-partition次のようになります。

@QuarkusTest
public class CustomerResourceTest {
	@Test
	public void testList() {
		given()
				.when().get("/customer")
				.then()
				.statusCode(200)
				.body("$.size()", is(2),
						"name", containsInAnyOrder("Joe", "Jim"));
	}
}

結論

多くの点で、QuarkusはSpringBootの激しい競争相手です。私の意見では、Quarkusのいくつかの事柄はさらによく解決されています。 app-implにはフレームワークの依存関係がありますが、これは注釈の依存関係にすぎません（Springの場合、spring-contextget@Componentに追加すると、Springコアの依存関係が多数追加されます）。これが気に入らない場合は@Produces、CDIの注釈を使用してメインセクションにJavaファイルを追加し、そこでコンポーネントを作成することもできます。この場合、に追加の依存関係は必要ありませんapp-impl。しかし、どういうわけか、jakarta.enterprise.cdi-api私はそこに中毒よりも中毒を見たいと思っていますspring-context。



Quarkusは速い、本当に速い。このタイプのアプリケーションでは、SpringBootよりも高速です。 Clean Architectureによると、フレームワークの依存関係のほとんど（すべてではないにしても）はアプリケーションの外部に存在する必要があるため、QuarkusとSpringBootのどちらを選択するかが明らかになります。この点で、Quarkusの利点は、GraalVMのサポートを考慮してすぐに作成されたため、最小限の労力でアプリケーションをネイティブに変換できることです。 Spring Bootは、この点でまだQuarkusに遅れをとっていますが、すぐに追いつくことは間違いありません。



確かに、Quarkusを試してみると、古典的なJakartaEEアプリケーションサーバーでQuarkusを使おうとする人々を待っている多くの不幸に気付くことができました。Quarkusでできることはまだ多くありませんが、そのコードジェネレーターは、従来のアプリケーションサーバーを使用するJakartaEEのコンテキストではまだ簡単に使用できないさまざまなテクノロジーをサポートしています。Quarkusは、Jakarta EEに精通している人々が必要とするすべての基本をカバーしており、その開発ははるかにスムーズです。Javaエコシステムがこの種の競争をどのように処理できるかを見るのは興味深いでしょう。



このプロジェクトのすべてのコードはGithubに投稿されています。