Flutter与IDEMPIERE集成插件idempiere_rest的使用

Flutter与IDEMPIERE集成插件idempiere_rest的使用

标题

Flutter与IDEMPIERE集成插件idempiere_rest的使用

内容

一个用于简化对IDEMPIERE REST API（https://github.com/bxservice/idempiere-rest）消费的Dart客户端。

特性

此包实现了官方文档中列出的一些API调用（https://wiki.idempiere.org/en/REST_Web_Services）

• 一步登录
• 正常登录
• 请求PO集合
• 请求单个PO ID
• 创建PO
• 删除PO
• 更新PO
• 流程

使用方法

主类是IdempiereClient，它是一个单例。一旦实例化，必须调用setBaseUrl方法。

// 实例化单例IDEMPIERE客户端并设置API URL
IdempiereClient().setBaseUrl("https://mundodocafe.brerp.cloud/api/v11");

之后，您可以根据情况选择一步登录或正常登录。

如果已经知道参数（Client, Role, Org, Warehouse, Lang），可以使用一步登录：

IdempiereClient().oneStepLogin("/auth/tokens", "superuser @ brerp.com.br",
      "cafe123", "1000000", "1000000")

要创建或更新PO，需要创建一个扩展抽象类ModelBase的子类，并实现其方法：

import 'package:idempiere_rest/src/model_base.dart';

class MBPartner extends ModelBase {
    
    late String name;

    MBPartner(Map<String, dynamic> json) : super(json) {
        id = json['id'];
        name = json['Name'];
    }

    [@override](/user/override)
    Map<String, dynamic> toJson() {
        return {'Name' : name};
    }

    [@override](/user/override)
    MBPartner fromJson(Map<String, dynamic> json) {
        id = json['id'];
        name = json['Name'];
        return this;
    }
}

然后，我们可以进行PO请求：

// 获取记录
List<MBPartner> records = await IdempiereClient().get<MBPartner>(
          "/models/c_bpartner", (json) => MBPartner(json))

// 创建记录
MBPartner newRecord = MBPartner();
IdempiereClient().post<MBPartner>("/models/c_bpartner", newRecord); 

// 更新记录
IdempiereClient().put<MBPartner>("/models/c_bpartner", newRecord);

完整示例

包括正常登录和GET请求中的查询选项，请参阅example/idempiere_rest_example.dart。

贡献

如果您发现任何bug或有任何建议，请随时创建问题或提交pull request。

示例代码

import 'package:idempiere_rest/idempiere_rest.dart';
import 'package:test/test.dart';

void main() async {
  // 实例化单例IDEMPIERE客户端并设置API URL
  IdempiereClient().setBaseUrl("https://mundodocafe.brerp.cloud/api/v11");
  // 第一次令牌请求
  LoginResponse login = await IdempiereClient()
      .login("/auth/tokens", "superuser @ brerp.com.br", "cafe123");

  // 使用第一次客户端ID（仅示例目的）
  int clientId = login.clients.first.id!;
  List<Role> roles = await IdempiereClient().getRoles(clientId);

  // 使用第一个角色ID（仅示例目的）
  int roleId = roles.first.id!;
  List<Organization> orgs =
      await IdempiereClient().getOrganizations(clientId, roleId);

  // 使用第一个组织ID（仅示例目的）
  int orgId = orgs.first.id!;
  List<Warehouse> warehouses =
      await IdempiereClient().getWarehouses(clientId, roleId, orgId);

  // 使用第一个仓库ID（仅示例目的）
  int whId = warehouses.first.id!;

  // 初始化会话
  IdempiereClient().initSession(
      "/auth/tokens", login.token, login.clients.first.id!, roleId,
      organizationId: orgId, warehouseId: whId);

  FilterBuilder filter = FilterBuilder();
  filter
      .addFilter('C_BP_Group_ID', Operators.eq, 1000000)
      .and()
      .addFilter('COF_SituacaoComercial', Operators.eq, 'PA')
      .and()
      .addFilter('lbr_IE', Operators.contains, '1');

  ExpandBuilder expand = ExpandBuilder();

  FilterBuilder childFilter = FilterBuilder();
  childFilter.addFilter('Name', Operators.contains, 'a');

  expand.expand("AD_User",
      columnName: ['Name', 'Phone'],
      filter: childFilter,
      orderBy: ['Name', 'EMail'],
      top: 10,
      skip: 5);

  List<MBPartner> records = await IdempiereClient().get<MBPartner>(
      "/models/c_bartner", (json) => MBPartner(json),
      filter: filter,
      expand: expand,
      orderBy: ['COF_SituacaoComercial', 'Name'],
      select: ['Name', 'Name2'],
      top: 10,
      skip: 2,
      showsql: true);

  print(records);

  MBPartner newRecord = MBPartner.newTest(1000000, 'BParner Test');
  MBPartner? record =
      await IdempiereClient().post<MBPartner>("/models/c_bartner", newRecord);

  print(record);

  record = await IdempiereClient().getRecord<MBPartner>(
      "/models/c_bartner", record.id!, (json) => MBPartner(json));

  print(record);

  record!.name = 'BPartner Test Put';
  MBPartner updatedRecord =
      await IdempiereClient().put<MBPartner>("/models/c_bartner", record);
  print(updatedRecord);

  bool isDeleted =
      await IdempiereClient().delete("/models/c_bartner", record.id!);
  print(isDeleted);

  ProcessSummary ps = await IdempiereClient().runProcess(
      "/processes/ad_role_accessupdate",
      params: {'AD_Role_ID': 1000000, 'ResetAccess': 'N'});

  print(ps.logs);
}

class MBPartner extends ModelBase {
  late int cBPGroupId;
  late String name;

  MBPartner.newTest(this.cBPGroupId, this.name) : super({});

  MBPartner(Map<String, dynamic> json) : super(json) {
    id = json['id'];
    name = json['Name'];
  }

  [@override](/user/override)
  Map<String, dynamic> toJson() {
    Map<String, dynamic> data = {};
    if (id != null) {
      data['id'] = id;
    }

    data['Name'] = name;
    data['C_BP_Group_ID'] = cBPGroupId;
    data['AD_Language'] = 'en_US';

    return data;
  }

  [@override](/user/override)
  MBPartner fromJson(Map<String, dynamic> json) {
    id = json['id'];
    name = json['Name'];
    return this;
  }
}