Spring项目中为JPA Repository创建自定义查询的最佳实践是什么

结论 #

方案1完全符合Spring项目编码规范，远优于方案2，同时你还可以对方案1做进一步优化，获得更好的性能和可维护性。

两种方案的对比 #

1. 方案2的问题

• 违反单一职责原则：Controller层的核心职责是处理HTTP请求逻辑，包括参数校验、请求映射、响应封装，不应该耦合数据查询逻辑。如果后续其他业务也需要按ref查询Circuit实体，你需要重复编写查询代码，维护成本大幅提升。
• 单元测试复杂度更高：你需要额外构造findAll()的返回数据才能完成Controller接口测试，测试代码冗余度高。

2. 方案1的优势

• 符合分层设计规范：所有数据查询逻辑收敛到Repository层，代码复用性高，后续修改查询逻辑只需要调整Repository层代码即可。
• 单元测试更便捷：你可以直接Mock findCircuitByRef方法的返回值，不需要关注内部查询实现，Controller层的测试只需要关注HTTP逻辑本身。

更优的实现方案 #

你当前方案1的default方法是查询全表后用Stream过滤，数据量较大时性能很差，Spring Data JPA本身支持根据方法名自动生成SQL查询，你不需要手写查询逻辑，直接在CircuitRepository接口中添加方法定义即可：

@Repository
public interface CircuitRepository extends JpaRepository<Circuit, Long>  {
    // Spring Data JPA会自动生成按circuit_ref字段查询的SQL
    Optional<Circuit> findByCircuitRef(String ref);
}

对应的Controller代码可以简化为：

@GetMapping("/api/circuits/")
public EntityModel<Circuit> getCircuitByRef(@RequestParam(value="ref") String ref) {
    Circuit circuit = circuitRepository.findByCircuitRef(ref)
            .orElseThrow(() -> new CircuitNotFoundException(ref));
    return circuitModelAssembler.toModel(circuit);
}

这种实现是Spring Data JPA的标准最佳实践，兼顾了规范、性能和可维护性。

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