深入理解Pageable

一、Pageable的概念

Pageable實現了分頁的概念，它是一個接口，提供了分頁的各種參數來進行查詢。通過它我們可以方便地實現數據的分頁查詢，例如在網頁數據展現或者手機APP上翻頁展示等。

public interface Pageable {
    int getPageNumber();
    int getPageSize();
    int getOffset();
    Sort getSort();
    boolean hasPrevious();
    Pageable next();
    Pageable previousOrFirst();
    Pageable first();
}

Pageable中的方法比較簡單，主要用於獲取分頁的一些參數。其中getPageNumber()方法表示當前頁碼，getPageSize()表示每頁顯示記錄數，getOffset()表示偏移量，getSort()表示根據什麼屬性進行排序等等。

二、使用Pageable實現簡單分頁查詢

使用Pageable進行分頁查詢的方式，通常是通過數據持久化層框架的查詢函數調用。以JPA為例：

@Repository
public interface UserRepository extends JpaRepository {
    Page findAll(Pageable pageable);
}

在接口中定義的findAll()方法傳入的參數為Pageable類型，通過調用findAll()方法即可返回一個Page對象，該對象中封裝了一些分頁相關的信息，例如當前頁碼、總頁數、總記錄數、每頁顯示的記錄數等。

接下來我們可以在controller層進行調用，並處理返回值：

@RestController
public class UserController {
    @Autowired
    private UserRepository userRepository;

    @GetMapping("/users")
    public Map getUsers(@RequestParam(name = "page", defaultValue = "0") int page,
                                        @RequestParam(name = "size", defaultValue = "10") int size) {
        Pageable pageable = PageRequest.of(page, size);
        Page users = userRepository.findAll(pageable);
        Map result = new HashMap();
        result.put("users", users.getContent());
        result.put("currentPage", users.getNumber());
        result.put("totalPages", users.getTotalPages());
        result.put("totalItems", users.getTotalElements());
        return result;
    }
}

在controller層我們實例化了一個Pageable對象，並根據前端傳遞的參數進行了分頁查詢，最後將分頁查詢的結果封裝到Map中返回給前端，提供給前端使用。

三、分頁排序

在分頁的過程中，經常需要對數據進行排序，我們可以通過Pageable接口提供的getSort()方法實現分頁排序。下面的例子中，我們對username屬性進行升序排序：

Pageable pageable = PageRequest.of(page, size, Sort.by("username").ascending());

類似的，如果我們需要對多個屬性進行排序，只需要在Sort.by()方法中添加多個Sort.Order即可。例如，以下代碼將先對username字段進行升序排序，然後對age字段進行降序排序：

Pageable pageable = PageRequest.of(page, size, Sort.by("username").ascending().and(Sort.by("age").descending()));

四、自定義分頁參數

除了默認提供的分頁參數，例如每頁顯示的記錄數、當前頁碼等，我們還可以通過實現Pageable接口來實現自定義的分頁參數。例如，我們可以實現以下代碼：

public class MyPageable implements Pageable {
    private int pageNo;
    private int pageSize;
    private String orderByColumn;
    private boolean isAsc;

    public MyPageable(int pageNo, int pageSize, String orderByColumn, boolean isAsc) {
        this.pageNo = pageNo;
        this.pageSize = pageSize;
        this.orderByColumn = orderByColumn;
        this.isAsc = isAsc;
    }

    @Override
    public int getPageNumber() {
        return pageNo;
    }

    @Override
    public int getPageSize() {
        return pageSize;
    }

    @Override
    public long getOffset() {
        return (long) (pageNo - 1) * pageSize;
    }

    @Override
    public Sort getSort() {
        return isAsc ? Sort.by(orderByColumn).ascending() : Sort.by(orderByColumn).descending();
    }

    @Override
    public Pageable next() {
        return new MyPageable(pageNo + 1, pageSize, orderByColumn, isAsc);
    }

    @Override
    public Pageable previousOrFirst() {
        return pageNo  1;
    }
}

自定義的MyPageable類實現了Pageable接口，並覆蓋了其所有方法。其中，我們可以實現自定義的分頁參數，例如orderByColumn屬性表示按照哪個字段進行排序，isAsc表示是否是升序排列等。實現後，我們就可以直接使用new MyPageable()的方式來進行分頁查詢。

五、總結

總的來說，使用Pageable可以方便地實現數據的分頁查詢，減輕後端查詢處理的壓力，同時也可以帶來更好的用戶交互體驗。在使用Pageable進行分頁查詢的過程中，我們可以通過排序、自定義參數等方式來滿足不同的需求。