Flutter账户服务管理插件pip_services_accounts的使用

Flutter账户服务管理插件pip_services_accounts的使用

用户账户微服务

这是来自Pip.Services库的用户账户管理微服务。

• 注册用户并创建其账户
• 保存用户的描述和设置（关于、位置、语言、主题等）

该微服务目前支持以下部署选项：

• 部署平台：独立进程、Seneca
• 外部API：HTTP/REST、Seneca
• 持久化：内存、平面文件、MongoDB

该微服务可选依赖于以下微服务：

• pip-services-activities-dart - 用于记录用户活动（注册、登录、更改设置）

合同

以下是微服务的逻辑合同。对于物理实现（HTTP/REST），请参阅特定协议的文档。

class AccountV1 implements IStringIdentifiable {
  /* Identification */
  String id;
  String login;
  String name;
  
  /* Activity tracking */
  DateTime create_time;
  bool deleted;
  bool active;

  /* User preferences */
  String about;
  String time_zone;
  String language;
  String theme;

  /* Custom fields */
  var custom_hdr;
  var custom_dat;
}

abstract class IAccountsV1 {
  Future<DataPage<AccountV1>> getAccounts(
      String correlationId, FilterParams filter, PagingParams paging);

  Future<AccountV1> getAccountById(String correlationId, String id);

  Future<AccountV1> getAccountByLogin(String correlationId, String login);

  Future<AccountV1> getAccountByIdOrLogin(String correlationId, String idOrLogin);

  Future<AccountV1> createAccount(String correlationId, AccountV1 account);

  Future<AccountV1> updateAccount(String correlationId, AccountV1 account);

  Future<AccountV1> deleteAccountById(String correlationId, String accountId);
}

下载

目前，获取该微服务的唯一方法是从GitHub仓库直接克隆。

git clone git@github.com:pip-services-users/pip-services-accounts-dart.git

Pip.Service团队正在努力实现打包，并使其稳定版本可供下载。

运行

在微服务文件夹的根目录下添加config.yaml文件，并设置配置参数。

以下是微服务配置的示例：

---
# 容器描述符
- descriptor: "pip-services:context-info:default:default:1.0"
  name: "pip-services-accounts"
  description: "Accounts microservice for pip-services"

# 控制台日志
- descriptor: "pip-services:logger:console:default:1.0"
  level: "trace"

# 性能计数器，将值发布到日志
- descriptor: "pip-services:counters:log:default:1.0"
  level: "trace"

{{#MEMORY_ENABLED}}
# 内存持久化。仅用于测试！
- descriptor: "pip-services-accounts:persistence:memory:default:1.0"
{{/MEMORY_ENABLED}}

{{#FILE_ENABLED}}
# 文件持久化。用于测试或简单的独立部署
- descriptor: "pip-services-accounts:persistence:file:default:1.0"
  path: {{FILE_PATH}}{{^FILE_PATH}}"./data/accounts.json"{{/FILE_PATH}}
{{/FILE_ENABLED}}

{{#MONGO_ENABLED}}
# MongoDB持久化
- descriptor: "pip-services-accounts:persistence:mongodb:default:1.0"
  collection: {{MONGO_COLLECTION}}{{^MONGO_COLLECTION}}accounts{{/MONGO_COLLECTION}}
  connection:
    uri: {{{MONGO_SERVICE_URI}}}
    host: {{{MONGO_SERVICE_HOST}}}{{^MONGO_SERVICE_HOST}}localhost{{/MONGO_SERVICE_HOST}}
    port: {{MONGO_SERVICE_PORT}}{{^MONGO_SERVICE_PORT}}27017{{/MONGO_SERVICE_PORT}}
    database: {{MONGO_DB}}{{#^MONGO_DB}}app{{/^MONGO_DB}}
  credential:
    username: {{MONGO_USER}}
    password: {{MONGO_PASS}}
{{/MONGO_ENABLED}}

{{^MEMORY_ENABLED}}{{^FILE_ENABLED}}{{^MONGO_ENABLED}}
# 默认内持久化
- descriptor: "pip-services-accounts:persistence:memory:default:1.0"
{{/MONGO_ENABLED}}{{/FILE_ENABLED}}{{/MEMORY_ENABLED}}

# 默认控制器
- descriptor: "pip-services-accounts:controller:default:default:1.0"

# 公共HTTP端点
- descriptor: "pip-services:endpoint:http:default:1.0"
  connection:
    protocol: "http"
    host: "0.0.0.0"
    port: 8080

# HTTP端点版本1.0
- descriptor: "pip-services-accounts:service:http:default:1.0"

# 心跳服务
- descriptor: "pip-services:heartbeat-service:http:default:1.0"

# 状态服务
- descriptor: "pip-services:status-service:http:default:1.0"

有关微服务配置的更多信息，请参阅配置指南。

使用以下命令启动微服务：

dart ./bin/run.dart

使用

与微服务最简单的方式是使用客户端SDK。可用的客户端SDK列表见快速链接。

如果你使用Dart，请获取所需的库引用：

• Pip.Services3.Commons: https://github.com/pip-services3-dart/pip-services3-commons-dart
• Pip.Services3.Rpc: https://github.com/pip-services3-dart/pip-services3-rpc-dart

添加pip-services3-commons-dart、pip-services3-rpc-dart 和 pip-services_accounts 包：

import 'package:pip_services3_commons/pip_services3_commons.dart';
import 'package:pip_services3_rpc/pip_services3_rpc.dart';

import 'package:pip_services_accounts/pip_services_accounts.dart';

定义与微服务外部API匹配的客户端配置参数：

// 客户端配置
var httpConfig = ConfigParams.fromTuples(
	"connection.protocol", "http",
	"connection.host", "localhost",
	"connection.port", 8080
);

实例化客户端并连接到微服务：

// 创建客户端实例
var client = AccountsHttpClientV1(config);

// 配置客户端
client.configure(httpConfig);

// 连接到微服务
try {
  await client.open(null);
} catch (err) {
  // 错误处理...
}       
// 与微服务交互
// ...

现在客户端已准备好执行操作：

// 创建新账户
final ACCOUNT = AccountV1(
    id: '1',
    login: 'user1@conceptual.vision',
    name: 'Test User 1',
    deleted: false
);

// 创建账户
try {
  var account = await client.createAccount('123', ACCOUNT);
  // 对返回的账户进行操作...
} catch (err) {
  // 错误处理...
}

// 获取账户
try {
  var account = await client.getAccountByLogin(
      null,
      'somebody@somewhere.com');
  // 对账户进行操作...
} catch (err) {
  // 错误处理...
}