JPA 中使用 JPQL 查询关联实体：从用户获取产品列表

理解 JPA 查询：JPQL 与原生 SQL

在使用 spring data jpa 进行数据查询时，我们主要有两种方式：jpql（java persistence query language）和原生 sql。

• JPQL 是一种面向对象的查询语言，它直接操作实体对象及其属性，而不是数据库表和列。JPQL 语句在执行时会被 JPA 提供者（如 Hibernate）转换为底层的 SQL 语句。它的主要优势在于数据库无关性、类型安全以及能够直接利用实体之间的映射关系。
• 原生 SQL 允许你直接编写数据库特定的 SQL 语句。当你需要利用数据库的特定功能、执行复杂的存储过程，或者查询结果不直接映射到现有实体时，原生 SQL 会非常有用。使用原生 SQL 时，你需要将 @Query 注解的 nativeQuery 属性设置为 true。

一个常见的误区是将 JPQL 的语法（特别是 SELECT new ... 构造器表达式）与原生 SQL 查询混用。SELECT new ... 是 JPQL 的特性，用于将查询结果直接映射到非实体类（通常是 DTOs），它不能在 nativeQuery = true 的情况下直接用于构造实体。当目标是获取完整的实体对象列表时，JPQL 的关联查询功能更为强大和简洁。

通过 JPQL 查询关联实体

在 JPA 中，实体之间的关系（如 @OneToMany、@ManyToOne 等）是查询的强大基础。当我们需要根据一个实体的 ID 来获取其关联的另一个实体列表时，JPQL 的 JOIN 语句是首选。

考虑以下 User 和 Product 实体定义，其中 User 与 Product 之间存在 @OneToMany 关系：

// Product 实体
@Entity
@Data
@Table(name = "product")
@NoArgsConstructor
@AllArgsConstructor
public class Product {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    // ... 其他属性
    private String productName;
    private BigDecimal price;
    // ...
}

// User 实体
@Data
@AllArgsConstructor
@NoArgsConstructor
@Entity
@Table(name = "users")
public class User {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    // ... 其他属性
    @OneToMany(fetch = FetchType.LAZY, cascade = CascadeType.ALL, orphanRemoval = true)
    private List products; // 用户拥有的产品列表
    // ...
}

为了根据 user_id 获取所有关联的 Product 列表，我们可以编写一个简洁的 JPQL 查询：

invideo AI

InVideo 使用现成的模板简化视频创建

下载

import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.data.jpa.repository.Query;
import org.springframework.data.repository.query.Param;
import java.util.List;

public interface ProductRepository extends JpaRepository {

    /**
     * 根据用户ID查询该用户关联的所有产品。
     * 使用JPQL的JOIN操作，直接通过实体关系进行查询。
     *
     * @param id 用户ID
     * @return 关联的产品列表
     */
    @Query("select p from User u join u.products p WHERE u.id = :id")
    List findAllProductsByUserId(@Param("id") Long id);
}

代码解析：

• @Query("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 实体中定义的 products 集合属性（对应 @OneToMany 关系）执行一个隐式的 JOIN 操作。JPA 会根据实体映射自动生成正确的 JOIN SQL 语句。p 是 products 集合中每个 Product 元素的别名。
  • WHERE u.id = :id: 筛选条件，根据传入的 id 参数匹配 User 的 ID。
• @Param("id") Long id: 将方法参数 id 绑定到 JPQL 查询中的 :id 占位符。

注意事项与最佳实践

1. 优先使用 JPQL： 对于涉及实体及其关系的查询，始终优先考虑 JPQL。它提供了更好的抽象、可移植性和类型安全性。只有当 JPQL 无法满足需求时（例如，需要调用数据库特有的函数、存储过程或进行复杂报表查询），才考虑使用原生 SQL。
2. 避免混淆语法： 明确 JPQL 和原生 SQL 的界限。SELECT new com.example.Product(...) 是 JPQL 构造器表达式的语法，用于 DTO 投影，不能与 nativeQuery = true 混用以直接实例化实体。如果需要在原生 SQL 中映射结果到对象，通常需要使用 SqlResultSetMapping 或手动处理 Tuple 结果。
3. 理解 JOIN 策略： JPQL 的 JOIN 语句会根据实体关系自动生成 JOIN SQL。在复杂场景下，可以根据需要使用 LEFT JOIN、RIGHT JOIN 或 FETCH JOIN 来优化查询性能和加载策略。例如，FETCH JOIN 可以避免 N+1 查询问题，一次性加载主实体及其关联集合。
4. 命名约定： 保持实体属性和数据库列的命名一致性（如果使用默认策略），或者通过 @Column 等注解明确映射，这有助于 JPA 正确地生成 SQL。

总结

通过 Spring Data JPA 和 JPQL，我们可以以面向对象的方式高效地查询关联实体。理解 JPQL 与原生 SQL 的区别，并掌握 JPQL 的 JOIN 语法，是编写高性能、可维护的 JPA 应用的关键。对于从一个实体获取其关联的多个实体列表的场景，利用 JPQL 的 JOIN 查询是最简洁和推荐的方式，它能充分利用 JPA 的强大功能，避免了手动编写复杂原生 SQL 的繁琐和潜在错误。