Spring Data Jpa 让@Query复杂查询分页支持实体返回

背景

  Spring Data Jpa 虽然可以减少代码中Sql的数量，但其在复杂查询中略显乏力。网上很多文章都采用Java代码的形式去实现复杂查询，但这样一来Sql的效率变得不可控。也有文章采用@Query 注解去执行JPQL原生SQL,本人在使用过程中也倾向于这种方式。
  但有时采用@Query方式，框架无法正常返回我们需要的类型。比如复杂查询后后分页，Repository方法的返回写的是Page，然而真正执行后返回的类型却变成了Page。究竟原因，分析源码后发现PagedExecution并未对执行结果进行处理。

通过对Spring-Data-Jpa源码的分析，发现在RepositoryFactorySupport.java中的getRepository方法（第124行），提供了钩子方法使得我们可以在自己的RepositoryProxyPostProcessor中向目标Repository注入MethodInterceptor（方法拦截器）。

    public  T getRepository(Class repositoryInterface, Object customImplementation) {
        ...
        Object target = this.getTargetRepository(information);
        ProxyFactory result = new ProxyFactory();
        result.setTarget(target);
        result.setInterfaces(new Class[]{repositoryInterface, Repository.class});
        ...
        Iterator var8 = this.postProcessors.iterator();
        while(var8.hasNext()) {
            RepositoryProxyPostProcessor processor = (RepositoryProxyPostProcessor)var8.next();
            processor.postProcess(result, information);
        }
        ...
        result.addAdvice(new RepositoryFactorySupport.QueryExecutorMethodInterceptor(information, customImplementation, target));
        return result.getProxy(this.classLoader);
    }

本文将介绍通过自定义RepositoryProxyPostProcessor向Repository（我们应用中声明的Repository）中注入自定义MethodInterceptor以使得@Qurey复杂查询能支持分页POJO的返回。

1.编写业务Repository，并继承JpaRepository

继承JpaRepository使得返回结果支持分页

@Repository
public interface UserRepository extends JpaRepository {
    /**
     * 返回指定部门下边的用户
     *
     * @param officeId
     * @param pageable
     * @return
     */
    @Query(value = "SELECT user.id, user.name FROM User user, Office office WHERE user.officeId = office.id AND office.id = ?1 ")
    Page getUserInOffice(String officeId, Pageable pageable);
}

上边的查询还是比较简单的，这只是为了作为例子好理解。如果需要你可以将Sql改得更加复杂。注意，我采用的是JPQL而非Native Sql。启动单元测试调用上述方法，结果的确返回了Page对象，但是当你page.getContent()时，会发现返回的结果为List。
接下来进入主题

2.自定义MethodInterceptor，将content由List转为List

继承MethodInterceptor，重写invoke方法执行其他代理获得Jpql返回结果集后，将List转为List。

public class JpqlBeanMethodInterceptor implements MethodInterceptor {

    /**
    * 用于存放QueryMethod对应的字段和返回类型信息
    */
    private Map selectAlias = new HashMap<>();

    public JpqlBeanMethodInterceptor(RepositoryInformation repositoryInformation) {
        Iterator iterable = repositoryInformation.getQueryMethods().iterator();
        SqlParser sqlParser = new DefaultSqlParser();
        while (iterable.hasNext()) {
            Method method = iterable.next();
            Query query = method.getAnnotation(Query.class);
            if (query == null || query.nativeQuery()) {
                continue;
            }
            //获取返回类型
            Class clazz = getGenericReturnClass(method);
            if (clazz == null) {
                continue;
            }
            SelectAlias alias = sqlParser.getAlias(query.value(), clazz);
            if (alias == null) {
                continue;
            }
            selectAlias.put(method, alias);
        }
    }

    @Override
    public Object invoke(MethodInvocation invocation) throws Throwable {
        //执行方法获得结果
        Object obj = invocation.proceed();
        if (!checkCanConvert(obj)) {
            return obj;
        }
        SelectAlias alias = selectAlias.get(invocation.getMethod());
        if (alias == null) {
            return obj;
        }
        List content = getPageContent((PageImpl) obj);
        convert(content, alias);
        return obj;
    }
    //由于篇幅原因只贴出部分代码
    ...
}

上述代码由于篇幅原因只贴出部分，后续整理完代码后将共享出来。代码中sqlParser采用jsqlparser从Sql中取出返回的字段解析后转换为SelectAlia。注意这部分代码是在构造方法中执行的，后续代码决定了这部分代码只会在Spring Boot启动的时候每个Repository执行一次，以提高执行效率。

3.自定义RepositoryProxyPostProcessor

在postProcess时向Repository注入JpqlBeanMethodInterceptor

public class JpqlBeanPostProcessor implements RepositoryProxyPostProcessor {

    @Override
    public void postProcess(ProxyFactory factory, RepositoryInformation repositoryInformation) {
        factory.addAdvice(new JpqlBeanMethodInterceptor(repositoryInformation));
    }

}

4.自定义JpaRepositoryFactoryBean

创建RepositoryFactory时，向其加入我们自定义的RepositoryProxyPostProcessor

public class GmRepositoryFactoryBean, S, ID extends Serializable>
        extends JpaRepositoryFactoryBean {

    public GmRepositoryFactoryBean(Class repositoryInterface) {
        super(repositoryInterface);
    }

    @Override
    protected RepositoryFactorySupport createRepositoryFactory(EntityManager entityManager) {
        JpaRepositoryFactory jpaRepositoryFactory = new JpaRepositoryFactory(entityManager);
        jpaRepositoryFactory.addRepositoryProxyPostProcessor(new JpqlBeanPostProcessor());
        return jpaRepositoryFactory;
    }
}

这一步大家应该很熟悉了，写过公用Repository的朋友应该都知道其作用。不过注意一下，我们在返回JpaRepositoryFactory前，要将我们的RepositoryProxyPostProcessor 加进postProcessors中，不然前边就白做了。

5.让我们的JpaRepositoryFactoryBean起作用

这一步大家应该也比较熟悉了，直接上代码。

@Configuration
@EnableJpaRepositories(repositoryFactoryBeanClass = GmRepositoryFactoryBean.class)
@EnableSpringDataWebSupport
public class JpaDataConfig {

}

注意要放到项目目录下或者在Application把这个文件的包加到BasePackages中，反正就是要让Spring Boot启动的时候扫的到就对啦。

最后

再次启动单元测试，重新执行getUserInOffice方法，可以看到返回的Page中的content已经正常返回User的List了，大功告成！经测试，其执行速度与原先的返回Object[]基本保持一致，有时甚至更快。这个我也不知道为什么会更快，可能与网络因素有关吧，毕竟我在测试的时候数据库不在本地。。。