【第三回】MyBatis Generatorのインストール方法と事前準備

はじめに
MyBatisとは
インストール方法
事前準備（xmlファイルを作っておく）
最後に

はじめに

DreamHanksの松下です。今回はMyBatis Generatorのインストールと実行するための事前準備を解説していきます。

連載記事まとめ

使用するビルドツールはMavenです。
インストールしたライブラリがプロジェクトで使えるように連動してくれるツールです。

今回のダウンロードしたMyBatis Generatorをプロジェクトに
インストールする方法のほとんどがMavenの設定の解説になります。

Mavenはプロジェクトを開発するうえでコアの部分になります。
仕組みについて深く理解したい方はこちらの記事もご覧ください。
Mavenの解説

MyBatisとは

一言でいうと
オブジェクトとデータベースに関する処理との対応づけを容易にするO/Rマッピングツールです。

O/Rマッピングとは、「オブジェクト」と「リレーショナルデータベース」をマッピング（対応付け）することです。
O/Rマッピングは実装時のデータベース操作にかかわる煩雑な作業を軽減してくれます。

インストール方法

今回使用するMyBatis Generatorのバージョンは1.3.7です。
最新の1.4以降のバージョンだと、今回の開発では不要な機能がたくさんあるため古いものを使いました。

通常インストールする場合、「eclipse > help > マーケットプレイス」からライブラリをダウンロードできます。
しかし、今回古いバージョンのものが欲しいのでMVNリポジトリから直接ダウンロードします。

①MVNリポジトリで「MyBatis Generator Core」を検索する。

上記の画像は実際に検索したものです。
Usagesを見ると最新のバージョンより1.3.7が多く使われていることがわかります。(2020/09/24現在）

②ほしいバージョンをダウンロードする

ほしいバージョンのボタンをクリックすると上記のページに遷移します。
赤枠内のコードをコピーします。

③pom.xmlに張り付けてビルドをする

上記のようにpom.xmlのdependenciesタグ内に先ほどコピーしたコードを張り付けます。
ビルドをすると、リモートリポジトリ（MVNリポジトリ）からダウンロードされます。

なぜビルドするとダウンロードされるのか気になる方はこちらの記事もご覧ください。
Mavenの解説

事前準備（xmlファイルを作っておく）

MyBatis　Generatorを実行する際に必要なxmlファイルが2つあります。

下記のディレクトリに配置してください。
C:\pleiades\workspace\プロジェクト名\src\main\resources

下記の二つの内容をそれぞれのxmlファイルに記述してください。

mybatis-generationConfig.xml作成

「mybatis-generationConfig.xml」ファイルを「src/main/resources」配下に作成します。

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE generatorConfiguration PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN" "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">
<generatorConfiguration>
<context id="simple" targetRuntime="MyBatis3">
<jdbcConnection
connectionURL="jdbc:mysql://localhost:ポート番号/スキーマ名?characterEncoding=UTF-8&amp;serverTimezone=UTC&amp;useSSL=false"
driverClass="com.mysql.cj.jdbc.Driver" 
password="パスワード"
userId="ユーザー名" />
<javaModelGenerator
targetPackage="com.dreamhanks.dto"
targetProject="プロジェクト名/src/main/java">
<property name="enableSubPackages" value="true" />
<property name="trimStrings" value="true" />
</javaModelGenerator>
<sqlMapGenerator 
targetPackage="mappers"
targetProject="プロジェクト名/src/main/resources" />
<javaClientGenerator
targetPackage="com.dreamhanks.dao" 
targetProject="プロジェクト名/src/main/java"
type="XMLMAPPER" />
<table schema="スキーマ名" tableName="テーブル名" enableCountByExample="true"
enableUpdateByExample="true"
enableDeleteByExample="true" enableSelectByExample="true" selectByExampleQueryId="trues">
<property name="useActualColumnNames" value="false"/>
<generatedKey column="id" sqlStatement="Mysql" identity="true"/>
</table>
 
</context>
</generatorConfiguration>

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE generatorConfiguration PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN" "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">

<jdbcConnection

connectionURL="jdbc:mysql://localhost:ポート番号/スキーマ名?characterEncoding=UTF-8&serverTimezone=UTC&useSSL=false"

driverClass="com.mysql.cj.jdbc.Driver"

password="パスワード"

userId="ユーザー名" />

<javaModelGenerator

targetPackage="com.dreamhanks.dto"

targetProject="プロジェクト名/src/main/java">

</javaModelGenerator>

<sqlMapGenerator

targetPackage="mappers"

targetProject="プロジェクト名/src/main/resources" />

<javaClientGenerator

targetPackage="com.dreamhanks.dao"

targetProject="プロジェクト名/src/main/java"

type="XMLMAPPER" />

<table schema="スキーマ名" tableName="テーブル名" enableCountByExample="true"

enableUpdateByExample="true"

enableDeleteByExample="true" enableSelectByExample="true" selectByExampleQueryId="trues">

</table>

</context>

</generatorConfiguration>

mybatis-config.xml

<span style="font-size: 12px;"><code>&lt;?xml version="1.0" encoding="UTF-8"?&gt;
&lt;!DOCTYPE configuration
PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-config.dtd"&gt;
&lt;configuration&gt;
&lt;/configuration&gt;</code></span>

<!DOCTYPE configuration

PUBLIC "-//mybatis.org//DTD Config 3.0//EN"

"http://mybatis.org/dtd/mybatis-3-config.dtd">

</configuration></code></span>

最後に

次回は作成したxmlファイルの内容について解説していきます。

数ある記事の中から、お読みいただきありがとうございました。