如何在Spring Boot REST接口中用GraphQL过滤响应字段？

当然可以实现，你不用局限于单独的GraphQL端点，完全可以在原有REST接口的基础上集成GraphQL的字段过滤能力，下面是具体实现步骤：

1. 引入GraphQL依赖 #

在pom.xml中添加Spring Boot GraphQL Starter依赖：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-graphql</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

2. 定义GraphQL Schema #

在src/main/resources/graphql/schema.graphqls中定义数据类型和查询规则：

type ProductOwner {
    ownerName: String
    # 其他不需要暴露的字段可以不在这里定义
}

type Product {
    productId: String
    productOwner: ProductOwner
    # 其他产品字段按需添加或隐藏
}

type Query {
    getProductDetails: [Product]
    getSingleProduct(productId: String): Product
}

这里只定义你需要对外暴露的字段，GraphQL会自动忽略未定义的字段。

3. 实现GraphQL查询解析器 #

编写一个Resolver类，对接原有业务逻辑获取完整数据：

@Component
public class ProductQueryResolver implements GraphQLQueryResolver {
    // 假设这是你原有获取产品数据的服务
    private final ProductService productService;

    public ProductQueryResolver(ProductService productService) {
        this.productService = productService;
    }

    public List<Product> getProductDetails() {
        return productService.getAllProducts();
    }

    public Product getSingleProduct(String productId) {
        return productService.getProductById(productId);
    }
}

这里的Product实体可以保留所有字段，GraphQL会根据Schema自动过滤。

4. 修改/新增REST接口，集成GraphQL执行逻辑 #

创建一个REST Controller，接收前端的查询语句，调用GraphQL执行器返回过滤后的结果：

@RestController
@RequestMapping("/api")
public class ProductRestController {
    private final GraphQL graphQL;

    public ProductRestController(GraphQL graphQL) {
        this.graphQL = graphQL;
    }

    @PostMapping("/getProductDetails")
    public Map<String, Object> getFilteredProducts(@RequestBody String query) {
        ExecutionResult executionResult = graphQL.execute(query);
        return executionResult.getData();
    }
}

5. 前端请求示例 #

前端可以通过POST请求，传入GraphQL查询语句来指定需要的字段：

{
    "query": "{ getProductDetails { productId productOwner { ownerName } } }"
}

接口会返回只包含productId和productOwner.ownerName的JSON结果。

如果是查询单个产品，请求语句可以是：

{
    "query": "{ getSingleProduct(productId: \"P001\") { productId productOwner { ownerName } } }"
}

这种方式既保留了REST接口的形式，又利用了GraphQL灵活的字段过滤能力，完美匹配你的需求。

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