Java利用mybatis-generator自动生成实体详解

Mybatis是半自动ORM，在使用该框架时工作量最大的就是书写Mapping的映射文件，由于手动书写很容易出错，我们可以利用mybatis-generator插件来完成自动生成实体类、配置文件等。

1、准备工作

mybatis-generator下载地址：https://github.com/mybatis/generator/releases（官网目前好像已经挂了）

使用Mysql数据库，需要准备一个连接mysql数据库的驱动jar包，如：mysql-connector-java-5.1.34.jar

2、在pom.xml文件中添加plugin插件，代码如下：

<plugin>
    <groupId>org.mybatis.generator</groupId>
    <artifactId>mybatis-generator-maven-plugin</artifactId>
    <version>1.3.3</version>
    <configuration>
<configurationFile>src/main/resources/mybatis-generator/generatorConfig.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>org.mybatis.generator</groupId>
    <artifactId>mybatis-generator-core</artifactId>
    <version>1.3.3</version>
</dependency>
    </dependencies>
</plugin>

3、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>  
    <classPathEntry location="E:\repository\mysql\mysql-connector-java\5.1.34\mysql-connector-java-5.1.34.jar" />
    <context id="sqlserverTables" targetRuntime="MyBatis3">  
<!-- 生成的pojo，将implements Serializable-->  
<plugin type="org.mybatis.generator.plugins.SerializablePlugin"></plugin>  
<commentGenerator >  
<property name="javaFileEncoding" value="UTF-8"/>
    <!-- 是否去除自动生成的注释 true：是 ： false:否 -->  
    <property name="suppressAllComments" value="true" />
    <property name="suppressDate" value="true" />
</commentGenerator>  
  
<!-- 数据库链接URL、用户名、密码 -->  
<!--数据库连接 -->
<jdbcConnection driverClass="com.mysql.jdbc.Driver"
connectionURL="jdbc:mysql://www.yoodb.com:3306/xxxxxx"
userId="xxxxxx"
password="xxxxxx">
</jdbcConnection>
  
<!--    
默认false，把JDBC DECIMAL 和 NUMERIC 类型解析为 Integer  
    true，把JDBC DECIMAL 和 NUMERIC 类型解析为java.math.BigDecimal    
-->  
<javaTypeResolver>  
    <property name="forceBigDecimals" value="false" />  
</javaTypeResolver>  
  
<!--   
生成model模型，对应的包路径，以及文件存放路径(targetProject)，targetProject可以指定具体的路径,如./src/main/java，  
也可以使用“MAVEN”来自动生成，这样生成的代码会在target/generatord-source目录下  
-->  
<!--<javaModelGenerator targetPackage="com.joey.mybaties.test.pojo" targetProject="MAVEN">-->  
<javaModelGenerator targetPackage="com.yoodb.domains" targetProject="./src/main/java">  
    <property name="enableSubPackages" value="true"/>  
    <!-- 从数据库返回的值被清理前后的空格  -->  
    <property name="trimStrings" value="true" />  
</javaModelGenerator>  
  
<!--对应的mapper.xml文件  -->  
<sqlMapGenerator targetPackage="biz-mybatis" targetProject="./src/main/resources">  
    <property name="enableSubPackages" value="true"/>  
</sqlMapGenerator>  
  
<!-- 对应的Mapper接口类文件 -->  
<javaClientGenerator type="XMLMAPPER" targetPackage="com.yoodb.dao" targetProject="./src/main/java">  
    <property name="enableSubPackages" value="true"/>  
</javaClientGenerator>  
  
  
<!-- 列出要生成代码的所有表，这里配置的是不生成Example文件 -->  
<table tableName="t_user" domainObjectName="User"  
       enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false"  
       enableSelectByExample="false" selectByExampleQueryId="false" >  
    <property name="useActualColumnNames" value="false"/>  
</table>  
    </context>  
</generatorConfiguration>

4、在eclipse中运行命令mybatis-generator:generate或在maven客户端运行命令mvn mybatis-generator:generate，运行成功后刷新对于的文件目录即可。