我們現(xiàn)在開發(fā)項目映砖,常使用 Spring Boot 框架,并使用 mybatis 進行數(shù)據(jù)CRUD齿风。但我們總還是需要手寫 SQL 創(chuàng)建 數(shù)據(jù)庫禾蚕,然后與 Java 實體體映射您朽。這樣 mybatis 才能將 java 對象與數(shù)據(jù)庫表進行互相轉(zhuǎn)換。
但是换淆,作為一很懶的開發(fā)哗总,有沒有什么方法,不用定義數(shù)據(jù)庫表倍试,而只寫 Java 實體類呢讯屈?
通過搜索,我們得知县习,用得很多的是 Hibernate 的自動生成數(shù)據(jù)庫表定義耻煤。
配置步驟如下:
- 在 Spring Boot 項目中引入 JPA 依賴,maven
pom.xml
中依賴示例如下:
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-jpa</artifactId>
<version>2.4.6</version>
</dependency>
- 在配置文件
application.yml
中添加 Hibernate 相關(guān)配置:
spring:
jpa:
hibernate:
ddl-auto: update
ddl-auto
有如下選項:
-
create
啟動時刪數(shù)據(jù)庫中的表准颓,然后創(chuàng)建,退出時不刪除數(shù)據(jù)表 -
create-drop
啟動時刪數(shù)據(jù)庫中的表棺妓,然后創(chuàng)建攘已,退出時刪除數(shù)據(jù)表 如果表不存在報錯 -
update
如果啟動時表格式不一致則更新表,原有數(shù)據(jù)保留 -
validate
項目啟動表結(jié)構(gòu)進行校驗 如果不一致則報錯
通過以上配置怜跑,在項目啟動時样勃,將會按配置自動將 @Entity
注解的實體類,在數(shù)據(jù)庫生成相應(yīng)的數(shù)據(jù)表性芬。
我們的目的峡眶,是想在開發(fā)時,不論如何修改實體類植锉,數(shù)據(jù)表都能實時匹配辫樱。但經(jīng)過實驗發(fā)現(xiàn),即使我們將選項配置為 update
俊庇,讓 Hibernate 隨時更新數(shù)據(jù)表狮暑,它也只能追加新增的列,并不會將實體類中已經(jīng)刪除的屬性對應(yīng)的列刪除辉饱,也不會把定義變更的屬性對應(yīng)的列的屬性進行變更搬男。
這就很愁了,這并不符合我們懶的需求彭沼。
在開源項目中找了一圈缔逛,也沒有發(fā)現(xiàn)合適的工具,我們決定自己造一個輪子!
FlyRafter
應(yīng)運而生褐奴!
我們想通過它按脚,初步達到如下目標:在開發(fā)過程中,不論怎么修改實體類歉糜,運行時乘寒,數(shù)據(jù)庫表的定義都與實體類定義一致。遠期目標匪补,我們希望伞辛,它能覆蓋一些 mybatis 的功能,最終能在項目中看不到寫 SQL夯缺。
目前我們已經(jīng)發(fā)布了 FlyRafter
的預(yù)覽版蚤氏,可在 maven 倉庫中搜索 “flyrafter”。
FlyRafter
的引入與使用也很簡單踊兜,在 Spring Boot 項目中:
在 maven 的 pom.xml 中添加引用:
<dependency>
<groupId>fun.mortnon</groupId>
<artifactId>flyrafter</artifactId>
<version>0.0.3</version>
</dependency>
添加引用后竿滨,會自動帶入 FlyWay 的引用∧缶常可自行指定 FlyWay 的依賴版本于游。
由于FlyRafter 已添加了 Spring Boot 的自動配置,添加引用后垫言,無需配置即可使用贰剥。
(如果非 Spring Boot 項目,還可按提供的 Java API 進行使用)
如果不想引入新的依賴筷频,還可以引入 FlyWay
后蚌成,選擇使用 FlyRafter
的 maven 插件:
- 方法一
- maven pom.xml 添加插件:
<plugin>
<groupId>fun.mortnon</groupId>
<artifactId>flyrafter-maven-plugin</artifactId>
<version>0.0.1</version>
</plugin>
- 執(zhí)行
輸入命令
mvn flyrafter:generate
- 方法二
- maven pom.xml 添加插件并指定 compile 階段后執(zhí)行命令 generate:
<plugin>
<groupId>fun.mortnon</groupId>
<artifactId>flyrafter-maven-plugin</artifactId>
<version>0.0.1</version>
<executions>
<execution>
<phase>compile</phase>
<goals>
<goal>generate</goal>
</goals>
</execution>
</executions>
</plugin>
項目官網(wǎng)地址:https://www.mortnon.fun
項目 gitee 地址: https://gitee.com/mortise-and-tenon
項目公眾號: 卯榫morTnon
項目正在不斷完善中,歡迎對項目 Star凛捏,也歡迎提交 issue担忧。希望這個工具能讓開發(fā)人員懶得舒服。