GraphQL-Spring Boot查询传递可选参数时类型转换异常问题

问题分析 #

出现typeMismatch.optionalInt异常的核心原因是：Spring GraphQL的参数绑定器默认没有为OptionalInt/Optional<Integer>这类基本类型的Optional包装类型提供适配转换器，当传递具体数值参数时，无法完成从GraphQL的Int类型到Java的Optional包装类型的转换，从而抛出绑定错误。

解决方案 #

方案1：直接使用Integer类型替代Optional包装类 #

这是最稳妥且简洁的方案，利用GraphQL可选参数未传递时为null的特性，直接用Integer接收参数，逻辑保持不变：

@QueryMapping
public List<Customer> getCustomers (@Argument Integer start,
                                    @Argument Integer end
                                    ) {
    List<Customer> customers = customerRepository.findAll();
    if (start != null && end != null) {
        try {
            return customers.subList(start, end);
        } catch (IndexOutOfBoundsException e) {
            return new LinkedList<>();
        }
    }

    return customers;
}

方案2：显式声明参数非必填并使用Optional（可选） #

如果坚持使用Optional容器，需要为@Argument添加required = false注解，明确告知参数是可选的，确保Spring GraphQL正确绑定：

@QueryMapping
public List<Customer> getCustomers (@Argument(required = false) Optional<Integer> start,
                                    @Argument(required = false) Optional<Integer> end
                                    ) {
    List<Customer> customers = customerRepository.findAll();
    if (start.isPresent() && end.isPresent()) {
        try {
            return customers.subList(start.get(), end.get());
        } catch (IndexOutOfBoundsException e) {
            return new LinkedList<>();
        }
    }

    return customers;
}

说明 #

• 方案1无需额外配置，完全适配Spring GraphQL的参数绑定逻辑，同时兼容无参调用和带参调用场景。
• 方案2需要注意Spring GraphQL版本兼容性，部分旧版本可能需要显式指定required=false才能正确识别可选参数。

内容的提问来源于stack exchange，提问作者Héctor Iglesias