mybatis-generator自動生成代碼插件

　　mybatis自動生成代碼（實體類、Dao接口等）是很成熟的了，就是使用mybatis-generator插件。 它是一個開源的插件，使用maven構建最好，可以很方便的執行

　　插件官方簡介：
　　　　http://www.mybatis.org/generator/index.html
　　插件的GitHub地址：
　　　　https://github.com/mybatis/generator

 

如何使用mybatis-generator插件呢？只需要三步： 

1、修改pom.xml配置文件

　　網上大部分說法都要添加依賴：mybatis-generator-core。但是我測試之后並不需要，可能新版本改版過了吧，只要在<build>中添加<plugin> 就可以了。（如果報錯的話再加上mybatis-generator-core的依賴吧）
　　需要特別注意的是：這里要指定配置文件目錄，名字可以自定義。

<build>
    <plugins>
        <plugin>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator-maven-plugin</artifactId>
            <version>1.3.6</version>
            <configuration>
                <!--指定配置文件目錄-->
                <configurationFile>${basedir}/src/main/resources/generatorConfig.xml</configurationFile>
                <overwrite>true</overwrite>
                <verbose>true</verbose>
            </configuration>
            <dependencies>
                <!--這里添加了mysql的驅動依賴，就不需要再配置文件中配置了-->
                <dependency>
                    <groupId>mysql</groupId>
                    <artifactId>mysql-connector-java</artifactId>
                    <version>5.1.44</version>
                </dependency>
            </dependencies>
        </plugin>
    </plugins>
</build>

 

2、添加pom中指定的配置文件generatorConfig.xml

　　比較重要的一個是，該插件生成代碼有帶xml映射文件的 和不帶xml而是使用注解的 兩種方式，只需要配置 <javaClientGenerator> 標簽的 type 屬性：
　　　　XMLMAPPER 生成xml映射文件, ANNOTATEDMAPPER 生成的dao采用注解來寫sql

　　mybatis-generator的屬性詳解網上也有很多資料，下面給出我的一個模板：

<?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>
    <!-- 數據庫驅動:選擇你的本地硬盤上面的數據庫驅動包，如果在pom文件中添加了依賴，那么這里就可以注釋掉了-->
    <!--<classPathEntry-->
    <!--location="E:\Maven\mvnRespo\mysql\mysql-connector-java\5.1.44\mysql-connector-java-5.1.44.jar"/>-->

    <!-- 一個數據庫一個context -->
    <context id="bing" targetRuntime="MyBatis3">

        <!-- 生成的model實現Serializable借口 -->
        <plugin type="org.mybatis.generator.plugins.SerializablePlugin">
            <!--<property name="suppressJavaInterface" value="true"/>-->
        </plugin>

        <!-- 自動生成equals方法和hashcode方法 -->
        <plugin type="org.mybatis.generator.plugins.EqualsHashCodePlugin"/>

        <!-- 該插件給實體類添加toString() -->
        <plugin type="org.mybatis.generator.plugins.ToStringPlugin"/>

        <!--<plugin type="org.mybatis.generator.plugins.CaseInsensitiveLikePlugin"/>-->
        <plugin type="org.mybatis.generator.plugins.MapperAnnotationPlugin"/>

        <plugin type="org.mybatis.generator.plugins.RowBoundsPlugin"/>


        <commentGenerator>
            <property name="suppressDate" value="true"/>
            <!-- 是否去除自動生成的注釋 true：是 ： false:否 -->
            <property name="suppressAllComments" value="false"/>
            <property name="addRemarkComments" value="false"/>
        </commentGenerator>

        <!--數據庫鏈接URL，用戶名、密碼 -->
        <jdbcConnection driverClass="com.mysql.jdbc.Driver"
                        connectionURL="jdbc:mysql://localhost:3306/test?useUnicode=true&amp;characterEncoding=UTF-8&amp;serverTimezone=UTC"
                        userId="root"
                        password="123456">
        </jdbcConnection>

        <!-- 類型轉換 -->
        <javaTypeResolver>
            <!-- 是否使用bigDecimal， false可自動轉化以下類型（Long, Integer, Short, etc.） -->
            <property name="forceBigDecimals" value="false"/>
        </javaTypeResolver>

        <!-- 生成模型（實體）的包名和位置-->
        <javaModelGenerator targetPackage="com.ajz.course.ddao.model" targetProject="src/main/java">
            <property name="enableSubPackages" value="true"/>
            <property name="trimStrings" value="true"/>
        </javaModelGenerator>

        <!-- 生成映射文件的包名和位置-->
        <sqlMapGenerator targetPackage="mapping" targetProject="src/main/resources">
            <property name="enableSubPackages" value="true"/>
        </sqlMapGenerator>

        <!-- 生成DAO的包名和位置-->
        <!-- XMLMAPPER生成xml映射文件, ANNOTATEDMAPPER 生成的dao采用注解來寫sql -->
        <javaClientGenerator type="XMLMAPPER" targetPackage="com.ajz.course.ddao.mapper" targetProject="src/main/java">
            <property name="enableSubPackages" value="true"/>
        </javaClientGenerator>

        <!-- 要生成的表 tableName是數據庫中的表名或視圖名 domainObjectName是實體類名-->
        <table tableName="course" domainObjectName="CourseModel">
            <generatedKey column="id" sqlStatement="MySql" identity="true"/>
        </table>
        <!-- table可以有多個,每個數據庫中的表都可以寫一個table，tableName表示要匹配的數據庫表,也可以在tableName屬性中通過使用%通配符來匹配所有數據庫表,只有匹配的表才會自動生成文件 -->
        <table tableName="rel_course_school" domainObjectName="CourseSchoolModel">
            <generatedKey column="id" sqlStatement="MySql" identity="true"/>
        </table>

    </context>
</generatorConfiguration>

 

3、執行mybatis-generator

　　如果使用IDEA來加載項目，那再簡單不過了。在【Maven Projects】窗口，找到對應項目下的【Plugins】目錄，找到【mybatis-generator】下第一個generate命令，直接雙擊就好了，如圖：

　　　　

　　如果非要自己寫命令，或者就是非maven項目，那就需要在第二步中必須指定本地的數據庫驅動，將目錄切換到lib目錄下，然后執行腳本：
　　　　java -jar mybatis-generator-core-1.3.6.jar -configfile generatorConfig.xml -overwrite

　　（PS：這種方法暫時沒驗證過啊，網上都這么寫的，囧）

　　注意：重復執行會覆蓋

原創文章，歡迎轉載，轉載請注明出處！