MyBatis Generator - 快速生成实体类和映射文件

快来打我* 2024-02-21 10:37 79阅读 0赞

**目录**

一、MyBatis Generator 的使用

1.1、生成类和映射文件

1.1.1、在 pom.xml 中引入依赖

1.1.2、根据 configurationFile 标签中配置的路径 创建 generatorConfig.xml 文件

1.1.3、自动生成类 和 映射文件

1.1.4、在 Insert 标签中添加获取主键值的选项

1.1.5、扫描配置：添加 @Mapper 注解 / 添加扫描注解

1.1.6、配置 mybatis

1.1.7、测试

--------------------

## 一、MyBatis Generator 的使用 ##

--------------------

### 1.1、生成类和映射文件 ###

#### 1.1.1、在 pom.xml 中引入依赖 ####

在 properties 标签中加入版本号.

<mybatis-generator-plugin-version>1.4.1</mybatis-generator-plugin-version>

在 build => plugins 标签中加入如下配置

<plugin>
                    <groupId>org.mybatis.generator</groupId>
                    <artifactId>mybatis-generator-maven-plugin</artifactId>
                    <version>${mybatis-generator-plugin-version}</version>
                    <executions>
                        <execution>
                            <id>Generate MyBatis Artifacts</id>
                            <phase>deploy</phase>
                            <goals>
                                <goal>generate</goal>
                            </goals>
                        </execution>
                    </executions>
                    
                    <configuration>
                        
                        <verbose>true</verbose>
                        
                        <overwrite>true</overwrite>
                        
                        <configurationFile>
                            src/main/resources/mybatis/generatorConfig.xml
                        </configurationFile>
                    </configuration>
                </plugin>

上述配置中需要注意的是 “配置文件路径”，这个路径就是用来生成 实体类和映射文件 配置规则的位置.

#### 1.1.2、根据 configurationFile 标签中配置的路径 创建 generatorConfig.xml 文件 ####

这个文件就是用来描述生成规则的.

根据路径（src/main/resources/mybatis），在 mybatis 目录下创建 generatorConfig.xml 文件.

> Ps：下述配置文件中需要修改的有 数据库连接、实体类和映射文件的路径、数据库表名

<?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="D:\class\source\mysql-connector-java-5.1.49.jar"/>
    
        <context id="DB2Tables" targetRuntime="MyBatis3">
            
            <commentGenerator>
                <property name="suppressAllComments" value="true"/>
                <property name="suppressDate" value="true"/>
            </commentGenerator>
            
            <jdbcConnection driverClass="com.mysql.jdbc.Driver"
                            connectionURL="jdbc:mysql://127.0.0.1:3306/javanav_db?
    characterEncoding=utf8&useSSL=false"
    
                            userId="root"
    
                            password="1111">
            </jdbcConnection>
            <javaTypeResolver>
                
                <property name="forceBigDecimals" value="false"/>
            </javaTypeResolver>
            
            <javaModelGenerator targetPackage="com.example.cyk.model"
    
                                targetProject="src/main/java">
                <property name="enableSubPackages" value="true"/>
                <property name="trimStrings" value="true"/>
            </javaModelGenerator>
            
            <sqlMapGenerator targetPackage="mapper"
    
                             targetProject="src/main/resources">
                <property name="enableSubPackages" value="true"/>
            </sqlMapGenerator>
            
            <javaClientGenerator type="XMLMAPPER"
    
                                 targetPackage="com.example.cyk.mapper" targetProject="src/main/java">
                <property name="enableSubPackages" value="true"/>
            </javaClientGenerator>
            
            <table tableName="j_article" domainObjectName="Article"
    
                   enableSelectByExample="false"
    
                   enableDeleteByExample="false" enableDeleteByPrimaryKey="false"
    
                   enableCountByExample="false"
    
                   enableUpdateByExample="false">
                
                <property name="useActualColumnNames" value="true"/>
            </table>
            <table tableName="j_article_reply" domainObjectName="ArticleReply"
    
                   enableSelectByExample="false"
    
                   enableDeleteByExample="false" enableDeleteByPrimaryKey="false"
    
                   enableCountByExample="false"
    
                   enableUpdateByExample="false">
                <property name="useActualColumnNames" value="true"/>
            </table>
            <table tableName="j_board" domainObjectName="Board"
    
                   enableSelectByExample="false" enableDeleteByExample="false"
    
                   enableDeleteByPrimaryKey="false" enableCountByExample="false"
    
                   enableUpdateByExample="false">
                <property name="useActualColumnNames" value="true"/>
            </table>
            <table tableName="j_message" domainObjectName="Message"
    
                   enableSelectByExample="false"
    
                   enableDeleteByExample="false" enableDeleteByPrimaryKey="false"
    
                   enableCountByExample="false"
    
                   enableUpdateByExample="false">
                <property name="useActualColumnNames" value="true"/>
            </table>
            <table tableName="j_user" domainObjectName="User"
    
                   enableSelectByExample="false" enableDeleteByExample="false"
    
                   enableDeleteByPrimaryKey="false" enableCountByExample="false"
    
                   enableUpdateByExample="false">
                <property name="useActualColumnNames" value="true"/>
            </table>
        </context>
    </generatorConfiguration>

> 注意：

驱动包路径是自己本地仓库的路径

![7b8f8f3ff170461bba9ac8731d0f14f8.png][]

但一定注意！！ 需要在非中文的目录下，因此你可以把这个驱动包拷贝出来，放到一个非中文的目录中即可.

![831ee10caac2406199e0ea9f6a8974c3.png][]

#### 1.1.3、自动生成类 和 映射文件 ####

重新加载Maven项⽬，在Plugins节点下出现mybatis-generator，双击运⾏，在对应的目录下⽣成相应的类与映射⽂件：

![23a79280940b4b1cbcab1679a8aadb9c.png][]

接着你就可以看到对应的生成了

![acc82c01e0d248b4adade1610e76d749.png][]

#### 1.1.4、在 Insert 标签中添加获取主键值的选项 ####

在生成的 xml 文件中，给每一个 insert 标签都添加以下属性：useGeneratedKeys="true" keyProperty="id"

<insert id="insert" parameterType="com.example.cyk.model.User" 
    useGeneratedKeys="true" keyProperty="id" >

> Ps：这个选项也可以自动生成，但是不理想（有些问题）

#### 1.1.5、扫描配置：添加 @Mapper 注解 / 添加扫描注解 ####

有两种方式配置扫描 Mapper 接口.

1）给每个 mapper 包下的 mapper 接口都添加 @Mapper 注解.

![fc2e29b71169452dbcb8884debc6ed7d.png][]

2）给启动类上 或者 新建一个配置类（有 @Configuration 注解）加上 @MapperScan("com.example.cyk.mapper") 注解.

#### 1.1.6、配置 mybatis ####

在 yml 文件中配置

mybatis:
      mapper-locations: classpath:mapper/**/*Mapper.xml

#### 1.1.7、测试 ####

@SpringBootTest
    public class TestMapper {
    
        @Autowired
        private UserMapper userMapper;
    
        @Test
        public void select() {
            User user = userMapper.selectByPrimaryKey(1L);
            System.out.println(user);
        }
    
    }

![a4d35c72f79a45a28d06146ebbf0b029.png][]

![6cd1333a22fd48b6b805ea99057c5ca2.gif][]

[7b8f8f3ff170461bba9ac8731d0f14f8.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/21/1fd7648d9d5e4078a046f1bbcbd9978b.png
[831ee10caac2406199e0ea9f6a8974c3.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/21/f7a26eb9044a49bb80def1274c010dc3.png
[23a79280940b4b1cbcab1679a8aadb9c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/21/9ee3c0e36984495ebb6bcb4061d61748.png
[acc82c01e0d248b4adade1610e76d749.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/21/332ed8b0a7994516bd08f9ddc6890c6f.png
[fc2e29b71169452dbcb8884debc6ed7d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/21/52d8df9eb7fb4f9287f97f72f9d0e80b.png
[a4d35c72f79a45a28d06146ebbf0b029.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/21/475759e805054494b158bf4314346a62.png
[6cd1333a22fd48b6b805ea99057c5ca2.gif]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/21/7256a5441b9e4f419d21b065393ff3a0.png