async-graphql/docs/zh-CN/src/apollo_federation.md

78 lines
2.1 KiB
Markdown
Raw Normal View History

2020-04-15 03:15:30 +00:00
# Apollo Federation集成
2020-04-22 02:30:21 +00:00
`Apollo Federation`是一个`GraphQL`网关它可以组合多个GraphQL服务允许每服务仅实现它负责的那一部分数据参考[官方文档](https://www.apollographql.com/docs/apollo-server/federation/introduction)。
`Async-graphql`可以完全支持`Apollo Federation`的所有功能,但需要对`Schema`定义做一些小小的改造。
- `async_graphql::Object`和`async_graphql::Interface`的`extends`属性声明这个类别是一个已有类型的扩充。
- 字段的`external`属性声明这个字段定义来自其它服务。
- 字段的`provides`属性用于要求网关提供的字段集。
2021-02-06 08:38:45 +00:00
- 字段的`requires`属性表示解析该字段值需要依赖该类型的字段集。
2020-04-22 02:30:21 +00:00
2020-06-19 05:03:17 +00:00
## 实体查找函数
2020-04-22 02:30:21 +00:00
```rust
struct Query;
#[Object]
2020-04-22 02:30:21 +00:00
impl Query {
#[entity]
async fn find_user_by_id(&self, id: ID) -> User {
2020-06-19 05:03:17 +00:00
User { ... }
2020-04-22 02:30:21 +00:00
}
2020-06-19 05:03:17 +00:00
#[entity]
2020-09-28 09:44:00 +00:00
async fn find_user_by_id_with_username(&self, #[graphql(key)] id: ID, username: String) -> User {
2020-06-19 05:03:17 +00:00
User { ... }
}
2020-04-22 02:30:21 +00:00
2020-06-19 05:03:17 +00:00
#[entity]
async fn find_user_by_id_and_username(&self, id: ID, username: String) -> User {
User { ... }
}
2020-04-22 02:30:21 +00:00
}
```
2020-06-19 05:03:17 +00:00
**注意这三个查找函数的不同他们都是查找User对象。**
- find_user_by_id
使用`id`查找`User`对象,`User`对象的key是`id`。
- find_user_by_id_with_username
使用`id`查找`User`对象,`User`对象的key是`id`,并且请求`User`对象的`username`字段值。
- find_user_by_id_and_username
使用`id`和`username`查找`User`对象,`User`对象的key是`id`和`username`。
2020-04-22 02:30:21 +00:00
2020-04-28 07:41:31 +00:00
完整的例子请参考https://github.com/async-graphql/examples/tree/master/federation
2021-02-22 01:52:41 +00:00
## 定义复合主键
一个主键可以包含多个字段,什么包含嵌套字段,你可以用`InputObject`来实现一个嵌套字段的Key类型。
下面的例子中`User`对象的主键是`key { a b }`。
```rust
#[derive(InputObject)]
struct NestedKey {
a: i32,
b: i32,
}
struct Query;
#[Object]
impl Query {
#[entity]
async fn find_user_by_key(&self, key: NestedKey) -> User {
User { ... }
}
}
```