在Spring Boot中加载初始化数据的实现

2023-08-01 16:15:04 62

在SpringBoot中，SpringBoot会自动搜索映射的Entity，并且创建相应的table，但是有时候我们希望自定义某些内容，这时候我们就需要使用到data.sql和schema.sql。

依赖条件

SpringBoot的依赖我们就不将了，因为本例将会有数据库的操作，我们这里使用H2内存数据库方便测试：


com.h2database
h2
runtime

我们需要使用JPA来创建Entity：

@Entity
publicclassCountry{

@Id
@GeneratedValue(strategy=IDENTITY)
privateIntegerid;

@Column(nullable=false)
privateStringname;

//...
}

我们这样定义repository：

publicinterfaceCountryRepositoryextendsCrudRepository{
ListfindByName(Stringname);
}

如果这时候我们启动SpringBoot程序，将会自动创建Country表。

data.sql文件

上面我们创建好了数据表格，我们可以使用data.sql来加载文件：

INSERTINTOcountry(name)VALUES('India');
INSERTINTOcountry(name)VALUES('Brazil');
INSERTINTOcountry(name)VALUES('USA');
INSERTINTOcountry(name)VALUES('Italy');

在data.sql文件中我们插入了4条数据，可以写个测试例子测试一下：

@RunWith(SpringRunner.class)
@SpringBootTest(classes=LoadIniDataApp.class)
publicclassSpringBootInitialLoadIntegrationTest{

@Autowired
privateCountryRepositorycountryRepository;

@Test
publicvoidtestInitDataForTestClass(){
assertEquals(4,countryRepository.count());
}
}

schema.sql文件

有时候我们需要自定义数据库的schema，这时候我们可以使用到schema.sql文件。

先看一个schema.sql的例子：

CREATETABLEcountry(
idINTEGERNOTNULLAUTO_INCREMENT,
nameVARCHAR(128)NOTNULL,
PRIMARYKEY(id)
);

SpringBoot会自动加载这个schema文件。

我们需要关闭springboot的schema自动创建功能以防冲突：

spring.jpa.hibernate.ddl-auto=none

spring.jpa.hibernate.ddl-auto有如下几个选项：

create:首先drop现有的tables，然后创建新的tables
update:这个模式不会删除现有的tables，它会比较现有的tables和新的注解或者xml配置是否一致，然后更新。
create-drop:和create很类似，不同的是会在程序运行完毕后自动drop掉tables。通常用在单元测试中。
validate:只会做table是否存在的验证，不存在则会报错。
none:关闭ddl自动生成功能。

如果SpringBoot没有检测到自定义的schemamanager的话，则会自动使用create-drop模式。否则使用none模式。

@sql注解

@Sql是测试包中的一个注解，可以显示的导入要执行的sql文件，它可以用在class上或者方法之上，如下所示：

@Test
@Sql({"classpath:new_country.sql"})
publicvoidtestLoadDataForTestCase(){
assertEquals(6,countryRepository.count());
}

上面的例子将会显示的导入classpath中的new_country.sql文件。

@Sql有如下几个属性：

config:用来配置SQL脚本，我们在下面的@SqlConfig详细讲解。
executionPhase:可以选择脚本是在BEFORE_TEST_METHOD或者AFTER_TEST_METHOD来执行。
statements:可以接受内联的sql语句
scripts:可以指明要执行脚本的路径

@SqlConfig注解

@SqlConfig主要用在class级别或者用在@Sql注解的config属性中：

@Sql(scripts={"classpath:new_country2.sql"},
config=@SqlConfig(encoding="utf-8",transactionMode=SqlConfig.TransactionMode.ISOLATED))

@SqlConfig有如下几个属性：

blockCommentStartDelimiter:指明了SQL脚本的开始标记。
blockCommentEndDelimiter:SQL脚本的结束标记。
commentPrefix:SQL脚本的注释标记
dataSource:javax.sql.DataSource的名字，指定该脚本将会在什么datasource下执行
encoding:SQL文件的编码
errorMode:脚本遇到错误的处理模式
separator:分隔符
transactionManager:指定的PlatformTransactionManager
transactionMode:事务模式

@Sql是可以多个同时使用的，如下所示：

@Test
@Sql({"classpath:new_country.sql"})
@Sql(scripts={"classpath:new_country2.sql"},
config=@SqlConfig(encoding="utf-8",transactionMode=SqlConfig.TransactionMode.ISOLATED))
publicvoidtestLoadDataForTestCase(){
assertEquals(6,countryRepository.count());
}

本文的例子可以参考:https://github.com/ddean2009/learn-springboot2/tree/master/springboot-load-ini-data

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持毛票票。

声明：本文内容来源于网络，版权归原作者所有，内容由互联网用户自发贡献自行上传，本网站不拥有所有权，未作人工编辑处理，也不承担相关法律责任。如果您发现有涉嫌版权的内容，欢迎发送邮件至：czq8825#qq.com（发邮件时，请将#更换为@）进行举报，并提供相关证据，一经查实，本站将立刻删除涉嫌侵权内容。

在Spring Boot中加载初始化数据的实现

热门推荐

随机推荐