如何使用mybatis generator

如何使用mybatis generator

mybatis generator是什么

根据官方介绍mybatis generator（MBG）是mybatis的代码生成器，它能为mybatis所有版本生成代码，能够对简单的CRUD（创建，检索，更新，删除）的大部分数据库操作产生重大影响，但也仍将需要手工编写一些sql和对象代码进行连接查询或存储过程。MGB还能根据其配置方式以不同的样式和不同的语言生成代码，比如生成java或kotiln代码。其他官方介绍见网址：http://mybatis.org/generator/index.html，下面我着重讲一下mybatis gennerator在Idle中java的使用过程，以及相应文件配置还有一些手动代码的使用。

mybatis generator的使用过程

1.引入mybatis generator的依赖

<build>
      <plugins>
        <plugin>
          <!--Mybatis-generator插件,用于自动生成Mapper和POJO-->
          <groupId>org.mybatis.generator</groupId>
          <artifactId>mybatis-generator-maven-plugin</artifactId>
          <version>1.3.7</version>
          <configuration>
            <!--配置文件的位置-->
            <configurationFile>src/main/resources/mybatisGeneratorConfig.xml</configurationFile>
            <verbose>true</verbose>
            <overwrite>true</overwrite>
          </configuration>
          <executions>
            <execution>
              <id>Generate MyBatis Artifacts</id>
              <goals>
                <goal>generate</goal>
              </goals>
            </execution>
          </executions>
          <dependencies>
            <dependency>
              <groupId>mysql</groupId>
              <artifactId>mysql-connector-java</artifactId>
              <version>5.1.30</version>
            </dependency>
            <!--生成代码插件-->
            <dependency>
              <groupId>org.mybatis.generator</groupId>
              <artifactId>mybatis-generator-core</artifactId>
              <version>1.3.7</version>
            </dependency>
          </dependencies>
        </plugin>
      </plugins>
  </build>    

2.创建mybatisGeneratorConfig.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="suppressDate" value="true"/>

            <property name="suppressAllComments" value="true"/>
        </commentGenerator>
        <jdbcConnection driverClass="com.mysql.jdbc.Driver" connectionURL="jdbc:mysql://localhost:3306/supergo"
                        userId="root"
                        password="123456">
        </jdbcConnection>
        <!--生成entity类存放位置-->
        <javaModelGenerator targetPackage="com.nier.entity" targetProject="D:\sm_shop\sm_shop\src\main\java">
            <property name="enableSubPackages" value="true"/>
            <property name="trimStrings" value="true"/>
        </javaModelGenerator>
        <!--生成映射文件存放位置-->
        <sqlMapGenerator targetPackage="mapper" targetProject="D:\sm_shop\sm_shop\src\main\resources">
            <property name="enableSubPackages" value="true"/>
        </sqlMapGenerator>
        <!--生成Dao类存放位置-->
        <javaClientGenerator type="XMLMAPPER" targetPackage="com.nier.dao"
                             targetProject="D:\sm_shop\sm_shop\src\main\java">
            <property name="enableSubPackages" value="true"/>
        </javaClientGenerator>
        <table tableName="tb_item" domainObjectName="Item">
    </table>
    </context>
</generatorConfiguration>

注意：创建的mybatisGeneratorConfig.xml文件应该是放在上面第一步设置插件中mybatis-generator-maven-plugin这个依赖下的配置文件路径下。

3.执行maven中的插件且生成效果预览
点击：

生成效果：

4.配置详解
在官方中很全面介绍了配置文件中的标签，这儿说下几个标签：

<context>元素用于指定一组对象的环境,也就是说是配置文件结构中的父标签。子环境也就是子标签用于指定要连接的数据库，要生成的对象的类型以及要进行内省的表。可以通过在<generatorConfiguration>元素内列出多个<context>元素，以允许在MGB的同一运行中从不同的数据库或具有不同的生成参数生成对象。标签内填写属性见官方地址:http://mybatis.org/generator/configreference/context.html

<jdbcConnection><javaModelGenerator><javaClientGenerator><sqlMapGenerator >分别设置数据库连接配置，项目中实体生成地址和包名，项目中生成映射文件Dao层接口地址和包名,项目中生成映射xml文件地址地址和包名。各标签下属性见分别见官方地址：http://mybatis.org/generator/configreference/jdbcConnection.html，http://mybatis.org/generator/configreference/javaModelGenerator.html，
http://mybatis.org/generator/configreference/javaClientGenerator.html，
http://mybatis.org/generator/configreference/sqlMapGenerator.html

<table>一个重要的标签，用于选择数据库的表进行创建，选定的表可以为每个表生成对象包括：mybatis格式化的sql Map文件；生成实体类；可以在一个context下指定无数个<table>，获取此标签更多了解地址:
http://mybatis.org/generator/configreference/table.html

<commmentGenerator>用于定义注释生成器的属性。注释生成器用于为mybatis生成器生成各种元素（java字段，java方法，xml元素）生成注释。获取此标签更多了解地址:
http://mybatis.org/generator/configreference/commentGenerator.html
<columnRenamingRule>用于元素重命名数据库列，当表中的所有列都有一个公共前缀，在计算属性名称之前应将其删除。如一个表中有以下字段（）item_title,item_price,item_sell_point就可以将前缀item去掉。获取此标签更多了解地址：http://mybatis.org/generator/configreference/columnRenamingRule.html

更多标签情况见官方地址：http://mybatis.org/generator/configreference/xmlconfig.html

5.配置中文件中涉及可代码自定义部分

此部分可以见网上自行查询,