Spring Data JPA 实战 - 投影Projections-对查询结果的扩展

在 Spring Data JPA 中，投影（Projections）是一种非常有用的功能，它允许你通过查询返回部分实体属性或自定义的 DTO（Data Transfer Object）。使用投影，你可以选择性地返回实体的部分属性，而不是整个实体对象，这对于减少数据传输量和提高性能非常有帮助。

投影类型

Spring Data JPA 支持三种类型的投影：

1. Interface Projection：定义一个接口，该接口声明了要返回的属性。
2. Constructor Projection：使用构造函数创建对象，指定要返回的属性。
3. Map Projection：返回 Map 结构，键为属性名，值为属性值。

示例代码

假设我们有一个 Product 实体类：

import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;

@Entity
public class Product {

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

    private String name;
    private Double price;
    private Integer quantity;

    // 构造函数、getters 和 setters 省略
}

接下来，我们将使用不同类型的投影来展示如何使用 Spring Data JPA 返回不同的数据结构。

Interface Projection

首先，定义一个接口来表示投影：

public interface ProductProjection {

    Long getId();
    String getName();
    Double getPrice();
}

然后，在 ProductRepository 接口中使用 @Query 注解返回 ProductProjection 的实例：

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

import java.util.List;

@Repository
public interface ProductRepository extends JpaRepository<Product, Long> {

    // 使用 Interface Projection
    @Query("SELECT new com.example.demo.ProductProjection(p.id, p.name, p.price) FROM Product p")
    List<ProductProjection> findProductProjections();
}

Constructor Projection

接下来，使用构造函数创建投影对象：

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

import java.util.List;

@Repository
public interface ProductRepository extends JpaRepository<Product, Long> {

    // 使用 Constructor Projection
    @Query("SELECT new com.example.demo.ProductProjection(p.id, p.name, p.price) FROM Product p")
    List<ProductProjection> findProductProjections();

    // 使用 Constructor Projection
    @Query("SELECT new com.example.demo.ProductSummary(p.id, p.name, p.price) FROM Product p")
    List<ProductSummary> findProductSummaries();
}

// DTO for constructor projection
public class ProductSummary {

    private final Long id;
    private final String name;
    private final Double price;

    public ProductSummary(Long id, String name, Double price) {
        this.id = id;
        this.name = name;
        this.price = price;
    }

    // Getters
    public Long getId() {
        return id;
    }

    public String getName() {
        return name;
    }

    public Double getPrice() {
        return price;
    }
}

Map Projection

最后，使用 Map 结构来表示投影：

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

import java.util.List;
import java.util.Map;

@Repository
public interface ProductRepository extends JpaRepository<Product, Long> {

    // 使用 Interface Projection
    @Query("SELECT new com.example.demo.ProductProjection(p.id, p.name, p.price) FROM Product p")
    List<ProductProjection> findProductProjections();

    // 使用 Constructor Projection
    @Query("SELECT new com.example.demo.ProductSummary(p.id, p.name, p.price) FROM Product p")
    List<ProductSummary> findProductSummaries();

    // 使用 Map Projection
    @Query("SELECT p FROM Product p")
    List<Map<String, Object>> findProductMaps();
}

使用示例

现在，我们可以创建一个简单的服务类来使用这些方法：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import java.util.List;
import java.util.Map;

@Service
public class ProductService {

    private final ProductRepository productRepository;

    @Autowired
    public ProductService(ProductRepository productRepository) {
        this.productRepository = productRepository;
    }

    public List<ProductProjection> findProductProjections() {
        return productRepository.findProductProjections();
    }

    public List<ProductSummary> findProductSummaries() {
        return productRepository.findProductSummaries();
    }

    public List<Map<String, Object>> findProductMaps() {
        return productRepository.findProductMaps();
    }
}

总结

• Interface Projection：通过定义接口来指定要返回的属性。
• Constructor Projection：通过构造函数创建对象，指定要返回的属性。
• Map Projection：返回 Map 结构，键为属性名，值为属性值。

投影是 Spring Data JPA 提供的一种非常灵活的方式来返回数据。你可以根据不同的业务需求选择最适合的投影类型。

如果你需要更详细的示例或有其他问题，请随时告诉我！