如何使用模式语言创建泛型?
How to create generics with the schema language?
使用 facebook 的参考库,我找到了一种破解泛型类型的方法,如下所示:
type PagedResource<Query, Item> = (pagedQuery: PagedQuery<Query>) => PagedResponse<Item>
interface PagedQuery<Query> {
query: Query;
take: number;
skip: number;
}
interface PagedResponse<Item> {
items: Array<Item>;
total: number;
}
function pagedResource({type, resolve, args}) {
return {
type: pagedType(type),
args: Object.assign(args, {
page: { type: new GraphQLNonNull(pageQueryType()) }
}),
resolve
};
function pageQueryType() {
return new GraphQLInputObjectType({
name: 'PageQuery',
fields: {
skip: { type: new GraphQLNonNull(GraphQLInt) },
take: { type: new GraphQLNonNull(GraphQLInt) }
}
});
}
function pagedType(type) {
return new GraphQLObjectType({
name: 'Paged' + type.toString(),
fields: {
items: { type: new GraphQLNonNull(new GraphQLList(type)) },
total: { type: new GraphQLNonNull(GraphQLInt) }
}
});
}
}
但我喜欢使用 Apollo Server 以声明方式创建模式的方式。所以问题是,你们如何使用模式语言创建类似泛型的类型?
您可以创建接口或联合来实现类似的结果。我认为 this article 很好地解释了如何正确实现接口和联合。您的架构看起来像这样:
type Query {
pagedQuery(page: PageInput!): PagedResult
}
input PageInput {
skip: Int!
take: Int!
}
type PagedResult {
items: [Pageable!]!
total: Int
}
# Regular type definitions for Bar, Foo, Baz types...
union Pageable = Bar | Foo | Baz
您还需要为联合定义一个 resolveType 方法。使用 graphql-tools
,这是通过解析器完成的:
const resolvers = {
Query: { ... },
Pageable {
__resolveType: (obj) => {
// resolve logic here, needs to return a string specifying type
// i.e. if (obj.__typename == 'Foo') return 'Foo'
}
}
}
__resolveType
将要解析的业务对象作为其第一个参数(通常是您让 GraphQL 解析的原始数据库结果)。您需要在此处应用一些逻辑来找出我们正在处理的所有不同的 Pageable 类型。对于大多数 ORM,您只需将某种 typename
字段添加到您正在使用的模型实例中,并且只需 resolveType
return 即可。
编辑: 正如您所指出的,这种方法的缺点是项目中的 returned 类型不再对客户端透明 - 客户端必须知道正在 returned 的类型,并在 ... on Foo
等内联片段中指定 items
的字段。当然,您的客户仍然需要了解 returned 的类型,否则他们将不知道要请求哪些字段。
我想以声明方式生成模式时,不可能按照您想要的方式创建泛型。要使您的模式按照当前的方式工作,您必须硬着头皮在定义 Foo
时定义 PagedFoo
,在定义 Bar
时定义 PagedBar
等等。
我能想到的唯一其他选择是结合这两种方法。以编程方式创建 "base" 模式。您只需要使用 pagedResource
函数在根查询下定义分页查询。然后,您可以使用 graphql/utilities
中的 printSchema
将其转换为可以与其余类型定义连接的字符串。在您的类型定义中,您可以使用 extend
关键字来构建已在基本架构中声明的任何类型,如下所示:
extend Query {
nonPaginatedQuery: Result
}
如果你走这条路,你可以跳过将 resolve
函数传递给 pagedResource
,或者在你的程序定义类型上定义任何解析器,而只使用你通常传递给的解析器对象buildExecutableSchema
.
使用 facebook 的参考库,我找到了一种破解泛型类型的方法,如下所示:
type PagedResource<Query, Item> = (pagedQuery: PagedQuery<Query>) => PagedResponse<Item>
interface PagedQuery<Query> {
query: Query;
take: number;
skip: number;
}
interface PagedResponse<Item> {
items: Array<Item>;
total: number;
}
function pagedResource({type, resolve, args}) {
return {
type: pagedType(type),
args: Object.assign(args, {
page: { type: new GraphQLNonNull(pageQueryType()) }
}),
resolve
};
function pageQueryType() {
return new GraphQLInputObjectType({
name: 'PageQuery',
fields: {
skip: { type: new GraphQLNonNull(GraphQLInt) },
take: { type: new GraphQLNonNull(GraphQLInt) }
}
});
}
function pagedType(type) {
return new GraphQLObjectType({
name: 'Paged' + type.toString(),
fields: {
items: { type: new GraphQLNonNull(new GraphQLList(type)) },
total: { type: new GraphQLNonNull(GraphQLInt) }
}
});
}
}
但我喜欢使用 Apollo Server 以声明方式创建模式的方式。所以问题是,你们如何使用模式语言创建类似泛型的类型?
您可以创建接口或联合来实现类似的结果。我认为 this article 很好地解释了如何正确实现接口和联合。您的架构看起来像这样:
type Query {
pagedQuery(page: PageInput!): PagedResult
}
input PageInput {
skip: Int!
take: Int!
}
type PagedResult {
items: [Pageable!]!
total: Int
}
# Regular type definitions for Bar, Foo, Baz types...
union Pageable = Bar | Foo | Baz
您还需要为联合定义一个 resolveType 方法。使用 graphql-tools
,这是通过解析器完成的:
const resolvers = {
Query: { ... },
Pageable {
__resolveType: (obj) => {
// resolve logic here, needs to return a string specifying type
// i.e. if (obj.__typename == 'Foo') return 'Foo'
}
}
}
__resolveType
将要解析的业务对象作为其第一个参数(通常是您让 GraphQL 解析的原始数据库结果)。您需要在此处应用一些逻辑来找出我们正在处理的所有不同的 Pageable 类型。对于大多数 ORM,您只需将某种 typename
字段添加到您正在使用的模型实例中,并且只需 resolveType
return 即可。
编辑: 正如您所指出的,这种方法的缺点是项目中的 returned 类型不再对客户端透明 - 客户端必须知道正在 returned 的类型,并在 ... on Foo
等内联片段中指定 items
的字段。当然,您的客户仍然需要了解 returned 的类型,否则他们将不知道要请求哪些字段。
我想以声明方式生成模式时,不可能按照您想要的方式创建泛型。要使您的模式按照当前的方式工作,您必须硬着头皮在定义 Foo
时定义 PagedFoo
,在定义 Bar
时定义 PagedBar
等等。
我能想到的唯一其他选择是结合这两种方法。以编程方式创建 "base" 模式。您只需要使用 pagedResource
函数在根查询下定义分页查询。然后,您可以使用 graphql/utilities
中的 printSchema
将其转换为可以与其余类型定义连接的字符串。在您的类型定义中,您可以使用 extend
关键字来构建已在基本架构中声明的任何类型,如下所示:
extend Query {
nonPaginatedQuery: Result
}
如果你走这条路,你可以跳过将 resolve
函数传递给 pagedResource
,或者在你的程序定义类型上定义任何解析器,而只使用你通常传递给的解析器对象buildExecutableSchema
.