如何使用JPA Repository通过JPQL查询关联实体-java教程-PHP中文网

如何使用jpa repository通过jpql查询关联实体

本文旨在详细阐述如何利用JPA Repository和JPQL（Java Persistence Query Language）高效地查询具有关联关系的实体，特别是从多对一或一对多关系中检索相关数据。我们将探讨常见的查询误区，并提供最佳实践，帮助开发者避免混合SQL与JPQL语法的问题，从而编写出清晰、可维护且符合JPA规范的代码。

理解JPA查询机制：JPQL与原生SQL

在使用Spring Data JPA时，我们通常会通过@Query注解来定义自定义查询。这里需要明确区分两种主要的查询语言：

JPQL (Java Persistence Query Language)：这是一种面向对象的查询语言，与SQL类似但操作的是实体对象及其属性，而不是数据库表和列。JPQL是数据库无关的，由JPA提供商（如Hibernate）在运行时转换为具体的SQL语句。它能够直接理解实体之间的关系，使得关联查询变得非常简洁。
原生SQL (Native SQL)：当@Query注解的nativeQuery属性设置为true时，表示我们希望执行原生的数据库SQL语句。这种方式直接操作数据库表和列，不经过JPA的实体映射层。虽然提供了最大的灵活性，但会失去JPQL的面向对象特性和数据库无关性，且实体映射需要额外处理（如通过@SqlResultSetMapping或手动映射）。

原始问题中出现的错误在于，尝试在nativeQuery=true的设置下，使用了类似JPQL的构造器表达式（new egecoskun121.com.crm.model.entity.Product(...)）和SQL风格的子查询语法（{SELECT PRODUCT_ID FROM USERS_PRODUCTS WHERE USER_ID=:id }），这种混淆导致了查询失败。当nativeQuery为true时，查询字符串必须是纯粹的SQL，不能包含JPQL特有的语法，反之亦然。

利用JPQL查询关联实体：最佳实践

对于涉及实体间关联关系的查询，JPQL是首选且更优雅的解决方案。JPA通过实体类中的@OneToMany、@ManyToOne等注解自动管理这些关系。

考虑以下两个实体：User 和 Product，它们之间存在一对多的关系，即一个用户可以拥有多个产品。

Product 实体

import jakarta.persistence.*;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.hibernate.annotations.CreationTimestamp;
import org.hibernate.annotations.UpdateTimestamp;

import java.math.BigDecimal;
import java.sql.Timestamp;
import jakarta.validation.constraints.Size;

@Entity
@Data
@Table(name = "product")
@NoArgsConstructor
@AllArgsConstructor
public class Product {

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

    @CreationTimestamp
    @Column(updatable = false)
    private Timestamp createdDate;

    @UpdateTimestamp
    private Timestamp lastModifiedDate;

    private String imageURL;

    private Long productCode;

    @Size(min = 3,max = 100)
    private String productName;

    @Size(min = 5,max = 100)
    private String details;

    private BigDecimal price;

    @Enumerated(EnumType.STRING) // 假设 ProductCategory 是枚举类型
    private ProductCategory productCategory;

    // ... 其他字段
}

// 假设 ProductCategory 是一个枚举
enum ProductCategory {
    ELECTRONICS, BOOKS, CLOTHING
}

登录后复制

User 实体

import jakarta.persistence.*;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.hibernate.annotations.CreationTimestamp;
import org.hibernate.annotations.UpdateTimestamp;

import java.sql.Timestamp;
import java.util.List;
import jakarta.validation.constraints.NotNull;
import jakarta.validation.constraints.Size;

@Data
@AllArgsConstructor
@NoArgsConstructor
@Entity
@Table(name = "users")
public class User {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    @Column(unique = true,nullable = false)
    private String phoneNumber;

    @Size(min = 5, max = 25, message = "Username length should be between 5 and 25 characters")
    @Column(unique = true, nullable = false)
    private String userName;

    @CreationTimestamp
    @Column(updatable = false)
    private Timestamp createdDate;

    @UpdateTimestamp
    private Timestamp lastModifiedDate;

    @Column(unique = true, nullable = false)
    @NotNull
    private String email;

    @Size(min = 5, message = "Minimum password length: 5 characters")
    @NotNull
    private String password;

    // User 和 Product 之间的一对多关系
    // 默认情况下，JPA会为 @OneToMany 关系创建一张中间表 (users_products)
    // 如果没有mappedBy属性，则由拥有方（这里是User）管理关系
    @OneToMany(fetch = FetchType.LAZY, cascade = CascadeType.ALL, orphanRemoval = true)
    @JoinTable( // 明确指定中间表，或者让JPA自动生成
        name = "users_products",
        joinColumns = @JoinColumn(name = "user_id"),
        inverseJoinColumns = @JoinColumn(name = "product_id")
    )
    private List<Product> products;

    // ... 其他字段和关系
    // @Transient 表示此字段不映射到数据库
    @Transient
    @OneToMany(fetch = FetchType.LAZY, mappedBy = "product", cascade = CascadeType.ALL, orphanRemoval = true)
    private List<ProductInquiry> productInquiries; // 假设 ProductInquiry 实体存在

    @Enumerated(EnumType.STRING) // 假设 Role 是枚举类型
    private Role role;
}

// 假设 Role 是一个枚举
enum Role {
    USER, ADMIN
}

登录后复制

要查询特定用户下的所有产品，最简洁且推荐的方式是使用JPQL的JOIN操作符。

JPA Repository 接口

import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.data.jpa.repository.Query;
import org.springframework.data.repository.query.Param;
import org.springframework.stereotype.Repository;

import java.util.List;

@Repository
public interface UserRepository extends JpaRepository<User, Long> {

    /**
     * 根据用户ID查询该用户关联的所有产品。
     * 使用JPQL的JOIN操作，从User实体开始，通过其products集合关联到Product实体。
     *
     * @param id 用户的ID
     * @return 属于该用户的所有产品列表
     */
    @Query("SELECT p FROM User u JOIN u.products p WHERE u.id = :id")
    List<Product> findAllProductsByUserId(@Param("id") Long id);
}

登录后复制

JPQL 查询解析：SELECT p FROM User u JOIN u.products p WHERE u.id = :id

SELECT p: 表示我们希望返回Product实体（别名为p）。
FROM User u: 指定查询的起始实体是User，并为其设置别名u。
JOIN u.products p: 这是关键部分。它表示通过User实体（u）的products集合属性（在User实体中定义为List<Product> products）进行连接，并将连接结果中的Product实体别名为p。JPA提供商会根据实体定义自动生成相应的SQL JOIN语句，通常是基于中间表或外键关联。
WHERE u.id = :id: 这是一个过滤条件，用于筛选出特定User ID（通过@Param("id")绑定）所关联的产品。

这种方式的优点是：

降重鸟

要想效果好，就用降重鸟。AI改写智能降低AIGC率和重复率。

308

查看详情

面向对象：直接操作实体和它们的属性，而不是数据库表和列。
类型安全：编译时检查，减少运行时错误。
数据库无关性：JPQL由JPA提供商翻译成适应不同数据库的SQL。
简洁明了：利用JPA的关联映射，查询语句非常直观。

何时考虑原生SQL查询

尽管JPQL是处理实体关联查询的首选，但在以下特定场景中，原生SQL查询可能更为合适：

执行复杂或数据库特有的操作：例如，调用存储过程、使用特定数据库的函数或语法（如CONNECT BY、PIVOT等）。
优化性能：对于某些极其复杂的报表查询，JPQL生成的SQL可能不够高效，此时手写优化的原生SQL可能带来性能提升。
查询非映射到实体的结果：当需要查询数据库中未映射到任何JPA实体的列或聚合结果时。
批量数据插入/更新：虽然JPA提供了批量操作，但有时原生SQL的INSERT INTO ... SELECT FROM或UPDATE ... WHERE等语句可能更直接高效。

当使用原生SQL并希望将其结果映射到Java对象时，有几种方法：

映射到实体 (resultClass)：如果原生SQL查询的结果集列名与目标实体属性名匹配，并且查询返回的是完整的实体数据，可以使用@Query(value = "...", nativeQuery = true, resultClass = YourEntity.class)。
映射到DTO (SqlResultSetMapping)：如果原生SQL的结果集不完全对应某个实体，或者你希望映射到自定义的DTO（数据传输对象），可以使用@SqlResultSetMapping结合@ConstructorResult或@ColumnResult。这通常需要更复杂的配置。
手动映射：直接获取List<Object[]>结果，然后手动遍历数组并填充到Java对象中。

示例（原生SQL映射到DTO，仅作演示，不推荐用于本场景）

假设有一个DTO ProductDTO：

public class ProductDTO {
    private Long id;
    private String productName;
    private BigDecimal price;

    public ProductDTO(Long id, String productName, BigDecimal price) {
        this.id = id;
        this.productName = productName;
        this.price = price;
    }
    // Getters and Setters
}

登录后复制

你可以定义一个@SqlResultSetMapping：

@NamedNativeQuery(
    name = "User.findProductsNative",
    query = "SELECT p.ID, p.PRODUCT_NAME, p.PRICE FROM PRODUCT p JOIN USERS_PRODUCTS up ON p.ID = up.PRODUCT_ID WHERE up.USER_ID = :id",
    resultSetMapping = "ProductDTOMapping"
)
@SqlResultSetMapping(
    name = "ProductDTOMapping",
    classes = @ConstructorResult(
        targetClass = ProductDTO.class,
        columns = {
            @ColumnResult(name = "ID", type = Long.class),
            @ColumnResult(name = "PRODUCT_NAME", type = String.class),
            @ColumnResult(name = "PRICE", type = BigDecimal.class)
        }
    )
)
@Entity // @SqlResultSetMapping 通常与一个实体关联，或者定义在orm.xml中
// 实际应用中，如果映射到DTO，这个Mapping可以放在任何一个实体上，或者通过orm.xml配置
// 为了简化，这里假设它放在User实体上
public class User { /* ... */ }

登录后复制

然后在Repository中使用：

public interface UserRepository extends JpaRepository<User, Long> {
    @Query(nativeQuery = true) // 或者直接使用 @NamedNativeQuery 的名称
    List<ProductDTO> findProductsNative(@Param("id") Long id);
}

登录后复制

显然，相比于JPQL的简洁，原生SQL在实体映射方面要复杂得多。因此，除非有明确的理由，否则应优先选择JPQL。