如何在Spring Data Neo4j中使用列表参数进行查询

问题根源分析 #

1. 自定义Cypher查询存在参数名不匹配：方法参数是merchantIds，但Cypher语句里写的是$merchantId，少了后缀s，导致参数无法正确绑定。
2. HTTP请求中列表参数的传递格式不符合Spring MVC默认解析规则，Swagger UI默认的参数输入方式可能不符合要求。

具体修复步骤 #

1. 修正自定义Cypher查询的参数绑定

调整Cypher语句的参数名，并显式用@Param注解绑定，避免编译时参数名丢失：

@Query("MATCH (m: Merchant) WHERE m.id IN $merchantIds RETURN m")
List<Merchant> customQuery(@Param("merchantIds") List<String> merchantIds);

2. 规范自动生成端点的参数传递格式

Spring Data REST对findByIdIn这类方法，默认要求用重复参数名传递列表，比如：

GET /merchants/search/findByIdIn?ids=90c55d4b-b3dc-4ae3-ab43-4d6ff523a20b&ids=另一个UUID值

在Swagger UI中，需要多次添加ids参数并填入不同UUID，而非逗号分隔的单个字符串。如果想支持逗号分隔格式，可添加Spring MVC配置：

@Configuration
public class WebConfig implements WebMvcConfigurer {
    @Override
    public void addFormatters(FormatterRegistry registry) {
        registry.addConverter(String.class, List.class, source -> 
            Arrays.asList(source.split(","))
        );
    }
}

配置后即可用GET /merchants/search/findByIdIn?ids=UUID1,UUID2的方式传递参数。

3. 自定义Controller控制参数解析（可选）

如果自动生成的端点参数绑定问题无法解决，可自定义Controller接管请求：

@RestController
@RequestMapping("/merchants")
public class MerchantController {
    private final MerchantRepository merchantRepository;

    public MerchantController(MerchantRepository merchantRepository) {
        this.merchantRepository = merchantRepository;
    }

    @GetMapping("/batch")
    public List<Merchant> getMerchantsByIds(@RequestParam("ids") List<String> ids) {
        return merchantRepository.findByIdIn(ids);
    }
}

通过自定义Controller可完全掌控参数解析逻辑，避免自动生成端点的潜在问题。

验证流程 #

1. 先测试修正后的自定义查询，用程序化调用确认结果正常。
2. 在Swagger UI中按重复参数名或逗号分隔格式传递列表参数，测试自动生成端点和自定义Controller端点。

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