造一个轮子FlyRafter——Java实体类映射为数据库表工具

spring

我们现在开发项目,常使用 Spring Boot 框架,并使用 mybatis 进行数据CRUD。但我们总还是需要手写 SQL 创建 数据库,然后与 Java 实体体映射。这样 mybatis 才能将 java 对象与数据库表进行互相转换。

但是,作为一很懒的开发,有没有什么方法,不用定义数据库表,而只写 Java 实体类呢?

通过搜索,我们得知,用得很多的是 Hibernate 的自动生成数据库表定义。

配置步骤如下:

  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 相关配置:
spring:
  jpa:
    hibernate:
      ddl-auto: update

ddl-auto 有如下选项:

  • create 启动时删数据库中的表,然后创建,退出时不删除数据表
  • create-drop 启动时删数据库中的表,然后创建,退出时删除数据表 如果表不存在报错
  • update 如果启动时表格式不一致则更新表,原有数据保留
  • validate 项目启动表结构进行校验 如果不一致则报错

通过以上配置,在项目启动时,将会按配置自动将 @Entity 注解的实体类,在数据库生成相应的数据表。

我们的目的,是想在开发时,不论如何修改实体类,数据表都能实时匹配。但经过实验发现,即使我们将选项配置为 update,让 Hibernate 随时更新数据表,它也只能追加新增的列,并不会将实体类中已经删除的属性对应的列删除,也不会把定义变更的属性对应的列的属性进行变更。

这就很愁了,这并不符合我们懒的需求。

在开源项目中找了一圈,也没有发现合适的工具,我们决定自己造一个轮子!

FlyRafter 应运而生!

我们想通过它,初步达到如下目标:在开发过程中,不论怎么修改实体类,运行时,数据库表的定义都与实体类定义一致。远期目标,我们希望,它能覆盖一些 mybatis 的功能,最终能在项目中看不到写 SQL。

目前我们已经发布了 FlyRafter 的预览版,可在 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>
  • 执行
    输入命令
mvn flyrafter:generate
  1. 方法二
  • maven pom.xml 添加插件并指定 compile 阶段后执行命令 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

项目官网地址:https://www.mortnon.fun

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

项目公众号: 卯榫morTnon

项目正在不断完善中,欢迎对项目 Star,也欢迎提交 issue。希望这个工具能让开发人员懒得舒服。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,088评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,715评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,361评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,099评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 60,987评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,063评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,486评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,175评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,440评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,518评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,305评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,190评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,550评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,880评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,152评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,451评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,637评论 2 335

推荐阅读更多精彩内容