Spring Boot初始化数据库和导入数据

0. 前言


本文参考的主要是Spring Boot 1.5.8官方文档,写这篇文章的原因是,在做Spring Boot的项目时,跑Unit Test,需要利用DDL重新建表,以及要在建表后想通过Spring Boot 或者Hibernate自动插入基础测试数据。

1. 数据库初始化


Spring Boot提供两种方法来定义数据库的表结构以及添加数据。

  1. 使用Hibernate提供的工具来创建表结构,该机制会自动搜索@Entity实体对象并创建对应的表,然后使用import.sql文件导入测试数据;
  2. 利用旧的Spring JDBC,通过schema.sql文件定义数据库的表结构、通过data.sql导入测试数据。

JPA有个生成DDL的特性,并且可以设置为在数据库启动时运行,这可以通过两个外部属性进行控制:

  1. spring.jpa.generate-ddl ( boolean )控制该特性的关闭和开启,跟实现者没关系。
  2. spring.jpa.hibernate.ddl-auto ( enum )是一个Hibernate特性,用于更细力度的控制该行为。

2.1 利用Hibernate实现数据库初始化

spring.jpa.hibernate.ddl-auto 可以显式设置 spring.jpa.hibernate.ddl-auto ,标准的Hibernate属性值有 none , validate , update , create , create-drop
Spring Boot 会根据数据库是否是内嵌类型,选择一个默认值。具体的关系见下图:

内嵌类型 数据库名称 默认值
内嵌 hsqldb, h2, derby create-drop
非内嵌 余下的所有数据库 none

spring.jpa.hibernate.ddl-auto的四个属性的含义见下表:

属性值 作用
create 每次加载hibernate时都会删除上一次的生成的表,然后根据你的model类再重新来生成新表,哪怕两次没有任何改变也要这样执行,这就是导致数据库表数据丢失的一个重要原因。
create-drop 每次加载hibernate时根据model类生成表,但是sessionFactory一关闭,表就自动删除。
update 最常用的属性,第一次加载hibernate时根据model类会自动建立起表的结构(前提是先建立好数据库),以后加载hibernate时根据 model类自动更新表结构,即使表结构改变了但表中的行仍然存在不会删除以前的行。要注意的是当部署到服务器后,表结构是不会被马上建立起来的,是要等应用第一次运行起来后才会。
validate 每次加载hibernate时,验证创建数据库表结构,只会和数据库中的表进行比较,不会创建新表,但是会插入新值。

此外,启动时处于classpath根目录下的 import.sql文件会被执行(前提是ddl-auto属性被设置为 createcreate-drop)。这在demos或测试时很有用,但在生产环境中可能不期望这样。这是Hibernate的特性,和Spring没有一点关系。

2.2 利用Spring JDBC实现数据库初始化

Spring Boot可以自动创建DataSource的模式(DDL脚本)并初始化它(DML脚本),并从标准的位置 schema.sqldata.sql (位于classpath根目录)加载SQL,脚本的位置可以通过设置 spring.datasource.schemaspring.datasource.data 来改变。此外,Spring Boot将加载 schema-${platform}.sqldata-${platform}.sql 文件(如果存在),在这里 platformspring.datasource.platform 的值,比如,可以将它设置为数据库的供应商名称( hsqldb , h2 , oracle , mysql , postgresql 等)。
Spring Boot默认启用Spring JDBC初始化快速失败特性,所以如果脚本导致异常产生,那应用程序将启动失败。能通过设置spring.datasource.continue-on-error的值来控制是否继续。一旦应用程序成熟并被部署了很多次,那该设置就很有用,例如,插入失败时意味着数据已经存在,也就没必要阻止应用继续运行。
如果想要在一个JPA应用中使用 schema.sql ,那如果Hibernate试图创建相同的表, ddl-auto=create-drop 将导致错误产生。为了避免那些错误,可以将 ddl-auto 设置为""或 none 。
最后要提的一点是,spring.datasource.initialize=false 可以阻止数据初始化。

3. 实验

本文的实验会用两种方式实现数据库建表以及插入数据的操作:

  1. 使用Hibernate提供的工具来创建表结构;
  2. 利用旧的Spring JDBC,通过schema.sql文件定义数据库的表结构、通过data.sql导入测试数据。

3.1 Hibernate 数据表初始化

0.建立maven项目,项目结构如下图所示:


项目结构

pom.xml配置如下:

<project xmlns="http://maven.apache.org/POM/4.0.0" >xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 >http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>com.syf.demo</groupId>
  <artifactId>spring-boot-jpa</artifactId>
  <version>0.0.1-SNAPSHOT</version>

  <properties>
      <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  </properties>

  <dependencies>
      <dependency>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-starter-web</artifactId>
      </dependency>
      <dependency>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-starter-data-jpa</artifactId>
      </dependency>
      <dependency>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-starter-jdbc</artifactId>
      </dependency>
      <dependency>
          <groupId>mysql</groupId>
          <artifactId>mysql-connector-java</artifactId>
      </dependency>

  </dependencies>

  <build>
      <plugins>
          <plugin>
              <groupId>org.springframework.boot</groupId>
              <artifactId>spring-boot-maven-plugin</artifactId>
          </plugin>
      </plugins>
  </build>

  <dependencyManagement>
      <dependencies>
          <dependency>
              <groupId>org.springframework.boot</groupId>
              <artifactId>spring-boot-dependencies</artifactId>
              <version>1.5.8.RELEASE</version>
              <type>pom</type>
              <scope>import</scope>
          </dependency>
      </dependencies>
  </dependencyManagement>
</project>

1.定义实体对象:Organization.java


@Entity
@Table(name = "organization")
public class Organization implements Serializable{

 private static final long serialVersionUID = 1L;

@Id
 @GeneratedValue(strategy = GenerationType.AUTO)
 private Long id;

 @Column(name = "company_name", nullable = false, length = 30)
 private String companyName;

 @Column(name = "active", nullable = false)
 private boolean active;

 public Long getId() {
   return id;
 }

 public void setId(Long id) {
   this.id = id;
 }

 public String getCompanyName() {
   return companyName;
 }

 public void setCompanyName(String companyName) {
   this.companyName = companyName;
 }

 public boolean isActive() {
   return active;
 }

 public void setActive(boolean active) {
   this.active = active;
 }

}

  1. 新建application.yml,设置spring.hibernate.ddl-autocreate,该机制会自动搜索@Entity实体对象>(orgnization类)并创建对应的表,然后使用import.sql文件导入测试数据,
    注意!注意!注意!并非所有的spring.hibernate.ddl-auto的值都会触发import.sql文件导入测试数据,只有当spring.hibernate.ddl-auto的值为create, create-drop才会,不然还是执行data.sql,不信的话可以把spring.hibernate.ddl-auto改为update,然后再classpath下加上data.sql,你会发现执行的还是data.sql的内容。
spring:
 application:
   name: spring-boot-database-initialization-hibernate
 jpa:
   generate-ddl: false
   show-sql: true
   hibernate: 
     ddl-auto: create
 datasource:
   database: MYSQL
   continue-on-error: false
   driver-class-name: com.mysql.jdbc.Driver
   url: jdbc:mysql://localhost:3306/syf?useSSL=false
   username: root
   password: 123456

server:
 port: 9090

3.import.sql

INSERT INTO organization (company_name, active) VALUES ('Hibernate IBM', true), ('Hibernate MS', >true);

4.测试程序

@SpringBootApplication
public class AppHibernate {
   public static void main(String[] args) {
       SpringApplication.run(AppHibernate.class, args);
   }
}

结果:


结果.png

从图中可以看出数据表自动建立,并且插入了数据。

3.2 Spring JDBC 数据表初始化

该方案通过schema.sql文件定义数据库的表结构、通过data.sql导入测试数据。
0.建立maven项目:同上

  1. 新建application.yml,如果想要在一个JPA应用中使用 schema.sql ,那如果Hibernate试图创建相同的>表, ddl-auto=create-drop 将导致错误产生。设置spring.hibernate.ddl-autonone,可以避免错误的>产生。
spring:
 application:
   name: spring-boot-jpa
 jpa:
   generate-ddl: false
   show-sql: true
 hibernate: 
     ddl-auto: none
 datasource:
   continue-on-error: false
   driver-class-name: com.mysql.jdbc.Driver
   url: jdbc:mysql://localhost:3306/syf?useSSL=false
   username: root
   password: 123456

server:
 port: 9090

2.schema.sql

DROP TABLE IF EXISTS `organization`;

CREATE TABLE `organization` (
 `id` bigint(20) NOT NULL PRIMARY KEY AUTO_INCREMENT,
 `active` bit(1) NOT NULL,
 `company_name` varchar(30) NOT NULL
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

3.data.sql

/*mock data***/
INSERT INTO organization (company_name, active) 
VALUES 
('JDBC IBM', true),
('JDBC MS', true);

4.结果:


结果.png

从图中可以看出数据表自动建立,并且插入了数据。

4.代码

该项目的源码参考如下链接:Github 地址

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

推荐阅读更多精彩内容