通过前面的学习,在实际开发中,我们基本上能对mybatis应用自如了,但是我们发现了一个问题,所有操作都是围绕着po类,xxxMapper.xml文件,xxxMapper接口等文件来进行的。如果实际开发中数据库的表特别多,那么我们需要手动去写每一张表的po类,xxxMapper.xml,xxxMapper.java文件,这显然需要花费巨大的精力,而且可能由于表字段太多,写错了而不知道也是可能的。
所以我们在实际开发中,一般使用逆向工程方式来自动生成所需的文件。
①、新建一个工程,并导入相应的jar包
注意:使用逆向工程时,最好新建一个工程,如果你在原来的工程中使用,那也可以,但是有一定的风险,因为mybatis是根据配置文件中配置的路径来生成的文件的,如果你工程中有相同名字的文件,那么就会被新生成的文件所覆盖。所以实际开发中,我们一般新建一个工程,将生成的文件复制到自己的所需的工程中。
②、创建配置文件 generatorConfig.xml 文件
1 <?xml version="1.0" encoding="UTF-8"?> 2 <!DOCTYPE generatorConfiguration 3 PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN" 4 "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd"> 5 6 <generatorConfiguration> 7 <context id="testTables" targetRuntime="MyBatis3"> 8 <commentGenerator> 9 <!-- 是否去除自动生成的注释 true:是 : false:否 --> 10 <property name="suppressAllComments" value="true"/> 11 </commentGenerator> 12 <!--数据库连接的信息:驱动类、连接地址、用户名、密码 --> 13 <jdbcConnection driverClass="com.mysql.jdbc.Driver" connectionURL="jdbc:mysql://localhost:3306/mybatis" userId="root" password="123456"/> 14 <!-- 默认false,把JDBC DECIMAL 和 NUMERIC 类型解析为 Integer,为 true时把JDBC DECIMAL和NUMERIC类型解析为java.math.BigDecimal --> 15 <javaTypeResolver> 16 <property name="forceBigDecimals" value="false"/> 17 </javaTypeResolver> 18 <javaModelGenerator targetPackage="com.etc.po" targetProject=".\src"> 19 <!-- enableSubPackages:是否让schema作为包的后缀 --> 20 <property name="enableSubPackages" value="false"/> 21 <!-- 从数据库返回的值被清理前后的空格 --> 22 <property name="trimStrings" value="true"/> 23 </javaModelGenerator> 24 <!-- targetProject:mapper映射文件生成的位置,重要!! --> 25 <sqlMapGenerator targetPackage="com.etc.dao" targetProject=".\src"> 26 <property name="enableSubPackages" value="false"/> 27 </sqlMapGenerator> 28 <!-- targetPackage:mapper接口生成的位置,重要!! --> 29 <javaClientGenerator type="XMLMAPPER" targetPackage="com.etc.dao" targetProject=".\src"> 30 <property name="enableSubPackages" value="false"/> 31 </javaClientGenerator> 32 <!-- 指定数据库表,要生成哪些表,就写哪些表,要和数据库中对应,不能写错! --> 33 <table tableName="user"></table> 34 </context> 35 </generatorConfiguration>
配置文件关键点:
1、连接数据库的配置,包括数据名称,数据库用户名密码等配置
2、指定要生成代码的包名,包括实体类po的包名,mapper的包名等
3、指定数据库中哪些表需要生成文件
③、运行主程序生成代码
1 package com.etc.test; 2 3 import org.mybatis.generator.api.MyBatisGenerator; 4 import org.mybatis.generator.config.Configuration; 5 import org.mybatis.generator.config.xml.ConfigurationParser; 6 import org.mybatis.generator.internal.DefaultShellCallback; 7 8 import java.io.File; 9 import java.util.ArrayList; 10 import java.util.List; 11 12 public class GeneratorTest { 13 public void testGenerator() throws Exception { 14 List<String> warnings = new ArrayList<>(); 15 boolean overwrite = true; 16 //指定逆向工程配置文件 17 File configFile = new File(GeneratorTest.class.getResource("/generatorConfig.xml").getFile()); 18 ConfigurationParser cp = new ConfigurationParser(warnings); 19 Configuration config = cp.parseConfiguration(configFile); 20 DefaultShellCallback callback = new DefaultShellCallback(overwrite); 21 MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config,callback,warnings); 22 myBatisGenerator.generate(null); 23 } 24 25 public static void main(String[] args) throws Exception { 26 GeneratorTest generator = new GeneratorTest(); 27 generator.testGenerator(); 28 } 29 }
直接运行上面的程序,控制台会打印如下代码,说明生成代码成功
然后generatorConfig.xml 文件中指定的包,会发现生成了如下文件
【附】
1、IDEA中多模块下Mybatis逆向工程不生成相应文件问题解决
首先Mybatis工程中配置文件需要放在resources包下:
在配置文件中需要注意一点
配置对应生成文件的所在目录时,最好使用绝对路径(若不是用maven聚合搭建的项目则不用修改):
总结:mybatis的逆向工程实现起来其实是非常简单的,但是在不同情况下,要特别注意文件路径的问题。