spring - 在 Spring 中配置特定的内存数据库以用于测试目的

Question

如何配置我的 Spring Boot 应用程序，以便在运行单元测试时它将使用内存数据库，例如 H2/HSQL，但是当我运行 Spring Boot 应用程序时，它将使用生产数据库 [Postgre/MySQL]？

Answer 1

弹簧配置文件可用于此。这将是一种特定的方式：

具有特定于环境的属性文件：

应用程序属性：

spring.profiles.active: dev

应用程序-dev.properties

spring.jpa.database: MYSQL
spring.jpa.hibernate.ddl-auto: update

spring.datasource.url: jdbc:mysql://localhost:3306/dbname
spring.datasource.username: username
spring.datasource.password: password

应用程序-test.properties

spring.jpa.database: HSQL

有MySQL和H2驱动程序pom.xml，如下所示：

<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <scope>runtime</scope>
</dependency>

<dependency>
    <groupId>org.hsqldb</groupId>
    <artifactId>hsqldb</artifactId>
    <scope>test</scope>
</dependency>

最后但并非最不重要的一点是，使用@ActiveProfiles("test").

Answer 2

另一种方法是将注释添加@AutoConfigureTestDatabase到您的测试类。我的测试通常如下所示：

@RunWith(SpringRunner.class)
@DataJpaTest
@AutoConfigureTestDatabase(connection = EmbeddedDatabaseConnection.H2)
public class MyRepositoryTest {

    @Autowired
    MyRepository repository;

    @Test
    public void test() throws Exception {
        // Tests...
    }
}

注意需要在 pom.xml 文件中添加嵌入式数据库依赖。对于嵌入式数据库，此注释不是必需的，即使仅在 pom 文件中添加了依赖项，它也会起作用。

Answer 3

最简单的解决方案：

1）在 src/main/resources 中有 application.properties （生产配置）：

spring.datasource.url=jdbc:mysql://localhost:3306/somedb
spring.datasource.username=root
spring.datasource.password=password
spring.datasource.driverClassName=com.mysql.jdbc.Driver
spring.jpa.database-platform = org.hibernate.dialect.MySQL5Dialect

和带有 HSQL 配置的 application-test.properties，例如：

spring.jpa.hibernate.ddl-auto = create-drop
spring.jpa.database = HSQL
spring.jpa.properties.hibernate.dialect = org.hibernate.dialect.HSQLDialect
spring.datasource.driverClassName = org.hsqldb.jdbcDriver
spring.datasource.url= jdbc:hsqldb:mem:scratchdb
spring.datasource.username = sa
spring.datasource.password =

2) 如果您还没有，请在 pom.xml 中添加 HSQL 依赖项。

3) 用@ActiveProfiles("test") 注释你的测试类。

在我的情况下像魅力一样工作。

Answer 4

@Sanjay 有一种说法，但我觉得它令人困惑。您也可以只拥有一个production在生产中启用的配置文件，例如：

spring.jpa.hibernate.ddl-auto: update
spring.datasource.url: jdbc:mysql://localhost:3306/dbname
spring.datasource.username: username
spring.datasource.password: password

并且不要指定其他任何内容。如果您在范围内添加嵌入式数据库test，它将在您的测试中可用。如果您使用默认配置文件（没有任何自定义）运行测试，它将找不到任何数据库信息（因为这些信息存储在production配置文件中）。在这种情况下，它将尝试找到一个嵌入式数据库并为您启动它。如果您出于某种原因需要更多定制，您可以application-test.properties为这些定制（您需要添加ActiveProfiles("test")到您的测试中）。

Answer 5

使用 @SpringBootTest 魔法，您只需要进行以下两项更改。

1. 在 pom.xml 中添加“h2”测试依赖项

<dependency>
    <groupId>com.h2database</groupId>
    <artifactId>h2</artifactId>
    <scope>test</scope>
</dependency>

2. 使用@AutoConfigureTestDatabase

@RunWith(SpringRunner.class)
@SpringBootTest(classes = MySpringBootApplication.class)
@AutoConfigureTestDatabase
public class SpringBootTest{

    @Autowired
    private RequestRepository requestRepository;
}

现在测试中使用的所有 spring jpa bean/repositories 都将使用 h2 作为后备数据库。

2019-04-26 13:13:34.198 INFO 28627 --- [main]beddedDataSourceBeanFactoryPostProcessor：用嵌入式版本替换“dataSource”DataSource bean

2019-04-26 13:13:34.199 INFO 28627 --- [main] osbfsDefaultListableBeanFactory：覆盖 bean 'dataSource' 的 bean 定义

2019-04-26 13:13:36.194 INFO 28627 --- [main] osjdeEmbeddedDatabaseFactory：启动嵌入式数据库：url='jdbc:h2:mem:2784768e-f053-4bb3-ab88-edda34956893;DB_CLOSE_DELAY=-1;DB_CLOSE_ON_EXIT=假'，用户名='sa'

注意：我仍然在“application.properties”中定义了“spring-jpa”属性，并且我没有使用任何配置文件。@AutoConfigureTestDatabase将使用测试默认值AutoConfigureTestDatabase.Replace覆盖现有的 jpa 配置。

Answer 6

如果使用 构建简单的解决方案maven：只需在下面放置一个application.properties文件src/test/resources并根据需要进行编辑以进行测试。

Spring (Boot) Profile 机制是一个非常强大的工具，在范围上远远超出了“在测试时间和运行时间之间交换设置”。虽然，很明显，正如所证明的那样，它也可以做到这一点:)

Answer 7

此解决方案支持开发和测试的通用设置。基于此解决方案： Override default Spring-Boot application.properties settings in Junit Test

1. src/main/resources/application.properties 中的application.properties

    #common settings for DEVELOPMENT and TEST:
    ......
    ......

    ## Spring DATASOURCE (DataSourceAutoConfiguration & DataSourceProperties)
    spring.datasource.url=jdbc:postgresql://localhost:5432/databasename
    spring.datasource.username=postgres
    spring.datasource.password=somepassword

    # The SQL dialect makes Hibernate generate better SQL for the chosen database
    spring.jpa.properties.hibernate.dialect = org.hibernate.dialect.PostgreSQLDialect
    spring.jpa.properties.hibernate.jdbc.time_zone=UTC

    # Hibernate ddl auto (create, create-drop, validate, update)
    spring.jpa.hibernate.ddl-auto = none
    spring.jpa.properties.hibernate.jdbc.lob.non_contextual_creation=true

2. test.properties (src/main/resources/application.properties)覆盖并在 application.properties 中添加属性：

    spring.datasource.url=jdbc:h2:mem:testdb;MODE=PostgreSQL
    spring.datasource.driverClassName=org.h2.Driver
    spring.datasource.username=sa
    spring.datasource.password=
    spring.jpa.hibernate.ddl-auto=update
    spring.h2.console.enabled=false

3. 用于 H2 和 Postgre 数据库的pom.xml中的设置

      <!-- h2 -->
      <dependency>
        <groupId>com.h2database</groupId>
        <artifactId>h2</artifactId>
      </dependency>

    <!-- postgress -->
      <dependency>
         <groupId>org.postgresql</groupId>
         <artifactId>postgresql</artifactId>
      </dependency>

4. 在测试类中：

    @RunWith(SpringRunner.class)
    @SpringBootTest
    @TestPropertySource(locations = "classpath:test.properties")
    public class ModelTest { 

    }

Answer 8

我有一个带有以下模块的多模块 Gradle SpringBootApplication

1. employeemanagerApp - 我的 SpringApplication 主类在哪里
2. employeemanagerIntTests - 我在哪里进行黄瓜测试

我的要求是在应用程序启动时使用 MySQL DB，在我的 Cucumber 集成测试期间使用 H2

解决方案：在我的employeemanagerApp 模块src/main/resources 中，我放置了application.properties，其内容如下

#My SQL Configuration
spring.datasource.url=jdbc:mysql://localhost:3306/employeemanager
spring.datasource.username=root
spring.datasource.password=password
spring.jpa.show-sql=true
spring.jpa.hibernate.ddl-auto=update  spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.MySQL5Dialect

在集成测试模块 (employeemanagerIntTests) src/ test /resources 中，我放置了具有以下内容的 application.properties

#H2 In-Memory DB Configuration
spring.datasource.url=jdbc:h2://mem:db;DB_CLOSE_DELAY=-1
spring.datasource.username=sa
spring.datasource.password=sa
spring.datasource.driver-class-name=org.h2.Driver
spring.jpa.show-sql=true
spring.jpa.hibernate.ddl-auto=create-drop
spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.MySQL5Dialect
spring.jpa.properties.hibernate.format_sql=true

在我的步骤定义类中，我只添加了这些注释

@CucumberContextConfiguration
@SpringBootTest(classes = SpringBootApplicationMainClass.class, webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)

在 build.gradle 文件中，我添加了 H2 依赖项

testImplementation 'com.h2database:h2:1.4.200'

因此，当我运行测试时，H2 处于活动状态，所有使用 Create、Update、Read 和 Delete 的测试都成功