async-graphql/docs/zh-CN/src/apollo_federation.md
2021-02-22 09:52:41 +08:00

2.1 KiB
Raw Blame History

Apollo Federation集成

Apollo Federation是一个GraphQL网关它可以组合多个GraphQL服务允许每服务仅实现它负责的那一部分数据参考官方文档

Async-graphql可以完全支持Apollo Federation的所有功能,但需要对Schema定义做一些小小的改造。

  • async_graphql::Objectasync_graphql::Interfaceextends属性声明这个类别是一个已有类型的扩充。

  • 字段的external属性声明这个字段定义来自其它服务。

  • 字段的provides属性用于要求网关提供的字段集。

  • 字段的requires属性表示解析该字段值需要依赖该类型的字段集。

实体查找函数

struct Query;

#[Object]
impl Query {
    #[entity]
    async fn find_user_by_id(&self, id: ID) -> User {
        User { ... }
    }

    #[entity]
    async fn find_user_by_id_with_username(&self, #[graphql(key)] id: ID, username: String) -> User {
        User { ... }
    }

    #[entity]
    async fn find_user_by_id_and_username(&self, id: ID, username: String) -> User {
        User { ... }
    }
}

注意这三个查找函数的不同他们都是查找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

    使用idusername查找User对象,User对象的key是idusername

完整的例子请参考https://github.com/async-graphql/examples/tree/master/federation

定义复合主键

一个主键可以包含多个字段,什么包含嵌套字段,你可以用InputObject来实现一个嵌套字段的Key类型。

下面的例子中User对象的主键是key { a b }

#[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 { ... }
  }
}