Mybatis 集成 Generator 快速生成代码

前言：

Mybatis是现在比较常用的持久层框架，使用起来方便，而且功能也比较强

大，实现方法大致分为两种：

1：基于注解

2：基于映射文件

但是当需要操作的实体类较多时，逐个编写基于注解或基于映射文件的 CRUD 耗

时长且容易出错，重复这种操作对个人能力的提升也没有任何帮助，使用这时

候 Generator 就派上用场了，它不仅可以保证基本 CRUD的编写准确，还能节省大

量的编码时间，给你留有足够的时间去实现业务逻辑，而不是复制代码上。

正文：

1.添加maven依赖

<dependency>
 <groupId>org.mybatis.generator</groupId>
 <artifactId>mybatis-generator-core</artifactId>
 <version>1.3.2</version>
</dependency>

2.编写核心配置文件 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">
<!-- 第一种 mybatis逆向生成 xml配置 -->
<generatorConfiguration>
<!-- <properties resource="test/application.properties" />-
->
<context id="sqlserverTables" targetRuntime="MyBatis3">
<!-- 生成的 pojo，将 implements Serializable-->
<plugin
type="org.mybatis.generator.plugins.SerializablePlugin"></plugin>
<commentGenerator>
<!-- 是否去除自动生成的注释 true：是 ： false:否 -
->
<property name="suppressAllComments" value="true"
/>
</commentGenerator>
<!-- 数据库链接 URL、用户名、密码 -->
<jdbcConnection driverClass="com.mysql.jdbc.Driver"
connectionURL="jdbc:mysql://192.168.145.112:3306/test?useUnicode=t
rue"
userId="root"
password="123456">
</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.test.hydra"
targetProject="./src/main/java">
<property name="enableSubPackages" value="true"/>
<!-- 从数据库返回的值被清理前后的空格 -->
<property name="trimStrings" value="true" />
</javaModelGenerator>
<!--对应的 mapper.xml文件 -->
<sqlMapGenerator targetPackage="mapper"
targetProject="./src/main/resources">
<property name="enableSubPackages" value="true"/>
</sqlMapGenerator>
<!-- 对应的 Mapper接口类文件 -->
<javaClientGenerator type="XMLMAPPER"
targetPackage="com.test.hydra.mapper"
targetProject="./src/main/java">
<property name="enableSubPackages" value="true"/>
</javaClientGenerator>
<!-- 列出要生成代码的所有表，这里配置的是不生成
Example 文件 domainObjectName 是指生成的类前缀，比如 UserMapper-->
<table tableName="user" domainObjectName="User"
enableCountByExample="false"
enableUpdateByExample="false" enableDeleteByExample="false"
enableSelectByExample="false"
selectByExampleQueryId="false" >
<property name="useActualColumnNames"
value="false"/>
</table>
</context>
</generatorConfiguration>

3. 编写自动生成代码类 GeneratorMain.java

完整的代码如下：

package com.test.bird.utils;
import org.mybatis.generator.api.MyBatisGenerator;
import org.mybatis.generator.config.Configuration;
import org.mybatis.generator.config.xml.ConfigurationParser;
import org.mybatis.generator.exception.InvalidConfigurationException;
import org.mybatis.generator.exception.XMLParserException;
import org.mybatis.generator.internal.DefaultShellCallback;
import java.io.File;
import java.io.IOException;
import java.sql.SQLException;
import java.util.ArrayList;
import java.util.List;
public class GeneratorMain {
public static void main(String[] args) {
List<String> warnings = new ArrayList<String>();
boolean overwrite = true;
String genCfg =
"D:\\IDEA_WORKSPACE\\bird\\src\\main\\resources\\generatorConfig.xml"
;
// java.net.URL url = GeneratorMain.class.getResource(genCfg);
File configFile = new File(genCfg);
ConfigurationParser cp = new ConfigurationParser(warnings);
Configuration config = null;
try {
config = cp.parseConfiguration(configFile);
} catch (IOException e) {
e.printStackTrace();
} catch (XMLParserException e) {
e.printStackTrace();
}
DefaultShellCallback callback = new
DefaultShellCallback(overwrite);
MyBatisGenerator myBatisGenerator = null;
try {
myBatisGenerator = new MyBatisGenerator(config, callback,
warnings);
} catch (InvalidConfigurationException e) {
e.printStackTrace();
}
try {
myBatisGenerator.generate(null);
} catch (SQLException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
} catch (InterruptedException e) {
e.printStackTrace();
}
}
}

4. Main 方法跑完，查看目录结构代码是否成功生成

TestUserMapper.java

TestUser.java

TestUserMapper.xml

后续我们再探讨自动生成代码的另一个工具：mybatis-plus