Flutter客户端通信插件jmixclientv1的使用

DartJmixClientV1

用于与jmix 1.x Rest API通信的库。

安装

在Dart项目中安装插件：

dart pub add jmixclientv1

在Flutter项目中安装插件：

flutter pub add jmixclientv1

示例代码

以下是一个完整的示例代码，展示了如何使用jmixclientv1插件进行基本操作。

示例代码：main.dart

import 'package:jmixclientv1/jmixclientv1.dart';
import 'package:jmixclientv1/src/entities/session.dart';

void main() async {
  // 初始化Jmix客户端
  final JmixClient jmixClient = JmixClient(
    protocol: 'http', // 协议（http或https）
    hostname: '127.0.0.1', // 主机名
    port: 8080, // 端口
    clientId: 'your_client_id', // 客户端ID
    clientSecret: 'your_client_secret', // 客户端密钥
  );

  try {
    // 获取访问令牌
    final Session session = await jmixClient.getAccessToken(
      username: 'admin', // 用户名
      password: 'admin', // 密码
    );

    // 打印会话信息
    print('Session Token: ${session.accessToken}');
    print('Refresh Token: ${session.refreshToken}');

    // 获取用户列表
    final List<User> users = await jmixClient.getEntities<User>(
      name: 'User',
      parseCallback: (e) => User.fromMap(e),
    );
    print('Users: $users');

    // 刷新访问令牌
    final Session refreshedSession = await jmixClient.refreshAccessToken(
      refreshToken: session.refreshToken!,
    );
    print('Refreshed Session Token: ${refreshedSession.accessToken}');

    // 查询单个用户
    final User singleUser = await jmixClient.getEntity<User>(
      name: 'User',
      id: users.first.id!,
      parseCallback: (e) => User.fromMap(e),
    );
    print('Single User: ${singleUser.toMap()}');

    // 搜索用户
    final List<User> searchedUsers = await jmixClient.searchEntities<User>(
      name: 'User',
      conditions: [Condition(property: 'username', operator: '=', value: 'admin')],
      parseCallback: (e) => User.fromMap(e),
    );
    print('Searched Users: $searchedUsers');

    // 创建新用户
    final User newUser = await jmixClient.executeService<User>(
      name: 'MobileApp',
      method: 'createUser',
      body: {
        "username": "newUser",
        "password": "password123",
        "firstname": "John",
        "lastname": "Doe",
      },
      parseCallback: (e) => User.fromMap(e),
    );
    print('New User Created: ${newUser.toMap()}');

    // 更新用户密码
    await jmixClient.executeService<void>(
      name: 'MobileApp',
      method: 'updatePassword',
      body: {"password": "updatedPassword"},
      parseCallback: (e) => e,
    );
    print('Password Updated Successfully');

    // 下载文件
    final File downloadedFile = await jmixClient.downloadFile(
      id: 'file_id_here', // 文件ID
      path: 'downloaded_file_path.txt',
    );
    print('File Downloaded: ${downloadedFile.path}');

    // 上传文件
    final Map<String, dynamic> uploadedFile = await jmixClient.uploadFile(
      path: '/path/to/file.txt',
      name: 'uploaded_file_name.txt',
    );
    print('File Uploaded: $uploadedFile');
  } catch (e) {
    print('Error: $e');
  }
}

说明

初始化Jmix客户端

通过构造函数初始化JmixClient对象，并提供必要的配置参数，例如协议、主机名、端口、客户端ID和客户端密钥。

final JmixClient jmixClient = JmixClient(
  protocol: 'http',
  hostname: '127.0.0.1',
  port: 8080,
  clientId: 'your_client_id',
  clientSecret: 'your_client_secret',
);

获取访问令牌

使用getAccessToken方法获取访问令牌，用于后续API调用。

final Session session = await jmixClient.getAccessToken(
  username: 'admin',
  password: 'admin',
);

获取实体数据

使用getEntities方法获取指定实体的数据列表。

final List<User> users = await jmixClient.getEntities<User>(
  name: 'User',
  parseCallback: (e) => User.fromMap(e),
);

查询单个实体

使用getEntity方法查询单个实体。

final User singleUser = await jmixClient.getEntity<User>(
  name: 'User',
  id: users.first.id!,
  parseCallback: (e) => User.fromMap(e),
);

搜索实体

使用searchEntities方法根据条件搜索实体。

final List<User> searchedUsers = await jmixClient.searchEntities<User>(
  name: 'User',
  conditions: [Condition(property: 'username', operator: '=', value: 'admin')],
  parseCallback: (e) => User.fromMap(e),
);

创建新实体

使用executeService方法创建新的实体。

final User newUser = await jmixClient.executeService<User>(
  name: 'MobileApp',
  method: 'createUser',
  body: {
    "username": "newUser",
    "password": "password123",
    "firstname": "John",
    "lastname": "Doe",
  },
  parseCallback: (e) => User.fromMap(e),
);

更新实体

使用executeService方法更新现有实体。

await jmixClient.executeService<void>(
  name: 'MobileApp',
  method: 'updatePassword',
  body: {"password": "updatedPassword"},
  parseCallback: (e) => e,
);

下载文件

使用downloadFile方法下载文件。

final File downloadedFile = await jmixClient.downloadFile(
  id: 'file_id_here',
  path: 'downloaded_file_path.txt',
);

上传文件

使用uploadFile方法上传文件。

final Map<String, dynamic> uploadedFile = await jmixClient.uploadFile(
  path: '/path/to/file.txt',
  name: 'uploaded_file_name.txt',
);