More than 1 year has passed since last update.

MyBatis Generatorの導入手順

Last updated at 2022-05-07Posted at 2022-02-27

はじめに

Spring Bootの勉強過程でMyBatisを用いてデータベース接続を行おうとしているのだが、
テーブル定義に則ったentityクラスを作る際、１つ１つ手作業で全カラムのフィールドを作成するのは骨が折れる。

以下のようなテーブルが複数あった場合、テーブルごとにentityクラスを作成する必要があるが...

１つ１つカラム名見て、データ型見て...と、勉強用の開発ならチマチマ手作業で行ってもいいのだが、業務で開発を行う際はテーブル・カラムの量が個人でやる比じゃないため、さすがに面倒くさいし、カラム名・データ型の宣言ミスが起こる可能性も高くなる。

そのため、既存のデータベースから自動でentityクラスを作ってくれたら嬉しいよねということで、MyBatis Generatorというツールを用いる。

前提

・IDE：eclipse
・データベース：MySQL（用いるデータベースおよびテーブルの作成は完了済み）
・Springスタータープロジェクトにより作成したプロジェクト（タイプ：Mavenプロジェクト）

手順①MyBatis Generatorをダウンロードする

パターン１、あるいはパターン２の方法でMyBatis Generatorのダウンロードを行う。
パターン１の方が楽だが、うまくインストールできない場合はパターン２の方を試してみる。
筆者はパターン２の方法でダウンロードを行う。

パターン１)Mavenを用いる

プロジェクト作成時に生成されたpom.xmlに、以下の記述（6-10行目）を行い保存することで、ライブラリのダウンロードおよびビルドパスへの反映を自動で行ってくれる。

	<build>
		<plugins>
			<plugin>
				...
			</plugin>
			<plugin>
                <groupId>org.mybatis.generator</groupId>
                <artifactId>mybatis-generator-maven-plugin</artifactId>
                <version>1.3.1</version>
            </plugin>
		</plugins>
	</build>

ただ、自分の場合うまく反映されなかったため、別の手法でダウンロードを行う。
（他のライブラリはmavenからダウンロードできたのに何故だ...）

パターン２）マーケットプレイスより直接ダウンロードを行う

１：ヘルプ→Eclipseマーケットプレイス

２：検索欄に「MyBatis」と入力し、「MyBatis Generator」をインストールする。

３：MyBatis Generatorが適用されているかの確認
適当なxmlファイル（pom.xmlなど）を右クリック→実行→Run MyBatis Generator
Run MyBatis Generatorと表示されていればダウンロード成功

手順②Configファイルを作成する

src/main/resources下に「generatorConfig.xml」を作成

generatorConfig.xmlに下記情報を記載する
（参考記事①を参考）

<?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>
    <classPathEntry
        location="C:/Users/user/.m2/repository/mysql/mysql-connector-java/8.0.22/mysql-connector-java-8.0.22-sources.jar" />
    <context id="context1">
 
<!--     JDBCの設定です (1) -->
        <jdbcConnection
            driverClass="com.mysql.cj.jdbc.Driver"
            connectionURL="jdbc:mysql://localhost:3306/sbsample1?serverTimezone=JST"
            userId="root"
            password="root"
        />
 
<!--     自動生成するエンティティの設定です (2) -->
        <javaModelGenerator
            targetPackage="com.example.entity1"
            targetProject="SpringBootSample7-1/src/main/java/"
        />
        <!-- 
        <sqlMapGenerator
            targetPackage="com.example.entity2"
            targetProject="SpringBootSample7-1/src/main/java/"
        />
        -->
        
        <javaClientGenerator
            targetPackage="com.example.entity3"
            targetProject="SpringBootSample7-1/src/main/java/"
            type="XMLMAPPER"
        />
 
<!--     生成対象のテーブルです（3) -->
        <table schema="sbsample1" tableName="m_user" />
    </context>
</generatorConfiguration>