Mybatis generator自动生成代码插件实例解析

mybatis自动生成代码（实体类、dao接口等）是很成熟的了，就是使用mybatis-generator插件。 它是一个开源的插件，使用maven构建最好，可以很方便的执行

　　插件官方简介：

　　　　

　　插件的github地址：

　　　　

如何使用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命令，直接双击就好了，如图：

　　如果非要自己写命令，或者就是非maven项目，那就需要在第二步中必须指定本地的数据库驱动，将目录切换到lib目录下，然后执行脚本：

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

　　（ps：这种方法暂时没验证过啊，网上都这么写的，囧）

　　注意：重复执行会覆盖

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持。