https://blogs.oracle.com/developers/creating-a-microservice-with-micronaut-gorm-and-oracle-atp
ここ一年の間に、Micronautフレームワークは非常にポピュラーになっています。そしてそれは理由あってのものでしょう。このフレームワークはJVMワールドにとって革命的なもので、コンパイル時の依存性注入、およびReflectionを利用しないAOPを使っています。このことが意味するのは、起動および実行パフォーマンスと、メモリ消費に関して大きな良い効果があるということです。フレームワークはパフォーマンスが良いだけではなく、使いやすくドキュメントもしっかり整備されていなければなりませんが、Micronautはこの両方を満たしています。使っていて楽しく、Groovy、KotlinやGraalVMとの組み合わせで素晴らしい仕事をしてくれます。さらに、Micronautの中のひとたちは、業界が向かっている方向を理解しており、このフレームワークをその方向を意識して作りあげてきました。サーバレスやクラウドデプロイメントに容易にし、それらを助けるような機能を備えています。
このポストでは"Person" APIを公開するマイクロサービスをMicronautを使って作る方法を紹介していきます。このサービスでは、データベース（トラディショナルなRDBMSからMongoDB、Neo4Jなどなどまで）をとても容易に利用することができる「データアクセスツールキット」であるGORMを使用します。具体的に言うと、GORMをOracle Autonomous Transaction Processing DB（ATPデータベース）とやり取りするためのHibernateとして使用します。以下のポイントを見ていきます。
- Groovyを使ってMircronautアプリケーションを作成する
- そのアプリケーションがGORMを使ってATPデータベースと接続するように設定する
- Personモデルを作成する
- Personに対してCRUDオペレーションを行うPersonサービスを作成する
- Personサービスとやり取りするControlerを作成する
まずはじめに、起動、稼働中であるATPデータベースのインスタンスをお持ちであることを確認してください。幸運なことに、ATPデータベースの構築はとても簡単で、私のボスのGerald Venzlが5分もかからずにATPインスタンスを構築する方法 のポストで説明もしてくれています。稼働中のインスタンスが容易できたら、クライアント証明書ウォレットをコピーしてローカル端末のどこかにunzipしておいてください。
次のステップに進む前に、ATPインスタンスで新しいスキーマを作成し、そこに以下のDDLでひとつテーブルを作成します：
これでMicronautアプリケーションを作成する次のステップの準備ができました。
Micronautアプリケーションの作成
これまでに使ったことがなければ、Micronautをインストールする必要があります。これにはアプリケーション自体やControllerなどの要素を扱いやすくするための便利なCLIも含まれています。インストールできていることを確認したら、以下のコマンドを実行してベーシックなアプリケーションを作成しましょう。
ディレクトリの中を一覧し、CLIによって生成されたものを見てみましょう。
見てお分かりのように、CLIによってGradleビルドスクリプト、Dockerfileおよびいくつかの設定ファイルと`src`ディレクトリが作成されています。このディレクトリは以下のようになっています：
この時点で、あなたのお気に入りのIDEにこのアプリケーションをインポートできるようになっているのでインポートしておきましょう。次のステップはCotrollerの生成です：
生成されたControllerに小さな修正を加えます。Controllerを開いて`@CompileStatic`アノテーションを加えましょう。修正イメージは以下です：
では`gradle run`（ラッパー経由の/gradlew runでも）を使ってアプリケーションを実行しましょう。アプリケーションが起動すると、ブラウザやcURLコマンドで稼働していることを確認できます。アプリケーションが立ち上がると、コンソールに以下のようなメッセージが表示されます：
テストしてみましょう：
何もコンテンツは返してきませんが、'200 OK'が見えるのでアプリケーションによってリクエストが受け付けられ、適切にレスポンスを返していることがわかります。
ローカルでのアプリケーションの開発とテストを簡単にするために、わたしは自分のIDE（IntelliJ IDEA）にカスタム実行／デバッグ設定を作成し、カスタムGradleタスクを参照させておきます。あとで結局システムプロパティを渡すことになりますが、これによりIDEから起動したときにそれをやれるようになります。以下のように`build.grade`に新しいタスク`myTask`を作成します：
ではこのタスクを参照するカスタム実行／デバッグ設定を作成し、のちほどOracle DB接続に必要となるVMオプションを追加しておきましょう：
コピペ用に追加が必要なプロパティを置いときます：
次のステップに進んでアプリケーションがATPとおしゃべりできるようにしましょう！
アプリケーションのGORMとATP用の設定
アプリケーションを設定する前にOracle JDBCドライバがあることを確認しておきましょう。ダウンロードし、アプリケーションのルートに`libs`というディレクトリを作成して配置しましょう。以下のJARが`libs`ディレクトリにあることを確認してください：
`build.gradle`の`dependencies`ブロックを修正し、Oracle JDB JARと`micronaut-hibernate-gorm`アーティファクトを依存に含めておいてください：
`src/main/resources/application.yml`にあるファイルを修正し、データソースとHibernateを設定しましょう：
これでアプリケーションがGORM経由でATPとやり取りすることができるようになったので、サービス、モデルといくつかのControllerメソッドを作成していきましょう！まずはモデルから始めます。
モデルの作成
GORMモデルを使うのはすごく簡単です。それはモデルエンティティであることを示し、Bean Validation APIでバリデーションをさせるための特別なアノテーションが追加されただけのPOGO（Plain Old Groovy Object）です。ここから'Person.groovy'というGroovyクラスを`model`という新ディレクトリに作成することで、`Person`モデルオブジェクトを作成していきましょう。以下のようにモデルを作ってください：
ここでいくつかのアイテムに注目してみましょう。クラスに@Entity(`grails.gorm.annotation.Entity`)のアノテーションを付けたので、GORMはこのクラスを管理対象であると知ることができます。われわれのモデルは3つのプロパティ、firstName、lastNameとisCoolを持っています。`person`テーブルを作った際に使ったDDLを見返すと、モデルに結び付けられていないふたつのカラム、IDとversionがあることに気づくでしょう。IDカラムはGORMエンティティで暗黙に用いられ、versionカラムもエンティティの楽観的ロックを扱うためにGORMに自動的に管理されます。また、のちに見ていくことになるいくつかのデータバリデーションに用いるプロパティのアノテーションも登場します。
ここでもういちどアプリケーションを起動するとGORMがエンティティを特定してMicronautがHibernateの設定をしているのを見ることができます：
次はサービスの作成を行っていきます。
サービスの作成
わたしは嘘は言いませんよ。もしあなたがステップが難しくなっていることを待っているなら、そんなことにはならないと言っておきましょう。`Person` CRUDオペレーションを管理するためのサービスの作成は、本当に簡単です。`PersonService`というGroovyクラスを`service`という新ディレクトリに作成し、以下のように記述しましょう：
実際のところこれだけです。これでこのサービスはControllerから渡されたオペレーションを扱うことができます。GORMは十分にスマートなので、ここで渡したメソッドシグネチャを受け取ってメソッドを実装してくれます。abstractクラスアプローチ（interfaceアプローチではなく）を使うののいいところは、追加でメソッドの実装が必要となるビジネスロジックがあれば自分でメソッドを実装することができる点です。
まだ目に見えるような変更を加えてないので、ここでアプリケーションを再起動する必要はありません。次でControllerを修正することで変更が目に見えるようになります。
Controllerの作成
前のステップで作成した`PersonController`を修正して永続化オペレーションを行うために使うエンドポイントを追加しましょう。まず、PersonServiceをこのControllerにinjectする必要があります。これもまた簡潔でおこなうことができ、以下をクラス宣言部に追加するだけです。
このControllerの中で最初にやっておくべきなのは`Person`の保存メソッドです。このための`@Post`とアノテーションをつけたメソッドを追加し、このメソッドの中で`PersonService.save()` メソッドを呼び出させます。うまくいった場合には新規に作成した`Person`を返却し、うまくいかなかった場合にはバリデーションエラーのリストを返却します。MicronautはHTTPリクエストのボディをControllerメソッドの`person`引数にバインドするので、このメソッドの中では完全に埋められた`Person`ビーンを取得できる点に留意してください。
これでアプリケーションを起動すると、`/person/save/`エンドポイントを用いて`Person`を永続化できるようになりました：
200 OKレスポンスとともに`Person`を格納したオブジェクトが返却されていることに注目ください。しかし、不適格なデータを用いてオペレーションを試してみると、エラーが返却されることになります：
われわれのモデルでは`Person`firstNameは（とても妙な話ではありますが）5～50文字でなければならないと指定していたため、バリデーションエラーの配列を格納した422 Unprocessable Entityがレスポンスと返されてきます。
ここで、ATPインスタンスの中に格納されているすべてのPersonオブジェクトをクエリするために使う`/list`エンドポイントを追加していきましょう。ページネーションに使うためのふたつのオプショナルな引数も設定しておきます。
Remember that our `PersonService` had two signatures for the `findAll` method - one that accepted no parameters and another that accepted a `Map`. The Map signature can be used to pass additional parameters like those used for pagination. So calling `/person/list` without any parameters will give us all `Person` objects:
`PersonService`には`findAll`メソッドとしてふたつのシグネチャを持っていることを思い出してください――ひとつはパラメータを受け付けておらず、もうひとつはMapを受け付けるものです。Mapシグネチャはページネーションに使うもののような追加の引数を渡すのに使えます。ということで、パラメータなしで`/person/list`を呼び出すと、全ての`Person`オブジェクトを返してくれます：
`PersonService`には`findAll`メソッドとしてふたつのシグネチャを持っていることを思い出してください――ひとつはパラメータを受け付けておらず、もうひとつはMapを受け付けるものです。Mapシグネチャはページネーションに使うもののような追加の引数を渡すのに使えます。ということで、パラメータなしで`/person/list`を呼び出すと、全ての`Person`オブジェクトを返してくれます：
あるいはページネーションパラメータを使うとサブセットが取れます：
また、IDで`Person`を取得するための`/person/get`エンドポイントも追加しておきましょう：
`Person`を削除するための`/person/delete`エンドポイントも追加しましょう：
まとめ
Micronautがパフォーマンスの高いマイクロサービスアプリケーションを作成する際のシンプルでありながらパワフルなやり方であること、また、Hibernate/GORMを用いてのOracle ATPバックエンドへのデータ永続化が簡単に実現できることがおわかりいただけたかと思います。
ここで紹介したアプリケーションの全体を見たい場合はGithubで見るかクローンしてくださいね。
0 件のコメント:
コメントを投稿