Spring Data Jpa 自動生成表結構

想在部署的時候隨應用的啓動而初始化數據腳本，這不就是Spring Data Jpa中的自動生成表結構，聽起來特別簡單，不就是配置Hibernate的ddl-auto嘛，有什麼好說的，是個人都知道。當初我也是這樣認爲，實際操作了一把，雖然表是創建成功了，但是字段註釋，字符集以及數據庫引擎都不對，沒想到在這些細節上翻車了。

畢竟開翻的車還要自己扶起來，於是在這記錄一下。

注：本文中使用的Spring Data Jpa版本爲2.1.4.RELEASE

以MySQL爲例，我這邊舉個例子:

import com.fasterxml.jackson.annotation.*;
import org.hibernate.annotations.*;
import org.springframework.data.annotation.*;

import javax.persistence.*;
import javax.persistence.Entity;
import javax.persistence.Id;
import java.math.BigDecimal;

@Entity
@javax.persistence.Table(name = "basic_city")
@org.hibernate.annotations.Table(appliesTo = "basic_city", comment = "城市基本信息")
public class CityDO {
    
    @Id
    @GenericGenerator(name = "idGenerator", strategy = "uuid")
    @GeneratedValue(generator = "idGenerator")
    @Column(name = "CITY_ID", length = 32)
    private String cityId;
 
    @Column(name = "CITY_NAME_CN", columnDefinition = "VARCHAR(255) NOT NULL COMMENT '名稱（中文）'")
    private String cityNameCN;
    
    @Column(name = "CITY_NAME_EN", columnDefinition = "VARCHAR(255) NOT NULL COMMENT '名稱（英文）'")
    private String cityNameEN;

    @Column(name = "LONGITUDE", precision = 10, scale = 7)
    private BigDecimal longitude;

    @Column(name = "LATITUDE", precision = 10, scale = 7)
    private BigDecimal latitude;

    @Column(name = "ELEVATION", precision = 5)
    private Integer elevation;

    @Column(name = "CITY_DESCRIPTION", length = 500)
    private String cityDescription;
    
    // 構造方法及get/set方法省略
}

• @javax.persistence.Table 修改默認ORM規則，屬性name設置表名；
• @org.hibernate.annotations.Table 建表時的描述， 屬性comment修改表描述；
• @Id 主鍵
• @GenericGenerator 設置主鍵策略，這裏使用了Hibernate的UUID來生成主鍵；
• @GeneratedValue 設置主鍵值,屬性generator關聯主鍵策略的name；
• @Column 修改默認ORM規則；
  name設置表中字段名稱，表字段和實體類屬性相同，則該屬性可不寫；
  unique設置該字段在表中是否唯一，默認false；
  nullable是否可爲空，默認true；
  insertable表示insert操作時該字段是否響應寫入，默認爲true；
  updatable表示update操作時該字段是否響應修改，默認爲true；
  columnDefinition是自定義字段，可以用這個屬性來設置字段的註釋；
  table表示當映射多個表時，指定表的表中的字段，默認值爲主表的表名；
  length是長度，僅對varchar類型的字段生效,默認長度爲255；
  precision表示一共多少位；
  scale表示小數部分佔precision總位數的多少位，例子中兩者共同使用來確保經緯度的精度；

接下來需要設置數據引擎和字符集,網上大把的繼承MySQL5InnoDBDialect，但是這個類已經過期了，我們用MySQL5Dialect來代替：

package com.jason.config;

import org.hibernate.dialect.MySQL5Dialect;
import org.springframework.stereotype.Component;

@Component
public class MySQL5TableType extends MySQL5Dialect {

    @Override
    public String getTableTypeString() {
        return "ENGINE=InnoDB DEFAULT CHARSET=utf8";
    }
}

然後在Spring Boot的配置文件中應用上面定義的MySQL5TableType ，使用spring.jpa.properties.hibernate.dialect配置：

spring:
  datasource:
    driver-class-name: com.mysql.jdbc.Driver
    url: jdbc:mysql://localhost:3306/techno?useUnicode=true&characterEncoding=utf8
    username: root
    password: root
  jpa:
    show-sql: true
    hibernate:
      ddl-auto: update
    database-platform: org.hibernate.dialect.MySQL5InnoDBDialect
    properties:
      hibernate:
        dialect: com.jason.config.MySQL5TableType

到此，Sprign Data Jpa生成表就完成了，應用就可以通過ApplicaitonRunner或者CommandLineRunner接口一鍵部署應用，省去初始化SQL等不必要的操作了，這兩個接口的簡單使用可以參考我的另外一篇文章。

原創不易，感謝支持。