Spring Boot中JPA实现Sort排序的三种方式

引言： 在Spring Boot应用中，基于数据某个字段进行排序是一个非常常用的需求，这里将给出Sort的三种常用用法，基于分页的应用，大家可以各取所需，择机使用。

环境说明

Spring 4.2 Spring Boot 1.5.11 Java 8

前置说明

ECardEntity.java的定义：

import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.Table;

import com.jd.ai.fasion.util.BaseEntity;

import lombok.Data;
import lombok.EqualsAndHashCode;

@Entity
@Table(name="t_ebusiness_card")
@Data
@EqualsAndHashCode(callSuper=true)
public class ECardEntity extends BaseEntity { 
    private static final long serialVersionUID = 6580526495176090890L;

    @Column
    private String name;

    @Column(name="zip_url")
    private String zipUrl;

    @Column(name="thumb_url")
    private String thumbUrl;

    @Column(name="seq_num")
    private int seqNum;
}

这里的seqNum是排序字段，基于升序来排序。
Repository的定义：

@Repository
public interface EBusinessCardRepository extends JpaRepository<ECardEntity, Long> {
   ///方法的定义
}

方法1： 基于特殊参数的排序（OrderBy写在执行方法中）

建立分页对象:

  Pageable pageable = new PageRequest(pageNum, size);

在Repository中定义相应的方法：

  Page<ECardEntity> findByOrderBySeqNumAsc(Pageable pageable);

这里使用默认的字段拼接形成的方法名，从而自动解析形成对应的方法。

方法2： 基于自定义的@Query进行排序（OrderBy直接写在sql语句中）

Pageable的对象定义与方法1中相同。
在Repository中定义相应的JPL语句：

@Query("select e from ECardEntity e ORDER BY e.seqNum ASC")
Page<ECardEntity> findInOrders(Pageable pageable);

方法3： 基于Pageable中的Sort字段（OrderBy隐藏在Sort字段中）

①单个字段sort排序

Pageable对象的声明：

Sort sort = new Sort(Direction.ASC, "seqNum");
Pageable pageable = new PageRequest(pageNum, size, sort);

这里将Sort字段作为构造方法的入口参数，创建了Pageable对象。
在Repository无需声明任何新的方法，直接使用JpaRepository中继承而来的findAll(Pageable pageable）方法即可。
在Service中调用具体Repository中的方法如下：

  Page<ECardEntity> eCardEntities = this.eCardRepo.findAll(pageable);

②多字段sort排序

1. public Sort(Order… orders);

2. public Sort(List orders);

方法1和2，性质相同，可以实现多个列属性的不同方向排序，例如需要实现一个形如下面的sql：

select * from table where a='a' and b='b' order by c desc,d asc,e desc;

这个Order一定要是import org.springframework.data.domain.Sort.Order;这个包下面的。

然后我们建立三个order分别为如下：

List< Order> orders=new ArrayList< Order>();
Order order2 = new Order(Direction.DESC, "age");
Order order3 = new Order(Direction.ASC, "pgrade");
Order order = new Order(Direction.DESC, "dnum");

那么我们目前的任务就是把这三个order放到list里面然后把list放到sort里面这么简单。不过这里要注意，添加到list中的先后直接关联着排序的优先级，如下：

list.add(order2);
list.add(order3);
list.add(order);
Sort sort1 = new Sort(list);

生成需要的pageable

Pageable pageable= new PageRequest(pageNumber, pageSize, new Sort(orders));

springboot 2.x 使用（上面new ... 的方式过期了）：

Pageable pageable= PageRequest.of(pageNumber, pageSize, new Sort(orders));

注：如不分页，可直接使用Sort作为参数传入dao（即不用封装在Pageable中） 

总结

这几种方法都是非常简单易用的，这里对于这个排序的简单需求来说，方法是最为简单的，无需在Repository进行任何的方法声明直接使用即可。

---

参考自：Spring Boot中JPA实现Sort排序的三种方式_木小鱼的笔记-CSDN博客_jpa 排序

Spring data jpa sort多属性排序问题_abyssalshen的博客-CSDN博客_jpa sort排序多个字段