Spring Boot @DataJpaTest
最后修改于 2023 年 7 月 28 日
在本文中，我们将展示如何使用@DataJpaTest注解测试JPA仓库。
Spring 是一个流行的 Java 应用程序框架，用于创建企业应用程序。Spring Boot 是 Spring 框架的演进，它有助于以最小的 effort 创建基于 Spring 的独立、生产级应用程序。
@DataJpaTest
@DataJpaTest 用于测试JPA仓库。 该注解禁用完全自动配置，仅应用与JPA测试相关的配置。 默认情况下，使用 @DataJpaTest 注解的测试使用嵌入式内存数据库。
在我们的测试中，我们可以注入一个DataSource，@JdbcTemplate，@EntityManager或来自我们应用程序的任何Spring Data仓库。
包含所有这些组件（包括内存数据库）的应用程序上下文在所有使用 @DataJpaTest 注解的测试类中的所有测试方法之间共享。 因此，每个测试方法在其自己的事务中运行，该事务在方法执行后回滚。 这样，测试保持相互独立。
Spring @DataJpaTest 示例
以下应用程序创建了一个自定义JPA查询方法。 该方法在用 @DataJpaTest 注解的测试类中进行测试。
build.gradle
...
src
├───main
│ ├───java
│ │ └───com
│ │ └───zetcode
│ │ │ Application.java
│ │ │ MyRunner.java
│ │ ├───model
│ │ │ City.java
│ │ └───repository
│ │ CityRepository.java
│ └───resources
│ application.properties
│ data-h2.sql
│ schema-h2.sql
└───test
└───java
└───com
└───zetcode
└───repository
CityRepositoryTest.java
这是项目结构。
build.gradle
plugins {
id 'org.springframework.boot' version '3.1.1'
id 'io.spring.dependency-management' version '1.1.0'
id 'java'
}
group = 'com.zetcode'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '17'
repositories {
mavenCentral()
}
dependencies {
implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
testImplementation 'org.springframework.boot:spring-boot-starter-test'
runtimeOnly 'com.h2database:h2'
}
test {
useJUnitPlatform()
}
Gradle构建文件包含Spring Data JPA、测试和H2数据库的依赖项。
resources/application.properties
spring.main.banner-mode=off spring.sql.init.platform=h2 spring.jpa.hibernate.ddl-auto=none
application.properties 是主要的Spring Boot配置文件。 通过 spring.main.banner-mode 属性，我们关闭了Spring横幅。 spring.sql.init.platform 设置数据库的供应商名称。 它用于初始化脚本。 最后， spring.jpa.hibernate.ddl-auto 禁用从实体自动创建模式。
resources/schema-h2.sql
CREATE TABLE cities(id INT PRIMARY KEY AUTO_INCREMENT,
name VARCHAR(255), population INT);
当应用程序启动时，将执行 schema-h2.sql 脚本。它创建一个新的数据库表。
resources/data-h2.sql
INSERT INTO cities(name, population) VALUES('Bratislava', 432000);
INSERT INTO cities(name, population) VALUES('Budapest', 1759000);
INSERT INTO cities(name, population) VALUES('Prague', 1280000);
INSERT INTO cities(name, population) VALUES('Warsaw', 1748000);
INSERT INTO cities(name, population) VALUES('Los Angeles', 3971000);
INSERT INTO cities(name, population) VALUES('New York', 8550000);
INSERT INTO cities(name, population) VALUES('Edinburgh', 464000);
INSERT INTO cities(name, population) VALUES('Suzhou', 4327066);
INSERT INTO cities(name, population) VALUES('Zhengzhou', 4122087);
INSERT INTO cities(name, population) VALUES('Berlin', 3671000);
INSERT INTO cities(name, population) VALUES('Brest', 139163);
INSERT INTO cities(name, population) VALUES('Bucharest', 1836000);
稍后，将执行 data-h2.sql 文件。它用数据填充表。
com/zetcode/model/City.java
package com.zetcode.model;
import java.util.Objects;
import jakarta.persistence.Entity;
import jakarta.persistence.GeneratedValue;
import jakarta.persistence.GenerationType;
import jakarta.persistence.Id;
import jakarta.persistence.Table;
@Entity
@Table(name = "cities")
public class City {
@Id
@GeneratedValue(strategy = GenerationType.AUTO)
private Long id;
private String name;
private int population;
public City() {
}
public City(String name, int population) {
this.name = name;
this.population = population;
}
public Long getId() {
return id;
}
public void setId(Long id) {
this.id = id;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public int getPopulation() {
return population;
}
public void setPopulation(int population) {
this.population = population;
}
@Override
public int hashCode() {
int hash = 7;
hash = 79 * hash + Objects.hashCode(this.id);
hash = 79 * hash + Objects.hashCode(this.name);
hash = 79 * hash + this.population;
return hash;
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (getClass() != obj.getClass()) {
return false;
}
final City other = (City) obj;
if (this.population != other.population) {
return false;
}
if (!Objects.equals(this.name, other.name)) {
return false;
}
return Objects.equals(this.id, other.id);
}
@Override
public String toString() {
var builder = new StringBuilder();
builder.append("City{id=").append(id).append(", name=")
.append(name).append(", population=")
.append(population).append("}");
return builder.toString();
}
}
这是 City 实体。
com/zetcode/repository/CityRepository.java
package com.zetcode.repository;
import com.zetcode.model.City;
import org.springframework.data.jpa.repository.Query;
import org.springframework.data.repository.CrudRepository;
import org.springframework.data.repository.query.Param;
import org.springframework.stereotype.Repository;
import java.util.List;
@Repository
public interface CityRepository extends CrudRepository<City, Long> {
@Query("SELECT c FROM City c WHERE c.name LIKE CONCAT('%',:ending, '%') AND c.population < :num")
List<City> findByNameEndingWithAndPopulationLessThan(@Param("ending") String ending,
@Param("num") Integer num);
}
CityRepository 包含自定义的 findByNameEndingWithAndPopulationLessThan 方法。 使用该方法，我们可以获取所有以指定字符串结尾且人口少于指定值的城市名称。
com/zetcode/MyRunner.java
package com.zetcode;
import com.zetcode.repository.CityRepository;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.CommandLineRunner;
import org.springframework.stereotype.Component;
@Component
public class MyRunner implements CommandLineRunner {
private static final Logger logger = LoggerFactory.getLogger(MyRunner.class);
@Autowired
private CityRepository cityRepository;
@Override
public void run(String... args) throws Exception {
var cities = cityRepository.findByNameEndingWithAndPopulationLessThan("est", 1800000);
cities.forEach(city -> logger.info("{}", city));
}
}
在 MyRunner 中，我们使用 findByNameEndingWithAndPopulationLessThan 方法。
注意： 在 Java 企业应用程序中，定义一个与存储库一起工作的服务层是一个好习惯。 为了简单起见，我们跳过服务层。
com/zetcode/Application.java
package com.zetcode;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}
Application 设置了 Spring Boot 应用程序。@SpringBootApplication 启用了自动配置和组件扫描。
com/zetcode/repository/CityRepositoryTest.java
package com.zetcode.repository;
import com.zetcode.model.City;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.orm.jpa.DataJpaTest;
import static org.assertj.core.api.Assertions.assertThat;
@DataJpaTest
public class CityRepositoryTest {
@Autowired
private CityRepository repository;
@Test
public void should_find_all_customers() {
Iterable<City> cities = repository.findAll();
int nOfCities = 12;
assertThat(cities).hasSize(nOfCities);
}
@Test
public void should_find_with_name_ending_population_less_than() {
var cities = repository.findByNameEndingWithAndPopulationLessThan("est", 150000);
assertThat(cities).isNotEmpty();
}
}
在 CityRepositoryTest 中，我们测试自定义JPA方法。
@DataJpaTest
public class CityRepositoryTest {
CityRepositoryTest 使用 @DataJpaTest 注解。 内存H2数据库用于执行集成测试。
@Test
public void should_find_with_name_ending_population_less_than() {
var cities = repository.findByNameEndingWithAndPopulationLessThan("est", 150000);
assertThat(cities).isNotEmpty();
}
此方法测试至少有一个城市名称以“est”结尾且人口少于150000。
$ ./gradlew bootRun
我们运行测试。
在本文中，我们展示了如何使用 @DataJpaTest 测试自定义JPA仓库方法。