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

我们现在开发项目，常使用 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>

2. 在配置文件 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

2. 方法二

• 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。希望这个工具能让开发人员懒得舒服。

也欢迎关注我的博客：阿呜的边城

也欢迎关注我的公众号：阿呜的编程