使用SpringBoot打造記帳簿專案(十七)使用Eclipse MyBatis Generator plugin自動產生存取資料表的檔案

本篇介紹如何在Eclipse安裝MyBatis Generator plugin (簡稱MBG)，然後自動生成MyBatis與資料表的相關檔案。。

記帳簿專案使用的資料庫為MySQL 8.0.11，資料表的相關設定請參考以下。

• 在Windows 7安裝MySQL
• 使用SpringBoot打造記帳簿專案(七)建立MySQL EER Diagram
• 使用SpringBoot打造記帳簿專案(九)建立MySQL資料表

開啟Eclipse的Marketplace，然後搜尋MyBatis Generator，然後點選Install。

安裝好後重新啟動Eclipse，然後點選Eclipse功能選單的File -> New -> Other... -> MaBatis -> MyBatis Generator Configuration File。

[Location]欄位選擇專案src/main/resources，這是MBG的配置檔generatorConfig.xml的生成目錄，然後按Finish。

然後在專案的src/main/resources目錄即可看到生成的MBG配置檔generatorConfig.xml

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>
  <context id="context1">
    <jdbcConnection connectionURL="???" driverClass="???" password="???" userId="???" />
    <javaModelGenerator targetPackage="???" targetProject="???" />
    <sqlMapGenerator targetPackage="???" targetProject="???" />
    <javaClientGenerator targetPackage="???" targetProject="???" type="XMLMAPPER" />
    <table schema="???" tableName="???">
      <columnOverride column="???" property="???" />
    </table>
  </context>
</generatorConfiguration>

generatorConfig.xml配置範例及說明請參考官方的MyBatis GeneratorXML Configuration File Reference

在使用MBG產生MyBatis的相關檔案時，要先進行以下設定。

使用MBG需要與資料庫連線的JDBC driver，所以要先下載MySQL的JDBC driver(MySQL connector for java)，這邊是直接透過Maven下載。

到Maven repository找到MySQL Connector的dependency如下。

<!-- https://mvnrepository.com/artifact/mysql/mysql-connector-java -->
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>8.0.15</version>
</dependency>

將以上貼到記帳簿專案的pom.xml的<dependecies>中。因為Spring Boot本身已經在<dependencyManagement>指定了MySQL版本，所以不用設定<version>。

因為產生的MyBatis的檔案需要依賴的jar，所以加入MyBatis的dependency，在Spring Boot專案使用以下即可。

<dependency>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter</artifactId>
    <version>1.3.2</version>
</dependency>

pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.2.0.BUILD-SNAPSHOT</version>
        <relativePath /> <!-- lookup parent from repository -->
    </parent>
    <groupId>idv.matt</groupId>
    <artifactId>moneynote</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>war</packaging>
    <name>moneynote</name>
    <description>moneynote</description>

    <properties>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            <exclusions>
                <exclusion>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-starter-logging</artifactId>
                </exclusion>
            </exclusions>
        </dependency>

        <!-- https://mvnrepository.com/artifact/org.springframework.boot/spring-boot-starter-aop -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-aop</artifactId>
        </dependency>
        
        <!-- MyBatis -->
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>1.3.2</version>
        </dependency>

        <!-- https://mvnrepository.com/artifact/mysql/mysql-connector-java -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>

        <!-- log4j2 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-log4j2</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-tomcat</artifactId>
            <scope>provided</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

    <repositories>
        <repository>
            <id>spring-snapshots</id>
            <name>Spring Snapshots</name>
            <url>https://repo.spring.io/snapshot</url>
            <snapshots>
                <enabled>true</enabled>
            </snapshots>
        </repository>
        <repository>
            <id>spring-milestones</id>
            <name>Spring Milestones</name>
            <url>https://repo.spring.io/milestone</url>
        </repository>
    </repositories>
    <pluginRepositories>
        <pluginRepository>
            <id>spring-snapshots</id>
            <name>Spring Snapshots</name>
            <url>https://repo.spring.io/snapshot</url>
            <snapshots>
                <enabled>true</enabled>
            </snapshots>
        </pluginRepository>
        <pluginRepository>
            <id>spring-milestones</id>
            <name>Spring Milestones</name>
            <url>https://repo.spring.io/milestone</url>
        </pluginRepository>
    </pluginRepositories>

</project>

設定好後會下載依賴的jar檔，而MBG需要使用MySql Connection的jar Maven預設放在
C:\Users\[username]\.m2\repository\mysql\mysql-connector-java\8.0.13。

在專案src/main/java建立以下package，待會MBG會在這三個package產生檔案。

• idv.matt.dao
• idv.matt.entity
• idv.matt.mapper

接著修改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>
    <!-- 指定MBG連線資料庫時所需要的MySQL JDBC driver的檔案位置 -->
    <classPathEntry
        location="C:/Users/matt/.m2/repository/mysql/mysql-connector-java/8.0.13/mysql-connector-java-8.0.13.jar" />
    <context id="moneynote_mybatis_generator"
        defaultModelType="flat" targetRuntime="MyBatis3Simple"><!-- 產生的model為flat型式。產生傳統的MyBatis Mapper及可，不要產生新的Example檔 -->
        <commentGenerator>
            <property name="suppressAllComments" value="true" /><!-- 不要產生MBG的註解 -->
            <property name="suppressDate" value="true" /><!-- 不要產生日期註解 -->
        </commentGenerator>
        <!-- 資料庫連線設定 -->
        <jdbcConnection
            connectionURL="jdbc:mysql://localhost:3306/moneynote"
            driverClass="com.mysql.cj.jdbc.Driver" password="12345"
            userId="matt">
            <property name="nullCatalogMeansCurrent"
                value="true" /><!-- MySQL不支援schema及catelog的設定 -->
        </jdbcConnection>
        <javaTypeResolver>
            <property name="useJSR310Types" value="true" /><!-- 日期或時間戳記不使用java.util.Date，改用Java 8的java.time.LocalDate -->
        </javaTypeResolver>
        <!-- 要產生的model位置，targetProject的值為專案的Source folder，所以是moneynote/src/main/java -->
        <javaModelGenerator
            targetPackage="idv.matt.entity"
            targetProject="moneynote/src/main/java" />
        <!-- 要產生的MyBatis Mapper位置 --> 
        <sqlMapGenerator targetPackage="idv.matt.mapper"
            targetProject="moneynote/src/main/java" />
        <!-- 要產生的MyBatis Dao位置 -->      
        <javaClientGenerator
            targetPackage="idv.matt.dao"
            targetProject="moneynote/src/main/java" type="XMLMAPPER" /><!-- MyBatis Mapper設為xml格式 -->
        <!-- 要生成的資料表 -->
        <table tableName="member">
            <columnOverride column="member_id"
                javaType="java.lang.Long" jdbcType="BIGINT" /><!-- 因為id為unsigned BIGINT所做的設定 -->
        </table>
        <table tableName="expense_record">
            <columnOverride column="expense_id"
                javaType="java.lang.Long" jdbcType="BIGINT" />
            <columnOverride column="member_id"
                javaType="java.lang.Long" jdbcType="BIGINT" />
        </table>
    </context>
</generatorConfiguration>

然後在generatorConfig.xml上點滑鼠右鍵 -> Run As -> Run MyBatis Generator便會開始產生對應的檔案。

如果出現project does not exist錯誤，代表targetProject屬性的位置沒有設置正確。

執行結束後結果如下，可以看到MBG在指定的package中產生了對應的檔案。往後我們就能直接利用MyBatis來存取資料庫的資料表了。

若要快速游走於Inteface Mapper與XML Mapper間，請參考Eclipse 如何快速導覽MyBatis的Interface Mapper方法與對應的XML Mapper。

若這時啟動專案會出現錯誤訊息，因為到此僅是加入MyBatis的依賴及使用MBG產生Mapper檔及Entity類而已，但專案的dataSource及MyBatis的相關配置尚未完成。

最後別忘了將修改推到Github。

接下來請參考使用SpringBoot打造記帳簿專案(十九)MyBatis設定。

參考：

• Running MyBatis Generator with Eclipse
• MySql Usage Notes
• Java 8新特性探究（七）深入解析日期和时间-JSR310
• Connecting to MySQL Using the JDBC DriverManager Interface
• MyBatis 3 JdbcType
• Java, JDBC and MySQL Types
• 如何让MyBatis Generator不生成Example相关内容