spring-data-elasticsearch-组件查询的bug跟踪

字数统计: 750阅读时长: 3 min

 2020/04/19   Share

写在前面

最近在排查生产问题的时候发现，基于spring-data-es（版本：spring-data-elasticsearch-3.0.8.RELEASE.jar）的ElasticsearchRepository的查询有bug，如下方法：

public interface IiapImplTemplateDeviceRepository extends ElasticsearchRepository<IiapTemplateDeviceDoc, String> {
    List<IiapTemplateDeviceDoc> findByXXId(String id);

}

这个方法原本是需要返回全量数据，但是它最多只会返回了10条数据，跟踪源码最终发现了此问题。

bug定位

首先根据之前的文章spring-data-es的源码浅析分析，我们直接去该组件的RepositoryQuery的实现类去看问题ElasticsearchPartQuery。
拦截后最终执行的代码如下：

//org.springframework.data.elasticsearch.repository.query.ElasticsearchPartQuery#execute
//可以看到这里首先是针对返回的类型或参数进行判断到低属于删除还是分页查询还是列表查询等等，
//可以看到我们最终会运行到这个判断里：if (this.queryMethod.isCollectionQuery())
public Object execute(Object[] parameters) {
        ParametersParameterAccessor accessor = new ParametersParameterAccessor(this.queryMethod.getParameters(), parameters);
        CriteriaQuery query = this.createQuery(accessor);
        if (this.tree.isDelete()) {
            Object result = this.countOrGetDocumentsForDelete(query, accessor);
            this.elasticsearchOperations.delete(query, this.queryMethod.getEntityInformation().getJavaType());
            return result;
        } else if (this.queryMethod.isPageQuery()) {
            query.setPageable(accessor.getPageable());
            return this.elasticsearchOperations.queryForPage(query, this.queryMethod.getEntityInformation().getJavaType());
        } else if (this.queryMethod.isStreamQuery()) {
            Class<?> entityType = this.queryMethod.getEntityInformation().getJavaType();
            if (query.getPageable().isUnpaged()) {
                int itemCount = (int)this.elasticsearchOperations.count(query, this.queryMethod.getEntityInformation().getJavaType());
                query.setPageable(PageRequest.of(0, Math.max(1, itemCount)));
            }

            return StreamUtils.createStreamFromIterator(this.elasticsearchOperations.stream(query, entityType));
        } else if (this.queryMethod.isCollectionQuery()) {
            if (accessor.getPageable() == null) {
                int itemCount = (int)this.elasticsearchOperations.count(query, this.queryMethod.getEntityInformation().getJavaType());
                query.setPageable(PageRequest.of(0, Math.max(1, itemCount)));
            } else {
                query.setPageable(accessor.getPageable());
            }

            return this.elasticsearchOperations.queryForList(query, this.queryMethod.getEntityInformation().getJavaType());
        } else {
            return this.tree.isCountProjection() ? this.elasticsearchOperations.count(query, this.queryMethod.getEntityInformation().getJavaType()) : this.elasticsearchOperations.queryForObject(query, this.queryMethod.getEntityInformation().getJavaType());
        }
    }

看到这里又判断了一遍是否分页: accessor.getPageable() == null

//org.springframework.data.repository.query.ParametersParameterAccessor#getPageable
public Pageable getPageable() {
        if (!this.parameters.hasPageableParameter()) {
            return Pageable.unpaged();
        } else {
            Pageable pageable = (Pageable)this.values.get(this.parameters.getPageableIndex());
            return pageable == null ? Pageable.unpaged() : pageable;
        }
    }
//看到我们这个方法最终要么返回Pageable.unpaged()，要么是Pageable对象。
//org.springframework.data.domain.Pageable#unpaged
static Pageable unpaged() {
        return Unpaged.INSTANCE;
    }