Flutter插件m10_sdk的使用方法介绍

Flutter插件m10_sdk的使用方法介绍

在本篇文档中，我们将详细介绍如何使用Flutter插件m10_sdk及其潜在用途。首先，我们需要生成protobuf代码并确保相关依赖项已安装。然后，我们将通过一个完整的示例演示如何使用该插件。

生成protobuf代码

确保protoc_plugin版本为20.0.0或更高。运行以下命令以升级：

pub global activate protoc_plugin

将.pub-cache/bin目录添加到你的PATH环境变量中。

确保已经安装了protobuf编译器：

# Linux
sudo apt-get update && sudo apt-get install protobuf-compiler

# Mac
brew install protobuf

运行以下命令以生成protobuf代码：

protoc --dart_out=grpc:lib/src/generated -I=../../protobuf/ ../../protobuf/sdk/*.proto
protoc --dart_out=grpc:lib/src/generated -I=../../protobuf/ ../../protobuf/sdk/**/*.proto
protoc --dart_out=grpc:lib/src/generated -I=../../protobuf/ ../../protobuf/directory/*.proto
protoc --dart_out=grpc:lib/src/generated -I=../../protobuf/ ../../protobuf/firehose/*.proto
protoc --dart_out=grpc:lib/src/generated -I=../../protobuf/ ../../protobuf/google/*.proto
protoc --dart_out=grpc:lib/src/generated -I=../../protobuf/ ../../protobuf/google/protobuf/*.proto

如何运行测试

要运行测试，请执行以下命令：

pub run test ./test/all_test.dart

完整示例

以下是一个使用m10_sdk的完整示例，展示了如何连接到M10目录、创建SDK实例并创建用户。

示例代码

import 'package:m10_sdk/m10_directory.dart';
import 'package:m10_sdk/m10_sdk.dart';
import 'package:m10_sdk/security/local_signing.dart';

Future<void> main() async {
  // 连接到M10目录
  final m10Directory = M10Directory(
    'https://example-host.io',
    tokenProvider: ExampleTokenProvider(),
  );

  // 创建SDK实例
  final m10 = M10Sdk(
    signer: await LocalSigning.loadKeyPair('/path/to/example_key'),
    ledgers: await m10Directory.listLedgers(),
  );

  // 创建用户
  await m10.createUser(operator: 'Example operator');
}

// 实现TokenProvider接口
class ExampleTokenProvider implements TokenProvider {
  @override
  Future<String> get accessToken async => 'Example token';

  @override
  String get subject => 'Example subject';
}

代码解释

1. 导入必要的包：

   import 'package:m10_sdk/m10_directory.dart';
   import 'package:m10_sdk/m10_sdk.dart';
   import 'package:m10_sdk/security/local_signing.dart';
   

2. 定义M10Directory实例：

   final m10Directory = M10Directory(
     'https://example-host.io',
     tokenProvider: ExampleTokenProvider(),
   );
   

   这里我们创建了一个M10Directory实例，并提供了目标主机地址和令牌提供者。

3. 加载密钥对并创建SDK实例：

   final m10 = M10Sdk(
     signer: await LocalSigning.loadKeyPair('/path/to/example_key'),
     ledgers: await m10Directory.listLedgers(),
   );
   

   我们加载了密钥对，并使用这些信息创建了一个M10Sdk实例。

4. 创建用户：

   await m10.createUser(operator: 'Example operator');
   

   最后，我们调用createUser方法来创建一个新的用户。

5. 实现TokenProvider接口：

   class ExampleTokenProvider implements TokenProvider {
     @override
     Future<String> get accessToken async => 'Example token';
   
     @override
     String get subject => 'Example subject';
   }