如何在GraphQL SPQR中使用@GraphQLInterface？配置问题排查

核心问题排查 #

你遇到的问题主要源于类型引用错误、枚举实现的注解缺失、SPQR未正确识别接口实现类，以及响应DTO字段未被GraphQL暴露这几点。

具体修复步骤 #

1. 修正类型引用 #

首先修正ResponseDto中的泛型类型，你代码中写的List<IValidation>与实际接口ValidationError不匹配，会导致SPQR无法识别接口类型，修正后代码如下：

public class ResponseDto {
    private List<ValidationError> validations;

    // 显式添加Getter并标注@GraphQLQuery，确保字段被GraphQL暴露
    @GraphQLQuery(name = "validations")
    public List<ValidationError> getValidations() {
        return validations;
    }
}

2. 枚举实现类显式标注查询方法 #

枚举作为接口实现时，Lombok自动生成的getMessage()方法无法被SPQR自动识别为GraphQL字段，需要显式重写并添加@GraphQLQuery注解：

@GraphQLType(name = "SimpleError")
@AllArgsConstructor
public enum SimpleError implements ValidationError {
    ERROR("some msg");

    private String message;

    @Override
    @GraphQLQuery(name = "message")
    public String getMessage() {
        return message;
    }
}

3. 手动注册接口与实现类 #

虽然接口添加了implementationAutoDiscovery = true，但旧版本SPQR的自动发现存在兼容问题，建议在配置类中手动关联接口与实现类：

@Configuration
public class GraphQLConfig {

    @Bean
    public GraphQLSchema graphQLSchema(GraphQLSchemaGenerator generator) {
        generator.withInterface(ValidationError.class)
                 .withImplementations(SimpleError.class);
        return generator.generate();
    }
}

4. 配置包扫描路径 #

确保SPQR的自动扫描路径包含你的模型类所在包，可在application.properties中添加配置：

graphql.spqr.base-packages=com.your.model.package

版本兼容性提示 #

你使用的graphql-spqr-spring-boot-starter 0.0.4版本较旧，存在接口处理的兼容性问题，建议升级到1.0.0+版本，能更好地支持接口自动发现与枚举实现。

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