如何使用Spring Data和JPA按嵌套属性对嵌套集合排序

问题背景 #

我需要获取一个Person实体，要求其关联的hobbies集合按Hobby的name字段排序。实体结构如下（修正了原代码的属性大小写问题）：

class Person {
    @OneToMany
    private List<HobbyPerson> hobbies = new ArrayList<>();
}

class HobbyPerson {
    @ManyToOne
    private Person person;
    @ManyToOne
    private Hobby hobby;
}

class Hobby {
    private String name;
    @OneToMany
    private List<HobbyPerson> hobbies = new ArrayList<>();
}

调用personRepository.findById(person_id)获取单个Person时，希望hobbies列表按Hobby的name排序。尝试过Spring Data方法命名规则和@Query注解均无效——方法命名仅支持主实体排序，@Query无法直接按嵌套属性排序关联集合。

解决方案 #

方法1：在@OneToMany中指定静态排序 #

这是最直接的实现方式，通过@OneToMany的orderBy属性定义固定排序规则：

class Person {
    // 按Hobby的name升序排列hobbies集合
    @OneToMany(mappedBy = "person", orderBy = "hobby.name ASC")
    private List<HobbyPerson> hobbies = new ArrayList<>();
}

此后每次获取Person时，hobbies集合会自动按Hobby.name升序排列。需要降序时，将ASC替换为DESC即可。

方法2：动态排序结合实体图 #

如果需要根据场景动态调整排序规则，可以使用实体图抓取关联数据，配合Sort参数实现：

1. 在Repository中定义带Sort参数的方法：

public interface PersonRepository extends JpaRepository<Person, Long> {
    @EntityGraph(attributePaths = {"hobbies", "hobbies.hobby"})
    Optional<Person> findById(Long id, Sort sort);
}

2. 调用时传入指定嵌套属性的Sort对象：

// 按Hobby.name升序排序
Optional<Person> person = personRepository.findById(personId, Sort.by("hobbies.hobby.name").ascending());
// 按Hobby.name降序排序
Optional<Person> personDesc = personRepository.findById(personId, Sort.by("hobbies.hobby.name").descending());

这种方式支持灵活切换排序字段和顺序，适合动态需求场景。

方法3：内存中手动排序 #

若JPA层面的排序无法满足需求，可以在获取实体后，手动对集合进行内存排序：

Optional<Person> personOpt = personRepository.findById(personId);
personOpt.ifPresent(person -> {
    // 按Hobby.name升序排序
    person.getHobbies().sort(Comparator.comparing(hobbyPerson -> hobbyPerson.getHobby().getName()));
    // 若需要降序，可添加reversed()
    // person.getHobbies().sort(Comparator.comparing(hp -> hp.getHobby().getName()).reversed());
});

这种方式无需修改JPA配置，适合临时排序需求，但性能略低于JPA层面的数据库排序。

内容的提问来源于stack exchange，提问作者beatrice