Spring Boot GraphQL中如何正确处理可选参数？

在Spring GraphQL中处理可选参数，不需要使用适用于REST接口的@RequestParam，以下是几种可行的解决方案：

1. 给@Argument设置默认值 #

直接通过@Argument的defaultValue属性指定默认值，即使参数是int类型，defaultValue也要传入字符串形式的数值，框架会自动完成类型转换。同时要确保GraphQL Schema中对应的参数标记为可选（不带!），并设置匹配的默认值。

示例代码：

@QueryMapping
public Book getBook(@Argument String id, @Argument(defaultValue = "10") int pageSize) {
    // 业务逻辑实现
}

对应的GraphQL Schema：

type Query {
    getBook(id: String!, pageSize: Int = 10): Book
}

2. 使用包装类接收可选参数 #

将基本类型（如int）替换为对应的包装类（Integer），这样当查询未传递该参数时，参数值会是null，不会触发崩溃。之后在方法内部自行处理null情况，设置业务默认值。

示例代码：

@QueryMapping
public Book getBook(@Argument String id, @Argument Integer pageSize) {
    int actualPageSize = pageSize != null ? pageSize : 10;
    // 业务逻辑实现
}

对应的GraphQL Schema：

type Query {
    getBook(id: String!, pageSize: Int): Book
}

3. 用DTO封装参数 #

如果参数数量较多，建议将所有参数封装到一个DTO类中，通过@Argument接收整个DTO对象。DTO中的可选字段可以设置默认值，或者使用包装类处理null。

示例DTO类：

public class BookQueryParams {
    private String id; // 必填字段
    private int pageSize = 10; // 可选字段，默认值10

    // getter、setter方法
}

Query方法：

@QueryMapping
public Book getBook(@Argument BookQueryParams params) {
    String bookId = params.getId();
    int pageSize = params.getPageSize();
    // 业务逻辑实现
}

对应的GraphQL Schema：

input BookQueryParams {
    id: String!
    pageSize: Int = 10
}

type Query {
    getBook(params: BookQueryParams!): Book
}

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