Spring Boot DB連携

MyBatis Generatorを使ってMapperやEntityを自動生成してみた

SpringフレームワークでMyBatisを利用する際、EntityクラスやMapperクラス、Mapperクラスが参照するXMLファイルが必要になってくるが、それらはMyBatis Generatorによって自動生成することができる。

今回は、MyBatis GeneratorによってEntityクラスやMapperクラス、Mapperクラスが参照するXMLファイルを自動生成してみたので、その手順を共有する。

なお、Entityクラスの例は、以下のサイトの「UserData.java」を参照のこと。

Spring BootのWEB画面上で、MyBatisによるOracle接続を実装してみた今回は、Oracle接続する処理をMyBatisにより実装してみたので、そのサンプルプログラムを共有する。MyBatisを利用すると、S...

また、MapperクラスやMapperクラスが参照するXMLファイルの例は、以下のサイトを参照のこと。

MyBatisのSQL文をXMLファイルに配置してみたMyBatisを利用するプログラムで、これまではMapperクラスに直接SQL文を記載していたが、今回はXMLファイルにSQL文を移動し...

前提条件

下記記事の手順に従って、STSをダウンロード済であること。

STSインストール_1
STS(Spring Tool Suite)をWindows端末上にダウンロードしてみたSpring BootアプリケーションをEclipse上で開発するには、Spring用のプラグインを同梱した「STS(Spring To...

また、データベース上に以下のテーブルが作成されていること。
user_dataテーブルの構成



やってみたこと

  1. MyBatis Generatorのインストール
  2. Spring Bootプロジェクトの作成
  3. MyBatis Generator用の設定ファイルの作成
  4. MyBatis Generatorの実行

MyBatis Generatorのインストール

MyBatis Generatorのインストール手順は、以下の通り。

1) STSを起動し、「ヘルプ」メニューから「Eclipse マーケットプレース」を選択する。
MyBatis Generatorのインストール_1

2) 検索ウィンドウに「MyBatis Generator」を指定し、「Go」ボタンを押下する。
MyBatis Generatorのインストール_2

3) 「MyBatis Generator」の「インストール」ボタンを押下する。
MyBatis Generatorのインストール_3

4) ライセンスのレビュー画面が表示されるので、「使用条件の条項に同意します」を選択後、「完了」ボタンを押下する。
MyBatis Generatorのインストール_4

5) セキュリティー警告ダイアログが表示されるので、「インストール」ボタンを押下する。
MyBatis Generatorのインストール_5

6) ソフトウェア更新ダイアログが表示されるので、「今すぐ再起動」ボタンを押下する。
MyBatis Generatorのインストール_6

7) パッケージ・エクスプローラー上で右クリックし、「新規」メニューから「その他」を選択すると、以下のように、「MyBatis Generator Configuration File」メニューが確認できる。
MyBatis Generatorのインストール_7_1

MyBatis Generatorのインストール_7_2



Spring Bootプロジェクトの作成

STS上で、MyBatis GeneratorによってEntityクラスやMapperクラス、Mapperクラスが参照するXMLファイルを自動生成の対象とするSpring Bootプロジェクトを作成する。その手順は以下の通り。

1) パッケージ・エクスプローラー上で右クリックし、「新規」メニューから「Spring スターター・プロジェクト」を選択する。
SpringBootプロジェクトの作成_1

2) 以下のように作成するプロジェクトの情報を指定し、「次へ」ボタンを押下する。
SpringBootプロジェクトの作成_2

3) MyBatis Frameworkのチェックを指定し、「次へ」ボタンを押下する。
SpringBootプロジェクトの作成_3

4) 以下の画面が表示されるので、「完了」ボタンを押下する。なお、下記画面では環境の都合上、Javaのバージョンを13に変更している。
SpringBootプロジェクトの作成_4

5) 以下のように、「demo2」プロジェクトが作成されることが確認できる。
SpringBootプロジェクトの作成_5

6) Oracleにojdbc経由で接続するため、以下のように、libフォルダ下にJDBCドライバ「ojdbc6.jar」を配置する。
SpringBootプロジェクトの作成_6

7) Oracleにojdbc経由で接続するため、pom.xmlに以下の記述を追加する。

追加後のpom.xmlの内容は以下の通り。

8) 今回作成したプロジェクトを選択し右クリックし、「Maven」から「プロジェクトの更新」を選択する。
SpringBootプロジェクトの作成_8_1

以下のように、Maven更新対象のプロジェクトが選択された状態で、「OK」ボタンを押下する。
SpringBootプロジェクトの作成_8_2



MyBatis Generator用の設定ファイルの作成

MyBatis Generator用の設定ファイルの作成手順は、以下の通り。

1) 作成したプロジェクトの「src/main/resources」フォルダを選択し右クリックし、「新規」メニューから「その他」を選択する。
MyBatis Generatorの設定ファイル作成_1

2) 「MyBatis Generator Configuration File」を選択し、「次へ」ボタンを押下する。
MyBatis Generatorの設定ファイル作成_2

3) 以下の画面が表示されるので、「完了」ボタンを押下する。
MyBatis Generatorの設定ファイル作成_3

4) 以下のように、「generatorConfig.xml」が作成されることが確認できる。
MyBatis Generatorの設定ファイル作成_4

5) 作成された「generatorConfig.xml」を、以下の内容に変更する。



MyBatis Generatorの実行

MyBatis Generatorの実行手順は、以下の通り。

1) 「generatorConfig.xml」を選択し右クリックし、「実行」から「Run MyBatis Generator」を指定する。
MyBatis Generatorの実行_1

2) 実行すると、以下のコンソールログが出力される。
MyBatis Generatorの実行_2

3) また、実行した結果、以下の赤枠のファイルが作成される。
MyBatis Generatorの実行_3

作成された「UserData.java」の内容は、以下の通り。



また、作成された「UserDataMapper.java」の内容は、以下の通り。



さらに、作成された「UserDataMapper.xml」の内容は、以下の通り。

要点まとめ

  • MyBatis Generatorを利用すると、SpringフレームワークでMyBatisを利用する際に必要な、EntityクラスやMapperクラス、Mapperクラスが参照するXMLファイルを自動生成できる。
  • STS上でMyBatis Generatorを利用するには、MyBatis GeneratorをEclipse マーケットプレースからインストールし、定義ファイル「generatorConfig.xml」を作成後、実行すればよい。