如何检测/建议Spring Data（JPA）存储库？

Question

我为spring数据jpa存储库提供建议的努力失败了。目标是（围绕）使用自定义注释（本例中的ResourceNotFound）注释的特定存储库中的所有非void公共方法，并在返回值为null或空集合时引发异常。

@Repository 
@ResourceNotFound
@Transactional(readOnly = true)
public interface CityRepository extends JpaRepository<City, Long>, JpaSpecificationExecutor<City> { … }

下面的建议是连接使用@ResourceNotFound注释的接口实现的所有公共方法。

@Pointcut("within(com.digitalmisfits.spring.aop.annotation.ResourceNotFound *)")
public void beanAnnotatedWithResourceNotFound() {}

@Pointcut("execution(public * *(..))")
public void publicMethod() {}

@Around("beanAnnotatedWithResourceNotFound() && publicMethod()")
public Object publicMethodInsideAClassMarkedWithResourceNotFound(ProceedingJoinPoint pjp) throws Throwable {

    System.out.println("publicMethodInsideAClassMarkedWithResourceNotFound " + pjp.getTarget().toString());;

    Object retVal =  pjp.proceed();

    if(((MethodSignature) pjp.getSignature()).getReturnType() != Void.TYPE && isObjectEmpty(retVal))
        throw new RuntimeException("isObjectEmpty == true");

    return retVal;
}

当切入点指定为以下内容时，publicMethodInsideAClassMarkedWithResourceNotFound（…）方法有效：

@Pointcut("execution(public * package.CityRepository+.*(..))")

但是，未提取ResourceNotFound注释。这可能是因为存储库接口的底层类是一个（代理的）SimpleJPrepository，它没有特定的注释。

有没有一种方法可以将@ResourceNotes传播到实现中？

--更新--

更改了问题以反映这样一个事实，即建议（around）只应适用于具有自定义注释的存储库。

Answer 1

我能够使用以下构造解决我的问题（基本上检查接口链并搜索特定注释）：

@Pointcut("execution(public !void org.springframework.data.repository.Repository+.*(..))")
public void publicNonVoidRepositoryMethod() {}

@Around("publicNonVoidRepositoryMethod()")
public Object publicNonVoidRepositoryMethod(ProceedingJoinPoint pjp) throws Throwable {

    Object retVal =  pjp.proceed();

    boolean hasClassAnnotation = false;
    for(Class<?> i: pjp.getTarget().getClass().getInterfaces()) {
        if(i.getAnnotation(ThrowResourceNotFound.class) != null) {
            hasClassAnnotation = true;
            break;
        }
    }

    if(hasClassAnnotation && isObjectEmpty(retVal))
        throw new RuntimeException(messageSource.getMessage("exception.resourceNotFound", new Object[]{}, LocaleContextHolder.getLocale()));

    return retVal;
}

Answer 2

尽管OP严重依赖于AeyJ解决方案，但目前的问题并不直接表明解决方案应该仅限于AeyJ。因此，我想提供一种非AeyJ的方法来建议Spring Data JPA存储库。它基于将自定义Interceptor添加到准系统Spring AOP代理拦截器链中。

首先，配置您的自定义RepositoryFactoryBean，例如。

@Configuration
@EnableJpaRepositories(repositoryFactoryBeanClass = CustomRepositoryFactoryBean.class)
public class ConfigJpaRepositories {
}

接下来，实现CustomRepositoryFactoryBean以将您自己的RepositoryProxyPostProcess添加到JpaRepositoryFactory

class CustomRepositoryFactoryBean<R extends JpaRepository<T, I>, T , I extends Serializable> extends JpaRepositoryFactoryBean<R, T, I> {

  protected RepositoryFactorySupport createRepositoryFactory(EntityManager em) {
    RepositoryFactorySupport factory = super.createRepositoryFactory(em);
    factory.addRepositoryProxyPostProcessor(new ResourceNotFoundProxyPostProcessor());
    return factory;
  }

}

您的存储库ProxyPostProcessor实现应该将您的方法拦截器添加到特定存储库的代理工厂（检查存储库信息）：

class ResourceNotFoundProxyPostProcessor implements RepositoryProxyPostProcessor {

    @Override
    public void postProcess(ProxyFactory factory, RepositoryInformation repositoryInformation) {
        if (repositoryInformation.getRepositoryInterface().equals(CityRepository.class))
            factory.addAdvice(new ResourceNotFoundMethodInterceptor());
    }

}

在你的方法拦截器（顺便说一句，它是org.aopalliance.aop.Advice的子接口，所以仍然是一个建议：）中，你拥有AspectJ关于建议的全部功能：

class ResourceNotFoundMethodInterceptor implements MethodInterceptor {

    @Override
    public Object invoke(MethodInvocation invocation) throws Throwable {
        Method method = invocation.getMethod();
        ResourceNotFound resourceNotFound = method.getAnnotation(ResourceNotFound.class);
        //...
        Object result = invocation.proceed();
        //...
        return result;
    }
}   

Answer 3

如果您想在存储库级别拦截存储库调用，您实际上不需要为此引入自定义注释。您应该能够使用普通类型匹配来实现这一点：

 @Pointcut("execution(public !void org.springframework.data.repository.Repository+.*(..))")

这将拦截所有扩展Spring数据存储库接口的Spring bean的所有非void方法的执行。

在Spring数据示例库中可以找到一个稍微相关的示例。