# @defra-fish/sqs-receiver-service 中文文档

规范地址：https://npmcn.com/package/%40defra-fish/sqs-receiver-service/

版本：1\.77\.1
npm 元数据更新时间：2026-11-12T12:00:38.358Z
中文译文更新时间：2026-11-12T12:31:25.307Z
软件包许可：SEE LICENSE IN LICENSE

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

原始 npm 页面：https://www.npmjs.com/package/%40defra-fish/sqs-receiver-service
原文对照：https://npmcn.com/package/%40defra-fish/sqs-receiver-service/?lang=original
项目主页：https://github.com/DEFRA/rod-licensing#readme
源码仓库：https://github.com/DEFRA/rod-licensing

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

- 包体积（解压后）：42.2 kB，18 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=22
- 运行依赖：5 个
- 首次发布：2020-03-24T08:35:19.989Z
- 最新版本发布：2026-11-12T12:00:37.875Z
- 近 30 天下载量：3118（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：1045（近 12 个月 138 个）

## 中文简介

SQS 接收服务

## 安装

```sh
npm install @defra-fish/sqs-receiver-service
```

也可以使用：`pnpm add @defra-fish/sqs-receiver-service`、`yarn add @defra-fish/sqs-receiver-service`、`bun add @defra-fish/sqs-receiver-service`

## README

# 接收服务

此服务被配置为对一组 SQS 队列进行投票, 并在收到队列中的消息后通知订阅服务 .

如果用户的响应成功, 消息将从队列中删除 。 如果不在可见度超时后,消息会再次被可见,并可能根据SQS再驱动策略进行再处理.

# 环境变量

| 名称 | 说明 | 所需经费 | 默认 | 无效 | 说明 |
| --- | --- | :-: | --- | --- | --- |
| 诺德-ENV | 节点环境 | 没有 |  | 开发, fsh-{env} |  |
| 区域 | 要使用的 AWS 区域 | 对 |  | 见 [AWS 地区](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints) |  |
| AWS SQS ENDPOINT (英语) | 自定义 SQS 端点 | 没有 | 具体区域 |  | 用于覆盖本地开发的 SQS 服务端点 |
| (原始内容存档于2013-10-12). RECEIVER PREFIX | 读取接收实例特有的环境变量的前缀 | 对 |  |  | 通过环境获取更多设置所使用的前缀(见下文) |
| <RECEIVER PREFIX> URL> (英语) | SQS 队列 URL | 对 |  |  |  |
| {\\FN黑体\\FS22\\BORD1\\SHAD0\\3AHBE\\4AH00\\FSCX67\\FSCY66\\2CHFFFFFF\\3CH808080}你应该知道 | 长选票时屏蔽消息的时间 | 没有 | 20000 (20秒钟) |  |  |
| <RECEIVER PREFIX> VISILITY TIMEOUT MS> (英语) | 信息被其他进程所忽略的时间长度 | 对 |  |  |  |
| {\\FN华文楷体\\FS16\\1CHE0E0E0}请检查DATE=中的日期值 (帮助) | 等待后续读取请求的最大时间 | 没有 | 300 000 (5分钟) |  | 将每个请求改为不返回信件,在读取前计算出一个指数延迟。 这限制了这种拖延. |
| {\\FN黑体\\FS22\\BORD1\\SHAD0\\3AHBE\\4AH00\\FSCX67\\FSCY66\\2CHFFFFFF\\3CH808080}你应该知道 {\\FN黑体\\FS22\\BORD1\\SHAD0\\3AHBE\\4AH00\\FSCX67\\FSCY66\\2CHFFFFFF\\3CH808080} | 在规定延迟前收到无信息请求的数目 | 没有 | 10个 |  | 接收信件请求时, 即使有信件等待, 也不会返回信件 。 在拖延之前先允许这些请求. |
| {\\FN黑体\\FS22\\BORD1\\SHAD0\\3AHBE\\4AH00\\FSCX67\\FSCY66\\2CHFFFFFF\\3CH808080}我从头开始 | 订阅者的位置 . | 对 |  |  |  |
| (原始内容存档于2018-09-25) (英语). RECEIVER PREFI SUBSCRIBER TIMEOUT MS | 读取接收实例特有的环境变量的前缀 | 没有 | 180 000(3米) |  |  |
| 吉布提 | 启用调试输出 | 没有 |  | sqs: \*, sqs: receivers, sqs: read-queue, sqs: process-message, sqs:delete-message, sqs: sqs: queue-stats (中文(简体) ) | 启用给定类别的调试输出, 接受通配符 |
| 空难 | 空气刹主机的 URL | 没有 |  |  |  |
| (原始内容存档于2013-10-12) (英语). AIRBRAKE PROJECT KEY | 空中刹车记录的项目密钥 | 没有 |  |  |  |

## 通过 pm2 控制

`pm2 [start|restart|stop|delete] ecosystem.config.js`

这个 `ecosystem.config.js` 文件包含要运行的接收服务集。 示例条目如下:

```apps:
   - script: ./index.js
     name: 'Sales Queue'
     env:
       RECEIVER_PREFIX: SALES_QUEUE
     output: ./logs/sales-queue.out
     error: ./logs/sales-queue.err
     autorestart: false
```

## 调试

服务使用调试包参见 DEBUG 环境变量引导

## 失败

当遇到一般错误读取 SQS 队列时, 如 ECONNREFUSED , 服务会提前失败

如果所有读取 SQS 队列的 http 出错, 服务会继续日志错误 . 见: [https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/CommonErrors.html 互联网档案馆的存檔,存档日期2013-12-20](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/CommonErrors.html)

如果用户进程队列中遇到所有错误, 服务会继续日志错误

只有在订阅者返回 http 成功状态时, 信件才会从 SQS 队列中删除

## 发展环境可建立如下:

```
AWS_REGION=eu-west-2
AWS_ACCESS_KEY_ID=local
AWS_SECRET_ACCESS_KEY=local
AWS_SQS_ENDPOINT=http://0.0.0.0:9324

DEBUG=sqs:*

TRANSACTION_QUEUE_URL=http://0.0.0.0:9324/queue/TransactionsQueue.fifo
TRANSACTION_QUEUE_MAX_POLLING_INTERVAL_MS=30000
TRANSACTION_QUEUE_VISIBILITY_TIMEOUT_MS=300000
TRANSACTION_QUEUE_SUBSCRIBER=http://0.0.0.0:4000/process-queue/transactions

TRANSACTION_DLQ_URL=http://0.0.0.0:9324/queue/TransactionsDlq.fifo
TRANSACTION_DLQ_MAX_POLLING_INTERVAL_MS=180000
TRANSACTION_DLQ_VISIBILITY_TIMEOUT_MS=300000
TRANSACTION_DLQ_SUBSCRIBER=http://0.0.0.0:4000/process-dlq/transactions
```

## 常见问题

### @defra-fish/sqs-receiver-service 是什么？

SQS 接收服务

### 如何安装 @defra-fish/sqs-receiver-service？

在项目目录运行 npm install @defra-fish/sqs-receiver-service，或使用 pnpm add / yarn add / bun add。

### @defra-fish/sqs-receiver-service 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/defra-fish\_\_sqs-receiver-service 是否存在。

### @defra-fish/sqs-receiver-service 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @defra-fish/sqs-receiver-service 需要什么版本的 Node\.js？

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

### @defra-fish/sqs-receiver-service 可以商用吗？

@defra-fish/sqs-receiver-service 使用 SEE LICENSE IN LICENSE 许可。许可条款写在包内的独立文件中，请阅读该文件确认可否商用。以上为概括，不构成法律意见，请以许可原文为准。

### @defra-fish/sqs-receiver-service 的下载量有多少？

根据 npm 官方下载统计，@defra-fish/sqs-receiver-service 在 2026/10/12 – 2026/11/10 这 30 天内被下载 3,118 次，日均约 104 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @defra-fish/sqs-receiver-service 还在维护吗？

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