自动生成部分代码工具

怼烎@ 2021-12-01 14:42 395阅读 0赞

### 文章目录 ###

*  此工具作用
 *  maven操作步骤
 *   *  添加依赖
     *  添加配置文件
     *  启动工具
 *  外部操作步骤
 *   *  配置文件设置
     *  启动工具

# 此工具作用 #

> 使用**mybatis**时自动生成数据库表对应的bean类、Mapper接口、Mapper接口对应的Mapper.xml

# maven操作步骤 #

## 添加依赖 ##

> 在maven项目的pox.xml引入依赖，位置：【build标签下】

<plugins>
          <plugin>
             <groupId>org.mybatis.generator</groupId>
             <artifactId>mybatis-generator-maven-plugin</artifactId>
            </plugin>
        </plugins>

> 在maven项目的pox.xml添加依赖，位置：【pluginManagement标签下的plugins内,若没有pluginManagement标签请自行创建（在< project >内）】

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

## 添加配置文件 ##

> 配置文件放在resources文件夹下，文件名为：generatorContext.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="localhost_mysql" targetRuntime="MyBatis3">
    
            
            <commentGenerator>
                <property name="suppressAllComments" value="true" />
            </commentGenerator>
    		
            <jdbcConnection driverClass="com.mysql.jdbc.Driver"
                            connectionURL="jdbc:mysql://localhost:3306/你的数据库名?characterEncoding=utf8&serverTimezone=UTC"
                            userId="root"
                            password="root">
            </jdbcConnection>
    
            <javaTypeResolver >
                <property name="forceBigDecimals" value="false" />
            </javaTypeResolver>
    
            
            <javaModelGenerator targetPackage="test.spring.bean" targetProject="src/main/java">
                <property name="enableSubPackages" value="false" />
                <property name="trimStrings" value="true" />
            </javaModelGenerator>
    
            
            <sqlMapGenerator targetPackage="src/main/resources/mappers" targetProject=".">
                <property name="enableSubPackages" value="false" />
            </sqlMapGenerator>
    
            
            
            <javaClientGenerator type="XMLMAPPER" targetPackage="test.spring.mapper"  targetProject="src/main/java">
                
                <property name="enableSubPackages" value="false" />
            </javaClientGenerator>
    		
            <table schema="bookasp" tableName="message" domainObjectName="Message"
                   enableCountByExample="false">
                
    
                
                
                <generatedKey column="id" sqlStatement="mysql" identity="true" />
    
                
                
                
                
            </table>
        </context>
    </generatorConfiguration>

## 启动工具 ##

> 1.  点击maven在Plugins下出现mybatis-generator
> 2.  点开mybatis-generator出现mybatis-generator:generate
> 3.  双击mybatis-generator:generate即可

上述步骤如下图  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1pYWV85MjY0X0FORw_size_16_color_FFFFFF_t_70]

# 外部操作步骤 #

[点击去下载工具][Link 1]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1pYWV85MjY0X0FORw_size_16_color_FFFFFF_t_70 1]  
下载后打开文件夹，共有五个文件（如图所示）  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1pYWV85MjY0X0FORw_size_16_color_FFFFFF_t_70 2]

## 配置文件设置 ##

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>
        
    	
    	<classPathEntry location="mysql-connector-java-5.1.47.jar" />
    	
    	
        <context id="localhost_mysql" targetRuntime="MyBatis3Simple">
    
            
            <commentGenerator>
                <property name="suppressAllComments" value="true" />
            </commentGenerator>
    
            <jdbcConnection driverClass="com.mysql.jdbc.Driver"
                            connectionURL="jdbc:mysql://localhost:3306/zzj0301?characterEncoding=utf8&serverTimezone=UTC"
                            userId="root"
                            password="root">
            </jdbcConnection>
    
            <javaTypeResolver >
                <property name="forceBigDecimals" value="false" />
            </javaTypeResolver>
    
    		
            <javaModelGenerator targetPackage="com.lanou3g.spring.bean" targetProject="src/main/java">
                <property name="enableSubPackages" value="false" />
                <property name="trimStrings" value="true" />
            </javaModelGenerator>
    
    		
            <sqlMapGenerator targetPackage="src/main/resources/mapper" targetProject=".">
                <property name="enableSubPackages" value="false" />
            </sqlMapGenerator>
    
    		
            
            <javaClientGenerator type="XMLMAPPER" targetPackage="com.lanou3g.spring.mapper"  targetProject="src/main/java">
                
                <property name="enableSubPackages" value="false" />
            </javaClientGenerator>
            
            <table schema="zzj0301" tableName="city" domainObjectName="City"
                   enableCountByExample="false">
                
    
                
                
    
                <generatedKey column="id" sqlStatement="mysql" identity="true" />
    
                
                
                
                
            </table>
        </context>
    </generatorConfiguration>

注意：上面的generatorConfig.xml配置文件中的几个生成代码文件的目录最好设置成你项目中的路径，否则等你将代码copy到你的项目中后有些代码中含有路径的地方还需要更改  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1pYWV85MjY0X0FORw_size_16_color_FFFFFF_t_70 3]

## 启动工具 ##

配置文件修改好之后就可以启动了，双击 `start` 文件弹出命令框开始运行工具。

若图所示，出现图中红框中的一行英文，则生成成功。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1pYWV85MjY0X0FORw_size_16_color_FFFFFF_t_70 4]  
此时文件根目录中会多出一个名为 src 的文件夹，此文件夹里就是生成的代码。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1pYWV85MjY0X0FORw_size_16_color_FFFFFF_t_70 5]  
把你需要的代码copy到你的代码中即可。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1pYWV85MjY0X0FORw_size_16_color_FFFFFF_t_70]: /images/20211201/bdcc2d8d0d7643d1b7acc5a7b12775fb.png
[Link 1]: https://gitee.com/zhumofeiyang/mybatis_genarator
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1pYWV85MjY0X0FORw_size_16_color_FFFFFF_t_70 1]: /images/20211201/0724fc763d494aa8a8ee6df7de1f5667.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1pYWV85MjY0X0FORw_size_16_color_FFFFFF_t_70 2]: /images/20211201/b62dce81205d40e9876ab2cd0ae362ec.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1pYWV85MjY0X0FORw_size_16_color_FFFFFF_t_70 3]: /images/20211201/806cabb6cab049ceabe92b71583d1ace.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1pYWV85MjY0X0FORw_size_16_color_FFFFFF_t_70 4]: /images/20211201/196d75581e3a40d58f3af9de2c207bc7.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1pYWV85MjY0X0FORw_size_16_color_FFFFFF_t_70 5]: /images/20211201/dbd6577476584f92be8afb5692039e20.png