spring boot 根据实体类生成表

在开发的过程中，经常会遇到数据库表结构发生变化或者新增表的情况，而spring 体系下提供的spring data jpa可以帮助我们很方便的处理这种情况，只需要简单的配置既可！以下便是实现路径以及其中需要注意的事项。

添加依赖

 <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-jpa</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
<dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>

        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.33</version>
        </dependency>

如上所示，示例使用mysql作为数据库，其中需要导入jpa的依赖，其他的根据情况进行配置。

数据库相关配置

spring:
  application:
    name: demo
  datasource:
    url: jdbc:mysql://ip:port/demo
    username: username
    password: password
    driver-class-name: com.mysql.cj.jdbc.Driver
  jpa:
    hibernate:
      ddl-auto: update

如上所示，除了数据库的配置之外，需要配置hibernate的ddl-auto字段，我们设置为update，即实体类发生变化时，会自动的更新表结构。

实体类

我们在设置实体类时，一般会有一个父类，用于存储每个类都共有的字段，如主键Id，创建者、创建时间等，配置如下

父类

@Data
@MappedSuperclass
public class BaseEntity implements Serializable {
    /**
     * 主键
     */
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    @Column(updatable = false, unique = true, nullable = false)
    private Long id;

    @CreatedBy
    @Column(updatable = false, name = "created_by")
    @Comment(value = "创建者")
    private String createdBy;

    @CreationTimestamp
    @Column(updatable = false, name = "created_date")
    @Comment(value = "创建时间")
    private LocalDateTime createdDate;

    @LastModifiedBy
    @Column(name = "update_by")
    private String updateBy;

    @UpdateTimestamp
    @Column(name = "update_date_time")
    private LocalDateTime updateDateTime;
}

具体类

@Data
@Table(name = "leave_record")
@Entity
public class LeaveRecord extends BaseEntity {
    private Long userId;
    /**
     * 请假时间
     */
    private Integer leaveHours;

}

如上所示，该类继承了BaseEntity类，并定义了该类特定的字段。

以上配置之后，启动程序，便可以发现生成了所需要的表，如果发生了变更，重新启动之后，会自动变更。需要注意的是，如果删除了字段，则不会删除表中的列。

注意事项

添加注释

添加注释的方式有多种，但有些需要特别注意

comment注解

可以在类或者字段上使用@Comment注解，并设置value的值，既可在生产的字段或者表上添加上对应的注释。这是最简单的方式，一般情况下，使用此方式是最方便的

Column注解

也可以通过Column主键的columnDefinition的值，但是使用该值时，需要特殊的注意，建议主键类的Id字段不使用，使用时，会报错。

错误的使用方式：

@CreatedBy
    @Column(updatable = false, name = "created_by", columnDefinition = " comment '创建者'")
    private String createdBy;

以上方式，会报错，如下

Caused by: java.sql.SQLSyntaxErrorException: You have an error in your SQL syntax; check the manual that corresponds to your MySQL server version for the right syntax to use near 'comment '部门Id' not null, remark TEXT comment '备注', update_by varchar(255' at line 1
	at com.mysql.cj.jdbc.exceptions.SQLError.createSQLException(SQLError.java:121) ~[mysql-connector-j-8.0.33.jar:8.0.33]
	at com.mysql.cj.jdbc.exceptions.SQLExceptionsMapping.translateException(SQLExceptionsMapping.java:122) ~[mysql-connector-j-8.0.33.jar:8.0.33]
	at com.mysql.cj.jdbc.StatementImpl.executeInternal(StatementImpl.java:763) ~[mysql-connector-j-8.0.33.jar:8.0.33]
	at com.mysql.cj.jdbc.StatementImpl.execute(StatementImpl.java:648) ~[mysql-connector-j-8.0.33.jar:8.0.33]
	at com.zaxxer.hikari.pool.ProxyStatement.execute(ProxyStatement.java:94) ~[HikariCP-5.1.0.jar:na]
	at com.zaxxer.hikari.pool.HikariProxyStatement.execute(HikariProxyStatement.java) ~[HikariCP-5.1.0.jar:na]
	at org.hibernate.tool.schema.internal.exec.GenerationTargetToDatabase.accept(GenerationTargetToDatabase.java:80) ~[hibernate-core-6.5.2.Final.jar:6.5.2.Final]
	... 39 common frames omitted

正确的使用方式：

@CreatedBy
    @Column(updatable = false, name = "created_by", columnDefinition = "bigint(20) comment '创建者'")
    private String createdBy;

以上方式，可以正常生成注释。

究其原因，是由于columnDefinition是用于定义字段的信息的，如类型，长度等，如果只是设置注释，则会报错

添加索引

可以在类级别的注解@Table中添加注解，如下所示：

@Table(name = "project", indexes = {
        @Index(name = "projectCodeIndex", columnList = "projectCode", unique = true),
        @Index(name = "projectNameIndex", columnList = "projectName",unique = true),
        @Index(name = "projectStageIndex", columnList = "projectStage", unique = false)
})
@Entity
@Comment("项目")
public class Project extends BaseEntity {

其中，indexes便是索引的基本信息，是一个列表，我们可以设置多个索引，每个索引通过@Index进行设置，其中name为索引的名称，columnList为索引的列列表，多个列通过逗号隔开，unique用于设置是否是唯一索引，默认不设置的话为false，即不是唯一的。

因此，建议大家使用@Comment注解进行设置，非常简单！