通過前面的學習,在實際開發中,我們基本上能對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的逆向工程實現起來其實是非常簡單的,但是在不同情況下,要特別注意文件路徑的問題。