# @arrirpc/codegen-dart 中文文档

规范地址：https://npmcn.com/package/%40arrirpc/codegen-dart/

版本：0\.85\.0
npm 元数据更新时间：2026-10-03T04:03:55.999Z
中文译文更新时间：2026-11-06T20:22:09.841Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40arrirpc/codegen-dart
原文对照：https://npmcn.com/package/%40arrirpc/codegen-dart/?lang=original
项目主页：https://github.com/modiimedia/arri#readme
源码仓库：https://github.com/modiimedia/arri

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

- 包体积（解压后）：88.3 kB，8 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：2 个
- 首次发布：2024-05-14T04:35:24.187Z
- 最新版本发布：2026-10-03T04:03:55.801Z
- 近 30 天下载量：4603（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：91（近 12 个月 11 个）

## 中文简介



## 安装

```sh
npm install @arrirpc/codegen-dart
```

也可以使用：`pnpm add @arrirpc/codegen-dart`、`yarn add @arrirpc/codegen-dart`、`bun add @arrirpc/codegen-dart`

## README

# 阿里·达特代码gen

## 设置

### 1) 将生成器添加到您的 arri 配置

```ts
// arri.config.ts
import { defineConfig, generators } from 'arri';

export default defineConfig({
    generators: [
        generators.dartClient({
            clientName: 'MyClient',
            outputFile: './client/src/my_client.g.dart',
        }),
    ],
});
```

**选项 :**

| 名称 | 说明 |
| --- | --- |
| 输出文件( 需要) | 由生成器创建的文件路径 |
| 客户端Name | 生成客户端类的名称( 默认为“ 客户端 ” ) |
| 格式 | 运行 `dart format` 在生成的文件( 默认为 `true`(中文(简体) ) |
| 类型 前缀 | 在生成的类名中添加前缀 |
| 根服务 | 生成客户端的根服务 |

### 2) 安装 Dart 客户端库

生成的代码依赖于 Dart [客户端](https://npmcn.com/languages/dart/dart-client/README.md) 图书馆。 所以在使用生成的代码时一定要安装它。 版本号应该与您的 Arri CLI 版本相匹配 。 (运行) `arri version` 检查).

```bash
dart pub add arri_client
```

## 使用生成代码

### 初始化客户端

```dart
// this will match whatever you put in the arri config
import "./my_client.g.dart";

main() async {
    final client = MyClient(
        baseUrl: "https://example.com",
        headers: () async {
            return {
                "Authorization": "<some-token>",
            };
        },
    );
    await client.myProcedure();
}
```

Root客户端将是一个包含单一类中所有服务和程序的类. 如果您只需要特定的服务,您可以初始化该服务.

```dart
final service = MyClientUsersService(
    baseUrl: "https://example.com",
    headers: () async {
        return {
            "Authorization": "<some-token>",
        };
    },
);
```

#### 客户端/ 服务选项

| 名称 | 类型 | 说明 |
| --- | --- | --- |
| httpclient 语句 | `http.Client` | 使用此选项通过自定义 `http.Client` 实例 |
| 基数Url | `String` | 后端服务器的基础 URL |
| 页眉 | `FutureOr<Map<String, String>> Function()?` | 返回信头映射的函数 |
| 错误 | `Function(Object)?` | 当客户端出现任何错误时 就会起火. |

### 使用Arri模型

所有生成的模型都将是不可改变的. 他们将获得以下特征:

**方法**数字 :

-   `Map<String, dynamic> toJson()`
-   `String toJsonString()`
-   `String toUrlQueryParams()`
-   `copyWith()`

**工厂方法**数字 :

-   `empty()`
-   `fromJson(Map<String, dynamic> input)`
-   `fromJsonString(String input)`

**覆盖**数字 :

-   `==` 操作员(允许进行深度平等检查)
-   `hashMap` (允许进行深度平等检查)
-   `toString` (将打印出所有属性和值而不是) `Instance of X`(中文(简体) )

这个库是用 [无](https://nx.dev/)。 。 。 .

## 发展

```bash
# build the library
pnpm nx build codegen-dart

# test
pnpm nx test codegen-dart

# lint
pnpm nx lint codegen-dart
```

## 常见问题

### 如何安装 @arrirpc/codegen-dart？

在项目目录运行 npm install @arrirpc/codegen-dart，或使用 pnpm add / yarn add / bun add。

### @arrirpc/codegen-dart 支持 TypeScript 吗？

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

### @arrirpc/codegen-dart 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @arrirpc/codegen-dart 可以商用吗？

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

### @arrirpc/codegen-dart 的下载量有多少？

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

### @arrirpc/codegen-dart 还在维护吗？

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