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

建立springboot工程时，好奇hibernate如何自动建表，导入import.sql文件的，因此做了如下学习。

1、在build.gradle中添加依赖

buildscript：
    // 自定义  Hibernate 的版本
	ext['hibernate.version'] = '5.2.8.Final'

dependencies ：
    // 添加 Spring Data JPA 的依赖
	compile('org.springframework.boot:spring-boot-starter-data-jpa')
	
	// 添加 MySQL连接驱动 的依赖
	compile('mysql:mysql-connector-java:6.0.5')

2、在application.properties中增加（重要的是）

spring.jpa.hibernate.ddl-auto=create-drop（自动删除数据库中的表数据，并新建）

# JPA
spring.jpa.show-sql = true
spring.jpa.hibernate.ddl-auto=create-drop

# DataSource 
spring.datasource.url=jdbc:mysql://localhost:3306/blog?characterEncoding=utf-8&useSSL=false&serverTimezone=UTC 
spring.datasource.username=root
spring.datasource.password=123456
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

3、 在resources目录下，新建import.sql文件，添加上你要新建的 内容。

4、重启工程，会看到数据库里初始化的数据

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属性被设置为 create 或create-drop)。这在demos或测试时很有用，但在生产环境中可能不期望这样。这是Hibernate的特性，和Spring没有一点关系。

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

Spring Boot可以自动创建DataSource的模式（DDL脚本）并初始化它（DML脚本），并从标准的位置 schema.sql 和 data.sql （位于classpath根目录）加载SQL，脚本的位置可以通过设置 spring.datasource.schema 和 spring.datasource.data 来改变。此外，Spring Boot将加载 schema-${platform}.sql和 data-${platform}.sql 文件（如果存在），在这里 platform 是 spring.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-auto为create，该机制会自动搜索@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-auto为none，可以避免错误的>产生。

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

作者：我想当码农
链接：https://www.jianshu.com/p/743894b9e2fe
来源：简书
简书著作权归作者所有，任何形式的转载都请联系作者获得授权并注明出处。