联合和接口

抽象架构类型

联合体和接口是抽象GraphQL类型，允许模式字段返回多种对象类型之一。

联合体类型

当你定义一个联合体类型时，声明哪些对象类型包含在联合体中：

1
union Media = Book | Movie

一个字段可以有一个联合体（或该联合体的列表）作为其返回类型。在这种情况下，它可以返回联合体中包含的任何对象类型：

1
type Query {
2
  allMedia: [Media] # This list can include both Book and Movie objects
3
}

联合体中包含的所有类型必须是对象类型（不是标量，输入类型等）。包含的类型不需要共享任何字段。

示例

以下模式定义了一个SearchResult联合体类型，可以返回Book或Author：

1
union SearchResult = Book | Author
2

3
type Book {
4
  title: String!
5
}
6

7
type Author {
8
  name: String!
9
}
10

11
type Query {
12
  search(contains: String): [SearchResult!]
13
}

The SearchResult联合体允许Query.search返回包含Book和Author的列表。

查询联合体

GraphQL客户端不知道如果字段的返回类型是联合类型时，该字段会返回哪种对象类型。为了处理这种情况，可以查询包含多个可能类型的子字段。

以上是有效的查询：

1
query GetSearchResults {
2
  search(contains: "Shakespeare") {
3
    # Querying for __typename is almost always recommended,
4
    # but it's even more important when querying a field that
5
    # might return one of multiple types.
6
    __typename
7
    ... on Book {
8
      title
9
    }
10
    ... on Author {
11
      name
12
    }
13
  }
14
}

“__typename”字段是什么？

这个查询使用了内联片段来获取结果对象的title（如果是Book），或它的name（如果是Author）。Web 客户端可以通过传递可能的类型选项来了解这种多态关系。

以上查询的有效结果如下：

1
{
2
  "data": {
3
    "search": [
4
      {
5
        "__typename": "Book",
6
        "title": "The Complete Works of William Shakespeare"
7
      },
8
      {
9
        "__typename": "Author",
10
        "name": "William Shakespeare"
11
      }
12
    ]
13
  }
14
}

解决联合类型

在阅读本节之前，请先学习了解解器。

要完全解析一个联合类型，Apollo Server需要指定返回联合类型的哪种类型。Apollo Server。要实现这一点，您需要在Resolver映射中为联合类型定义一个__resolveType函数。

该__resolveType函数负责确定对象的对应GraphQL类型，并以字符串形式返回该类型的名称。它可以使用任何逻辑来完成此操作，例如：

检查联合类型中是否包含特定类型的唯一字段
使用instanceof，如果JavaScript对象的类型与其GraphQL对象类型相关

以下是上述SearchResult__resolveType函数的基本实现：

1
const resolvers = {
2
  SearchResult: {
3
    __resolveType(obj, contextValue, info){
4
      // Only Author has a name field
5
      if(obj.name){
6
        return 'Author';
7
      }
8
      // Only Book has a title field
9
      if(obj.title){
10
        return 'Book';
11
      }
12
      return null; // GraphQLError is thrown
13
    },
14
  },
15
  Query: {
16
    search: () => { ... }
17
  },
18
};
19

20
const server = new ApolloServer({
21
  typeDefs,
22
  resolvers,
23
});
24

25
const { url } = await startStandaloneServer(server);
26

27
console.log(`🚀  Server ready at: ${url}`);

如果__resolveType函数返回的任何值都不是有效的类型名称，则相关操作会产生GraphQL错误。

接口类型

接口指定一个多对象类型可以包含的字段集：

1
interface Book {
2
  title: String!
3
  author: Author!
4
}

如果一个对象类型实现了接口，那么它必须包含该接口的所有字段：

1
type Textbook implements Book {
2
  title: String! # Must be present
3
  author: Author! # Must be present
4
  courses: [Course!]!
5
}

一个字段可以作为接口（或该接口的列表）作为其返回类型。在这种情况下，它可以返回实现了该接口的任何对象类型：

1
type Query {
2
  books: [Book!]! # Can include Textbook objects
3
}

示例

以下模式定义了一个Book接口，以及两个实现它的对象类型：

1
interface Book {
2
  title: String!
3
  author: Author!
4
}
5

6
type Textbook implements Book {
7
  title: String!
8
  author: Author!
9
  courses: [Course!]!
10
}
11

12
type ColoringBook implements Book {
13
  title: String!
14
  author: Author!
15
  colors: [String!]!
16
}
17

18
type Query {
19
  books: [Book!]!
20
}

在这个模式中，Query.books返回一个可以包含Textbook和ColoringBook的列表。

查询接口

如果一个字段的返回类型是接口，那么客户端可以查询该接口的任何包含的字段：

1
query GetBooks {
2
  books {
3
    title
4
    author
5
  }
6
}

客户端还可以查询接口中不包含的子字段：

1
query GetBooks {
2
  books {
3
    # Querying for __typename is almost always recommended,
4
    # but it's even more important when querying a field that
5
    # might return one of multiple types.
6
    __typename
7
    title
8
    ... on Textbook {
9
      courses {
10
        # Only present in Textbook
11
        name
12
      }
13
    }
14
    ... on ColoringBook {
15
      colors # Only present in ColoringBook
16
    }
17
  }
18
}

“__typename”字段是什么？

此查询使用内联片段来获取一本 Book 的课程（如果是 Textbook）或其 colors（如果是 ColoringBook）。可以通过传递 possibleTypes 选项来告知网页客户端这种多态关系。

以上查询的有效结果如下：

1
{
2
  "data": {
3
    "books": [
4
      {
5
        "__typename": "Textbook",
6
        "title": "Wheelock's Latin",
7
        "courses": [
8
          {
9
            "name": "Latin I"
10
          }
11
        ]
12
      },
13
      {
14
        "__typename": "ColoringBook",
15
        "title": "Oops All Water",
16
        "colors": ["Blue"]
17
      }
18
    ]
19
  }
20
}

解决一个接口

在阅读本节之前，请先学习了解解器。

与联合类型一样， Apollo Server 需要接口来定义一个 __resolveType 函数以确定返回哪种实现对象类型。

以下是上面定义的 Book 接口的 __resolveType 函数的例子：

1
const resolvers = {
2
  Book: {
3
    __resolveType(book, contextValue, info){
4
      // Only Textbook has a courses field
5
      if(book.courses){
6
        return 'Textbook';
7
      }
8
      // Only ColoringBook has a colors field
9
      if(book.colors){
10
        return 'ColoringBook';
11
      }
12
      return null; // GraphQLError is thrown
13
    },
14
  },
15
  Query: {
16
    books: () => { ... }
17
  },
18
};

Schema基础知识

自定义标量