Flutter Odoo RPC调用插件odoo_rpc的使用

Odoo RPC Client Library

Odoo RPC Client Library 是一个用于 Dart 的库，允许开发者通过 JSON-RPC 与 Odoo 进行交互。以下是该库的一些主要功能：

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

使用方法

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

dependencies:
  odoo_rpc: ^0.4.5

示例代码

基本RPC调用

以下是一个基本的 RPC 调用示例，它连接到 Odoo 实例并获取已安装的模块列表：

import 'dart:io';
import 'package:odoo_rpc/odoo_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.callRPC('/web/session/modules', 'call', {});
    print('Installed modules: \n' + res.toString());
  } on OdooException catch (e) {
    print(e);
    client.close();
    exit(-1);
  }
  client.close();
}

带有会话更改跟踪的RPC调用

以下示例展示了如何处理会话更改，并在每次调用时从 Odoo 服务器获取新的 session_id：

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

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

void main() async {
  var prev_session = restore_session_somehow();
  var client = OdooClient("https://my-db.odoo.com", prev_session);

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

  try {
    final session = await client.authenticate('my-db', 'admin', 'admin');
    var res = await client.callRPC('/web/session/modules', 'call', {});
    print('Installed modules: \n' + res.toString());

    // 登出
    await client.destroySession();
  } on OdooException catch (e) {
    print(e);
    subscription.cancel();
    client.close();
    exit(-1);
  }

  try {
    await client.checkSession();
  } on OdooSessionExpiredException {
    print('Session expired');
  }

  subscription.cancel();
  client.close();
}

Flutter 示例：使用 FutureBuilder 获取联系人信息

以下是一个完整的 Flutter 示例，它使用 FutureBuilder 来获取并显示 Odoo 中的联系人信息：

import 'package:flutter/material.dart';
import 'package:odoo_rpc/odoo_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
  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
  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();
              }
            }),
      ),
    );
  }
}

注意事项

• Web平台支持：此包有意使用 http 包而不是 dart:io，以便支持 Web 平台。但是，由于 CORS 请求当前未被 Odoo 正确处理，因此托管在不同域上的 Web 客户端（Dart JS）的 RPC 调用将无法工作。详情请参见 Odoo GitHub Pull Request。

• 问题反馈：如果您遇到任何问题、错误或有功能请求，请在我们的 GitHub 页面上提交。

• 贡献：如果您想为插件做出贡献（例如改进文档、解决错误或添加新功能），请发送 Pull Request。

• 作者：Odoo RPC Client Library 由 ERP Ukraine 开发。

希望这些信息对您有所帮助！如果您有任何其他问题或需要进一步的帮助，请随时提问。