原文： http://zetcode.com/springboot/datajpaquerybyexample/

Spring Boot Data JPA 示例查询教程展示了如何使用 Spring Data JPA 示例查询技术创建查询。

Spring 是用于创建企业应用的流行 Java 应用框架。 Spring Boot 是 Spring 框架的演进，可帮助您轻松创建独立的，生产级的基于 Spring 的应用。

Spring Data JPA

Spring Data JPA 有助于实现基于 JPA 的存储库。 它增强了对基于 JPA 的数据访问层的支持。 它使构建使用数据访问技术的 Spring 支持的应用变得更加容易。 Spring Data JPA 是较大的 Spring Data 系列的一部分。

Spring Data JPA 查询示例

示例查询（QBE）是一种具有简单接口的用户友好查询技术。 它允许动态查询创建。 我们不需要使用商店特定的查询语言编写查询。

我们处理三个对象。 probe是带有填充字段的域对象的实际示例。 ExampleMatcher包含有关如何匹配特定字段的详细信息。 Example由探针和ExampleMatcher组成。 它用于创建查询。

QBE 有一些局限性。 它无法创建一些更高级的查询。

Spring Boot Data JPA QBE 示例

以下应用使用 QBE 生成查询。

  1. pom.xml
  2. src
  3. ├───main
  4. │   ├───java
  5. │   │   └───com
  6. │   │       └───zetcode
  7. │   │           │   Application.java
  8. │   │           │   MyRunner.java
  9. │   │           ├───model
  10. │   │           │       City.java
  11. │   │           ├───repository
  12. │   │           │       CityRepository.java
  13. │   │           └───service
  14. │   │                   CityService.java
  15. │   │                   ICityService.java
  16. │   └───resources
  17. │           application.properties
  18. │           data-h2.sql
  19. │           schema-h2.sql
  20. └───test
  21.     └───java

这是项目结构。

pom.xml

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0"
  3.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
  5. http://maven.apache.org/xsd/maven-4.0.0.xsd">
  7.     <modelVersion>4.0.0</modelVersion>
  8.     <groupId>com.zetcode</groupId>
  9.     <artifactId>springbootquerybyexample</artifactId>
  10.     <version>1.0-SNAPSHOT</version>
  11.     <packaging>jar</packaging>
  13.     <properties>
  14.         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  15.         <maven.compiler.source>11</maven.compiler.source>
  16.         <maven.compiler.target>11</maven.compiler.target>
  17.     </properties>
  19.     <parent>
  20.         <groupId>org.springframework.boot</groupId>
  21.         <artifactId>spring-boot-starter-parent</artifactId>
  22.         <version>2.1.1.RELEASE</version>
  23.     </parent>
  25.     <dependencies>
  26.         <dependency>
  27.             <groupId>org.springframework.boot</groupId>
  28.             <artifactId>spring-boot-starter-data-jpa</artifactId>
  29.         </dependency>
  30.         <dependency>
  31.             <groupId>com.h2database</groupId>
  32.             <artifactId>h2</artifactId>
  33.             <scope>runtime</scope>
  34.         </dependency>
  35.     </dependencies>
  37.     <build>
  38.         <plugins>
  39.             <plugin>
  40.                 <groupId>org.springframework.boot</groupId>
  41.                 <artifactId>spring-boot-maven-plugin</artifactId>
  42.             </plugin>
  43.         </plugins>
  44.     </build>
  45. </project>

Maven POM 文件包含 H2 数据库和 Spring Boot Data JPA 的依赖项。

resources/application.properties

  1. spring.main.banner-mode=off
  2. spring.datasource.platform=h2
  3. spring.jpa.hibernate.ddl-auto=none

在application.properties文件中，我们编写了 Spring Boot 应用的各种配置设置。 使用spring.main.banner-mode属性，我们可以关闭 Spring 横幅。

spring.datasource.platform设置数据库的供应商名称。 在初始化脚本中使用它。 spring.jpa.hibernate.ddl-auto禁止从实体自动创建模式。

com/zetcode/model/City.java

  1. package com.zetcode.model;
  3. import java.util.Objects;
  4. import javax.persistence.Entity;
  5. import javax.persistence.GeneratedValue;
  6. import javax.persistence.GenerationType;
  7. import javax.persistence.Id;
  8. import javax.persistence.Table;
  10. @Entity
  11. @Table(name = "cities")
  12. public class City {
  14.     @Id
  15.     @GeneratedValue(strategy = GenerationType.AUTO)
  16.     private Long id;
  18.     private String name;
  19.     private int population;
  21.     public City() {
  22.     }
  24.     public City(String name, int population) {
  25.         this.name = name;
  26.         this.population = population;
  27.     }
  29.     public Long getId() {
  30.         return id;
  31.     }
  33.     public void setId(Long id) {
  34.         this.id = id;
  35.     }
  37.     public String getName() {
  38.         return name;
  39.     }
  41.     public void setName(String name) {
  42.         this.name = name;
  43.     }
  45.     public int getPopulation() {
  46.         return population;
  47.     }
  49.     public void setPopulation(int population) {
  50.         this.population = population;
  51.     }
  53.     @Override
  54.     public int hashCode() {
  55.         int hash = 7;
  56.         hash = 79 * hash + Objects.hashCode(this.id);
  57.         hash = 79 * hash + Objects.hashCode(this.name);
  58.         hash = 79 * hash + this.population;
  59.         return hash;
  60.     }
  62.     @Override
  63.     public boolean equals(Object obj) {
  64.         if (this == obj) {
  65.             return true;
  66.         }
  67.         if (obj == null) {
  68.             return false;
  69.         }
  70.         if (getClass() != obj.getClass()) {
  71.             return false;
  72.         }
  73.         final City other = (City) obj;
  74.         if (this.population != other.population) {
  75.             return false;
  76.         }
  77.         if (!Objects.equals(this.name, other.name)) {
  78.             return false;
  79.         }
  80.         return Objects.equals(this.id, other.id);
  81.     }
  83.     @Override
  84.     public String toString() {
  86.         var builder = new StringBuilder();
  87.         builder.append("City{id=").append(id).append(", name=")
  88.                 .append(name).append(", population=")
  89.                 .append(population).append("}");
  91.         return builder.toString();
  92.     }
  93. }

这是City实体。 每个实体必须至少定义两个注解：@Entity和@Id。

resources/schema-h2.sql

  1. CREATE TABLE cities(id INT PRIMARY KEY AUTO_INCREMENT,
  2.     name VARCHAR(255), population INT);

启动应用时，将执行schema-h2.sql脚本。 它创建一个新的数据库表。

resources/data-h2.sql

  1. INSERT INTO cities(name, population) VALUES('Bratislava', 432000);
  2. INSERT INTO cities(name, population) VALUES('Budapest', 1759000);
  3. INSERT INTO cities(name, population) VALUES('Prague', 1280000);
  4. INSERT INTO cities(name, population) VALUES('Warsaw', 1748000);
  5. INSERT INTO cities(name, population) VALUES('Los Angeles', 3971000);
  6. INSERT INTO cities(name, population) VALUES('New York', 8550000);
  7. INSERT INTO cities(name, population) VALUES('Brest', 139163);
  8. INSERT INTO cities(name, population) VALUES('Edinburgh', 464000);
  9. INSERT INTO cities(name, population) VALUES('Suzhou', 4327066);
  10. INSERT INTO cities(name, population) VALUES('Zhengzhou', 4122087);
  11. INSERT INTO cities(name, population) VALUES('Berlin', 3671000);
  12. INSERT INTO cities(name, population) VALUES('Bucharest', 1836000);

之后，执行data-h2.sql文件。 它用数据填充表。

com/zetcode/repository/CityRepository.java

  1. package com.zetcode.repository;
  3. import com.zetcode.model.City;
  4. import org.springframework.data.repository.CrudRepository;
  5. import org.springframework.data.repository.query.QueryByExampleExecutor;
  6. import org.springframework.stereotype.Repository;
  8. @Repository
  9. public interface CityRepository extends CrudRepository<City, Long>,
  10.         QueryByExampleExecutor<City> {
  12. }

我们通过从QueryByExampleExecutor扩展存储库来启用 QBE API。

com/zetcode/service/ICityService.java

  1. package com.zetcode.service;
  3. import com.zetcode.model.City;
  5. import java.util.List;
  7. public interface ICityService {
  9.     List<City> findByNameEnding(String ending);
  10.     List<City> findByName(String name);
  11. }

ICityService提供了两种签约方法。

com/zetcode/service/CityService.java

  1. package com.zetcode.service;
  3. import com.zetcode.model.City;
  4. import com.zetcode.repository.CityRepository;
  5. import org.springframework.beans.factory.annotation.Autowired;
  6. import org.springframework.data.domain.Example;
  7. import org.springframework.data.domain.ExampleMatcher;
  8. import org.springframework.stereotype.Service;
  10. import java.util.List;
  12. import static org.springframework.data.domain.ExampleMatcher.GenericPropertyMatchers.exact;
  14. @Service
  15. public class CityService implements ICityService {
  17.     @Autowired
  18.     private CityRepository cityRepository;
  20.     @Override
  21.     public List<City> findByNameEnding(String ending) {
  23.         var city = new City();
  24.         city.setName(ending);
  26.         var matcher = ExampleMatcher.matching()
  27.                 .withMatcher("name", match -> match.endsWith())
  28.                 .withIgnorePaths("population");
  30.         var example = Example.of(city, matcher);
  31.         return (List<City>) cityRepository.findAll(example);
  32.     }
  34.     @Override
  35.     public List<City> findByName(String name) {
  37.         var city = new City();
  38.         city.setName(name);
  40.         var matcher = ExampleMatcher.matching()
  41.                 .withMatcher("name", exact())
  42.                 .withIgnorePaths("population");
  44.         var example = Example.of(city, matcher);
  45.         return (List<City>) cityRepository.findAll(example);
  46.     }
  47. }

CityService包含服务方法实现。

  1. var city = new City();
  2. city.setName(ending);

我们有一个City域对象。 这称为探针。

  1. var matcher = ExampleMatcher.matching()
  2.     .withMatcher("name", match -> match.endsWith())
  3.     .withIgnorePaths("population");

匹配器将以城市名称结尾的字符串匹配，并忽略人口。

  1. var example = Example.of(city, matcher);

根据域对象和匹配器创建一个Example。

  1. return (List<City>) cityRepository.findAll(example);

Example传递给findAll()方法。

com/zetcode/MyRunner.java

  1. package com.zetcode;
  3. import com.zetcode.service.ICityService;
  4. import org.slf4j.Logger;
  5. import org.slf4j.LoggerFactory;
  6. import org.springframework.beans.factory.annotation.Autowired;
  7. import org.springframework.boot.CommandLineRunner;
  8. import org.springframework.stereotype.Component;
  10. @Component
  11. public class MyRunner implements CommandLineRunner {
  13.     private static final Logger logger = LoggerFactory.getLogger(MyRunner.class);
  15.     @Autowired
  16.     private ICityService cityService;
  18.     @Override
  19.     public void run(String... args) throws Exception {
  21.         logger.info("Finding cities by name");
  22.         var res1 = cityService.findByName("Bratislava");
  23.         logger.info("{}", res1);
  25.         var res2 = cityService.findByName("Berlin");
  26.         logger.info("{}", res2);
  28.         logger.info("Finding cities by name ending with est");
  29.         var res3 = cityService.findByNameEnding("est");
  30.         logger.info("{}", res3);
  31.     }
  32. }

MyRunner查找"Bratislava"和"Berlin"城市，并找到所有名称以"est"结尾的城市。

com/zetcode/Application.java

  1. package com.zetcode;
  3. import org.springframework.boot.SpringApplication;
  4. import org.springframework.boot.autoconfigure.SpringBootApplication;
  6. @SpringBootApplication
  7. public class Application {
  9.     public static void main(String[] args) {
  10.         SpringApplication.run(Application.class, args);
  11.     }
  12. }

Application设置 Spring Boot 应用。 @SpringBootApplication启用自动配置和组件扫描。

  1. $ mvn spring-boot:run
  2. ...
  3. 2019-05-21 16:24:33.480  com.zetcode.MyRunner  Finding cities by name
  4. 2019-05-21 16:24:33.771  com.zetcode.MyRunner  [City{id=1, name=Bratislava, population=432000}]
  5. 2019-05-21 16:24:33.773  com.zetcode.MyRunner  [City{id=11, name=Berlin, population=3671000}]
  6. 2019-05-21 16:24:33.774  com.zetcode.MyRunner  Finding cities by name ending with est
  7. 2019-05-21 16:24:33.781  com.zetcode.MyRunner  [City{id=2, name=Budapest, population=1759000}, 
  8. City{id=7, name=Brest, population=139163}, City{id=12, name=Bucharest, population=1836000}]
  9. ...

我们运行该应用。

在本教程中，我们使用了 Spring Data JPA 示例查询技术来生成查询。 您可能也对相关教程感兴趣：

列出所有 Spring Boot 教程。