IDEA MyBatis Generator逆向工程入门及案例

爱被打了一巴掌 2023-06-13 06:20 19阅读 0赞

### MyBatis逆向工程创建CRUD代码 ###

*  逆向工程简介
 *   *  什么是逆向工程
     *  官方文档
 *  逆向工程的创建
 *   *  创建Maven项目导入依赖
     *  创建配置文件
     *  在IDEA中执行generate
     *  生成WithBLOBS文件原因及解决方法
     *   *  原因
         *  解决方法
 *  如何使用刚刚生成的代码
 *   *  创建MyBatis的配置文件
     *  创建测试类调用

# 逆向工程简介 #

## 什么是逆向工程 ##

MyBatis需要程序员自己编写sql语句，MyBatis官方提供逆向工程，可以针对单表自动生成MyBatis执行所需要的代码（mapper.java、mapper.xml、pojo…），可以让程序员将更多的精力放在繁杂的业务逻辑上。  
实际开发中，常用的逆向工程方式：由数据库的表生成java代码。

## 官方文档 ##

[MyBatis Generator][]

# 逆向工程的创建 #

## 创建Maven项目导入依赖 ##

在pom.xml中添加如下依赖和插件，具体可见官方文档：[Running MyBatis Generator With Maven][]

<dependencies>
            <dependency>
                <groupId>org.mybatis</groupId>
                <artifactId>mybatis</artifactId>
                <version>3.5.2</version>
            </dependency>
            <dependency>
                <groupId>junit</groupId>
                <artifactId>junit</artifactId>
                <version>4.12</version>
                <scope>test</scope>
            </dependency>
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <version>8.0.18</version>
            </dependency>
        </dependencies>
    
        <build>
            <plugins>
                <plugin>
                    <groupId>org.mybatis.generator</groupId>
                    <artifactId>mybatis-generator-maven-plugin</artifactId>
                    <version>1.3.7</version>
                    <configuration>
                        
                        <configurationFile>src/main/resources/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.7</version>
                        </dependency>
                        <dependency>
                            <groupId>mysql</groupId>
                            <artifactId>mysql-connector-java</artifactId>
                            <version>8.0.18</version>
                        </dependency>
                    </dependencies>
                </plugin>
            </plugins>
        </build>

## 创建配置文件 ##

在resources中创建generatorConfig.xml，使用如下代码，具体见官方文档：[MyBatis GeneratorXML Configuration File Reference][]

<?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="DB2Tables" targetRuntime="MyBatis3">
            
            <jdbcConnection driverClass="com.mysql.cj.jdbc.Driver" connectionURL="jdbc:mysql://localhost:3306/eesy_mybatis?serverTimezone=UTC" userId="root" password="1999">
            </jdbcConnection>
    
            <javaTypeResolver >
                
                <property name="forceBigDecimals" value="false" />
            </javaTypeResolver>
    
            
            <javaModelGenerator targetPackage="com.cjx.entity" targetProject=".\src\main\java">
                
                <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.cjx.mapper" targetProject=".\src\main\java">
                
                <property name="enableSubPackages" value="true" />
            </javaClientGenerator>
    
            
            <table tableName="user"/>
    
        </context>
    </generatorConfiguration>

## 在IDEA中执行generate ##

如图所示，在IDEA中点击Maven窗口，在Plugins中找到mybatis-generator，点击generate，就可以看到左边已经出现了在配置文件中配置的数据库的表生成的类（User）  
![点击这里生成][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzE2ODE5MA_size_16_color_FFFFFF_t_70_pic_center]

## 生成WithBLOBS文件原因及解决方法 ##

### 原因 ###

生成结束后，发现跟我想象的不太一样，不只有User和UserExample，还有Key和WithBLOBS文件，看下面的警告，发现是因为数据库中不只一个表叫user，如图所示：  
![出现warning][warning]

### 解决方法 ###

在generatorConfig.xml里jdbc连接配置中加入一行

添加后如下：

<jdbcConnection driverClass="com.mysql.cj.jdbc.Driver" connectionURL="jdbc:mysql://localhost:3306/eesy_mybatis?serverTimezone=UTC" userId="root" password="1999">
                <property name="nullCatalogMeansCurrent" value="true" />
            </jdbcConnection>

然后一定要把上一次生成的删除干净，因为mapper.xml文件再次生成时并不会覆盖，而是追加，所以后面运行时会出现xml解析错误的问题，然后再次在Maven中的Plugins里生成，这次只生成了User和UserExample，下面也没有警告了，结果如下：  
![结果如下][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzE2ODE5MA_size_16_color_FFFFFF_t_70_pic_center 1]

# 如何使用刚刚生成的代码 #

## 创建MyBatis的配置文件 ##

在resources下创建SqlMapConfig.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>
        
        <environments default="mysql">
            
            <environment id="mysql">
                
                <transactionManager type="JDBC"/>
                
                <dataSource type="POOLED">
                    
                    <property name="driver" value="com.mysql.cj.jdbc.Driver"/>
                    <property name="url" value="jdbc:mysql://localhost:3306/eesy_mybatis?serverTimezone=UTC"/>
                    <property name="username" value="root"/>
                    <property name="password" value="1999"/>
                </dataSource>
            </environment>
        </environments>
    
        
        <mappers>
            <mapper resource="mapper/UserMapper.xml"/>
        </mappers>
    </configuration>

## 创建测试类调用 ##

在test下创建MyBatisTest类，如下：

public class MyBatisTest { 
        private InputStream in;
        private SqlSession session;
        private UserMapper userMapper;
        
        @Before
        public void init() throws Exception{ 
            in = Resources.getResourceAsStream("SqlMapConfig.xml");
            SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(in);
            session = factory.openSession();
            userMapper = session.getMapper(UserMapper.class);
        }
    
        @After
        public void destroy() throws Exception{ 
            session.close();
            in.close();
        }
    
        @Test
        public void testFindById(){ 
            User user = userMapper.selectByPrimaryKey(1);
            System.out.println(user);
        }
    }

还要记得在User类中添加一个toString()方法，可用IDEA右键类Generate自动生成：  
![Generate][]  
点击运行后结果如下：![运行结果][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzE2ODE5MA_size_16_color_FFFFFF_t_70_pic_center 2]

[MyBatis Generator]: http://mybatis.org/generator/
[Running MyBatis Generator With Maven]: http://mybatis.org/generator/running/runningWithMaven.html
[MyBatis GeneratorXML Configuration File Reference]: http://mybatis.org/generator/configreference/xmlconfig.html
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzE2ODE5MA_size_16_color_FFFFFF_t_70_pic_center]: https://img-blog.csdnimg.cn/20191115211012856.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzE2ODE5MA==,size_16,color_FFFFFF,t_70#pic_center
[warning]: https://img-blog.csdnimg.cn/20191115213146304.png#pic_center
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzE2ODE5MA_size_16_color_FFFFFF_t_70_pic_center 1]: https://img-blog.csdnimg.cn/20191115213944604.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzE2ODE5MA==,size_16,color_FFFFFF,t_70#pic_center
[Generate]: https://img-blog.csdnimg.cn/20191115235014704.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzE2ODE5MA==,size_16,color_FFFFFF,t_70#pic_center
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzE2ODE5MA_size_16_color_FFFFFF_t_70_pic_center 2]: https://img-blog.csdnimg.cn/20191115235135384.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzE2ODE5MA==,size_16,color_FFFFFF,t_70#pic_center