ZetCode

Spring Boot Data JPA @Query

最后修改于 2023 年 7 月 25 日

在本文中，我们将展示如何使用 Data JPA @Query 创建自定义查询。

Spring 是一个流行的 Java 应用程序框架，用于创建企业应用程序。Spring Boot 是 Spring 框架的演进，它有助于以最小的 effort 创建基于 Spring 的独立、生产级应用程序。

Spring Data JPA

Spring Data JPA 促进了基于 JPA 的存储库的实现。它增强了对基于 JPA 的数据访问层的支持。它使得构建使用数据访问技术的 Spring 应用程序更加容易。Spring Data JPA 是更大的 Spring Data 家族的一部分。

Spring Data JPA @Query

@Query 注解直接在存储库方法上声明查找器查询。虽然类似的 @NamedQuery 用于域类，但 Spring Data JPA @Query 注解用于 Repository 接口。这使得域类摆脱了特定于持久性的信息，这是一件好事。

Spring Boot Data JPA @Query 示例

以下应用程序是一个简单的 Spring Boot Web 应用程序，它使用 Data JPA @Query 创建自定义查询。

build.gradle
...
src
├───main
│   ├───java
│   │   └───com
│   │       └───zetcode
│   │           │   Application.java
│   │           ├───controller
│   │           │       MyController.java
│   │           ├───model
│   │           │       City.java
│   │           ├───repository
│   │           │       CityRepository.java
│   │           └───service
│   │                   CityService.java
│   │                   ICityService.java
│   └───resources
│       │   application.properties
│       │   data-h2.sql
│       │   schema-h2.sql
│       ├───static
│       │       index.html
│       └───templates
│               showCities.ftlh
└───test
    └───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-web'
    implementation 'org.springframework.boot:spring-boot-starter-freemarker'
    implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
    implementation 'com.h2database:h2'
}

Gradle 构建文件包含 H2 数据库、Freemarker 模板引擎和 Spring Boot Data JPA 的依赖项。

resources/application.properties 
spring.main.banner-mode=off
spring.sql.init.platform=h2
logging.level.org.hibernate.SQL=DEBUG
spring.jpa.show-sql=true
spring.jpa.hibernate.ddl-auto=none

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

spring.sql.init.platform 设置数据库的供应商名称。它用于初始化脚本中。spring.jpa.show-sql 启用 SQL 语句的日志记录。最后，spring.jpa.hibernate.ddl-auto 禁用从实体自动创建模式。

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 实体。每个实体都必须至少定义两个注解：@Entity 和 @Id。

@Entity
@Table(name = "cities")
public class City {

@Entity 注解指定该类是一个实体，并映射到一个数据库表。@Table 注解指定用于映射的数据库表的名称。

@Id
@GeneratedValue(strategy = GenerationType.AUTO)
private Long id;

@Id 注解指定了实体的标识符，@GeneratedValue 提供了为主键值生成策略的规范。

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);

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

com/zetcode/repository/CityRepository.java 
package com.zetcode.repository;

import com.zetcode.model.City;
import java.util.List;
import org.springframework.data.jpa.repository.Query;
import org.springframework.data.repository.CrudRepository;
import org.springframework.stereotype.Repository;

@Repository
public interface CityRepository extends CrudRepository<City, Long> {

    @Query("select c from City c where c.name like %?1")
    List<City> findByNameEndsWith(String chars);
}

通过扩展 Spring CrudRepository，我们将实现一些用于数据存储库的方法。此外，我们创建一个自定义的 findByNameEndsWith 方法。

@Query("select c from City c where c.name like %?1")
List<City> findByNameEndsWith(String chars);

@Query 注解包含自定义的 JPQL 查询。它返回名称以提供的字符结尾的城市。

com/zetcode/service/ICityService.java 
package com.zetcode.service;

import com.zetcode.model.City;
import java.util.List;

public interface ICityService {

    List<City> findByNameEndsWith(String name);
}

ICityService 提供了一个契约方法，用于获取所有以特定字符结尾的城市。

com/zetcode/service/CityService.java 
package com.zetcode.service;

import com.zetcode.model.City;
import com.zetcode.repository.CityRepository;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import java.util.List;

@Service
public class CityService implements ICityService {

    private final CityRepository repository;

    @Autowired
    public CityService(CityRepository repository) {
        this.repository = repository;
    }

    @Override
    public List<City> findByNameEndsWith(String name) {

        return repository.findByNameEndsWith(name);
    }
}

CityService 包含 findByNameEndsWith 方法的实现。我们使用存储库从数据库中检索数据。

private final CityRepository repository;

@Autowired
public CityService(CityRepository repository) {
    this.repository = repository;
}

CityRepository 被注入。

return repository.findByNameEndsWith(name);

存储库的 findByNameEndsWith 方法返回以特定字符结尾的城市列表。

com/zetcode/controller/MyController.java 
package com.zetcode.controller;

import com.zetcode.model.City;
import com.zetcode.service.ICityService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;

import java.util.List;

@Controller
public class MyController {

    private final ICityService cityService;

    @Autowired
    public MyController(ICityService cityService) {
        this.cityService = cityService;
    }

    @GetMapping(path="showCitiesEnding")
    public String findCitiesNameEndsWith(Model model, @RequestParam String name) {

        var cities = (List<City>) cityService.findByNameEndsWith(name);

        model.addAttribute("cities", cities);

        return "showCities";
    }
}

MyController 类使用 @Controller 注解。

private final ICityService cityService;

@Autowired
public MyController(ICityService cityService) {
    this.cityService = cityService;
}

我们将 ICityService 注入到 cityService 字段中。

@GetMapping("/showCitiesEnding")
public String findCitiesNameEndsWith(Model model, @RequestParam String name) {

    var cities = (List<City>) cityService.findByNameEndsWith(name);

    model.addAttribute("cities", cities);

    return "showCities";
}

我们将带有 showCitiesEnding 路径的请求映射到控制器的 findCitiesNameEndsWith 方法。模型获得一个匹配的城市列表，并将处理发送到 showCities.ftl Freemarker 模板文件。

resources/templates/showCities.ftlh 
<!DOCTYPE html>
<html>
    <head>
        <title>Cities</title>
        <meta charset="UTF-8">
        <meta name="viewport" content="width=device-width, initial-scale=1.0">
        </head>
    <body>
        <h2>List of cities</h2>

        <table>
            <tr>
                <th>Id</th>
                <th>Name</th>
                <th>Population</th>
            </tr>

            <#list cities as city>
                <tr>
                    <td>${city.id}</td>
                    <td>${city.name}</td>
                    <td>${city.population}</td>
                </tr>
            </#list>
        </table>
    </body>
</html>

在 showCities.ftlh 模板文件中，我们将数据显示在一个 HTML 表格中。

resources/static/index.html 
<!DOCTYPE html>
<html>
    <head>
        <title>Home page</title>
        <meta charset="UTF-8"/>
        <meta name="viewport" content="width=device-width, initial-scale=1.0"/>
    </head>
    <body>
        <a href="showCitiesEnding?name=ou">Show cities ending in ou</a>
    </body>
</html>

在 index.html 中，有一个链接可以显示以 ou 字符结尾的城市。

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 启用了自动配置和组件扫描。

$ ./gradlew bootRun

运行应用程序后，我们可以导航到 localhost:8080。

在本文中，我们展示了如何使用 Spring Data JPA @Query 注解创建自定义 JPQL 查询。

作者

我叫 Jan Bodnar，是一位充满激情的程序员，拥有丰富的编程经验。自 2007 年以来，我一直在撰写编程文章。迄今为止，我撰写了 1,400 多篇文章和 8 本电子书。 我拥有超过十年的编程教学经验。

列出 所有 Spring Boot 教程。