Spring Boot Data JPA @Query教程 · ZetCode 中文系列教程

# Spring Boot Data JPA `@Query`教程 > 原文： [http://zetcode.com/springboot/datajpaquery/](http://zetcode.com/springboot/datajpaquery/) Spring Boot Data JPA `@Query`教程展示了如何使用 Data JPA `@Query`創建自定義查詢。 Spring 是用于創建企業應用的流行 Java 應用框架。 Spring Boot 是 Spring 框架的演進，可幫助您輕松創建獨立的，生產級的基于 Spring 的應用。 ## Spring Data JPA Spring Data JPA 有助于實現基于 JPA 的存儲庫。它增強了對基于 JPA 的數據訪問層的支持。它使構建使用數據訪問技術的 Spring 支持的應用變得更加容易。 Spring Data JPA 是較大的 Spring Data 系列的一部分。 ## Spring Data JPA `@Query` `@Query`注解直接在存儲庫方法上聲明查找程序查詢。雖然在域類上使用了類似的`@NamedQuery`，但在`Repository`接口上使用了 Spring Data JPA `@Query`注解。這樣可以將域類從持久性特定的信息中解放出來，這是一件好事。 ## Spring Boot Data JPA `@Query`示例以下應用是一個簡單的 Spring Boot Web 應用，它使用 Data JPA @Query 創建一個自定義查詢。 ```java pom.xml 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.ftl └───test └───java ``` 這是項目結構。 `pom.xml` ```java <?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>com.zetcode</groupId> <artifactId>springbootcustomdatajpaquery</artifactId> <version>1.0-SNAPSHOT</version> <packaging>jar</packaging> <properties> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <maven.compiler.source>11</maven.compiler.source> <maven.compiler.target>11</maven.compiler.target> </properties> <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>2.1.1.RELEASE</version> </parent> <dependencies> <dependency> <groupId>com.h2database</groupId> <artifactId>h2</artifactId> <scope>runtime</scope> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-freemarker</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-data-jpa</artifactId> </dependency> </dependencies> <build> <plugins> <plugin> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-maven-plugin</artifactId> </plugin> </plugins> </build> </project> ``` Maven POM 文件包含 H2 數據庫，Freemarker 模板引擎和 Spring Boot Data JPA 的依賴項。 `resources/application.properties` ```java server.servlet.contextPath=/myapp spring.main.banner-mode=off spring.datasource.platform=h2 logging.level.org.hibernate.SQL=DEBUG spring.jpa.show-sql=true spring.jpa.hibernate.ddl-auto=none ``` 在`application.properties`文件中，我們編寫了 Spring Boot 應用的各種配置設置。 `server.servlet.contextPath`設置上下文路徑（應用名稱）。完成這些設置后，我們可以通過`localhost:8080/myapp/`訪問該應用。使用`spring.main.banner-mode`屬性，我們可以關閉 Spring 橫幅。 `spring.datasource.platform`設置數據庫的供應商名稱。在初始化腳本中使用它。 `spring.jpa.show-sql`允許記錄 SQL 語句。最后，`spring.jpa.hibernate.ddl-auto`禁止從實體自動創建模式。 `com/zetcode/model/City.java` ```java package com.zetcode.model; import java.util.Objects; import javax.persistence.Entity; import javax.persistence.GeneratedValue; import javax.persistence.GenerationType; import javax.persistence.Id; import javax.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`。 ```java @Entity @Table(name = "cities") public class City { ``` `@Entity`注解指定該類是一個實體，并映射到數據庫表。 `@Table`注解指定要用于映射的數據庫表的名稱。 ```java @Id @GeneratedValue(strategy = GenerationType.AUTO) private Long id; ``` `@Id`注解指定實體的主鍵，`@GeneratedValue`提供規范主鍵值的生成策略。 `resources/schema-h2.sql` ```java CREATE TABLE cities(id INT PRIMARY KEY AUTO_INCREMENT, name VARCHAR(255), population INT); ``` 啟動應用時，將執行`schema-h2.sql`腳本。它創建一個新的數據庫表。 `resources/data-h2.sql` ```java 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` ```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()`方法。 ```java @Query("select c from City c where c.name like %?1") List<City> findByNameEndsWith(String chars); ``` `@Query`注解包含自定義 JPQL 查詢。它返回名稱以提供的字符結尾的城市。 `com/zetcode/service/ICityService.java` ```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` ```java package com.zetcode.service; import com.zetcode.model.City; import com.zetcode.repository.CityRepository; import java.util.List; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Service; @Service public class CityService implements ICityService { @Autowired private CityRepository repository; @Override public List<City> findByNameEndsWith(String name) { var cities = (List<City>) repository.findByNameEndsWith(name); return cities; } } ``` `CityService`包含`findByNameEndsWith()`方法的實現。我們使用存儲庫從數據庫檢索數據。 ```java @Autowired private CityRepository repository; ``` 注入`CityRepository`。 ```java var cities = (List<City>) repository.findByNameEndsWith(name); ``` 存儲庫的`findByNameEndsWith()`方法返回以某些字符結尾的城市列表。 `com/zetcode/controller/MyController.java` ```java package com.zetcode.controller; import com.zetcode.model.City; import com.zetcode.service.ICityService; import java.util.List; 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; @Controller public class MyController { @Autowired 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"; } } ``` `MyController`類用`@Controller`注解。 ```java @Autowired private ICityService cityService; ``` 我們在`cityService`字段中插入`ICityService`。 ```java @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.ftl` ```java <!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.ftl`模板文件中，我們在 HTML 表中顯示數據。 `resources/static/index.html` ```java <!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` ```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`啟用自動配置和組件掃描。 ```java $ mvn spring-boot:run ``` 應用運行后，我們可以導航到`localhost:8080/myapp/`。在本教程中，我們展示了如何使用 Spring Data JPA `@Query`注解創建自定義 JPQL 查詢。您可能也對相關教程感興趣： * [Spring Boot MySQL 教程](/springboot/mysql/) * [Spring Boot Data JPA `@NamedQuery`教程](/springboot/datajpanamedquery/) * [Spring Boot REST Data JPA 教程](/articles/springbootrestdatajpa/) [](/articles/springbootrestdatajpa/) * [Spring Boot Data JPA 排序教程](/springboot/datajpasort/) * [Spring Boot `CrudRepository`教程](/springboot/crudrepository/) * [Spring Boot H2 REST 教程](/articles/springbootresth2/) 列出[所有 Spring Boot 教程](/all/#springboot)。