1. 程式人生 > 程式設計 >Mybatis generator自動生成程式碼外掛例項解析

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&characterEncoding=UTF-8&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命令,直接雙擊就好了,如圖:

Mybatis generator自動生成程式碼外掛例項解析

  如果非要自己寫命令,或者就是非maven專案,那就需要在第二步中必須指定本地的資料庫驅動,將目錄切換到lib目錄下,然後執行指令碼:

    java -jar mybatis-generator-core-1.3.6.jar -configfile generatorConfig.xml -overwrite

  (PS:這種方法暫時沒驗證過啊,網上都這麼寫的,囧)

  注意:重複執行會覆蓋

以上就是本文的全部內容,希望對大家的學習有所幫助,也希望大家多多支援我們。