前言
我们在项目中应该经常遇到过初始化数据的场景,特别是项目部署或者交付的时候,需要建表、初始化数据等,那我们一般可能在部署前,提前在DB中执行SQL,那么有什么方式可以在项目启动的时候自动初始化数据库呢?SpringBoot为我们提供了几种快捷的方式。
JPA映射初始化
如果我们在项目中用到了jpa,那就初始化数据库表结构就比较简单,因为我们的类就关联的表名和字段,我们可以通过配置:
spring.jpa.generate-ddl = true
来开启自动生成DDL,又或者直接指定hibernate配置:
# none:不处理
# validate:只校验表是否和实体类对应
# update:更新表结构,但是它只会新增,不会删除
# create:先drop再创建
# create-drop:和create不同的是应用关闭时会drop表,一般会在单元测试时使用
spring.jpa.hibernate.ddl-auto = none / validate / update / create / create-drop
spring.jpa.hibernate.ddl-auto
的默认值是变化的,如果我们用了内嵌数据库,那么默认值是create-drop
,如果没有,那么就是none
,即不做任何操作。
如果我们指定了
spring.jpa.hibernate.ddl-auto
那么就没有必要再使用spring.jpa.generate-ddl
了,不要混用两个配置。
初始化脚本
上面所说的数据库初始化依赖于我们的ORM框架,而且它只能初始化表结构,如果有数据需要初始化就无法实现了,SpringBoot也考虑到了这一点,因此我们还可以能过初始化脚本来进行数据库初始化,比如我们定义一个SQL脚本如下:
CREATE TABLE IF NOT EXISTS t_user
(
id bigint auto_increment primary key comment 'id',
name varchar(64) default '' not null comment '姓名',
age int default 0 not null comment '年龄',
description varchar(128) default '' not null comment '描述',
)
COMMENT '用户';
-- 插入默认用户
INSERT IGNORE INTO t_user (name, age, description) VALUES ('admin', 10, '');
脚本名称为:schema-mysql.sql
,那么我们就可以通过配置来在项目启动时,自动执行上面的SQL脚本:
# 指定对应的数据库平台,可以取值all或者指定的平台
spring.sql.init.platform = mysql
# 指定SQL初始化模式,取值always / never / embedded
# embedded则是只在使用嵌入式DB时才执行
# 如果不需要执行初始化脚本,那么可以设置值为 never
spring.sql.init.mode = always
SpringBoot在启动时,会自动在classpath下寻找schema-${platform}.sql
或data-${platform}.sql
文件并执行。
@Sql注解
这种方式只能用于单元测试,在单元测试时通过@Sql
注解来指定测试前后需要执行的脚本,具体可以查看:《SpringBoot单元测试实践——数据隔离篇》
总结
上面介绍了几种SpringBoot中在项目运行前初始化数据库的方式,那么我们在实际生产环境中会使用吗?我的回答是看场景:
-
一般情况下,不会使用
,因为如果是一个长期运行的服务,除了第一次部署需要初始化,后续更多的是表结构的变更,比如增加、删除字段,那么对于这种操作,是比较谨慎的,特别是大表,更多的是采用在线改表的方式进行。 -
但是对于一些特定的场景还是有价值的,比如乙方的
项目交付
,我一个项目可能需要交付给很多地方,而且后续也没什么变更,那么通过这种方式可以简化部署流程。 -
还有一种场景是
边缘部署
,可能我们的项目需要在边缘侧部署,可能部署的数量也非常多,且是持续的,那么使用这种方式也可以提升效率,简化流程。