SQL多出limit ?导致报错

PgageHelper使用不当导致sql报错

1、发现接口调用异常

org.springframework.jdbc.BadSqlGrammarException: 
 select * from table where xx
 order by cl.plan_live_time asc         limit 20 LIMIT ?

发现出现了limit 语法错误 limit 20 LIMIT ?

2、排查 业务sql

 select * from table where xx
        order by cl.plan_live_time asc
        limit 20

查看业务sql没有问题，也不会存在拼接问题，怀疑组件帮忙做了添加limit ?这件事

3、发现 PageHelper使用不当会造成该问题

  PageHelper.startPage(pageInfoVO.getPage(), pageInfoVO.getPageSize());

底层会调用下面的方法：

public static <E> Page<E> startPage(int pageNum, int pageSize, boolean count, Boolean reasonable, Boolean pageSizeZero) {
        Page<E> page = new Page(pageNum, pageSize, count);
        page.setReasonable(reasonable);
        page.setPageSizeZero(pageSizeZero);
        Page<E> oldPage = getLocalPage();
        if (oldPage != null && oldPage.isOrderByOnly()) {
            page.setOrderBy(oldPage.getOrderBy());
        }

        setLocalPage(page);
        return page;
    }

调用setLocalPage(page);

public abstract class PageMethod {
    protected static final ThreadLocal<Page> LOCAL_PAGE = new ThreadLocal();
    protected static boolean DEFAULT_COUNT = true;

    public PageMethod() {
    }

    protected static void setLocalPage(Page page) {
        LOCAL_PAGE.set(page);
    }

    public static <T> Page<T> getLocalPage() {
        return (Page)LOCAL_PAGE.get();
    }

    public static void clearPage() {
        LOCAL_PAGE.remove();
    }

Springboot 中interceptor会拦截PageHelper做sql增强处理，如果PageHelper中含有Page分页参数，则会添加limit ?
1、setLocalPage后，变量和线程进行绑定，在上下文中环境中都可能存在PageHelper中设置的Page分页参数，后面的sql可能会添加limit ?。
2、ThreadLocal 中的ThreadLocalMap中的key是弱引用，发生GC时会被回收。如果其他请求分配到了此线程时未发生gc，则新请求也会出现此问题。

4、解决方式

在需要执行分页查询的sql前，开启PageHelper分页，执行完后清空PageHelper.clearPage()就是删除之之前在ThreadLocalMap中的Page

 PageHelper.startPage(pageDTO.getPage(), pageDTO.getPageSize());
 //分页sql代码
   ......
 //清理PageHelper可能自动添加limit导致分页bug
 PageHelper.clearPage();