在springboot中使用mybatis generate自动生成实体类和mapper

Myth丶恋晨 2022-11-11 05:09 205阅读 0赞

## 1、在全局的pom中引入mybatis generate的依赖 ##

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

## 2、在全局的pom中加入插件 ##

<plugin>
                    <groupId>org.mybatis.generator</groupId>
                    <artifactId>mybatis-generator-maven-plugin</artifactId>
                    <version>1.3.5</version>
                    <configuration>
                        
                        <configurationFile>src/main/resources/mybatis-generator/generatorConfig.xml</configurationFile>
                        <verbose>true</verbose>
                        <overwrite>true</overwrite>
                    </configuration>
                    <executions>
                        <execution>
                            <id>Generate MyBatis Artifacts</id>
                            <goals>
                                <goal>generate</goal>
                            </goals>
                            <phase>generate-sources</phase>
                        </execution>
                    </executions>
                    
                    <dependencies>
                        <dependency>
                            <groupId>mysql</groupId>
                            <artifactId>mysql-connector-java</artifactId>
                            <scope>runtime</scope>
                            <version>5.1.46</version>
                        </dependency>
                    </dependencies>
         </plugin>

## 3、创建配置文件 ##

以下是我自己的创建配置文件的位置。  
可以看到我这个项目里面有很多个模块，但是我为什么放在XApplication这个模块中呢，因为这个模块是我整个项目的唯一启动入口，所以才会在这里进行配置。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NTE1MTk2MA_size_16_color_FFFFFF_t_70]

#### 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="mybatis-generator/mybatisGeneratorinit.properties"/>
        
        
    
        
        
        <context id="MysqlTables" targetRuntime="MyBatis3Simple" defaultModelType="flat">
            
            <property name="autoDelimitKeywords" value="true" />
            
            <property name="javaFileEncoding" value="utf-8" />
            
            <property name="beginningDelimiter" value="`" />
            <property name="endingDelimiter" value="`" />
    
            
            <property name="javaFormatter" value="org.mybatis.generator.api.dom.DefaultJavaFormatter"/>
            
            <property name="xmlFormatter" value="org.mybatis.generator.api.dom.DefaultXmlFormatter"/>
            <plugin type="org.mybatis.generator.plugins.SerializablePlugin" />
    
            <plugin type="org.mybatis.generator.plugins.ToStringPlugin" />
    
            
            <commentGenerator >
                <property name="suppressAllComments" value="false"/>
                <property name="suppressDate" value="true" /> 
            </commentGenerator>
    
            
            <jdbcConnection driverClass="${jdbc_driver}" connectionURL="${jdbc_url}" userId="${jdbc_user}" password="${jdbc_password}" />
            
            <javaTypeResolver>
                
                <property name="forceBigDecimals" value="false"/>
            </javaTypeResolver>
    
            
            <javaModelGenerator targetPackage="biz.xcj.entity.sys.permit" targetProject="${models}" >
                <property name="enableSubPackages" value="false"/>
                <property name="trimStrings" value="true"/>
            </javaModelGenerator>
            
            <sqlMapGenerator targetPackage="biz.xcj.mapper.sys.permit" targetProject="${resources}" >
                <property name="enableSubPackages" value="false" />
            </sqlMapGenerator>
            
            <javaClientGenerator targetPackage="biz.xcj.mapper.sys.permit" targetProject="${dao}" type="XMLMAPPER" >
                <property name="enableSubPackages" value="true" />
            </javaClientGenerator>
            
            
            <table tableName="text"
                   enableCountByExample="true"
                   enableUpdateByExample="true"
                   enableDeleteByExample="true"
                   enableSelectByExample="true"
                   selectByExampleQueryId="true">
                <property name="useActualColumnNames" value="false" />
                
                <generatedKey column="uuid" sqlStatement="Mysql" identity="true" />
            </table>
        </context>
    </generatorConfiguration>

#### mybatisGeneratorinit.properties文件 ####

jdbc_driver=com.mysql.jdbc.Driver
    jdbc_url=jdbc:mysql://localhost:3306/hyqd?useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai
    jdbc_user=root
    jdbc_password=123456
    models=C:\\jinshu\\develop\\projects\\HYQD\\web-user-manager-pojo\\src\\main\\java
    resources=C:\\jinshu\\develop\\projects\\HYQD\\web-user-manager-pojo\\src\\main\\java
    dao=C:\\jinshu\\develop\\projects\\HYQD\\web-user-manager-pojo\\src\\main\\java

## 4、配置文件需要自己配置的内容讲解 ##

##### 1：数据库连接配置 #####

在**mybatisGeneratorinit.properties**文件中的所有jdbc配置中，这个大家应该都很熟系了，连接上自己的数据库即可。

##### 2：实体类生成地址配置 #####

在**generatorConfig.xml**文件中的这个地方。

<javaModelGenerator targetPackage="biz.xcj.entity.sys.permit" targetProject="${models}" >
                <property name="enableSubPackages" value="false"/>
                <property name="trimStrings" value="true"/>
            </javaModelGenerator>

targetProject="$\{models\}" 引用的就是**mybatisGeneratorinit.properties**文件中的**models**的配置。  
因为我自己是想直接生成在项目中，所以我的models配置的路径就是我自己项目的绝对路径。  
![在这里插入图片描述][20210319101139328.png]  
**targetPackage**里面的内容就是生成实体类的具体位置。因为我的**models**已经配置到java的这个位置了，所以我的**targetPackage**只需要配置java后面的路径就可以了，如图所示，我java后面的路径为**biz.xcj.entity.sys.permit**。  
总结：配置生成地址，只需要修改**targetPackage**和**models**两个参数即可。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NTE1MTk2MA_size_16_color_FFFFFF_t_70 1]

##### 3：mapper层生成地址配置 #####

在**generatorConfig.xml**文件中的这个地方。

<sqlMapGenerator targetPackage="biz.xcj.mapper.sys.permit" targetProject="${resources}" >
                <property name="enableSubPackages" value="false" />
            </sqlMapGenerator>
     
            <javaClientGenerator targetPackage="biz.xcj.mapper.sys.permit" targetProject="${dao}" type="XMLMAPPER" >
                <property name="enableSubPackages" value="true" />
            </javaClientGenerator>

这里面配置的内容其实适合实体类的配置一模一样的，都是同一个原理。  
只需要修改**targetPackage**的参数和**mybatisGeneratorinit.properties**中对应的配置就可以了。

##### 4：配置需要生成的数据库表 #####

在**generatorConfig.xml**文件中的这个地方。tableName就表示需要生成的表名称。

<table tableName="text"
                   enableCountByExample="true"
                   enableUpdateByExample="true"
                   enableDeleteByExample="true"
                   enableSelectByExample="true"
                   selectByExampleQueryId="true">
                <property name="useActualColumnNames" value="false" />
                
                <generatedKey column="uuid" sqlStatement="Mysql" identity="true" />
            </table>

## 4、生成代码 ##

配置好后，打开后面的maven窗口。  
![在这里插入图片描述][20210319102031413.png]  
因为我是在XApplication模块中配置的，所以打开的位置路径是**XApplication-Plugins-mybatis-generator**，双击第一个**mybatis-generator:generate**  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NTE1MTk2MA_size_16_color_FFFFFF_t_70 2]  
最后提示**SUCCESS**则表示自动生成成功。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NTE1MTk2MA_size_16_color_FFFFFF_t_70 3]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NTE1MTk2MA_size_16_color_FFFFFF_t_70]: /images/20221022/d81d3cbb94e54c3781b5c67f3a0caae5.png
[20210319101139328.png]: /images/20221022/2d28ea55707b41c38918d40e9cff2310.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NTE1MTk2MA_size_16_color_FFFFFF_t_70 1]: /images/20221022/8b81556bc6ae40b19b6877b27a0d6f07.png
[20210319102031413.png]: /images/20221022/9a8e6b381fec45d79351f55ee5e84d4e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NTE1MTk2MA_size_16_color_FFFFFF_t_70 2]: /images/20221022/e9ba7edb96fd4784a1a8ae0890ea3ed8.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NTE1MTk2MA_size_16_color_FFFFFF_t_70 3]: https://img-blog.csdnimg.cn/20210319102211129.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NTE1MTk2MA==,size_16,color_FFFFFF,t_70