mybatis之mybatis-generator生成model、mapper、mapperxml

开发工具：idea社区版2018.1+jdk8+maven3.5.2

本例使用maven方式生成，也可以使用java编码方式运行MBG。

使用通用 Mapper 插件
插件代码在tk.mybatis.mapper.generator包下面，一共有如下两个类：

MapperCommentGenerator：该类用于生成数据库备注字段的注释，以及实体类字段的注解。

MapperPlugin：插件的实现类，该类默认使用上面这个注释生成器，插件屏蔽了一般的CRUD方法（保留了Example），插件可以生成实体的@Table注解。

参考文档：https://mapperhelper.github.io/docs/3.usembg/

1、新建一个maven项目，添加mybatis3.4.6依赖、添加数据库连接jar(本例中是mysql)。

<dependency>
    <groupId>org.mybatis</groupId>
    <artifactId>mybatis</artifactId>
    <version>3.4.6</version>
</dependency>
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>8.0.11</version>
</dependency>

配置mybatis-config.xml,XML 配置文件（configuration XML）中包含了对 MyBatis 系统的核心设置，包含获取数据库连接实例的数据源（DataSource）和决定事务作用域和控制方式的事务管理器（TransactionManager）。

本例中mybatis-config.xml

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
  PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
  "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
    <properties resource="db.properties"/>--引入的数据库连接的properties文件。
  <environments default="development">
    <environment id="development">
      <transactionManager type="JDBC"/>
      <dataSource type="com.mybatis.db.DruidDataSourceFacotry">--定义使用druid连接池、默认使用的是C3p0
       <!-- <property name="driver" value="${driverClass}"/>-->
        <property name="url" value="${url}"/>
        <property name="username" value="${username}"/>
        <property name="password" value="${password}"/>
        
       <!--  <property name="poolMaximumActiveConnections" value="${poolMaximumActiveConnections}"/>在任意时间可以存在的活动（也就是正在使用）连接数量，默认值：10
        <property name="poolMaximumIdleConnections" value="${poolMaximumIdleConnections}"/>任意时间可能存在的空闲连接数
        <property name="poolMaximumCheckoutTime" value="${poolMaximumCheckoutTime}"/>在被强制返回之前，池中连接被检出（checked out）时间 
        <property name="poolTimeToWait" value="${poolTimeToWait}"/>如果获取连接花费了相当长的时间，连接池会打印状态日志并重新尝试获取一个连接 
        <property name="poolMaximumLocalBadConnectionTolerance" value="${poolMaximumLocalBadConnectionTolerance}"/>这是一个关于坏连接容忍度的底层设置
        <property name="poolPingQuery" value="${poolPingQuery}"/>发送到数据库的侦测查询，用来检验连接是否正常工作并准备接受请求。 
        <property name="poolPingEnabled" value="${poolPingEnabled}"/>是否启用侦测查询 
        <property name="poolPingConnectionsNotUsedFor" value="${poolPingConnectionsNotUsedFor}"/>配置 poolPingQuery 的频率 -->
      </dataSource>
    </environment>
  </environments>
  <databaseIdProvider type="DB_VENDOR">
  <property name="SQL Server" value="sqlserver"/>
  <property name="DB2" value="db2"/>        
  <property name="Oracle" value="oracle" />
</databaseIdProvider>
   <!-- <typeAliases>
        <typeAlias type="com.mybatis.pojo.User" alias="user"/>
    </typeAliases>-->
   <!--<mappers>
    <mapper resource="org/mybatis/example/BlogMapper.xml"/>
  </mappers> -->

</configuration>

db.properties文件

username=mysql
password=mysql
driverClass=com.mysql.jdbc.Driver
url=jdbc:mysql://192.168.135.136:3306/starter?useUnicode=true&characterEncoding=UTF-8&serverTimezone=GMT%2B8&useSSL=false
poolMaximumActiveConnections=10
poolMaximumIdleConnections=5
poolMaximumCheckoutTime=20000
poolTimeToWait=20000
poolMaximumLocalBadConnectionTolerance=3
poolPingQuery=NO PING QUERY SET
poolPingEnabled=false
poolPingConnectionsNotUsedFor=0

2、配置mybatis-generator。

-MBG maven插件配置

pom文件

引入mapper插件

<dependency>
        <groupId>tk.mybatis</groupId>
        <artifactId>mapper</artifactId>
        <version>4.0.1</version>
 </dependency>

配置mapper

<build>
        <plugins>
            <plugin>
                <groupId>org.mybatis.generator</groupId>
                <artifactId>mybatis-generator-maven-plugin</artifactId>
                <version>1.3.2</version>
                <configuration>
                    <configurationFile>${basedir}/src/main/resources/generatorConfig.xml</configurationFile>
                    <overwrite>true</overwrite>
                    <verbose>true</verbose>
                </configuration>
                <dependencies>
                    <dependency>
                        <groupId>mysql</groupId>
                        <artifactId>mysql-connector-java</artifactId>
                        <version>${mysql.version}</version>
                    </dependency>
                    <dependency>
                        <groupId>tk.mybatis</groupId>
                        <artifactId>mapper</artifactId>
                        <version>4.0.1</version>
                    </dependency>
                </dependencies>
            </plugin>
        </plugins>

    </build>

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>
    <properties resource="db.properties"/>


    <context id="Mysql" targetRuntime="MyBatis3Simple" defaultModelType="flat">
        <property name="beginningDelimiter" value="`"/>
        <property name="endingDelimiter" value="`"/>


        <plugin type="${mapper.plugin}">
            <property name="mappers" value="${mapper.Mapper}"/>
        </plugin>


        <jdbcConnection driverClass="${driverClass}"
                        connectionURL="${url}"
                        userId="${username}"
                        password="${password}">
        </jdbcConnection>


        <javaModelGenerator targetPackage="${targetModelPackage}" targetProject="${targetJavaProject}"/>


        <sqlMapGenerator targetPackage="${targetXMLPackage}"  targetProject="${targetResourcesProject}"/>


        <javaClientGenerator targetPackage="${targetMapperPackage}" targetProject="${targetJavaProject}" type="XMLMAPPER" />


        <table tableName="%" >
            <generatedKey column="id" sqlStatement="Mysql" identity="true"/>
        </table>
    </context>

</generatorConfiguration>

db.properties中添加：

mapper.plugin = tk.mybatis.mapper.generator.MapperPlugin
mapper.Mapper = tk.mybatis.mapper.common.Mapper

3、生成model、mapper、mapperxml。

运行generator

如果你使用ide工具可以直接点击运行。

如果你使用cmd，可以进到pom文件的目录，执行mvn mybatis-generator:generate

生成的结果如图：

完。

本例地址：https://github.com/vlijiantao/mybatis-generator