🚀 支持跳过分页

Author: hengboy

src/main/java/org/minbox/framework/mybatis/pageable/common/PagingStatus.java

@@ -0,0 +1,17 @@
+package org.minbox.framework.mybatis.pageable.common;
+
+/**
+ * 分页状态
+ *
+ * @author 恒宇少年
+ */
+public enum PagingStatus {
+    /**
+     * 已开启分页
+     */
+    STARTED,
+    /**
+     * 跳过本次分页
+     */
+    SKIPPING
+}

src/main/java/org/minbox/framework/mybatis/pageable/common/exception/ExceptionCode.java

@@ -11,7 +11,8 @@
 public enum ExceptionCode {
     PAGE_INDEX_FAILED("分页参数：当前页码参数传递错误，请传递大于0的正整数."),
     PAGE_SIZE_FAILED("分页参数：每页条数参数传递错误，请传递大于0的正整数."),
-    DIALECT_NOT_FOUND("数据库方言暂未支持.");
+    DIALECT_NOT_FOUND("数据库方言暂未支持."),
+    PAGE_LOCAL_NOT_FOUND("线程副本中不存在分页对象.");
     private String message;
 
     ExceptionCode(String message) {

src/main/java/org/minbox/framework/mybatis/pageable/request/PageLocal.java

@@ -0,0 +1,30 @@
+package org.minbox.framework.mybatis.pageable.request;
+
+import lombok.AccessLevel;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+import lombok.Setter;
+import org.minbox.framework.mybatis.pageable.Page;
+import org.minbox.framework.mybatis.pageable.common.PagingStatus;
+
+/**
+ * 本地分页封装对象
+ *
+ * @author 恒宇少年
+ */
+@Getter
+@NoArgsConstructor(access = AccessLevel.PRIVATE)
+public class PageLocal {
+    @Setter
+    private PagingStatus pagingStatus;
+    private Page<?> page;
+
+    private PageLocal(PagingStatus pagingStatus, Page<?> page) {
+        this.pagingStatus = pagingStatus;
+        this.page = page;
+    }
+
+    public static PageLocal instance(Page<?> page) {
+        return new PageLocal(PagingStatus.STARTED, page);
+    }
+}

src/main/java/org/minbox/framework/mybatis/pageable/request/PageLocalContext.java

@@ -1,6 +1,9 @@
 package org.minbox.framework.mybatis.pageable.request;
 
 import org.minbox.framework.mybatis.pageable.Page;
+import org.minbox.framework.mybatis.pageable.common.PagingStatus;
+import org.minbox.framework.mybatis.pageable.common.exception.ExceptionCode;
+import org.minbox.framework.mybatis.pageable.common.exception.PageableException;
 
 /**
  * {@link ThreadLocal}上下文类
@@ -10,21 +13,45 @@
  * @author 恒宇少年
  */
 public class PageLocalContext {
-    private static final ThreadLocal<Page<?>> PAGE_THREAD_LOCAL = new ThreadLocal<>();
+    private static final ThreadLocal<PageLocal> PAGE_THREAD_LOCAL = new ThreadLocal<>();
 
     public static Page<?> getPageInstance() {
-        return PAGE_THREAD_LOCAL.get();
+        PageLocal pageLocal = PAGE_THREAD_LOCAL.get();
+        if (pageLocal == null) {
+            throw new PageableException(ExceptionCode.PAGE_LOCAL_NOT_FOUND);
+        }
+        return pageLocal.getPage();
     }
 
+    /**
+     * 判定是否启动了分页
+     *
+     * @return 线程副本中存在 {@link PageLocal}对象并且是{@link PagingStatus#STARTED}状态时返回"true"
+     */
     public static boolean isStarting() {
-        return PAGE_THREAD_LOCAL.get() != null;
+        PageLocal pageLocal = PAGE_THREAD_LOCAL.get();
+        return pageLocal != null && PagingStatus.STARTED == pageLocal.getPagingStatus();
     }
 
-    public static void startPaging(Page<?> page) {
-        PAGE_THREAD_LOCAL.set(page);
+    public static void startPaging() {
+        PageLocal pageLocal = PAGE_THREAD_LOCAL.get();
+        if (!isStarting()) {
+            pageLocal.setPagingStatus(PagingStatus.STARTED);
+        }
     }
 
-    public static void stopPaging() {
+    static void startPaging(Page<?> page) {
+        if (!isStarting()) {
+            PAGE_THREAD_LOCAL.set(PageLocal.instance(page));
+        }
+    }
+
+    public static void skipPaging() {
+        PageLocal pageLocal = PAGE_THREAD_LOCAL.get();
+        pageLocal.setPagingStatus(PagingStatus.SKIPPING);
+    }
+
+    static void stopPaging() {
         PAGE_THREAD_LOCAL.remove();
     }
 }

src/main/java/org/minbox/framework/mybatis/pageable/request/PageableRequest.java

@@ -38,19 +38,15 @@ public static Pageable of(Object pageableObject) {
 
     @Override
     public <T> Page<T> request(LogicFunction function) {
-        if (PageLocalContext.isStarting()) {
-            try {
-                function.invoke();
-                return (Page<T>) PageLocalContext.getPageInstance();
-            } catch (Exception e) {
-                log.error(e.getMessage(), e);
-            } finally {
-                if (PageLocalContext.isStarting()) {
-                    PageLocalContext.stopPaging();
-                }
+        try {
+            function.invoke();
+            return (Page<T>) PageLocalContext.getPageInstance();
+        } catch (Exception e) {
+            log.error(e.getMessage(), e);
+        } finally {
+            if (PageLocalContext.isStarting()) {
+                PageLocalContext.stopPaging();
             }
-        } else {
-            log.warn("There is no page replica instance in PageLocalContext.");
         }
         return DefaultPage.instance(this);
     }