Spring Data基于抽象类实现自定义仓库过滤功能报错排查

错误原因 #

Spring Data JPA在解析Repository接口方法时，会将filter方法误认为是基于实体属性的查询方法，试图在Event实体中查找对应的filter属性，因此抛出PropertyReferenceException。

正确实现方案（复用通用逻辑） #

遵循Spring Data JPA的自定义Repository实现规范，通过抽象类复用通用过滤逻辑：

1. 定义通用过滤接口 #

创建独立的自定义接口，存放过滤方法：

public interface CustomRepositoryFilter<T, F> {
    List<T> filter(F filter);
}

2. 实现通用抽象类 #

编写包含通用过滤逻辑的抽象类，子类只需指定实体类型：

import jakarta.persistence.EntityManager;
import jakarta.persistence.criteria.CriteriaBuilder;
import jakarta.persistence.criteria.CriteriaQuery;
import jakarta.persistence.criteria.Root;
import org.springframework.beans.factory.annotation.Autowired;
import java.lang.reflect.Field;
import java.util.List;

public abstract class AbstractRepositoryFilterImpl<T, F> implements CustomRepositoryFilter<T, F> {

    @Autowired
    protected EntityManager entityManager;

    @Override
    public List<T> filter(F filter) {
        // 通用过滤逻辑：使用CriteriaBuilder动态构建查询
        CriteriaBuilder cb = entityManager.getCriteriaBuilder();
        CriteriaQuery<T> query = cb.createQuery(getEntityClass());
        Root<T> root = query.from(getEntityClass());

        // 示例：反射遍历Filter对象的非空属性，添加等值查询条件
        Field[] fields = filter.getClass().getDeclaredFields();
        for (Field field : fields) {
            field.setAccessible(true);
            try {
                Object value = field.get(filter);
                if (value != null) {
                    query.where(cb.equal(root.get(field.getName()), value));
                }
            } catch (IllegalAccessException e) {
                throw new RuntimeException("构建过滤条件失败", e);
            }
        }

        return entityManager.createQuery(query).getResultList();
    }

    // 抽象方法：由子类返回对应实体的Class对象
    protected abstract Class<T> getEntityClass();
}

3. 编写实体专属实现类 #

针对Event实体，继承抽象类并指定实体类型：

public class EventRepositoryFilterImpl extends AbstractRepositoryFilterImpl<Event, EventFilter> {

    @Override
    protected Class<Event> getEntityClass() {
        return Event.class;
    }
}

4. 定义主Repository接口 #

让EventRepository继承CrudRepository和自定义的过滤接口：

import org.springframework.data.repository.CrudRepository;

public interface EventRepository extends CrudRepository<Event, Long>, CustomRepositoryFilter<Event, EventFilter> {
}

5. 确保Spring扫描到实现类 #

• 把实现类EventRepositoryFilterImpl放在和EventRepository相同的包下，Spring会自动扫描识别；
• 如果包结构不同，可通过@EnableJpaRepositories的repositoryImplementationPostfix属性指定实现类后缀（默认是Impl），示例：

@SpringBootApplication
@EnableJpaRepositories(basePackages = "com.yourpackage.repository", repositoryImplementationPostfix = "FilterImpl")
public class YourApplication {
    public static void main(String[] args) {
        SpringApplication.run(YourApplication.class, args);
    }
}

核心原理 #

Spring Data JPA会识别Repository接口继承的自定义接口，并自动寻找命名符合规范（接口名+Impl，或指定后缀）的实现类，将自定义方法的执行逻辑委托给该实现类，而不是试图解析为实体属性查询。

内容的提问来源于stack exchange，提问作者Svetlana