源碼地址: 點擊下載
前言:
mybatis是目前很流行的持久層框架,其逆向工程更是大大縮減了我們的開發時間。所謂mybatis逆向工程,就是mybatis會根據我們設計好的數據表,自動生成pojo、mapper以及mapper.xml。本文將介紹三種方式實現mybatis的逆向工程。
mybatis逆向工程的作用是根據數據庫裏的表結構自動生成實體類、映射文件和接口。
和hibernate的自動建表相反。
方式一:手工代碼
需要的jar包
1.mybatis-3.2.3.jar
2.mybatis-generator-core-1.3.2.jar
3.mysql-connector-java-5.1.28-bin.jar
另外加上一個啓動類GeneratorSqlmap和一個稍微改動的xml文件即可:
啓動類GeneratorSqlmap
通用java代碼只要修改你的配置文件的路徑即可
public class GeneratorSqlmap {
public 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);
}
public static void main(String[] args) throws Exception {
try {
GeneratorSqlmap generatorSqlmap = new GeneratorSqlmap();
generatorSqlmap.generator();
} catch (Exception e) {
e.printStackTrace();
}
}
}
配置文件 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>
<context id="testTables" targetRuntime="MyBatis3">
<commentGenerator>
<!-- 是否去除自動生成的註釋 true:是 : false:否 -->
<property name="suppressAllComments" value="true" />
</commentGenerator>
<!--數據庫連接的信息:驅動類、連接地址、用戶名、密碼 -->
<jdbcConnection driverClass="com.mysql.jdbc.Driver"
connectionURL="jdbc:mysql://localhost:3306/fortune" userId="root"
password="1234">
</jdbcConnection>
<!--
默認false,把JDBC DECIMAL 和 NUMERIC 類型解析爲 Integer,
爲 true時把JDBC DECIMAL 和 NUMERIC 類型解析爲java.math.BigDecimal
-->
<javaTypeResolver>
<property name="forceBigDecimals" value="false" />
</javaTypeResolver>
<!-- targetProject:生成PO類的位置 -->
<javaModelGenerator targetPackage="com.entity"
targetProject=".\src">
<property name="enableSubPackages" value="false" />
<!-- 從數據庫返回的值被清理前後的空格 -->
<property name="trimStrings" value="true" />
</javaModelGenerator>
<!-- mapper映射文件生成的位置 -->
<sqlMapGenerator targetPackage="com.mapper"
targetProject=".\src">
<property name="enableSubPackages" value="false" />
</sqlMapGenerator>
<!-- mapper接口生成的位置 -->
<javaClientGenerator type="XMLMAPPER"
targetPackage="com.mapper"
targetProject=".\src">
<property name="enableSubPackages" value="false" />
</javaClientGenerator>
<!-- 指定數據庫表 -->
<table schema="" tableName="admin"></table>
<table schema="" tableName="member"></table>
<table schema="" tableName="record"></table>
</context>
</generatorConfiguration>
上面需要改動的地方有:
<jdbcConnection> | 自定義數據庫名,用戶名和密碼 |
<javaModelGenerator> | 實體類路徑。沒有會新建 |
<sqlMapGenerator > | 映射文件的路徑 |
<javaClientGenerator > | 接口的路徑 |
<table> | 需要映射的數據庫的表名 |
插件啓動maven-generator
如果使用maven項目就可以省去編寫Java啓動類,使用maven插件和配置文件.xml即可
在pow中加上如下代碼來添加插件:
<plugin>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-maven-plugin</artifactId>
<version>1.3.2</version>
<configuration>
<verbose>true</verbose>
<overwrite>true</overwrite>
<configurationFile>${project.basedir}/generatorConfig.xml</configurationFile>
</configuration>
<dependencies>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.30</version>
</dependency>
</dependencies>
</plugin>
配置完generatorConfig,找到IDE 上的該插件點擊運行,效果是一樣的。
注意事項:
1.修改配置文件時,如果不想生成example使用下面這句做配置文件開頭:
<context id="MysqlContext" targetRuntime="MyBatis3Simple" defaultModelType="flat">
如果想生成example使用下面這句做配置文件開頭:
<context id="testTables" targetRuntime="MyBatis3">
2.重構時,多次運行逆向工程,除了.java文件是覆蓋的,.xml文件都是累加的。所以,要重構就的將已存在的映射.xml文件刪除或者清理成下面的樣子:
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-mapper.dtd" >
<mapper namespace="" >
</mapper>
3 .如果使用maven插件,<plugin>
外層不可以用<pluginManagement>
標籤包裹,否則插件不顯示。
4.如果使用maven插件,裏面的<artifactId>mysql-connector-java</artifactId>
不能省,即使上面配置了也不行,不然就告你驅動找不到!
除了這樣配置,還可以在generatorConfig.xml裏面配置驅動jar的路徑,
如:<classPathEntry location="d:\mshu\mysql-connector-java-5.1.6-bin.jar"/>
哪個方便就用哪個吧。
方式二:使用eclipse插件
點我下載源碼。
1、安裝插件
在eclipse程點擊Help ----> Eclipse Marketplace,然後搜索"mybatis",如下圖:
安裝這個插件,安裝完成後重啓eclipse。
2、新建逆向工程
①、新建一個空的java project
②、新建Mybatis Generator
點擊finish,這樣就自動生成了generatorConfig.xml。
3、加jar包
逆向工程的包不需要了,因爲插件已經集成了,只需要數據庫驅動包和mybatis的包,如下圖:
4、配置generatorConfig.xml
配置和方式一的基本上一樣,有一個不同的地方,就是方式一中targetProject = ".\src"
,寫的是相對路徑,而使用插件時應該寫成targetProject = "generator\src"
,寫絕對路徑,generator是工程名。同樣把配置文件放在工程的最外層,我也不清楚爲什麼用插件時寫相對路徑就會找不到src,知道的老鐵可以留言指教一下哦!
5、運行
裝了插件就不需要寫Java類來執行配置文件了,直接選擇配置文件run as mybatis Generator,如下圖:
執行後就可以生成代碼了。
方式三:使用idea插件
彩蛋mybatis plugin 插件
號稱mybatis三劍客之一mybatis plugin插件,可以讓你快速的在剛剛生成的java接口和對應的xml映射文件之間來去自如,就如接口和實現類一樣。
使用方法,【file】>【seting】>【plugins】>【Browes repositories】搜索“mybatis plugin” 安裝,重啓。
但是,收費
你可以,破解
生成的表格名前綴:
更改配置文件:
<table schema="" tableName="t_user"><domainObjectRenamingRule searchString="^T" replaceString="" /></table>
相比之前的配置新增了一個屬性:
<domainObjectRenamingRule searchString="^T" replaceString="" />
注意:T必須大寫,否則是沒用的。
總結:
mybatis逆向工程非常強大,可以大大提高工作效率,而且也不會出現數據庫表與實體類對不上號的情況。用eclipse、idea插件更簡單一點,不用自己寫執行的代碼,但是自己手動也不算麻煩,而且不依賴開發工具。
參考:
https://www.jianshu.com/p/74ab984b4fee(來源:簡書)
https://segmentfault.com/a/1190000011444427(來源:思否)