MyBatis Generator如何Generate

小咪咪 2022-08-06 16:22 158阅读 0赞

# MyBatis Generator如何Generate #

\[MyBatis Generator\]\[6\]是一个自动生成代码的工具，可以生成基本的数据表对应的实体对象以及对对象基本操作的dao层，今天介绍如何利用Maven来使用\[MyBatis Generator\]\[6\]，猴急的童鞋可以拖到最后看完整的示例代码。

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

## Maven Goal and Execution ##

如下是在`pom.xml`中最简配置：

MGB Maven插件包含一个goal：  
`mybatis-generator:generate`  
这个goal并不会自动地被Maven执行。可以通过两种方式来执行它。  
**第一种：**  
使用命令行来运行：  
`mvn mybatis-generator:generate`  
你在执行这个goal的时候还可以用标准的Maven命令行属性传递参数，比如：  
`mvn -Dmybatis.generator.overwrite=true mybatis-generator:generate`  
它将会运行MGB并且覆盖已经存在的Java文件。

**第二种：**  
而在一个需要持续build的环境中，你可能想要Maven在build期间自动执行MBG。这可以通过配置一个自动执行的goal来完成。下面给出一个例子：

<project ...>
         ...
         <build>
           ...
           <plugins>
            ...
            <plugin>
              <groupId>org.mybatis.generator</groupId>
              <artifactId>mybatis-generator-maven-plugin</artifactId>
              <version>1.3.2</version>
              <executions>
                <execution>
                  <id>Generate MyBatis Artifacts</id>
                  <goals>
                    <goal>generate</goal>
                  </goals>
                </execution>
              </executions>
            </plugin>
            ...
          </plugins>
          ...
        </build>
        ...
      </project>

MBG插件被绑定到generate-sources阶段，所以它将在compile之前运行。

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

## MyBatis Generator 属性配置 ##

说几个比较常用的属性：  
**mybatis.generator.configurationFile**：这个是设置配置文件路径的，默认为`${basedir}/src/main/resources/generatorConfig.xml`

**mybatis.generator.overwrite**：这个是设置若存在同名文件是否覆盖的，若为false且已存在同名文件，那么会生成xxx.1（23456）

其它属性就不一一列出来的，这里主要说如何配置属性。

这里对于属性的配置也有两种情况：  
第一种其实上面已经提到过了，还有印象吗？就是使用标准的Maven命令行参数，比如：  
`mvn -Dmybatis.generator.overwrite=true mybatis-generator:generate`  
这样配置仅仅影响用命令行手动执行的情况。

而后一种则是在plugin中配置：

<plugin>
                <groupId>org.mybatis.generator</groupId>
                <artifactId>mybatis-generator-maven-plugin</artifactId>
                <version>1.3.2</version>
                <executions>
                    <execution>
                        <id>Generate MyBatis Artifacts</id>
                        <goals>
                            <goal>
                                generate
                            </goal>
                        </goals>
                    </execution>
                </executions>
                <configuration>
                    <verbose>true</verbose>  
                    <overwrite>true</overwrite>
                </configuration>
            </plugin>

这种配置不仅影响手动执行，还会影响到Maven自动build过程中执行MGB  
那么可能有童鞋会问，若两种配置都存在，会取哪一个呢？答案是xml文件中配置的configuration。

第一次用markdown~feel 倍儿爽，妈妈再也不用担心我的排版了~