MyBatis Generator生成代码的几种方式

Myth丶恋晨 2022-06-07 06:51 161阅读 0赞

由于MyBatis属于一种半自动的ORM框架，所以主要的工作就是配置Mapping映射文件，但是由于手写映射文件很容易出错，所以可利用MyBatis生成器自动生成实体类、DAO接口和Mapper映射文件。这样可以省去一部分的功夫，下面将介绍几种生成方式:

MyBatis Generator 参考文档:

[http://blog.csdn.net/isea533/article/details/42102297][http_blog.csdn.net_isea533_article_details_42102297]

[http://www.mybatis.org/generator/running/running.html][http_www.mybatis.org_generator_running_running.html]

第一种:使用命令行创建

生成代码需要的文件和jar包：

![Center][]

其中有mybatis框架的jar包，数据库驱动程序jar包以及MyBatis生成器jar包。其中的generatorConfig.xml是需要我们来配置的文件，配置如下：

当以上这些完成之后，只需要打开控制台，进入lib目录下，执行脚本：java -jar mybatis-generator-core-1.3.2.jar -configfile generatorConfig.xml -overwrite即可。

![Center 1][]

这样在生成之后，就可以在src目录下找到相应的文件夹，每张表都会对应三个文件（实体类、接口、配置文件）。

![Center 2][]

最后附上完整demo:[http://download.csdn.net/download/qq\_32786873/10020288][http_download.csdn.net_download_qq_32786873_10020288]

第二种:通过MybatisGenerator类和配置文件生成代码

项目结构如下:

![Center 3][]

generatorConfig.xml配置如下:

创建MybatisGeneratorUtil类:

package com.solin;
    
    import java.io.File;
    import java.util.ArrayList;
    import java.util.List;
    
    import org.mybatis.generator.api.MyBatisGenerator;
    import org.mybatis.generator.config.Configuration;
    import org.mybatis.generator.config.xml.ConfigurationParser;
    import org.mybatis.generator.internal.DefaultShellCallback;
    
    public class MybatisGeneratorUtil {
    
    	public static void main(String[] args) throws Exception {
    		   generator();
    	}
    
    	private static void generator() throws Exception {
    		List<String> warnings = new ArrayList<String>();
    		   boolean overwrite = true;
    		   File configFile = new File("generatorConfig.xml");
    		   ConfigurationParser cp = new ConfigurationParser(warnings);
    		   
    		   Configuration config = cp.parseConfiguration(configFile);
    		   DefaultShellCallback callback = new DefaultShellCallback(overwrite);
    		   MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config, callback, warnings);
    		   myBatisGenerator.generate(null);
    		   
    		   System.out.println("代码生成完毕>>>>>>>>>>>>");
    	}
    
    }

执行main方法就可以生成代码了,执行后的结果如下:

![Center 4][]  
最后附上完整demo:[http://download.csdn.net/download/qq\_32786873/10020408][http_download.csdn.net_download_qq_32786873_10020408]

第三种方式 通过GeneratorAntTask类和配置文件生成

项目结构如下:

![Center 5][]

generatorConfig.xml配置如下:

创建GeneratorAntTaskUtil类:

package com.solin;
    
    import org.mybatis.generator.ant.GeneratorAntTask;
    
    public class GeneratorAntTaskUtil {
    
    	public static void main(String[] args) throws Exception {
    		   generator();
    	}
    
    	private static void generator() throws Exception {
    	   GeneratorAntTask task = new GeneratorAntTask();
           task.setConfigfile("generatorConfig.xml");  //（配置文件具体path）
           task.execute();
    	   
    	   System.out.println("代码生成完毕>>>>>>>>>>>>");
    	}
    
    }

执行main方法就可以生成代码了,执行后的结果如下:

![Center 6][]

最后附上完整demo:[http://download.csdn.net/download/qq\_32786873/10022347][http_download.csdn.net_download_qq_32786873_10022347]

第四种:基于Maven插件的方式

首先创建一个Maven工程，项目目录如下：

![Center 7][]

pom.xml文件配置如下：

<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.solin</groupId>
      <artifactId>autoGenerate</artifactId>
      <version>0.0.1-SNAPSHOT</version>
      <packaging>jar</packaging>
    
      <name>autoGenerate</name>
      <url>http://maven.apache.org</url>
    
      <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
      </properties>
    
      <dependencies>
        <dependency>
          <groupId>junit</groupId>
          <artifactId>junit</artifactId>
          <version>3.8.1</version>
          <scope>test</scope>
        </dependency>
      </dependencies>
      
      <build>
    		<finalName>autoGenerate</finalName>
    		<plugins>  
    	        <plugin>
    	           <groupId>org.mybatis.generator</groupId>
    	           <artifactId>mybatis-generator-maven-plugin</artifactId>
    	           <version>1.3.2</version>
    	           <executions>
    	              <execution>
    	                 <id>Generate MyBatis Files</id>
    	                 <goals>
    	                    <goal>generate</goal>
    	                 </goals>
    	                 <phase>generate</phase>
    	                 <configuration>
    	                    <verbose>true</verbose>
    	                    <overwrite>true</overwrite>
    	                 </configuration>
    	              </execution>
    	           </executions>
    	 
    	           <dependencies>
    	              <dependency>
    	                 <groupId>mysql</groupId>
    	                 <artifactId>mysql-connector-java</artifactId>
    	                 <version>5.1.38</version>
    	              </dependency>
    	              <dependency>
    	                 <groupId>org.mybatis.generator</groupId>
    	           <artifactId>mybatis-generator-core</artifactId>
    	                 <version>1.3.5</version>
    	              </dependency>
    	 
    	              <dependency>
    	                 <groupId>org.mybatis</groupId>
    	                 <artifactId>mybatis</artifactId>
    	                 <version>3.4.2</version>
    	              </dependency>
    	           </dependencies>
    	        </plugin> 
    	    </plugins>
    	</build>
    </project>

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="application.properties"/>
    
    	  
        <context id="MBG" targetRuntime="MyBatis3">
            <plugin type="org.mybatis.generator.plugins.EqualsHashCodePlugin" />
            <plugin type="org.mybatis.generator.plugins.SerializablePlugin" />
            <plugin type="org.mybatis.generator.plugins.CaseInsensitiveLikePlugin" />
            <plugin type="org.mybatis.generator.plugins.ToStringPlugin"></plugin>
            
              
            <commentGenerator >  
                <property name="suppressAllComments" value="true"/>  
                <property name="suppressDate" value="true" />   
            </commentGenerator>  
            
              
            <jdbcConnection 
            	driverClass="${jdbc.driverClassName}"
                connectionURL="${jdbc.url}" 
                userId="${jdbc.username}" 
                password="${jdbc.password}">
            </jdbcConnection>
    
     		  
            <javaTypeResolver>  
                  
                <property name="forceBigDecimals" value="false"/>  
            </javaTypeResolver>  
    
    		   
            <javaModelGenerator targetPackage="${package.entity}" targetProject="src/main/java">
            	
                <property name="constructorBased" value="true" />
                   
                <property name="enableSubPackages" value="false" />
                  
                <property name="trimStrings" value="true" />
            </javaModelGenerator>
    
    		  
            <sqlMapGenerator targetPackage="${package.mapper}" targetProject="src/main/java">
                <property name="enableSubPackages" value="false" />
            </sqlMapGenerator>
    
    		
            <javaClientGenerator type="XMLMAPPER" targetPackage="${package.mapper}" targetProject="src/main/java">
                <property name="enableSubPackages" value="false" />
            </javaClientGenerator>
            
    
            <table tableName="${tableName}" 
            	enableCountByExample="false" 
            	enableUpdateByExample="false"
                enableDeleteByExample="false" 
                enableSelectByExample="false"
                selectByExampleQueryId="false">
            	
                <property name="constructorBased" value="true" />
                
                <property name="useActualColumnNames" value="false" />
                
                <property name="ignoreQualifiersAtRuntime" value="false" />
                
            	
            </table>
        </context>
    </generatorConfiguration>

对于generatorConfig.xml文件中引入的 application.properties文件，里面主要是数据库连接信息和生成的文件的目录信息，application.properties文件配置如下：

jdbc.url=jdbc:mysql:///test?createDatabaseIfNotExist=true&useUnicode=true&characterEncoding=utf8
    jdbc.driverClassName=com.mysql.jdbc.Driver
    jdbc.username=root
    jdbc.password=root
    
    package.entity=com.solin.autoGenerate.entity
    package.mapper=com.solin.autoGenerate.mapper
    #指定要生成代码的表名,如果tableName等于%,则生成全部表的代码
    tableName=user

以上文件配置好了之后，在项目上点击右键，如图：  
![Center 8][]  
在点击Run Configurations以后，会弹出对话框，在对话框上找到Maven Build，然后右键并且点击new，如下图:  
![Center 9][]

在新出现的界面上填写Name，Base directory，Goals这三个地方，其中Name可以随便写，Base directory是你的工程的路径，Goals这个地方不用变，照着图写，这个是maven插件的命令。至于Maven  Runtime下拉框可以不选，也可以选择自己安装在eclipse外面的那个。

![Center 10][]

点击Apply,在点击 Run，稍等一会，你可以看到generate执行成功了，如图：

![Center 11][]

刷新项目，可以看到生成的文件，如图：

![Center 12][]

最后附上完整demo:[http://download.csdn.net/download/qq\_32786873/10022351][http_download.csdn.net_download_qq_32786873_10022351]

第五种:通过eclipse mybatis generater代码生成插件自动生成代码

详细说明见:[http://blog.csdn.net/qq\_32786873/article/details/78226513][http_blog.csdn.net_qq_32786873_article_details_78226513]

[http_blog.csdn.net_isea533_article_details_42102297]: http://blog.csdn.net/isea533/article/details/42102297
[http_www.mybatis.org_generator_running_running.html]: http://www.mybatis.org/generator/running/running.html
[Center]: /images/20220607/95dd561d4a6f4e949470823673740761.png
[Center 1]: /images/20220607/62c5db1a08964dcfa1a5fe983f403b1b.png
[Center 2]: /images/20220607/dd5a4bca3dbb482d9b726b42b273e5e2.png
[http_download.csdn.net_download_qq_32786873_10020288]: http://download.csdn.net/download/qq_32786873/10020288
[Center 3]: /images/20220607/d5e6eba936d243ecad2c5f58960317c2.png
[Center 4]: /images/20220607/fbfa1023aabf4ba1bbdb979aa43aba07.png
[http_download.csdn.net_download_qq_32786873_10020408]: http://download.csdn.net/download/qq_32786873/10020408
[Center 5]: /images/20220607/517ec62c337846bfbcf145fbea0a2f47.png
[Center 6]: /images/20220607/e507cd2418de4b1997fb665eb37c5d69.png
[http_download.csdn.net_download_qq_32786873_10022347]: http://download.csdn.net/download/qq_32786873/10022347
[Center 7]: /images/20220607/2f499d84ec0b47aa9636cc0fe52ac3a2.png
[Center 8]: /images/20220607/bbb67917968442e6aae5f6e6696107ea.png
[Center 9]: /images/20220607/a38b8e5b61f648d292dd760c38b3ea8b.png
[Center 10]: /images/20220607/e430cc4e1e6e4661a75ff0c7b2e3e9bd.png
[Center 11]: /images/20220607/101adc09c7344241bf91de6002f09b6e.png
[Center 12]: /images/20220607/c601dbdb60b344f08d7050be0bf03e96.png
[http_download.csdn.net_download_qq_32786873_10022351]: http://download.csdn.net/download/qq_32786873/10022351
[http_blog.csdn.net_qq_32786873_article_details_78226513]: http://blog.csdn.net/qq_32786873/article/details/78226513