使用mybatis-generator自動生成mybatis相關代碼

• 1. mybatis-generator是什麼？
• 2. 如何配置
• • 2.1 maven configuration
  • 2.2 resources下增加generatorConfig.xml配置檔案
• 3. 執行mybatis-generator
• • 3.1 準備資料庫表
  • 3.2 執行 mybatis-generator:generate
  • 3.3 執行結果（自動建立的類）
• 參考

對于變化一開始我們總是排斥的，我們總是墨守成規，不願改變。以至于很長一段時間内我還是甯願自己寫Domain類，自己寫Mapping檔案。直到有一天我有點膩味了，我想要是有工具能幫我做這事就好了！于是我發現了mybatis-generator。

1. mybatis-generator是什麼？

mybatis-generator可以根據資料庫表自動生成Domain類、DAO類以及Mapping檔案等mybatis構件，節省手動編碼的時間做更有意義的事情。

它支援所有的MyBatis版本以及iBatis2.2.0以上的版本。

支援Maven插件。

2. 如何配置

2.1 maven configuration

添加mybatis-generator-maven-plugin，示例中使用的mysql DB。

<build>
        <plugins>
            <plugin>
                <groupId>org.mybatis.generator</groupId>
                <artifactId>mybatis-generator-maven-plugin</artifactId>
                <version>1.3.7</version>
                <configuration>
                    <!-- 是否覆寫，true表示會替換生成的JAVA檔案，false則不覆寫 -->
                    <overwrite>true</overwrite>
                    <verbose>true</verbose>
                </configuration>
                <dependencies>
                    <!--mysql驅動包-->
                    <dependency>
                        <groupId>mysql</groupId>
                        <artifactId>mysql-connector-java</artifactId>
                        <version>5.1.45</version>
                    </dependency>
                </dependencies>
            </plugin>
        </plugins>
    </build>
           

2.2 resources下增加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="DB2Tables" targetRuntime="MyBatis3">
        <commentGenerator>
            <property name="suppressAllComments" value="true"/><!-- 是否取消注釋 -->
            <property name="suppressDate" value="true"/> <!-- 是否生成注釋代時間戳-->
        </commentGenerator>

        <!-- mysql配置 -->
        <jdbcConnection driverClass="com.mysql.jdbc.Driver"
                        connectionURL="jdbc:mysql://localhost:3306/sbia_demo?useUnicode=true&amp;characterEncoding=UTF-8"
                        userId="user"
                        password="password">
            <!-- 針對mysql資料庫 -->
            <property name="useInformationSchema" value="true"></property>
        </jdbcConnection>

        <javaTypeResolver >
            <property name="forceBigDecimals" value="false" />
        </javaTypeResolver>

        <!-- domain 領域模型 -->
        <javaModelGenerator targetPackage="com.tm.sbia.domain" targetProject="../sbia-feature-mybatis/src/main/java">
            <property name="enableSubPackages" value="true" />
            <property name="trimStrings" value="true" />
        </javaModelGenerator>

        <!-- Mapper XML映射檔案 -->
        <sqlMapGenerator targetPackage="mapping"  targetProject="src/main/resources">
            <property name="enableSubPackages" value="true" />
        </sqlMapGenerator>

        <!-- dao 接口 -->
        <javaClientGenerator type="XMLMAPPER" targetPackage="com.tm.sbia.dao"  targetProject="src/main/java">
            <property name="enableSubPackages" value="true" />
        </javaClientGenerator>

        <!-- 表 -->
        <table tableName="%" >
            <property name="useActualColumnNames" value="false"/>
            <generatedKey column="id" sqlStatement="Mysql" identity="true" />
        </table>
    </context>
</generatorConfiguration>
           

3. 執行mybatis-generator

3.1 準備資料庫表

建立一張示例表，SQL如下：

CREATE TABLE `demo_user` (
  `id` int(11) unsigned NOT NULL AUTO_INCREMENT COMMENT '主鍵',
  `code` varchar(20) NOT NULL DEFAULT '' COMMENT '編碼',
  `name` varchar(20) NOT NULL DEFAULT '' COMMENT '名字',
  `birthday` date NOT NULL COMMENT '生日',
  `sex` tinyint(4) NOT NULL COMMENT '性别',
  `demo` varchar(100) DEFAULT NULL COMMENT '備注',
  `create_user` varchar(20) NOT NULL DEFAULT '' COMMENT '建立使用者',
  `create_time` datetime NOT NULL COMMENT '建立時間',
  `update_user` varchar(20) DEFAULT NULL COMMENT '更新使用者',
  `update_time` datetime DEFAULT NULL COMMENT '更新時間',
  `ts` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '時間戳',
  `dr` tinyint(4) NOT NULL DEFAULT '0' COMMENT '邏輯删除辨別位。0：未删除；1：已删除',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='使用者表';
           

3.2 執行 mybatis-generator:generate

3.3 執行結果（自動建立的類）

參考

MyBatis Generator

Maven下用MyBatis Generator生成檔案