Flutter远程过程调用插件kangaroo_rpc的使用

特性

• 使用之前存储的Odoo会话初始化客户端。
• 通过数据库名称、登录名和密码进行身份验证。
• 向JSON控制器发出JSON-RPC请求。
• 通过CallKw执行公共方法。
• 通过流获取Odoo会话更新。
• 终止会话（登出）。
• 在会话过期时捕获异常。

使用

要使用此插件，在您的pubspec.yaml文件中添加kangaroo_rpc作为依赖项。例如：

dependencies:
  kangaroo_rpc: ^0.4.5

示例

基本RPC调用

import 'dart:io';
import 'package:kangaroo_rpc/kangaroo_rpc.dart';

void main() async {
  final client = OdooClient('https://my-db.odoo.com');
  try {
    await client.authenticate('my-db', 'admin', 'admin');
    final res = await client.callKw({
      'model': 'res.users',
      'method': 'search_read',
      'args': [],
      'kwargs': {
        'context': {'bin_size': true},
        'domain': [],
        'fields': ['id', 'name', '__last_update'],
      },
    });
    print('User info: \n' + res.toString());
  } on OdooException catch (e) {
    print(e);
    client.close();
    exit(-1);
  }
  client.close();
}

带有跟踪会话变化的RPC调用

Odoo服务器将在每次调用时发出新的session_id。

import 'dart:io';
import 'package:kangaroo_rpc/kangaroo_rpc.dart';

void sessionChanged(OdooSession sessionId) async {
  print('We got new session ID: ${sessionId.id}');
  // 将会话ID写入持久存储
}

void main() async {
  // 从存储中恢复会话ID并传递给客户端构造函数
  final baseUrl = 'https://demo.odoo.com';
  final client = OdooClient(baseUrl);

  // 订阅会话变化以存储最新的会话
  var subscription = client.sessionStream.listen(sessionChanged);

  try {
    // 使用数据库名称和凭据对服务器进行身份验证
    final session = await client.authenticate('odoo', 'admin', 'admin');
    print(session);
    print('Authenticated');

    // 根据服务器版本计算图像字段名称
    final imageField = session.serverVersionInt >= 13 ? 'image_128' : 'image_small';

    // 读取用户字段
    final uid = session.userId;
    var res = await client.callKw({
      'model': 'res.users',
      'method': 'search_read',
      'args': [],
      'kwargs': {
        'context': {'bin_size': true},
        'domain': [
          ['id', '=', uid]
        ],
        'fields': ['id', 'name', '__last_update', imageField],
      },
    });
    print('\nUser info: \n' + res.toString());

    // 如果收到回复，计算头像URL
    if (res.length == 1) {
      var unique = res[0]['__last_update'] as String;
      unique = unique.replaceAll(RegExp(r'[^0-9]'), '');
      final userAvatar = '$baseUrl/web/image?model=res.user&field=$imageField&id=$uid&unique=$unique';
      print('User Avatar URL: $userAvatar');
    }

    // 创建合作伙伴
    var partnerId = await client.callKw({
      'model': 'res.partner',
      'method': 'create',
      'args': [
        {
          'name': 'Stealthy Wood',
        },
      ],
      'kwargs': {},
    });

    // 通过ID更新合作伙伴
    res = await client.callKw({
      'model': 'res.partner',
      'method': 'write',
      'args': [
        partnerId,
        {
          'is_company': true,
        },
      ],
      'kwargs': {},
    });

    // 获取已安装模块列表
    res = await client.callRPC('/web/session/modules', 'call', {});
    print('\nInstalled modules: \n' + res.toString());

    // 检查是否已登录
    print('\nChecking session while logged in');
    res = await client.checkSession();
    print('ok');

    // 登出
    print('\nDestroying session');
    await client.destroySession();
    print('ok');
  } on OdooException catch (e) {
    // 处理Odoo异常时的清理工作
    print(e);
    await subscription.cancel();
    client.close();
    exit(-1);
  }

  print('\nChecking session while logged out');
  try {
    var res = await client.checkSession();
    print(res);
  } on OdooSessionExpiredException {
    print('Odoo Exception:Session expired');
  }
  await client.inRequestStream.isEmpty;
  await subscription.cancel();
  client.close();
}

Flutter示例

使用FutureBuilder的Flutter示例。

import 'package:flutter/material.dart';
import 'package:kangaroo_rpc/kangaroo_rpc.dart';

final orpc = OdooClient('https://my-odoo-instance.com');

void main() async {
  await orpc.authenticate('odoo-db', 'admin', 'admin');
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: HomePage(),
    );
  }
}

class HomePage extends StatelessWidget {
  Future<dynamic> fetchContacts() {
    return orpc.callKw({
      'model': 'res.partner',
      'method': 'search_read',
      'args': [],
      'kwargs': {
        'context': {'bin_size': true},
        'domain': [],
        'fields': ['id', 'name', 'email', '__last_update', 'image_128'],
        'limit': 80,
      },
    });
  }

  Widget buildListItem(Map<String, dynamic> record) {
    var unique = record['__last_update'] as String;
    unique = unique.replaceAll(RegExp(r'[^0-9]'), '');
    final avatarUrl =
        '${orpc.baseURL}/web/image?model=res.partner&field=image_128&id=${record["id"]}&unique=$unique';
    return ListTile(
      leading: CircleAvatar(backgroundImage: NetworkImage(avatarUrl)),
      title: Text(record['name']),
      subtitle: Text(record['email'] is String ? record['email'] : ''),
    );
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Contacts'),
      ),
      body: Center(
        child: FutureBuilder(
            future: fetchContacts(),
            builder: (BuildContext context, AsyncSnapshot<dynamic> snapshot) {
              if (snapshot.hasData) {
                return ListView.builder(
                    itemCount: snapshot.data.length,
                    itemBuilder: (context, index) {
                      final record = snapshot.data[index] as Map<String, dynamic>;
                      return buildListItem(record);
                    });
              } else {
                if (snapshot.hasError) return Text('Unable to fetch data');
                return CircularProgressIndicator();
              }
            }),
      ),
    );
  }
}