# @apollo/utils\.usagereporting 中文文档

规范地址：https://npmcn.com/package/%40apollo/utils.usagereporting/

版本：3\.2\.0
npm 元数据更新时间：2026-11-06T08:46:51.492Z
中文译文更新时间：2026-11-06T10:54:05.274Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40apollo/utils.usagereporting
原文对照：https://npmcn.com/package/%40apollo/utils.usagereporting/?lang=original
项目主页：https://github.com/apollographql/apollo-utils#readme
源码仓库：https://github.com/apollographql/apollo-utils

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：26.5 kB，22 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=16
- 运行依赖：6 个
- peer 依赖：graphql 14\.x \|\| 15\.x \|\| 16\.x \|\| 17\.x
- 首次发布：2022-05-19T17:54:32.198Z
- 最新版本发布：2026-11-06T08:46:51.180Z
- 近 30 天下载量：14369980（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：8（近 12 个月 1 个）

## 中文简介

生成阿波罗用户报告签名

## 安装

```sh
npm install @apollo/utils.usagereporting
```

也可以使用：`pnpm add @apollo/utils.usagereporting`、`yarn add @apollo/utils.usagereporting`、`bun add @apollo/utils.usagereporting`

## README

# 报表

此软件包导出与签名计算和引用字段计算相关的有用的使用报告位数 .

## `usageReportingSignature`

在阿波罗工作室中,我们想要将相同的查询请求组合在一起,并明确处理不同的查询。 但两个查询"相同"是什么意思?. 如果你不想把查询的全文发送到阿波罗的服务器上, 要么是因为它包含敏感数据, 要么是因为它包含不相干操作或碎片?

为了解决这些问题,阿波罗工作室和相关组件都有"签名"的概念. 我们不(默认情况下)将查询的全部查询串发送到阿波罗的服务器上. 相反,每个跟踪都有其查询字符串的"签名".

这个 `usageReportingSignature` 函数是下列变换的组合:

-   `dropUnusedDefinitions`:去除不会用于执行的操作和碎片
-   `stripSensitiveLiterals`: 将所有数字和字符串字元以及列表和对象输入值替换为“空”值
-   `removeAliases`: 从操作中删除字段别名
-   `sortAST`: 将大多数多子女节点的儿童进行连续排序
-   `printWithReducedWhitespace`,在图克-js上的一个变体 `print` 清除不需要的空白区域

## `calculateReferencedFieldsByType`

鉴于a `DocumentNode` (业务)和a `GraphQLSchema`, (中文(简体) ), `calculateReferencedFieldsByType` 构造一个记录 `typeName -> { fieldNames: string[], isInterface: boolean }`。本记录 _实值_ 按操作签名键向阿波罗工作室发送的字段使用数据(`usageReportingSignature`) (中文(简体) ).

## 常见问题

### @apollo/utils\.usagereporting 是什么？

生成阿波罗用户报告签名

### 如何安装 @apollo/utils\.usagereporting？

在项目目录运行 npm install @apollo/utils\.usagereporting，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：graphql（14\.x \|\| 15\.x \|\| 16\.x \|\| 17\.x）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @apollo/utils\.usagereporting 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @apollo/utils\.usagereporting 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @apollo/utils\.usagereporting 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=16。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @apollo/utils\.usagereporting 可以商用吗？

@apollo/utils\.usagereporting 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @apollo/utils\.usagereporting 的下载量有多少？

根据 npm 官方下载统计，@apollo/utils\.usagereporting 在 2026/10/07 – 2026/11/05 这 30 天内被下载 14,369,980 次，日均约 478,999 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @apollo/utils\.usagereporting 还在维护吗？

最新版本 3\.2\.0 发布于 2026/11/06（今天）；至今共发布 8 个版本，其中过去 12 个月发布了 1 个；首次发布于 2022/05/20。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。