Flutter构建工具插件candid_dart_build的使用

简体中文 | English

为Dart Build System 提供处理 .did 文件的构建器，并快速生成与 .did 文件对应的 Dart 代码。

生成的代码包括：

• IDL
• Service 及其相关方法
• 与 .did 文件对应的对象及其相关方法

生成的代码依赖于 agent_dart

快速开始

依赖项简介

执行以下命令（推荐）

# 使用 Dart
dart pub add --dev candid_dart_build
dart pub add --dev build_runner

# 使用 Flutter
flutter pub add --dev candid_dart_build
flutter pub add --dev build_runner

手动添加到项目下的 pubspec.yaml 中

dev_dependencies:
  candid_dart_build: any
  build_runner: any

运行生成器

# 使用 Dart
dart run build_runner build

# 使用 Flutter
flutter pub run build_runner build

配置

targets:
  $default:
    builders:
      candid_dart_build|candid2dart:
        options:
          # 是否使用 Freezed，默认为 `false`
          freezed: false
          # 是否生成 `copyWith` 方法，默认为 `true`
          copy_with: true
          # 是否生成 `equals` 和 `hashCode` 方法，默认为 `true`
          equal: true
          # 是否使集合字段不可修改，仅在启用 Freezed 时有效，默认为 `true`
          make_collections_unmodifiable: true
          # 是否自动生成 `Service`？
          service: true
          # 导入设置包到每个生成的 Dart 文件。
          inject_packages:
            - package:recase/recase.dart
            - package:dart_style/dart_style.dart
          # 在调用 Actor 方法之前注入一段代码，可以引用请求参数 `request` 和类型为 CanisterActor 的参数 `actor`。
          pre_actor_call: |
            print(method);
            print(request);
            print(actor);
            // ...
          # 在调用 Actor 方法之后注入一段代码，可以引用请求参数 `request`、类型为 CanisterActor 的参数 `actor` 和方法的返回结果 `response`。
          post_actor_call: |
            print(method);
            print(request);
            print(actor);
            print(response);
            // ...

示例

请查看 示例 项目。

许可证

MIT License

Copyright (c) 2022 AstroxNetwork

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

示例代码

// example/lib/example.dart
void main(List<String> arguments) {}