Mybatis Generator逆向工程的使用

待我称王封你为后i 2021-12-18 15:55 310阅读 0赞

# **MyBatis Generator简介** #

MyBatis Generator（MBG）是MyBatis [MyBatis][] 和[iBATIS][]的代码生成器。它将为所有版本的MyBatis以及版本2.2.0之后的iBATIS版本生成代码。它将内省数据库表（或许多表），并将生成可用于访问表的工件。这减少了设置对象和配置文件以与数据库表交互的初始麻烦。MBG寻求对简单CRUD（创建，检索，更新，删除）的大部分数据库操作产生重大影响。您仍然需要为连接查询或存储过程手动编写SQL和对象代码。

MyBatis Generator将生成：

*  与表结构匹配的Java POJO。这可能包括：
    
     *  一个匹配表的主键的类（如果有主键）
     *  一个匹配表的非主键字段的类（BLOB字段除外）
     *  包含表的BLOB字段的类（如果表具有BLOB字段）
     *  用于启用动态选择，更新和删除的类
    
    这些类之间存在适当的继承关系。请注意，生成器可以配置为生成不同类型的POJO层次结构 - 例如，如果您愿意，可以选择为每个表生成单个域对象。
 *  MyBatis / iBATIS兼容的SQL Map XML文件。MBG为配置中的每个表上的简单CRUD函数生成SQL。生成的SQL语句包括：
    
     *  插入
     *  按主键更新
     *  通过示例更新（使用动态where子句）
     *  按主键删除
     *  按示例删除（使用动态where子句）
     *  按主键选择
     *  按示例选择（使用动态where子句）
     *  以身作则
    
    根据表的结构，这些语句有不同的变体（例如，如果表没有主键，则MBG不会通过主键功能生成更新）。
 *  适当使用上述对象的Java客户端类。Java客户端类的生成是可选的。MBG将为MyBatis 3.x生成以下类型的Java客户端：
    
     *  适用于MyBatis 3.x映射器基础结构的映射器接口
    
    MBG将为iBATIS 2.x生成以下类型的Java客户端：
    
     *  符合[Spring][]框架的DAO
     *  仅使用iBATIS SQL映射API的DAO。这些DAO可以生成两种：通过构造函数或setter注入提供SqlMapClient。
     *  符合iBATIS DAO框架的DAO（iBATIS的可选部分，现在不推荐使用此框架，我们建议您使用Spring框架）

MyBatis生成器设计为在迭代开发环境中运行良好，并且可以作为Ant任务或Maven插件包含在连续构建环境中。迭代运行MBG时需要注意的重要事项包括：

1.  如果存在与新生成的XML文件同名的现有文件，MBG将自动合并XML文件。MBG不会覆盖您对其生成的XML文件所做的任何自定义更改。您可以反复运行它，而不必担心会丢失对XML的自定义更改。MBG将替换先前运行中生成的任何XML元素。
2.  MBG **不会**合并Java文件，它可以覆盖现有文件或使用不同的唯一名称保存新生成的文件。如果对生成的Java文件进行更改并以迭代方式运行MBG，则必须手动合并更改。当作为[Eclipse][] 插件运行时 ，MBG可以自动合并Java文件。

# **MyBatis Generator使用** #

第一步：新建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="generator.properties"></properties>
        
        
    
        <context id="default" targetRuntime="MyBatis3">
    
            
            <commentGenerator>
                <property name="suppressDate" value="false"/>
                <property name="suppressAllComments" value="false"/>
            </commentGenerator>
    
            
            <jdbcConnection
                    driverClass="${jdbc.driverClass}"
                    connectionURL="${jdbc.connectionURL}"
                    userId="${jdbc.userId}"
                    password="${jdbc.password}">
            </jdbcConnection>
    
    
            
            
            <javaTypeResolver>
                <property name="forceBigDecimals" value="false"/>
            </javaTypeResolver>
    
    
            
            <javaModelGenerator targetPackage="com.test.model"
                                targetProject=".\src\main\java">
                
                <property name="enableSubPackages" value="false"/>
                
                <property name="constructorBased" value="false"/>
                
                <property name="trimStrings" value="true"/>
                
                <property name="immutable" value="false"/>
            </javaModelGenerator>
    
            
            <sqlMapGenerator targetPackage="com.test.mapper"
                             targetProject=".\src\main\java">
                <property name="enableSubPackages" value="false"/>
            </sqlMapGenerator>
    
            
            <javaClientGenerator targetPackage="com.test.mapper"
                                 targetProject=".\src\main\java" type="XMLMAPPER">
                <property name="enableSubPackages" value="true"/>
            </javaClientGenerator>
    
            
            <table tableName="t_userinfo" domainObjectName="UserInfo"
                   enableCountByExample="false" enableUpdateByExample="false"
                   enableDeleteByExample="false" enableSelectByExample="false"
                   selectByExampleQueryId="false">
            </table>
        </context>
    </generatorConfiguration>

第二步：新建generator.properties文件

jdbc.driverLocation=C:\\mysql-connector-java-5.1.43.jar
    jdbc.driverClass=com.mysql.jdbc.Driver
    jdbc.connectionURL=jdbc:mysql://localhost:3306/mybatis
    jdbc.userId=root
    jdbc.password=tiger

第三步：配置执行mybatis generator操作，这里有两种方式

这里有两种方式

第1种方式：如果使用maven项目就可以省去编写Java启动类，使用maven插件和配置文件pom.xml即可，插件启动maven-generator，在pom.xml中添加maven-generator插件

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

点击mybatis-generator:generate就能执行mybatis generator了

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5NjY5MDU4_size_16_color_FFFFFF_t_70][]

第2种方式：

①：如果不是maven项目添加该mybatis-generator-core-1.3.2.jar，编写main方法指向mybatis逆向工程，我给依赖粘贴到下面了

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

②：修改generatorConfig.xml文件

③：然后编写测试类执行：

/**
     * 如果不是maven项目可以这样生成
     */
    public class MybatisGeneratorTest {
        public static void main(String[] args) throws InterruptedException, SQLException, IOException, InvalidConfigurationException, XMLParserException {
            List<String> warnings = new ArrayList<String>();
            //生成的java文件是否覆盖
            boolean overwrite = true;
            //指定逆向工程配置文件
            //File configFile = new File("E:\\project\\mybatis-generator\\src\\main\\resources\\generatorConfig.xml");
            InputStream resourceAsStream = MybatisGeneratorTest.class.getClassLoader().getResourceAsStream("generatorConfig.xml");
            ConfigurationParser cp = new ConfigurationParser(warnings);
            Configuration config = cp.parseConfiguration(resourceAsStream);
            DefaultShellCallback callback = new DefaultShellCallback(overwrite);
            MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config,callback, warnings);
            myBatisGenerator.generate(null);
        }
    }

数据库表结构：

![2019070218122856.png][]

查看生成的实体类：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5NjY5MDU4_size_16_color_FFFFFF_t_70 1][]

**TIP:****可以看出如果****实体类****想要遵循****驼峰命名****规范，数据库表字段名设计需要****用"\_"来划分**

查看生成的文件信息：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5NjY5MDU4_size_16_color_FFFFFF_t_70 2][]

**TIP1：**必须在<plugin></plugin>标签里添加数据库驱动，在其他地方添加无效，如果不添加会报找不到驱动错误，如过不在该插件添加数据库依赖的话可以使用 <classPathEntry location="$\{jdbc.driverLocation\}"/>来指定数据库驱动位置。

**TIP2：**如果你在使用mybatis generator插件执行的时候报\[ERROR\] Failed to execute goal org.mybatis.generator:mybatis-generator-maven-plugin:1.3.2:generate (default-cli) on project mybatis-generator: <properties> resource generator.properties does not exist -> \[Help 1\]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5NjY5MDU4_size_16_color_FFFFFF_t_70 3][]

尽管你的<properties resource="generator.properties"></properties>配置的没有问题，但是还是找不到generator.properties，查看该配置，注释掉

![20190702193711835.png][]

**该配置会改变generatorConfig.xml中读取generator.properties文件的默认路径**

**TIP3：**Mybatis Generator反向工程默认不会覆盖生成的\*.java文件。也可以设置覆盖生成的\*.java文件，在反向工程插件mybatis-generator-maven-plugin添加该配置<overwrite>true</overwrite>则会覆盖生成的\*.java文件，如图

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5NjY5MDU4_size_16_color_FFFFFF_t_70 4][]

Mybatis Generator不会覆盖你的mapper.xml文件，他会合并追加到mapper.xml和你自定义的存在一起，但是如果你修改他第一次默认生成的sql（自己生成的CRUD），他会重新把自己生成的CRUD恢复默认，说白了，他只会覆盖他自己生成的，不会覆盖你自定义的，你自定义的不变。。如图，他不会动你的自定义sql，只会覆盖Mybatis反向工程自己生成的sql

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5NjY5MDU4_size_16_color_FFFFFF_t_70 5][]

更多Mybatis逆向工程的使用参考：[http://www.mybatis.org/generator/index.html][http_www.mybatis.org_generator_index.html]

[MyBatis]: http://mybatis.org/
[iBATIS]: http://ibatis.apache.org/
[Spring]: http://www.springframework.org/
[Eclipse]: http://www.eclipse.org/
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5NjY5MDU4_size_16_color_FFFFFF_t_70]: /images/20211218/691691ce65994056828eacad0408961d.png
[2019070218122856.png]: /images/20211218/7084fc497ad1433491b5b3a33957693b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5NjY5MDU4_size_16_color_FFFFFF_t_70 1]: /images/20211218/ba8ec28a6bc94591bae2b8e789db50dd.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5NjY5MDU4_size_16_color_FFFFFF_t_70 2]: /images/20211218/0fb11aef5b034d4d9950edc260be78a8.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5NjY5MDU4_size_16_color_FFFFFF_t_70 3]: /images/20211218/8b23946c379a44a683edb0e1d6c05fc4.png
[20190702193711835.png]: /images/20211218/2fa2bbaea13747ea9372e53158c6fa99.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5NjY5MDU4_size_16_color_FFFFFF_t_70 4]: /images/20211218/6e80f367610e4cbb89bf1ed27dc049bb.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5NjY5MDU4_size_16_color_FFFFFF_t_70 5]: /images/20211218/77063a2ed8984f2cbb67bf96d611c1cb.png
[http_www.mybatis.org_generator_index.html]: http://www.mybatis.org/generator/index.html