【Mybatis从入门到实战教程】第九章 Mybatis Generator代码生成

本是古典何须时尚 2024-04-28 13:21 67阅读 0赞

## 九、Mybatis Generator代码生成 ##

虽然MyBatis是一个简单易学的框架，但是配置XML文件也是一件相当繁琐的一个过程，而且会出现很多不容易定位的错误。当在工作中需要生成大量对象的时候，有太多的重复劳动，简直是生无可恋。  
  
为此官方开发了MyBatis Generator。它只需要很少量的简单配置，就可以完成大量的表到Java对象的生成工作，拥有零出错和速度快的优点，让开发人员解放出来更专注于业务逻辑的开发。

### 9.1 生成文件介绍 ###

MyBatis Generator生成的文件包含三类：  
1、Model实体文件，一个数据库表对应生成一个 Model 实体；  
2、Mapper接口文件，数据数操作方法都在此接口中定义；  
3、Mapper XML配置文件；

### 9.2 配置依赖 ###

<dependencies>
        
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.4.6</version>
        </dependency>
        
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.49</version>
        </dependency>
        
        <dependency>
            <groupId>log4j</groupId>
            <artifactId>log4j</artifactId>
            <version>1.2.17</version>
        </dependency>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.12</version>
            <scope>test</scope>
        </dependency>
        
        <dependency>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator-core</artifactId>
            <version>1.3.7</version>
        </dependency>
    </dependencies>

### 9.3 引入相关配置 ###

我们只需引入log4j.properties即可，无需引入mybatis-config.xml。

### 9.4 生成配置文件 ###

**generator.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="testTables" targetRuntime="MyBatis3">
            
            <plugin type="org.mybatis.generator.plugins.SerializablePlugin"/>
            
            <plugin type="org.mybatis.generator.plugins.ToStringPlugin"/>
            
            <plugin type="org.mybatis.generator.plugins.UnmergeableXmlMappersPlugin" />
    
            <commentGenerator>
                
                <property name="suppressAllComments" value="true" />
            </commentGenerator>
    
            
            <jdbcConnection driverClass="com.mysql.jdbc.Driver"
                            connectionURL="jdbc:mysql://localhost:3306/ssm"
                            userId="root"
                            password="root">
            </jdbcConnection>
    
            
            <javaTypeResolver>
                <property name="forceBigDecimals" value="false" />
            </javaTypeResolver>
    
            
            <javaModelGenerator targetPackage="com.newcapec.entity" targetProject=".\src\main\java">
                
                <property name="constructorBased" value="true"/>
    
                
                <property name="enableSubPackages" value="false" />
                
                <property name="trimStrings" value="true" />
            </javaModelGenerator>
    
            
            <sqlMapGenerator targetPackage="mapper" targetProject=".\src\main\resources">
                <property name="enableSubPackages" value="false" />
            </sqlMapGenerator>
    
            
            <javaClientGenerator type="XMLMAPPER" targetPackage="com.newcapec.mapper" targetProject=".\src\main\java">
                <property name="enableSubPackages" value="false" />
            </javaClientGenerator>
    
    
            
            
            
            <table tableName="users" domainObjectName="Users"
                   enableCountByExample="false"
                   enableUpdateByExample="false"
                   enableDeleteByExample="false"
                   enableSelectByExample="false"
                   selectByExampleQueryId="false">
                
                <property name="useActualColumnNames" value="false"/>
            </table>
        </context>
    </generatorConfiguration>

Mybatis Generator最完整配置详解：  
https://blog.csdn.net/qq\_33326449/article/details/105930655

### 9.5 生成文件代码 ###

public class Generator {
    
        public static void main(String[] args) throws Exception {
            //是否覆盖已有文件
            boolean overwirte = true;
            DefaultShellCallback callback = new DefaultShellCallback(overwirte);
            List<String> warnings = new ArrayList<>();
    
            //创建配置解析类
            ConfigurationParser configurationParser = new ConfigurationParser(warnings);
            InputStream in = Generator.class.getClassLoader().getResourceAsStream("generator.xml");
            Configuration configuration = configurationParser.parseConfiguration(in);
            MyBatisGenerator myBatisGenerator = new MyBatisGenerator(configuration, callback, warnings);
            myBatisGenerator.generate(null);
            System.out.println("代码生成成功...");
        }
    }

### 9.6 第三方插件 ###

#### 9.6.1 Free Mybatis Tool ####

**安装插件**

File -> Settings -> Plugins -> 搜索框输入：Free Mybatis Tool，点击Install安装。  
  
注意：安装完成之后，最好重启IDEA。

![e57b24b4a9da42dc8f714120d26ec59e.png][]

**逆向生成mapper、类**

通过这个插件不用使用官方的mybatis逆向生成包，写配置文件等等，仅需连接对应数据库就可以实现逆向生成对应的类、mapper文件等。

第一步：连接数据库

![2e38b96947074e5286fc2a465eb0a478.png][]

![02ed09c9da6743cdbb907273d6b78a35.png][]

第二步：配置Driver（首次使用）

点击Driver：Mysql -> Go to Driver，配置MySQL驱动；

![f73c31d6e3e74115ace2ba976757e057.png][]

![e8c5733ec8134ab4b1029a121b4b45ea.png][]

第三步：找到需要逆向生成的表右键选择Mybatis-Generator

![b4feb6e0a12d46cd984163f1f5795120.png][]

第四步：配置

![cd42ab36af21456d9436987f0dbce721.png][]

**跳转功能**

在使用mybatis框架的时候，你还在一个类一个类的点开寻找对应mapper或者dao程序的位置吗？那样就会显得特别麻烦且浪费时间。而这个Free Mybatis Tool插件提供了跳转的功能。通过点击箭头就可以跳转到相应的地方。

![c18e1c9a751142f1a847db53b239dd1b.png][]

#### 9.6.2 Easy Code ####

EasyCode是idea的一个插件，可以采用图形化的方式对数据的表生成entity，controller，service，dao，mapper……无需任何编码，简单而强大。

**安装插件**

File -> Settings -> Plugins -> 搜索框输入：EasyCode，点击Install安装。  
  
注意：安装完成之后，最好重启IDEA。

![2d6cee3c3b434590bd92c620aef63c8c.png][]

**逆向生成mapper、类**

找到需要逆向生成的表右键选择EasyCode。  
1、Generate Code，代码生成；  
2、Config Table，配置表信息；

![77cbeca4a9a44ccaaba1b1661b8cc436.png][]

[e57b24b4a9da42dc8f714120d26ec59e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/28/e616059d348a4cbf8cde661d20a399b1.png
[2e38b96947074e5286fc2a465eb0a478.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/28/54569ecae21b4bf0a53f189d2efccff7.png
[02ed09c9da6743cdbb907273d6b78a35.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/28/007dea826ed64952b83bdbb56ef37771.png
[f73c31d6e3e74115ace2ba976757e057.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/28/a2d558ba885441b0ae5e28ae79abed3d.png
[e8c5733ec8134ab4b1029a121b4b45ea.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/28/5357556a04494ee6a1456c5c973fd4a9.png
[b4feb6e0a12d46cd984163f1f5795120.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/28/cc83de361d264a759b73eeaaa5708677.png
[cd42ab36af21456d9436987f0dbce721.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/28/c70607b31e8b4268859c9ada5343eb3d.png
[c18e1c9a751142f1a847db53b239dd1b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/28/ccf3d384f42e4ce1a9bb91d60864c0ef.png
[2d6cee3c3b434590bd92c620aef63c8c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/28/a50e27dc3c904d6ea09a6c4af2a2d410.png
[77cbeca4a9a44ccaaba1b1661b8cc436.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/28/e4c465be53c844e18effaed5d1975d7f.png