mybatis-generator 详细配置及使用，爬坑记录

左手的ㄟ右手 2022-03-30 11:50 309阅读 0赞

### mybatis-generator 详细配置及使用，爬坑记录 ###

提示：如果不成功一定是项目路径和 数据库配置出问题，本篇基于 MySQL 8.0.13，调试没有问题。

如果失败，建议使用相同的项目结构，包名，进行重试，博主也是多次调试，才成功。一些常见问题，看报错提示信息是可以看懂的，加油。

整个项目的源代码，最后，也会给出下载链接。

**这是根据数据库，生成后的项目结构：**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMTQ3ODYz_size_16_color_FFFFFF_t_70][]

### 一、简介： ###

mybatis-geneator 是一款 mybatis 自动代码生成工具，可以通过配置，快速生成 mapper 和 xml 文件。

### 二、配置方法： ###

**（1）在项目的 pom.xml 文件中添加插件配置**

详细的 pom.xml 配置：

<plugin>
    	<groupId>org.mybatis.generator</groupId>
    	<artifactId>mybatis-generator-maven-plugin</artifactId>
    	<version>1.3.7</version>
    
    	<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.13</version>
            </dependency>
         </dependencies>
    
         <executions>
            <execution>
              <id>mybatis generator</id>
              <phase>package</phase>
              <goals>
                <goal>generate</goal>
              </goals>
              <configuration>
                
                <verbose>true</verbose>
                
                <overwrite>true</overwrite>
                <configurationFile>
                  src/main/resources/generatorConfig.xml
                </configurationFile>
           </configuration>
         </execution>
         </executions>
    
    
    </plugin>

**（2）根据自己配置的文件路径及名称，创建相应 generatorConfig.xml 文件，位置如下图：**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMTQ3ODYz_size_16_color_FFFFFF_t_70 1][]

**（3）先手动创建一些目录，在配置的时候回有提示，大大降低出错概率，整体目录结构：**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMTQ3ODYz_size_16_color_FFFFFF_t_70 2][]

### 三、创建 MySQL 数据库，创建 2 两个表： ###

之前介绍过多次命令行创建数据库表了，查看 [MySQL - 最经典的 命令行操作数据库 + 表（增删改查实例）][MySQL - _ _ _]

这次使用 Navicat for MySQL，如果没有安装请参考：[Navicat for MySQL 最新版安装与破解 + 报错解决办法][Navicat for MySQL _ _]

**（1）建立连接，创建数据库：**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMTQ3ODYz_size_16_color_FFFFFF_t_70 3][]

**（2）数据库名，选择编码：**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMTQ3ODYz_size_16_color_FFFFFF][]

**（3）新建表：**  
![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMTQ3ODYz_size_16_color_FFFFFF 1][]

**（4）填写表信息：**

主键：  
![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMTQ3ODYz_size_16_color_FFFFFF_t_70 4][]

其他：  
![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMTQ3ODYz_size_16_color_FFFFFF 2][]

表名为 user\_info

**（5）插入一条信息：**  
![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMTQ3ODYz_size_16_color_FFFFFF 3][]

（6）细心的你可能发现了没有 upwd 存密码的字段，我们这里放在另外一张表上，新建表 user\_pwd：  
![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMTQ3ODYz_size_16_color_FFFFFF 4][]

### 四、配置源代码 ###

**老规矩，先看一下，整个的项目结构：**  
![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMTQ3ODYz_size_16_color_FFFFFF_t_70 5][]

**（1）编辑 mybatis-generator.xml 文件：**

（重要！）  
（请详细看注释！自行修改自己的配置信息）

**修改目录请自行对应，可放大查看：**

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

**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>
    
        
        
        
        <context id="default" targetRuntime="MyBatis3">
    
    
            
            
            
            <jdbcConnection driverClass="com.mysql.cj.jdbc.Driver" connectionURL="jdbc:mysql://127.0.0.1:3306/miaosha?serverTimezone=UTC" userId="root" password="xiaopengwei">
            </jdbcConnection>
    
            
            
            
            <javaModelGenerator targetPackage="com.miaoshapro.dataobject" targetProject=".\src\main\java">
                
                <property name="enableSubPackages" value="false" />
                
                <property name="constructorBased" value="true" />
                
                <property name="trimStrings" value="true" />
                
                <property name="immutable" value="false" />
            </javaModelGenerator>
    
            
            <sqlMapGenerator targetPackage="mapping" targetProject=".\src\main\resources">
                
                <property name="enableSubPackages" value="false" />
            </sqlMapGenerator>
    
            
            <javaClientGenerator type="XMLMAPPER" targetPackage="com.miaoshapro.dao" targetProject=".\src\main\java">
                
                <property name="enableSubPackages" value="true" />
            </javaClientGenerator>
    
            
            <table tableName="user_info" domainObjectName="UserDO">
            </table>
            <table tableName="user_pwd" domainObjectName="UserPwdDO">
            </table>
        </context>
    </generatorConfiguration>

**如果不想要那个 Example 一堆，编辑 mybatis-generator.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="default" targetRuntime="MyBatis3">
    
    
            
            
            
            <jdbcConnection driverClass="com.mysql.cj.jdbc.Driver" connectionURL="jdbc:mysql://127.0.0.1:3306/miaosha?serverTimezone=UTC" userId="root" password="xiaopengwei">
            </jdbcConnection>
    
            
            
            
            <javaModelGenerator targetPackage="com.miaoshapro.dataobject" targetProject=".\src\main\java">
                
                <property name="enableSubPackages" value="false" />
                
                <property name="constructorBased" value="true" />
                
                <property name="trimStrings" value="true" />
                
                <property name="immutable" value="false" />
            </javaModelGenerator>
    
            
            <sqlMapGenerator targetPackage="mapping" targetProject=".\src\main\resources">
                
                <property name="enableSubPackages" value="false" />
            </sqlMapGenerator>
    
            
            <javaClientGenerator type="XMLMAPPER" targetPackage="com.miaoshapro.dao" targetProject=".\src\main\java">
                
                <property name="enableSubPackages" value="true" />
            </javaClientGenerator>
    
            
            <table tableName="user_info" domainObjectName="UserDO" enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false" enableSelectByExample="false">
            </table>
            <table tableName="user_pwd" domainObjectName="UserPwdDO" enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false" enableSelectByExample="false">
            </table>
        </context>
    </generatorConfiguration>

**（2）配置 application.properties 文件**

#自定义端口
    server.port=8090
    
    mybatis.mapper-locations=classpath:mapping/*.xml spring.datasource.name=miaosha spring.datasource.url=jdbc:mysql://127.0.0.1:3306/miaosha?serverTimezone=UTC spring.datasource.username=root spring.datasource.password=xiaopengwei # 使用 druid 数据源 spring.datasource.type=com.alibaba.druid.pool.DruidDataSource spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

### 六、执行 mybatis-generator 插件 ###

（1）打开配置：  
![20190106130248264.png][]

（2）点击 +，选择 Maven：  
![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMTQ3ODYz_size_16_color_FFFFFF_t_70 7][]

（3）输入信息，命令：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMTQ3ODYz_size_16_color_FFFFFF_t_70 8]

（4）选中刚才创建的名称，点击执行：  
![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMTQ3ODYz_size_16_color_FFFFFF_t_70 9][]

### 七、运行结果： ###

（1）：  
![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMTQ3ODYz_size_16_color_FFFFFF_t_70][]

（2）：  
![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMTQ3ODYz_size_16_color_FFFFFF_t_70 10][]

（3）：  
![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMTQ3ODYz_size_16_color_FFFFFF_t_70 11][]

（4）：  
![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMTQ3ODYz_size_16_color_FFFFFF_t_70 12][]

### 八、连接数据库测试 ###

**（1）编辑 main/java/com.包名。。 下面的 App.java 文件：**

package com.miaoshapro;
    
    import com.miaoshapro.dao.UserDOMapper;
    import com.miaoshapro.dataobject.UserDO;
    import org.mybatis.spring.annotation.MapperScan;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    /** * Hello world! * */
    
    //自动配置注解，自动扫描，加载到项目工程中
    
    @SpringBootApplication(scanBasePackages = { "com.miaoshapro"})
    @RestController
    @MapperScan("com.miaoshapro.dao")
    public class App { 
    
        @Autowired(required = false)
        private UserDOMapper userDOMapper;
    
        //请求映射，当请求 /home 时执行该方法
        @RequestMapping("/home")
        public String home(){ 
            UserDO userDO = userDOMapper.selectByPrimaryKey(1);
            if (userDO == null){ 
                return "用户对象不存在";
            }else
                return userDO.getUname();
        }
    
        public static void main( String[] args ) { 
    
            System.out.println( "Hello World!" );
    
            //启动 Web 容器
            SpringApplication.run(App.class, args);
        }
    }

**（2）打开浏览器访问，（默认端口是 8080 ，这里是配置文件中修改的）：**

http://localhost:8090/home

**（3）查看结果：**

因为在 App 中我们测试的，通过主键为 1 进行查询，并返回结果：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMTQ3ODYz_size_16_color_FFFFFF_t_70 13][]

（4）成功！

### 更多文章链接 ###

*  [Java 分类导航][Java]

### 支持博主 ###

我正在参加 CSDN 2018 年博客之星评选，希望大家能支持我，  
我是【No. 001】号 肖朋伟 ，感谢大家宝贵的一票 ^\_^/  
投票地址：[https://bss.csdn.net/m/topic/blog\_star2018/index][https_bss.csdn.net_m_topic_blog_star2018_index]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMTQ3ODYz_size_16_color_FFFFFF_t_70]: /images/20220330/468b97bdeed0480a8c6c40ebddc204b7.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMTQ3ODYz_size_16_color_FFFFFF_t_70 1]: /images/20220330/61340c4afcb747e09f4ca600481c1b78.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMTQ3ODYz_size_16_color_FFFFFF_t_70 2]: /images/20220330/0288d354039d44edb93bd5bc425bea27.png
[MySQL - _ _ _]: https://blog.csdn.net/qq_40147863/article/details/85703718
[Navicat for MySQL _ _]: https://blog.csdn.net/qq_40147863/article/details/84231811
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMTQ3ODYz_size_16_color_FFFFFF_t_70 3]: /images/20220330/bd9f4a461494498eaf9228a9669b5c47.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMTQ3ODYz_size_16_color_FFFFFF]: /images/20220330/c182d9cd51af4a8b812342836007a9f5.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMTQ3ODYz_size_16_color_FFFFFF 1]: /images/20220330/0f51013ec8ab4456a114352f3bb49558.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMTQ3ODYz_size_16_color_FFFFFF_t_70 4]: /images/20220330/68a020fa842e45d29c52ea2c11922586.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMTQ3ODYz_size_16_color_FFFFFF 2]: /images/20220330/ab554e8f45d241cf8cf5d2bedaf66ad0.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMTQ3ODYz_size_16_color_FFFFFF 3]: /images/20220330/9699a868c5374f9a9c9746d24eca8085.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMTQ3ODYz_size_16_color_FFFFFF 4]: /images/20220330/762f2300976246ac8f9fb6103a233796.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMTQ3ODYz_size_16_color_FFFFFF_t_70 5]: /images/20220330/ff094ae90f3145bf8396cb79b62c589e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMTQ3ODYz_size_16_color_FFFFFF_t_70 6]: /images/20220330/7b72e5cb94e74c6d83dc3db2664a82a4.png
[20190106130248264.png]: /images/20220330/4388e3b9c3554c328583906addf0d4ce.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMTQ3ODYz_size_16_color_FFFFFF_t_70 7]: /images/20220330/ca3b4688afd84af4a50862ba721b8f40.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMTQ3ODYz_size_16_color_FFFFFF_t_70 8]: /images/20220330/d3224bd812dd46818d2df810b152767f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMTQ3ODYz_size_16_color_FFFFFF_t_70 9]: /images/20220330/ea8eb8507e004d7c9c3ee6ee4875f58f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMTQ3ODYz_size_16_color_FFFFFF_t_70 10]: /images/20220330/2319a135acaa47ab9a79251343dc1835.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMTQ3ODYz_size_16_color_FFFFFF_t_70 11]: /images/20220330/508a441bfbb94f39be72a3df5db7f85b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMTQ3ODYz_size_16_color_FFFFFF_t_70 12]: /images/20220330/105972b2c6d54affb1de680c6db464c5.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwMTQ3ODYz_size_16_color_FFFFFF_t_70 13]: /images/20220330/9dbde6c5cba9492ca9f6b2deca2b0f78.png
[Java]: https://blog.csdn.net/qq_40147863/article/details/85304872
[https_bss.csdn.net_m_topic_blog_star2018_index]: https://bss.csdn.net/m/topic/blog_star2018/index