IntelliJのMyBatisプラグインを使ってSpring BootプロジェクトでMyBatisのマッパーとエンティティを生成する

2019年9月23日2020年7月12日

IntelliJのプラグインMyBatis Builderでマッパーとエンティティを生成する

　Java + Spring Boot + MyBatisのプロジェクトにおいてMyBatis用のマッパークラス、エンティティクラスをテーブル定義から生成したい。MyBatis Generatorを使用すると生成可能ではあるが、IntelliJ上からGUIの操作で簡単にマッパーとエンティティを生成できる。

参考ページ

• Introduction to MyBatis Generator
• MyBatis GeneratorでMapper&Entityを自動生成しよう！
• MyBatis Generatorを使ってMapperクラスやXMLファイルを自動生成する
• MyBatis Builder

IntelliJのプラグインでMyBatis Builderというものがあったので試してみる。

プラグインのインストールと起動

IntelliJnのPreference→Plugins→Marcketplaceで「MyBatis」で検索すると「MyBatis Builder」が見つかるのでインストールしてIntelliJを再起動する。

IntelliJが再起動をShiftキー連打でどこでも検索を起動し「MyBatis」で検索する。

プラグインのウィンドウが表示される。

プラグインへDB接続設定を追加

以下の画面キャプチャの手順で接続するDBを設定する。

DBは作成済みとする。この例ではlocalhost:5432 でPostgreSQLが起動しecという名前のDB、Productという名前のテーブルが存在している。
MyBatisプラグインへ新たな設定を追加する。

DBのホスト名、ポート、DBの種類を入力する。
その他の設定はデフォルトとしている。

マッパークラスとエンティティクラスの生成

作成したDB接続から生成対象とするテーブルを選択し、スパナボタンをクリックする。そして、生成するCRUDの種類を選択する。 その後マッパークラスのモードなどを選択する。Lombokの@Dataアノテーションを使用することができるので、getter, setterを省略できる。

GradleのMyBatis Generatorプラグインを使用する方法

GradleのMyBatis Generatorプラグインを使ってマッパー、エンティティを生成する方法は別の記事でまとめている。