造一個輪子FlyRafter——Java實體類映射為數(shù)據(jù)庫表工具

spring

我們現(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ù)庫表定義耻煤。

配置步驟如下:

  1. 在 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>
  1. 在配置文件 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 插件:

  1. 方法一
  • maven pom.xml 添加插件:
<plugin>
    <groupId>fun.mortnon</groupId>
    <artifactId>flyrafter-maven-plugin</artifactId>
    <version>0.0.1</version>
</plugin>
  • 執(zhí)行
    輸入命令
mvn flyrafter:generate
  1. 方法二
  • 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>

FlyRafter Wiki

FlyRafter Maven 插件 Wiki

項目官網(wǎng)地址:https://www.mortnon.fun

項目 gitee 地址: https://gitee.com/mortise-and-tenon

項目公眾號: 卯榫morTnon

項目正在不斷完善中,歡迎對項目 Star凛捏,也歡迎提交 issue担忧。希望這個工具能讓開發(fā)人員懶得舒服。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末坯癣,一起剝皮案震驚了整個濱河市瓶盛,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌示罗,老刑警劉巖蓬网,帶你破解...
    沈念sama閱讀 221,198評論 6 514
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異鹉勒,居然都是意外死亡帆锋,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 94,334評論 3 398
  • 文/潘曉璐 我一進店門禽额,熙熙樓的掌柜王于貴愁眉苦臉地迎上來锯厢,“玉大人皮官,你說我怎么就攤上這事∈导” “怎么了捺氢?”我有些...
    開封第一講書人閱讀 167,643評論 0 360
  • 文/不壞的土叔 我叫張陵,是天一觀的道長剪撬。 經(jīng)常有香客問我摄乒,道長,這世上最難降的妖魔是什么残黑? 我笑而不...
    開封第一講書人閱讀 59,495評論 1 296
  • 正文 為了忘掉前任馍佑,我火速辦了婚禮,結(jié)果婚禮上梨水,老公的妹妹穿的比我還像新娘拭荤。我一直安慰自己,他們只是感情好疫诽,可當(dāng)我...
    茶點故事閱讀 68,502評論 6 397
  • 文/花漫 我一把揭開白布舅世。 她就那樣靜靜地躺著,像睡著了一般奇徒。 火紅的嫁衣襯著肌膚如雪雏亚。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 52,156評論 1 308
  • 那天摩钙,我揣著相機與錄音罢低,去河邊找鬼。 笑死腺律,一個胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的宜肉。 我是一名探鬼主播匀钧,決...
    沈念sama閱讀 40,743評論 3 421
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼谬返!你這毒婦竟也來了之斯?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 39,659評論 0 276
  • 序言:老撾萬榮一對情侶失蹤遣铝,失蹤者是張志新(化名)和其女友劉穎佑刷,沒想到半個月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體酿炸,經(jīng)...
    沈念sama閱讀 46,200評論 1 319
  • 正文 獨居荒郊野嶺守林人離奇死亡瘫絮,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 38,282評論 3 340
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了填硕。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片麦萤。...
    茶點故事閱讀 40,424評論 1 352
  • 序言:一個原本活蹦亂跳的男人離奇死亡鹿鳖,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出壮莹,到底是詐尸還是另有隱情翅帜,我是刑警寧澤,帶...
    沈念sama閱讀 36,107評論 5 349
  • 正文 年R本政府宣布命满,位于F島的核電站涝滴,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏胶台。R本人自食惡果不足惜歼疮,卻給世界環(huán)境...
    茶點故事閱讀 41,789評論 3 333
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望概作。 院中可真熱鬧腋妙,春花似錦、人聲如沸讯榕。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,264評論 0 23
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽愚屁。三九已至济竹,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間霎槐,已是汗流浹背送浊。 一陣腳步聲響...
    開封第一講書人閱讀 33,390評論 1 271
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留丘跌,地道東北人袭景。 一個月前我還...
    沈念sama閱讀 48,798評論 3 376
  • 正文 我出身青樓,卻偏偏與公主長得像闭树,于是被迫代替她去往敵國和親耸棒。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 45,435評論 2 359

推薦閱讀更多精彩內(nèi)容