Flutter Odoo数据交互插件manex_odoo_repository的使用

Odoo Models Repository

抽象层以与Odoo后端进行通信。
它帮助实现Odoo和Dart客户端之间的数据通信，并支持持久化和离线模式。

特性

• 静态类型：Odoo记录由Dart类型表示。
• 离线模式：记录存储在本地缓存中。
• 调用队列：RPC调用在网络恢复在线时执行。
• 记录流：轻松集成BLoC或FutureBuilder的数据更新。

描述

Odoo Repository包使用OdooRecord作为基类来表示从远程Odoo实例获取的记录。
该记录具有以下属性：

• 包含用于存储数据的字段；
• 是不可变的；
• 可以与其他相同类型的记录进行比较以检查相等性；
• 可以从JSON转换为对象或反之亦然。

基本的res.partner记录实现如下：

import 'package:equatable/equatable.dart';
import 'package:odoo_repository/odoo_repository.dart';

class Partner extends Equatable implements OdooRecord {
  const Partner(this.id, this.name);

  [@override](/user/override)
  final int id;
  final String name;

  /// 将Partner转换为JSON
  [@override](/user/override)
  Map<String, dynamic> toJson() {
    return {
      'id': id,
      'name': name,
    };
  }

  /// 从JSON创建[Partner]
  static Partner fromJson(Map<String, dynamic> json) {
    return Partner(
      json['id'] as int,
      json['name'] as String,
    );
  }

  /// Equatable相关的比较逻辑
  [@override](/user/override)
  List<Object> get props => [id, name];

  /// 需要从Odoo获取的字段列表
  static List<String> get oFields => ['id', 'name'];

  [@override](/user/override)
  String toString() => 'User[$id]: $name';
}

每个需要从Odoo获取的模型都需要有自己的OdooRecord和OdooRepository实现对。

在实现了Partner类之后，我们可以定义基于OdooRepository并配置了Partner类型的PartnerRepository类。

为了使PartnerRepository类能够提供Partner记录，只需要很少的配置即可。

import 'package:odoo_repository/odoo_repository.dart';
import 'package:odoo_rpc/odoo_rpc.dart';
import 'partner_record.dart';

class PartnerRepository extends OdooRepository<Partner> {
  [@override](/user/override)
  final String modelName = 'res.partner';

  PartnerRepository(OdooDatabase database) : super(database);

  [@override](/user/override)
  Partner createRecordFromJson(Map<String, dynamic> json) {
    return Partner.fromJson(json);
  }
}

首先我们需要实例化OdooEnvironment，它包含一组Odoo仓库并在添加到环境中的顺序相同地执行调用队列。

OdooEnvironment需要OdooClient、数据库名称、缓存和网络连接。当实例化时，可以通过add()调用添加新的仓库实例。

// 使用Hive初始化缓存存储
final cache = OdooKvHive();
await cache.init();
// 尝试从存储中恢复会话
OdooSession? session = cache.get('cacheSessionKey', defaultValue: null);
const odooServerURL = 'https://my-odoo-instance.com';
final odooClient = OdooClient(odooServerURL, session);
final netConn = NetworkConnectivity();
const odooDbName = 'odoo';

final env = OdooEnvironment(odooClient, odooDbName, cache, netConn);

final partnerRepo = env.add(PartnerRepository(env));
env.add(UserRepository(env));
env.add(SaleOrderRepository(env));
env.add(SaleOrderLineRepository(env));
// 等等...
// 后面我们可以通过以下方式访问PartnerRepository实例
final saleOrderRepo = env.of<SaleOrderRepository>();
final saleOrderLineRepo = saleOrderRepo.env.of<SaleOrderLineRepository>();

以下是使用connectivity包实现NetConnState的一个示例。

import 'package:connectivity/connectivity.dart';
import 'package:odoo_repository/odoo_repository.dart' show netConnState, NetConnState;

class NetworkConnectivity implements NetConnState {
  static NetworkConnectivity? _singleton;
  static late Connectivity _connectivity;

  factory NetworkConnectivity() {
    _singleton ??= NetworkConnectivity._();
    return _singleton!;
  }

  NetworkConnectivity._() {
    _connectivity = Connectivity();
  }

  [@override](/user/override)
  Future<netConnState> checkNetConn() async {
    final connectivityResult = await (_connectivity.checkConnectivity());
    if (connectivityResult == ConnectivityResult.mobile) {
      return netConnState.online;
    } else if (connectivityResult == ConnectivityResult.wifi) {
      return netConnState.online;
    }
    return netConnState.offline;
  }

  [@override](/user/override)
  Stream<netConnState> get onNetConnChanged async* {
    await for (var netState in _connectivity.onConnectivityChanged) {
      if (netState == ConnectivityResult.mobile) {
        // 网络现在在线
        yield netConnState.online;
      } else if (netState == ConnectivityResult.wifi) {
        // 网络现在在线
        yield netConnState.online;
      } else if (netState == ConnectivityResult.none) {
        // 网络现在离线
        yield netConnState.offline;
      }
    }
  }
}