GraphQL JAVA - Schema

最新推荐文章于 2024-09-24 07:15:00 发布

彭英峻

最新推荐文章于 2024-09-24 07:15:00 发布

阅读量675

点赞数

分类专栏： GraphQL 文章标签： java graphql 开发语言

本文链接：https://blog.csdn.net/pengdeman/article/details/124780606

版权

本文详细介绍了如何使用GraphQL Java构建Schema，包括通过SDL和编程方式创建，讲解了DataFetcher和TypeResolver的角色，以及Schema中的Scalar、Object、Interface、Union、Enum等类型。此外，还讨论了Schema的模块化和订阅支持。

摘要由CSDN通过智能技术生成

Schema

创建一个schema

GraphQL API具有一个Schema，该Schema定义了可以Query（查询）或Mutation（变更）的每个字段以及这些字段的类型。

graphql-java提供了两种不同的定义schema的方式：编程方式编写，和使用graphql dsl语法（也称为SDL）编写。

例如：

SDL示例：

    type Foo {
        bar: String
    }

Java代码示例：

    GraphQLObjectType fooType = newObject()
        .name("Foo")
        .field(newFieldDefinition()
                .name("bar")
                .type(GraphQLString))
        .build();

DataFetcher和TypeResolver

DataFetcher用于获取字段（field）对应的数据。另外，如果是Mutation（变更）类型，则可用于更新数据。

GraphQL中的每个字段（Field Definition）都有一个DataFetcher。如果未指定DataFetcher，则该字段启用默认的PropertyDataFetcher。

PropertyDataFetcher从Map和Java Bean中获取数据。当字段名称与Map中的key或bean对象的属性相同时，无需显式指定DataFetcher。

TypeResolver（类型解析器）用于帮助graphql-java判断数据的实际类型。例如对于Interface和Union类型，TypeResolver用于确定最终获取到的对象属于Interface（接口）的哪个实现，或Union（联合）中的哪种具体类型。

例如，假定你有一个Interface类型叫做MagicUserType，有一系列实现该接口的具体类型：Wizard、Witch和Necomancer。TypeResolver（类型解析器）用于在运行时识别出数据的具体类型（Type），进而决定调用哪个DataFetcher和字段。

        new TypeResolver() {
            @Override
            public GraphQLObjectType getType(TypeResolutionEnvironment env) {
                Object javaObject = env.getObject();
                if (javaObject instanceof Wizard) {
                    return env.getSchema().getObjectType("WizardType");
                } else if (javaObject instanceof Witch) {
                    return env.getSchema().getObjectType("WitchType");
                } else {
                    return env.getSchema().getObjectType("NecromancerType");
                }
            }
        };

使用SDL创建一个schema

通过SDL定义模式时，需提供DataFetcher和TypeResolver。

例如，对于如下的schema定义：(starWarsSchema.graphqls)

    schema {
        query: QueryType
    }

    type QueryType {
        hero(episode: Episode): Character
        human(id : String) : Human
        droid(id: ID!): Droid
    }


    enum Episode {
        NEWHOPE
        EMPIRE
        JEDI
    }

    interface Character {
        id: ID!
        name: String!
        friends: [Character]
        appearsIn: [Episode]!
    }

    type Human implements Character {
        id: ID!
        name: String!
        friends: [Character]
        appearsIn: [Episode]!
        homePlanet: String
    }

    type Droid implements Character {
        id: ID!
        name: String!
        friends: [Character]
        appearsIn: [Episode]!
        primaryFunction: String
    }

这个schema定义包含了字段（field）和类型（type）定义，但是仍需要一个“运行时绑定”（runtime wiring）ÿ