SubQuery GraphQL订阅优化：减少实时区块链数据传输量- 惊觉

SubQuery GraphQL订阅优化：减少实时区块链数据传输量

【免费下载链接】subql SubQuery is an Open, Flexible, Fast and Universal data indexing framework for web3. Our mission is to help developers create the decentralised products of the future. 项目地址: https://gitcode.com/gh_mirrors/su/subql

在Web3开发中，实时获取区块链数据是许多DApp的核心需求。然而，未经优化的GraphQL订阅可能导致大量冗余数据传输，增加带宽消耗并影响应用性能。本文将介绍SubQuery项目中GraphQL订阅的优化方案，帮助开发者减少实时数据传输量，提升应用响应速度。

订阅服务的基本架构

SubQuery的GraphQL订阅功能主要由GraphqlModule模块实现，该模块位于packages/query/src/graphql/graphql.module.ts。它负责创建Apollo服务器实例，并配置WebSocket服务以支持实时数据推送。

订阅服务的核心组件包括：

Apollo Server：处理GraphQL请求和订阅
WebSocket服务器：建立持久连接，推送实时更新
PostgreSQL订阅插件：监听数据库变化并生成订阅事件

订阅工作流程

客户端通过WebSocket建立与服务器的连接
服务器监听PostgreSQL数据库的变化
当数据发生变化时，通过订阅推送给客户端

以下是创建WebSocket服务器的关键代码：

if (argv.subscription) {
  const wsServer = new WebSocketServer({
    server: httpServer,
    path: WS_ROUTE,
  });
  this.wsCleanup = useServer({schema, context: {pgClient: this.pgPool}}, wsServer);
}

数据传输优化策略

SubQuery采用了多种策略来减少订阅数据传输量，主要包括：

1. 精准的事件过滤机制

PgSubscriptionPlugin插件实现了基于ID和操作类型的过滤功能，确保只推送客户端关心的数据变化。该插件代码位于packages/query/src/graphql/plugins/PgSubscriptionPlugin.ts。

const filter = (event, args) => {
  if (args.mutation && !args.mutation.includes(event.mutation_type)) {
    return false;
  }
  if (args.id && !args.id.includes(event.id)) {
    return false;
  }
  return true;
};

通过这种过滤机制，客户端可以只订阅特定ID的实体变化或特定类型的操作（INSERT、UPDATE、DELETE），避免接收无关数据。

2. 按需返回实体数据

在订阅响应中，SubQuery只返回变化的实体数据，而不是整个数据集。这通过_entity字段的解析器实现：

_entity: {
  resolve: async ({_block_height, _entity}, args, context, resolveInfo) => {
    const [row] = await resolveInfo.graphile.selectGraphQLResultFromTable(
      sql.identifier(table.namespace.name, table.name),
      (tableAlias, queryBuilder) => {
        // 构建查询条件
        queryBuilder.where(sql.fragment`${tableAlias}.id = ${sql.value(_entity.id)}`);
        queryBuilder.limit(1);
      }
    );
    return row;
  },
}

3. 配置化的订阅启用

订阅功能在默认情况下是关闭的，开发者可以通过命令行参数按需启用：

subscription: {
  demandOption: false,
  describe: 'Enable subscription service',
  type: 'boolean',
  default: false,
}

这种设计避免了不必要的资源消耗，只有在确实需要实时数据时才启用订阅服务。

实际应用示例

基本订阅查询

以下是一个典型的SubQuery订阅查询示例，只订阅特定ID的实体更新：

subscription {
  transfers(id: ["0x123..."]) {
    id
    mutation_type
    _entity {
      id
      from
      to
      value
    }
  }
}

按操作类型过滤

只订阅INSERT操作：

subscription {
  transfers(mutation: [INSERT]) {
    id
    mutation_type
    _entity {
      id
      from
      to
      value
    }
  }
}

性能调优参数

SubQuery提供了多个配置参数来优化订阅性能，位于packages/query/src/yargs.ts：

参数	描述	默认值
`--query-complexity`	设置查询复杂度限制	未设置
`--query-depth-limit`	设置查询深度限制	未设置
`--query-alias-limit`	设置查询别名限制	未设置
`--sl-keep-alive-interval`	设置连接保持活跃的时间间隔(毫秒)	180000

合理设置这些参数可以有效防止恶意查询和过度订阅导致的性能问题。

监控与调试

为了帮助开发者监控和调试订阅性能，SubQuery提供了查询分析插件：

if (argv['query-explain']) {
  apolloServerPlugins.push(queryExplainPlugin(getLogger('explain')));
}

启用此插件后，可以记录和分析订阅查询的执行情况，找出性能瓶颈。

总结

SubQuery通过精准过滤、按需数据返回和灵活配置等方式，有效减少了GraphQL订阅的数据传输量。这些优化措施不仅提升了应用性能，还降低了带宽消耗，为Web3开发者提供了高效、经济的实时数据解决方案。

随着区块链技术的发展，实时数据处理将变得越来越重要。SubQuery将继续优化订阅功能，为开发者提供更好的工具和体验。如果你想了解更多细节，可以查阅以下资源：

官方文档：README.md
订阅插件源码：packages/query/src/graphql/plugins/PgSubscriptionPlugin.ts
配置选项：packages/query/src/yargs.ts

通过合理利用这些优化技术和工具，你可以构建出更高效、更可靠的Web3应用，为用户提供流畅的实时数据体验。

转载自 CSDN-专业IT技术社区

原文链接：https://blog.csdn.net/gitblog_00346/article/details/152774947

SubQuery GraphQL订阅优化：减少实时区块链数据传输量