如何在SpringDataJPA中使用DTO投影获取数据

介绍

在这篇文章中，我们将探讨投影在 spring data jpa 中的工作原理，讨论不同的类型，并通过示例来演示它们如何简化数据访问。

对于本指南，我们使用：

ide：intellij idea（推荐用于 spring 应用程序）或 eclipsejava 版本：17spring data jpa 版本：2.7.x 或更高版本（兼容 spring boot 3.x）使用的实体：用户（代表用户个人资料）和地址（代表用户的地址详细信息）

注意：有关更详细的示例，请访问我的 github 存储库

@setter@getter@entity(name = "tbl_address")public class address { @id @generatedvalue(strategy = generationtype.identity) private long id; private string street; private string city; private string state; private string country; private string zipcode;}

@setter@getter@entity(name = "tbl_user")public class user { @id @generatedvalue(strategy = generationtype.identity) private long id; private string firstname; private string lastname; private string email; private string status; @onetoone(cascade = cascadetype.all) @joincolumn(name = "address_id", referencedcolumnname = "id") private address address;}

1. 为什么在 spring data jpa 中使用投影？

通常，您的应用程序仅需要实体字段的子集，加载不必要的数据可能会导致：

内存使用量增加查询速度慢处理连接数据时的复杂实体管理

投影使您能够仅以所需的确切格式获取所需的数据，从而帮助我们避免出现问题。当为 restful api 获取数据时，这特别有用，其中响应不需要实体的所有字段。

. spring data jpa 中的投影类型。

spring data jpa 提供多种类型的投影：

基于界面的投影基于类的投影（dto 投影）

2.1 – 基于界面的投影

基于接口的投影允许我们为要检索的字段定义带有 getter 方法的接口。然后，spring data jpa 将使用这些 getter 将实体的字段映射到接口。

示例：

定义投影接口和存储库类：

@repositorypublic interface userrepository extends jparepository<user, long> { @query(""" selectconcat(u.firstname, ‘ ‘, u.lastname) as fullname,u.email as email,concat( a.street, ‘, ‘, a.city, ‘, ‘, a.state) as fulladdress,a.country as country,a.zipcode as zipcode from tbl_user u left join tbl_address a on u.address.id = a.id """) list<userinfoprojection> findalluserinfo(); interface userinfoprojection { string getfullname(); string getemail(); string getfulladdress(); string getcountry(); string getzipcode(); }}

定义一个 dto 类以从投影传输到 dto。

@builder@setter@getterpublic class userdto { private string fullname; private string email; private string address; private string country; private string zipcode; public static userdto of(userrepository.userinfoprojection entity) { if (objects.isnull(entity))return null; return userdto.builder() .fullname(entity.getfullname()) .email(entity.getemail()) .address(entity.getfulladdress()) .country(entity.getcountry()) .zipcode(entity.getzipcode()) .build(); }}

测试：

@springboottest@autoconfiguremockmvcclass querytypesapplicationtests { @autowired private userrepository userrepository; @test public void testderivedquerymethods() { list<userdto> results = userrepository.findalluserinfo() .stream() .map(userdto::of) .tolist(); assertequals(10, results.size(), "expected 10 users"); }}

.2 – 基于类的预测

通过基于类的投影，我们可以使用自定义 dto 直接映射结果。这种方法可以让您更好地控制数据的结构，如果您需要在构造函数中自定义逻辑，这种方法会很有用。

示例：

定义 dto：

@setter@getterpublic class userprojectiondto { private final string fullname; private final string email; private final string address; private final string country; private final string zipcode; public userprojectiondto(string fullname, string email, string address, string country, string zipcode) { this.fullname = fullname; this.email = email; this.address = address; this.country = country; this.zipcode = zipcode; }}

定义存储库类并编写sql查询来获取用户信息。

@repositorypublic interface userrepository extends jparepository<user, long> { @query( """select new .davidnguyen.querytypes.user.userprojectiondto( concat(u.firstname, ‘ ‘, u.lastname), u.email, concat(a.street, ‘, ‘, a.city, ‘, ‘, a.state), a.country, a.zipcode)from tbl_user u left join tbl_address a on u.address.id = a.id """ ) list<userprojectiondto> findalluserinfo();}

spring data jpa 执行一个查询，为每行数据构造一个 dto，仅选择构造函数中指定的字段。

测试：

@SpringBootTest@AutoConfigureMockMvcclass QueryTypesApplicationTests { @Autowired private UserRepository userRepository; @Test public void testDerivedQueryMethods() { List<UserProjectionDTO> users = userRepository.findAllUserInfo(); assertEquals(10, users.size(), "Expected 10 users"); }}

3. 选择正确的投影类型

每种投影类型都有其用例：

基于界面的投影非常适合简单的字段选择。基于类的投影更适合复杂的转换或自定义逻辑。

性能说明：

复杂的投影可能会导致过于复杂的查询，这可能会影响性能。使用 dto 的基于类的投影会带来开销，特别是对于大型结果集，因为每一行都需要一个新的 dto 实例。因此，请始终根据需要监控和优化查询。4. spring data jpa 中 dto 投影的最佳实践。

仅选择您需要的字段：无论使用基于类还是基于接口的投影，始终将选择限制为仅必要的字段以优化数据库负载。

对 dto 使用不变性：对于基于类的投影，创建不可变的 dto（最终字段，无 setter）以使其安全稳定。

考虑复杂联接的本机查询：如果您的投影涉及复杂联接或计算字段，请考虑使用带有 @sqlresultsetmapping 和 @constructorresult 注释的本机 sql 查询以获得更多控制。

分析性能查询：特别是对于大型数据集，使用分析工具（如 jpa/hibernate 日志记录）来监视查询性能并确保您的投影不会无意中加载额外的数据。

总结

spring data jpa 中的投影提供了强大的选项来控制从查询返回的数据。通过使用基于接口、基于类和动态投影，您可以微调数据检索以满足应用程序的要求。请记住，有效地实施投影可以提高数据处理的效率，尤其是在具有大型数据集的应用程序中。

下一篇文章见。快乐编码！