如何通过Netflix DGS获取完整的运行时GraphQLSchema对象？

获取完整GraphQLSchema对象 #

在Netflix DGS中，可通过注入DgsSchemaProvider直接获取当前的GraphQLSchema实例，无需依赖请求处理流程：

@Component
public class SchemaManager {
    private final DgsSchemaProvider schemaProvider;

    public SchemaManager(DgsSchemaProvider schemaProvider) {
        this.schemaProvider = schemaProvider;
    }

    // 获取当前完整的GraphQLSchema
    public GraphQLSchema getFullSchema() {
        return schemaProvider.schema();
    }
}

生成完整SDL（区别于联邦_service { sdl }） #

使用graphql-java的SchemaPrinter自定义打印配置，确保输出包含所有类型、指令、内省类型等完整内容：

public String generateFullSDL() {
    GraphQLSchema schema = getFullSchema();
    SchemaPrinter printer = new SchemaPrinter(SchemaPrinter.Options.defaultOptions()
            .includeDirectives(true)
            .includeExtendedScalarTypes(true)
            .includeIntrospectionTypes(true)
            .includeSchemaDefinition(true));
    return printer.print(schema);
}

收集基于指令的元数据 #

遍历Schema中的类型、字段，提取指令信息（解决客户端无法自省指令的问题）：

public Map<String, List<Directive>> collectDirectiveMetadata() {
    GraphQLSchema schema = getFullSchema();
    Map<String, List<Directive>> directiveMap = new HashMap<>();

    // 遍历所有类型
    schema.getAllTypesAsList().forEach(type -> {
        if (type instanceof GraphQLObjectType objectType) {
            // 收集类型级指令
            List<Directive> typeDirectives = objectType.getDirectives();
            if (!typeDirectives.isEmpty()) {
                directiveMap.put("Type:" + objectType.getName(), typeDirectives);
            }
            // 收集字段级指令
            objectType.getFields().forEach(field -> {
                List<Directive> fieldDirectives = field.getDirectives();
                if (!fieldDirectives.isEmpty()) {
                    directiveMap.put("Field:" + objectType.getName() + "." + field.getName(), fieldDirectives);
                }
            });
        }
    });

    return directiveMap;
}

支持运行时Schema变更/重载 #

通过自定义DgsSchemaProvider实现可重载的Schema管理：

1. 实现DgsSchemaProvider接口，维护一个volatile的Schema实例确保线程安全
2. 提供重载方法，从外部源（如配置中心、数据库）重新构建Schema

@Component
public class ReloadableSchemaProvider implements DgsSchemaProvider {
    private volatile GraphQLSchema currentSchema;

    public ReloadableSchemaProvider() {
        // 初始化加载Schema
        refreshSchema();
    }

    @Override
    public GraphQLSchema schema() {
        return currentSchema;
    }

    // 运行时重载Schema的方法
    public void refreshSchema() {
        // 这里实现Schema重新构建逻辑：
        // 比如读取新的SDL文件、从配置中心获取Schema内容，结合DGS的代码注册表构建Schema
        GraphQLSchema newSchema = buildSchemaFromSource();
        this.currentSchema = newSchema;
    }

    private GraphQLSchema buildSchemaFromSource() {
        // 自定义Schema构建逻辑，示例：
        String sdl = fetchLatestSDLFromConfig();
        TypeDefinitionRegistry typeRegistry = new SchemaParser().parse(sdl);
        RuntimeWiring runtimeWiring = RuntimeWiring.newRuntimeWiring()
                // 添加数据加载器、类型 resolver 等配置
                .build();
        return new SchemaGenerator().makeExecutableSchema(typeRegistry, runtimeWiring);
    }
}

注意：如果是联邦架构，DgsSchemaProvider默认返回的是合并后的完整联邦Schema，无需额外处理。

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