# @grest-ts/discovery 中文文档

规范地址：https://npmcn.com/package/%40grest-ts/discovery/

版本：0\.0\.101
npm 元数据更新时间：2026-11-02T15:34:29.281Z
中文译文更新时间：2026-11-17T06:45:49.839Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40grest-ts/discovery
原文对照：https://npmcn.com/package/%40grest-ts/discovery/?lang=original
项目主页：https://grest-ts.com/packages/discovery
源码仓库：https://github.com/grest-ts/grest-ts

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

- 包体积（解压后）：14.9 kB，20 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=24
- 运行依赖：0 个
- peer 依赖：@grest-ts/locator 0\.0\.101
- 首次发布：2026-02-24T10:54:21.146Z
- 最新版本发布：2026-11-02T15:34:29.115Z
- 近 30 天下载量：5518（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：84（近 12 个月 84 个）

## 中文简介

Grest框架服务发现实施

## 安装

```sh
npm install @grest-ts/discovery
```

也可以使用：`pnpm add @grest-ts/discovery`、`yarn add @grest-ts/discovery`、`bun add @grest-ts/discovery`

## README

> 部分 [灰尘](https://github.com/grest-ts/grest-ts) 框架. [文档](https://github.com/grest-ts/grest-ts#readme) | [所有软件包](https://github.com/grest-ts/grest-ts#package-reference)

# @ grest-ts/ 发现

在grest-ts中发现服务的基础软件包. 提供所有发现执行所依赖的抽象类,类型和定位键.

关于发现如何发挥作用和现有执行情况的全面概述,请参见: [发现指南](https://npmcn.com/package/%40grest-ts/discovery/@guide/discovery)。 。 。 .

## 出口

### `GGDiscoveryClient` (摘要类)

基础类 所有发现的实现 延伸:

```typescript
abstract class GGDiscoveryClient {
    readonly isLocal: boolean = false;

    abstract registerRoutes(registrations: GGServiceRegistration[]): void;
    abstract register(): Promise<void>;
    abstract unregister(): Promise<void>;
    abstract discoverApi(apiName: string): Promise<string>;
}
```

| 方法 | 目的 |
| --- | --- |
| `registerRoutes()` | 当 HTTP 服务器启动时调用 。 告诉人们该提供什么API. |
| `register()` | 用发现后端注册服务. |
| `unregister()` | 清理关闭. |
| `discoverApi()` | 返回给定的 API 名称的完整 URL 。 这就是客户的称呼. |

这个 `isLocal` 旗帜表示本地开发模式。 何时 `true`,云资源(AWS SNS等)应取而代之地使用本地适配器.

### `GG_DISCOVERY` (定位键)

```typescript
const GG_DISCOVERY = new GGLocatorKey<GGDiscoveryClient>("GGDiscovery");
```

用于注册和访问活动发现客户端的服务定位键.

### `GGServiceRegistration` (互动)

```typescript
interface GGServiceRegistration {
    runtime: string;       // Service name
    api: string;           // API name, e.g. "UserApi"
    protocol: "http" | "ws";
    port: number;
    pathPrefix: string;    // e.g. "/api/users/"
}
```

## 执行情况

| 软件包 | 使用大小写 |
| --- | --- |
| [`@grest-ts/discovery-static`](https://npmcn.com/package/%40grest-ts/discovery/@pkg/discovery-static) | 已知URL的生产部署 |
| [`@grest-ts/discovery-local`](https://npmcn.com/package/%40grest-ts/discovery/@pkg/discovery-local) | 地方发展和测试 |
| [`@grest-ts/discovery-kubernetes`](https://npmcn.com/package/%40grest-ts/discovery/@pkg/discovery-kubernetes) | 库伯内特部署 |
| [`@grest-ts/discovery-migration`](https://npmcn.com/package/%40grest-ts/discovery/@pkg/discovery-migration) | 战略之间的零下行迁移 |

为了本地开发,路由器也可以单独推出 `npx @grest-ts/discovery-local --port 9000` ——运行时间然后连接为平面 `GGLocalDiscoveryClient`s 而不是默认的领袖选中 `GGLocalDiscoveryResilientClient`。 。 。 .

## 常见问题

### @grest-ts/discovery 是什么？

Grest框架服务发现实施

### 如何安装 @grest-ts/discovery？

在项目目录运行 npm install @grest-ts/discovery，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@grest-ts/locator（0\.0\.101）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @grest-ts/discovery 支持 TypeScript 吗？

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

### @grest-ts/discovery 支持 ESM 还是 CommonJS？

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

### @grest-ts/discovery 需要什么版本的 Node\.js？

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

### @grest-ts/discovery 可以商用吗？

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

### @grest-ts/discovery 的下载量有多少？

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

### @grest-ts/discovery 还在维护吗？

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

