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 创建一个自定义查询。
这是项目结构。
pom.xml
Maven POM 文件包含 H2 数据库,Freemarker 模板引擎和 Spring Boot Data JPA 的依赖项。
resources/application.properties
在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
这是City
实体。 每个实体必须至少定义两个注解:@Entity
和@Id
。
@Entity
注解指定该类是一个实体,并映射到数据库表。 @Table
注解指定要用于映射的数据库表的名称。
@Id
注解指定实体的主键,@GeneratedValue
提供规范主键值的生成策略。
resources/schema-h2.sql
启动应用时,将执行schema-h2.sql
脚本。 它创建一个新的数据库表。
resources/data-h2.sql
之后,执行data-h2.sql
文件。 它用数据填充表。
com/zetcode/repository/CityRepository.java
通过从 Spring CrudRepository
扩展,我们将为数据存储库实现一些方法。 另外,我们创建一个自定义的findByNameEndsWith()
方法。
@Query
注解包含自定义 JPQL 查询。 它返回名称以提供的字符结尾的城市。
com/zetcode/service/ICityService.java
ICityService
提供了一种获取所有以特定字符结尾的城市的合同方法。
com/zetcode/service/CityService.java
CityService
包含findByNameEndsWith()
方法的实现。 我们使用存储库从数据库检索数据。
注入CityRepository
。
存储库的findByNameEndsWith()
方法返回以某些字符结尾的城市列表。
com/zetcode/controller/MyController.java
MyController
类用@Controller
注解。
我们在cityService
字段中插入ICityService
。
我们将带有showCitiesEnding
路径的请求映射到控制器的findCitiesNameEndsWith()
方法。 该模型将获取匹配城市的列表,并将处理过程发送到showCities.ftl
Freemarker 模板文件。
resources/templates/showCities.ftl
在showCities.ftl
模板文件中,我们在 HTML 表中显示数据。
resources/static/index.html
在index.html
中有一个链接,显示以 ou 字符结尾的城市。
com/zetcode/Application.java
Application
设置 Spring Boot 应用。 @SpringBootApplication
启用自动配置和组件扫描。
应用运行后,我们可以导航到localhost:8080/myapp/
。
在本教程中,我们展示了如何使用 Spring Data JPA @Query 注解创建自定义 JPQL 查询。