SpringBoot精通系列-使用Mybatis Generator生成Dao层代码

不念不忘少年蓝@ 2023-05-31 10:28 1阅读 0赞

> **导语**  
>   使用Mybatis的时候通常会创建很多的映射文件以及创建很多的Model对象，相对来说比较麻烦也有很多的重复的工作。下面就来使用一个Mybatis Dao层代码生成器。

### 文章目录 ###

*  开始使用Mybatis Generator 代码生成器
 *   *  创建一个Maven项目
     *  在Resource文件夹下创建generator.properties
     *  在Resource文件夹下创建generatorConfig.xml
     *  配置Pom文件
     *  配置Maven项目启动
     *   *  1、添加配置项
         *  2、配置启动
         *  3、在Command Line 中添加 mybatis-generator:generate -e配置。
     *  运行效果
 *  总结

# 开始使用Mybatis Generator 代码生成器 #

## 创建一个Maven项目 ##

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25paHVpMTIz_size_16_color_FFFFFF_t_70]

**填写GroupID和ArtifactId**  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25paHVpMTIz_size_16_color_FFFFFF_t_70 1]

**创建完成项目目录**  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25paHVpMTIz_size_16_color_FFFFFF_t_70 2]

## 在Resource文件夹下创建generator.properties ##

**内容如下**

jdbc.driverLocation=/mysql/mysql-connector-java/5.1.37/mysql-connector-java-5.1.37.jar
    jdbc.driverClass=com.mysql.jdbc.Driver
    jdbc.connectionURL=jdbc:mysql://localhost:3306/test
    jdbc.userId=root
    jdbc.password=123456

当然上面的内容需要根据自己的本地目录进行修改。

## 在Resource文件夹下创建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>
    
        
        <classPathEntry location="${jdbc.driverLocation}"/>
    
        <context id="default" targetRuntime="MyBatis3">
    
    
            
            <commentGenerator>
                <property name="suppressDate" value="true" />
            </commentGenerator>
    
    
            
            <jdbcConnection driverClass="${jdbc.driverClass}" connectionURL="${jdbc.connectionURL}" userId="${jdbc.userId}" password="${jdbc.password}">
            </jdbcConnection>
    
    
    
            
            <javaTypeResolver >
                <property name="forceBigDecimals" value="false" />
            </javaTypeResolver>
    
            
            <javaModelGenerator targetPackage="org.nihui.po" targetProject="src/main/java">
                
                <property name="constructorBased" value="true"/>
    
                
                <property name="enableSubPackages" value="false"/>
    
                
                <property name="immutable" value="true"/>
    
                
                <property name="rootClass" value="com.nihui.UserHello"/>
    
                
                <property name="trimStrings" value="true"/>
            </javaModelGenerator>
    
            
            <sqlMapGenerator targetPackage="org.nihui.domain" targetProject="src/main/java">
                <property name="enableSubPackages" value="false"/>
            </sqlMapGenerator>
    
    
            
            <javaClientGenerator targetPackage="com.nihui.dao" targetProject="src/main/java" type="MIXEDMAPPER">
                <property name="enableSubPackages" value=""/>
                
                <property name="exampleMethodVisibility" value=""/>
                
                <property name="methodNameCalculator" value=""/>
    
                
                <property name="rootInterface" value=""/>
    
            </javaClientGenerator>
    
    
    
            <table tableName="user">
    
                
                
    
    
                
                
    
    
    
                
                
    
    
                
                
    
            </table>
        </context>
    </generatorConfiguration>

## 配置Pom文件 ##

**内容如下**  
  在POM中添加如下的一些内容。当然也可使用高版本的打包工具

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
    
        <groupId>com.nh.mybatis</groupId>
        <artifactId>generator</artifactId>
        <version>1.0-SNAPSHOT</version>
    
    
        <build>
            <finalName>nihui</finalName>
            <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>
                    </configuration>
                </plugin>
            </plugins>
        </build>
    </project>

## 配置Maven项目启动 ##

### 1、添加配置项 ###

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25paHVpMTIz_size_16_color_FFFFFF_t_70 3]

### 2、配置启动 ###

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25paHVpMTIz_size_16_color_FFFFFF_t_70 4]

### 3、在Command Line 中添加 mybatis-generator:generate -e配置。 ###

## 运行效果 ##

点击运行之后出现如下的效果。表示完成  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25paHVpMTIz_size_16_color_FFFFFF_t_70 5]

**项目路径变化为下图内容**  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25paHVpMTIz_size_16_color_FFFFFF_t_70 6]

# 总结 #

通过上面的方式可以快速高效的生成Mybatis的Dao层所需要的代码，但是为了项目的高效性，在生成之后我们还需要将这些文件移动到自己的项目中，然后在做一些定制化的开发，这样才能完全的适配与我们的项目，当然如果在使用的过程中项目比较简单的话也可以不使用这种方式，直接开发就可以了。这样的做法在一定程度上减少了项目编写代码量。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25paHVpMTIz_size_16_color_FFFFFF_t_70]: /images/20230531/733e3c77fbe446a7bf9b1c9ae73b5a09.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25paHVpMTIz_size_16_color_FFFFFF_t_70 1]: /images/20230531/28678e84077b49d0a519998fd3da689d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25paHVpMTIz_size_16_color_FFFFFF_t_70 2]: /images/20230531/20547e1254b94485bd8a2dd4972ff7a4.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25paHVpMTIz_size_16_color_FFFFFF_t_70 3]: /images/20230531/55862a12bd8548c7b8ee72a15559c1c8.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25paHVpMTIz_size_16_color_FFFFFF_t_70 4]: /images/20230531/f75a21ff7569416ca5aeaf0e82287ba9.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25paHVpMTIz_size_16_color_FFFFFF_t_70 5]: /images/20230531/11ef041bf5164c7084669a091f5a45be.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25paHVpMTIz_size_16_color_FFFFFF_t_70 6]: /images/20230531/603207405e9242ecb715ae6c5bc50a6c.png