Mybatis 代码生成工具

冷不防 2023-10-17 07:49 44阅读 0赞

Mybatis 应用程序，需要大量的配置文件，对于一个成百上千的数据库表来说，完全手工配置，这是一个很恐怖的工作量. 所以 Mybatis 官方也推出了一个 Mybatis 代码生成工具的 jar 包.

首先要下载mybatis-generator-core-1.3.2-bundle.zip 文件，之后解压有两个文件夹

![Center][]

**docs 是帮助文档目录；** **lib 目录是jar 包，需要 mybatis-generator-core-1.3.2.jar，将它拷贝到我们刚刚创建的 Java工程中；**

按照 Mybatis generator 的 doc 文档参考，如：**E:/jar/mybatis-generator-core-1.3.2/docs/configreference/xmlconfig.html**

初步配置出了一个可以使用的版本，我把源代码也提供下载,Mybatis 代码生成工具，主要有一下功能:

1.  生成 pojo 与 数据库结构对应
2.  如果有主键，能匹配主键
3.  如果没有主键，可以用其他字段去匹配
4.  动态 select,update,delete 方法
5.  自动生成接口(也就是以前的 dao 层)
6.  自动生成 sql mapper，增删改查各种语句配置，包括动态 where 语句配置
7.  生成 Example 例子供参考

具体的步骤：

#### 配置 Mybatis 代码生成工具的配置文件 ####

在用 Mybatis 代码生成工具之前，这些目录必须先创建好，作为一个好的应用程序，这些目录的创建也是有规律的。

（1）在创建的 Web 工程中，创建相应的 package 比如 :

（2）com.hlx.inter 用来存放 Mybatis 接口对象。

（3）com.hlx.mapper 用来存放 sql mapper 对应的映射，sql 语句等。

（4）com.hlx.model 用来存放与数据库对应的 model 。

（5）com.hlx.test 用来测试。

**(a)根据 Mybatis 代码生成工具文档，需要一个配置文件，这里命名为:`generatorConfiguration.xml`放在 src 目录下.**

<?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="E:\jar\ojdbc6.jar"/>
       
       
        <context id="hlx_oracle_tables" targetRuntime="MyBatis3">
    
        
        <commentGenerator>
          <property name="suppressAllComments" value="true" />
          <property name="suppressDate" value="true" />
        </commentGenerator>
        
    
        
        <jdbcConnection driverClass="oracle.jdbc.driver.OracleDriver"
            connectionURL="jdbc:oracle:thin:@localhost:1521:HLX"
            userId="rent"
            password="aaa">
        </jdbcConnection>
    
        <javaTypeResolver >
          <property name="forceBigDecimals" value="false" />
        </javaTypeResolver>
    
        
        <javaModelGenerator targetPackage="com.hlx.model" targetProject="src">
          <property name="enableSubPackages" value="true" />
          <property name="trimStrings" value="true" />
        </javaModelGenerator>
    
        
        <sqlMapGenerator targetPackage="com.hlx.mapper"  targetProject="src">
          <property name="enableSubPackages" value="true" />
        </sqlMapGenerator>
    
        
        <javaClientGenerator type="XMLMAPPER" targetPackage="com.hlx.inter"  targetProject="src">
          <property name="enableSubPackages" value="true" />
        </javaClientGenerator>
    
        
        <table schema="rent" tableName="USERINFOS" domainObjectName="Userinfo">     
        </table>
    
      </context>
     
    </generatorConfiguration>

**(b) 测试能否用 Mybatis 成生成刚刚创建的Userinfos表对应的 model,sql mapper 等内容.**

package com.hlx.test;
    
    import java.io.File;
    import java.io.IOException;
    import java.sql.SQLException;
    import java.util.ArrayList;
    import java.util.List;
    
    import org.junit.Test;
    import org.mybatis.generator.api.MyBatisGenerator;
    import org.mybatis.generator.config.Configuration;
    import org.mybatis.generator.config.xml.ConfigurationParser;
    import org.mybatis.generator.exception.InvalidConfigurationException;
    import org.mybatis.generator.exception.XMLParserException;
    import org.mybatis.generator.internal.DefaultShellCallback;
    
    public class GeneratorTest {
    
    	@Test
    	public void test() {
    		List<String> warnings = new ArrayList<String>();
    		boolean overwrite = true;
    		String genCfg = "/generatorConfiguration.xml";
    		File configFile = new File(GeneratorTest.class.getResource(genCfg).getFile());
    		ConfigurationParser cp = new ConfigurationParser(warnings);
    		Configuration config = null;
    		try {
    			config = cp.parseConfiguration(configFile);
    		} catch (IOException e) {
    			e.printStackTrace();
    		} catch (XMLParserException e) {
    			e.printStackTrace();
    		}
    		DefaultShellCallback callback = new DefaultShellCallback(overwrite);
    		MyBatisGenerator myBatisGenerator = null;
    		try {
    			myBatisGenerator = new MyBatisGenerator(config, callback, warnings);
    		} catch (InvalidConfigurationException e) {
    			e.printStackTrace();
    		}
    		try {
    			myBatisGenerator.generate(null);
    		} catch (SQLException e) {
    			e.printStackTrace();
    		} catch (IOException e) {
    			e.printStackTrace();
    		} catch (InterruptedException e) {
    			e.printStackTrace();
    		}
    	}
    
    }

执行之后, **记得刷新工程**，即图示：

![Center 1][]

注意：另外生成的 sql mapper 等，只是对单表的增删改查，如果你有多表 join 操作，你就可以手动配置，如果调用存储过程，你也需要手工配置. 这时工作量已经少很多了。

如果你想用命令行方式处理，也是可以的。

比如:

java -jar mybatis-generator-core-1.3.2.jar -generatorConfiguration.xm -overwrite

这时，要用绝对路径才行. 另外 generatorConfiguration.xml 配置文件中 targetProject 的配置也必须是绝对路径

测试刚刚生成的代码：

mybatis.xml配置文件：

<?xml version="1.0" encoding="UTF-8"?>
    <!DOCTYPE configuration
    PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
    "http://mybatis.org/dtd/mybatis-3-config.dtd">
    <configuration>
    
    	
    	<properties resource="jdbc.properties" />
    
       
       
    
    	
    	
    	 
    	<typeAliases>
    	  <package name="com.hlx.model.rent" />
    	</typeAliases>
    	
    
    		
    	<environments default="development">
    		<environment id="development">
    			
    			<transactionManager type="JDBC" />
    			
    			
    			<dataSource type="POOLED">
    				<property name="driver" value="${driver}" />
    				<property name="url" value="${url}" />
    				<property name="username" value="${username}" />
    				<property name="password" value="${password}" />
    			</dataSource>
    		</environment>
    	</environments>
    	
    	<mappers>
    		<mapper resource="com/hlx/mapper/rent/UserinfoMapper.xml" />
    	</mappers>
    
    </configuration>

**测试类：**

package com.hlx.test;
    
    import java.util.List;
    
    import org.apache.ibatis.session.SqlSession;
    import org.junit.Test;
    
    import com.hlx.inter.rent.UserinfoMapper;
    import com.hlx.model.rent.Userinfo;
    import com.hlx.util.MyBatisUtil;
    
    public class TestUserinfo {
    
    	@Test
    	public void list() {
    		// 获得会话
    		SqlSession session = MyBatisUtil.getSqlSession(true);
    		try { // shift+alt+Z 提示块
    				// 接口
    			UserinfoMapper uMapper = session.getMapper(UserinfoMapper.class);
    
    			// 调用方法
    			List<Userinfo> list = uMapper.selectByExample(null);
    
    			for (Userinfo userinfo : list) {
    				System.out.println(userinfo);
    			}
    		} catch (Exception e) {
    			// TODO Auto-generated catch block
    			e.printStackTrace();
    		} finally {
    			// 关闭会话
    			session.close();
    		}
    
    	}
    
    	@Test
    	public void add() {
    		// 获得会话
    		SqlSession session = MyBatisUtil.getSqlSession(true);
    
    		try {
    			// 接口
    			UserinfoMapper uMapper = session.getMapper(UserinfoMapper.class);
    
    			// 调用方法
    			int count = uMapper.insert(new Userinfo(10, "girl", "198033"));
    		} catch (Exception e) {
    			// TODO Auto-generated catch block
    			e.printStackTrace();
    		} finally {
    			// 关闭会话
    			session.close();
    		}
    
    	}
    }

效果：

![Center 2][]

[Center]: https://img-blog.csdn.net/20160712144657564?watermark/2/text/aHR0cDovL2Jsb2cuY3Nkbi5uZXQv/font/5a6L5L2T/fontsize/400/fill/I0JBQkFCMA==/dissolve/70/gravity/Center
[Center 1]: https://img-blog.csdn.net/20160712145657607?watermark/2/text/aHR0cDovL2Jsb2cuY3Nkbi5uZXQv/font/5a6L5L2T/fontsize/400/fill/I0JBQkFCMA==/dissolve/70/gravity/Center
[Center 2]: https://img-blog.csdn.net/20160712150556792?watermark/2/text/aHR0cDovL2Jsb2cuY3Nkbi5uZXQv/font/5a6L5L2T/fontsize/400/fill/I0JBQkFCMA==/dissolve/70/gravity/Center