跳到主要内容

订阅(subscription)

快速浏览订阅示例

安装​

添加依赖

repositories {
    mavenCentral()
    jcenter()
}

dependencies {
    implementation 'org.graphoenix:graphoenix-rabbitmq:0.1.3'

    // ...
}

Altair​

使用 Altair GraphQL Client 进行订阅测试 Altair

配置​

  1. 打开 Request Handlers Request Handlers

  2. 配置订阅地址, 选择订阅类型为 SSE Settings

基本订阅​

订阅接口​

接口名类型参数说明示例 (Type=User)
(type)(Type)(Type)SubscriptionArguments订阅单条user
(type)List[(Type)](Type)ListSubscriptionArguments订阅列表userList
(type)Connection[(Type)](Type)ConnectionSubscriptionArguments订阅分页userConnection

订阅与变更​

变更请求会把变更内容发送到消息队列(MQ)中, 订阅会根据类型和字段订阅 MQ 中对应的频道, 在匹配到符合条件的变更内容后通过 SSE 推送新的数据

使用与字段同名的参数构造查询条件, opr 作为查询符号, val 作为查询内容, 如果查询内容为数组则使用 arr

例: 订阅所有类型是 VIP 的用户

subscription {
  userList(userType: { val: VIP }) {
    name
    email
    userType
  }
}
{
  "data": {
    "userList": [
      {
        "name": "Alice",
        "email": "alice@example.com",
        "userType": "VIP"
      },
      {
        "name": "Charlie",
        "email": "charlie@example.com",
        "userType": "VIP"
      },
      {
        "name": "Edward",
        "email": "edward@example.com",
        "userType": "VIP"
      },
      {
        "name": "George",
        "email": "george@example.com",
        "userType": "VIP"
      },
      {
        "name": "Ian",
        "email": "ian@example.com",
        "userType": "VIP"
      },
      {
        "name": "Kyle",
        "email": "kyle@example.com",
        "userType": "VIP"
      },
      {
        "name": "Mike",
        "email": "mike@example.com",
        "userType": "VIP"
      },
      {
        "name": "Oliver",
        "email": "oliver@example.com",
        "userType": "VIP"
      },
      {
        "name": "Quentin",
        "email": "quentin@example.com",
        "userType": "VIP"
      },
      {
        "name": "Steve",
        "email": "steve@example.com",
        "userType": "VIP"
      }
    ]
  }
}

通过变更新增 VIP 用户 Uma

mutation {
  user(
    name: "Uma"
    email: "uma@example.com"
    userType: VIP
    phoneNumbers: ["13918124629", "18536492446"]
  ) {
    id
    name
    email
    phoneNumbers
    userType
  }
}

订阅收到新的推送数据

{
  "data": {
    "userList": [
      {
        "name": "Alice",
        "email": "alice@example.com",
        "userType": "VIP"
      },
      {
        "name": "Charlie",
        "email": "charlie@example.com",
        "userType": "VIP"
      },
      {
        "name": "Edward",
        "email": "edward@example.com",
        "userType": "VIP"
      },
      {
        "name": "George",
        "email": "george@example.com",
        "userType": "VIP"
      },
      {
        "name": "Ian",
        "email": "ian@example.com",
        "userType": "VIP"
      },
      {
        "name": "Kyle",
        "email": "kyle@example.com",
        "userType": "VIP"
      },
      {
        "name": "Mike",
        "email": "mike@example.com",
        "userType": "VIP"
      },
      {
        "name": "Oliver",
        "email": "oliver@example.com",
        "userType": "VIP"
      },
      {
        "name": "Quentin",
        "email": "quentin@example.com",
        "userType": "VIP"
      },
      {
        "name": "Steve",
        "email": "steve@example.com",
        "userType": "VIP"
      },
      {
        "name": "Uma",
        "email": "uma@example.com",
        "userType": "VIP"
      }
    ]
  }
}

订阅参数​

参数名类型默认值说明SQL 示例 (x=10 y=5)
(field)(Scalar/Enum/Object)Expression无条件字段SELECT id FROM t WHERE t.field = 'xyz'
firstInt无获取前 x 条SELECT id FROM t LIMIT 10
lastInt无获取后 x 条SELECT id FROM t ORDER BY id DESC LIMIT 10
offsetInt无跳过 y 条SELECT id FROM t LIMIT 5, 10
condConditionalAND参数内条件的组合关系WHERE t.field = 'xyz' AND t.field <> 'abc'
notBooleanfalse条件取非WHERE NOT (t.field = 'xyz' AND t.field <> 'abc')
exs[(Object)Expression]无同一字段多次作为查询条件时可使用此参数WHERE ( t.field = 'xyz' AND t.field <> 'abc' )
orderBy[(Object)OrderBy]无排序字段SELECT id FROM t ORDER BY t.field
groupBy[String]无分组字段SELECT id FROM t GROUP BY t.field