top / index / prev / next / target / source

2021-06-06 diary: [Oiyokan] Spring Boot プロジェクトに Oiyokan SDK を組み込む方法

いがぴょんの日記 日記形式でつづる いがぴょんコラム ウェブページです。

[Oiyokan] Spring Boot プロジェクトに Oiyokan SDK を組み込む方法

Oiyokan を Spring Boot プロジェクトに組み込む方法を説明します。

Oiyokan 組込済みの Spring Boot プロジェクトを生成する Spring Initializr のテンプレートソースに、ちょうど組込みに向けた有益な情報がありますので、これを引用しながら説明します。

ビルドおよび実行依存関係に Oiyokan を追加

最初に依存関係に Oiyokan を追加します。Maven 記述だと以下のようになります。(Oiyokan v1.19 を組み込む例)

<dependency>
  <groupId>jp.igapyon.oiyokan</groupId>
  <artifactId>oiyokan</artifactId>
  <version>1.19.20210603a</version>
</dependency>

前後関係を含めた完全な記述は次を参照: https://github.com/igapy...pom.xml#L25

ビルドおよび実行依存関係に JDBCドライバを追加

公開したいデータベースの JDBCドライバを依存関係に追加します。

JDBCドライバのいくつかについては Maven Repository を参照依存させることができます。

Java Servlet 呼び出しリクエストを Oiyokan のエントリポイントにマッピング

Java Servlet 呼び出しリクエストを Oiyokan のエントリポイントにマッピングします。

以下に Spring Boot web における記述例を示します。

@RestController
public class DemoOData4Register {
    private static final String ODATA_ROOTPATH = "/odata4.svc";

    @RequestMapping(ODATA_ROOTPATH + "/*")
    public void serv(final HttpServletRequest req, final HttpServletResponse resp) throws ServletException {
        final OiyoInfo oiyoInfo = new OiyoInfo();
        OiyokanOdata4RegisterImpl.serv(oiyoInfo, req, resp, ODATA_ROOTPATH);
    }
}

前後関係を含めた完全な記述は次を参照: https://github.com/igapy...er.java#L17

oiyokan-settings.json を配置

Oiyokan の挙動を定義する oiyokan-settings.json を所定のパス(src/main/resources/oiyokan/)に配置します。

oiyokan-settings.json の指定内容は https://www.igapyon.jp/i...210426.html を参考にすることができます。 ただし、初見で oiyokan-settings.json をスクラッチで作成するのは困難でしょうから、初回は Oiyokan Initializr を用いて oiyokan-settings.json を作成し、それをテキストエディタなどでカスタマイズすることを推奨します。

まとめ

ここまでの手順により、Spring Boot web アプリに Oiyokan の組み込みは完了です。

Related Diary

Last modified: $Date: 2021-06-06 $

登場キーワード

この日記について