背景
odoo 数据拉取,创建,更新
参考
官方 external api 文档
External API — Odoo 14.0 文档
术语
ORM odoo 数据以对象模型呈现,支持 one2many,many2one,many2many 等对象的关联关系
Model 可以看作数据表,数据类型
XML-RPC odoo 使用 xml-rpc 通信
设计模型
Client 负责连接协议,即 xml rpm 协议
Connector 封装获取数据逻辑
QueryRequest 查找请求,封装查找条件参数
表达式模型
odoo 的查询表达式是逆波兰表达式,连接器支持两种构建表达式方式
表达式分析器(未实现)
用户出入 (traceId==’b’) and ((database==’d’) or ((days>=12) or (eventType==’g’)))
通用格式的表达式,分析器转换成逆波兰式,
流式 api 构建器
流式 builder 构建逆波兰式
两方式比较:
分析器 ,通用的表达式符合开发人员的思维,但分析器递归分析消耗一定性能,可增加缓存支持,但要考虑参数化表达式
流式 api 性能高 ,需要开发人员先转为逆波兰式
接口设计
setupTestDataBase 获取 demo 库的属性,包括 host,user,password,database(数据库名称),用于 demo 库拉取,demo 库是动态,先通过此方法,odoo 分配哪个 demo 库
authenticate 认证,认证的参数,host,user,password,database,连接器 构造方法 传入
listFieldsOfModel 获取模型的字段,包括名称,类型,说明
count 返回传入请求条件查到的记录总数
search 查找
createRecored/updateRecord/deleteRecord 增删改记录
开发指南
以下代码来源于代码包单元测试
1. 构建连接器
odooConnector = new Connector(host, dbParams, false);
host = “#34; xxx 申请时填写
user = “???@?????.com” 邮箱地址
database = “xxx” 同 host 的域名
password 支持密码,app key 两种方式,推荐使用 app key,不需要发布密码,防止别人登录,一个账号可以发布多个 key,用名称识别,区分谁调用接口
其中,后 3 个参数封装到 DatabaseParams 类,即 dbParams
若使用 demo 库,需要先用 setupTestDataBase 接口方法获取动态 demo 库的 DatabaseParam
2. 认证
userID = odooConnector.authenticate();
userId 用于后面查找 api
3. 构建查找表达式
QueryExpBuilder eb = new QueryExpBuilder();
eb.or().and().left(“amount_total”, Operator .GT, 1000)
.right(“amount_total”, Operator.LT, 2000)
.right(“amount_total”, Operator.LT, 1000)
逆波兰表达式
构建查找请求
Query Request Builder builder = new QueryRequestBuilder();
QueryRequest qr = builder.build();
最后调用 build 方法生成查询请求 Query Request
执行查找
Object[] orders = odooConnector.search(orderModel, qr);
返回 map 数组,应用需转换成具体业务对象
单元测试
代码包提供完整单元测试,覆盖各种场景,包括 not and or 嵌套和优先级
代码包提供两个测试类,OdooConnectorDemoTest 和 OdooConnectorTest
分表用于 odoo 提供的 demo 数据库和自建数据库
- demo 库
demo 库 odoo 提供,不需要自己创建应用,导入数据,直接可以使用,但 demo 是动态,每次测试可能连不同的库,数据不能延续,速度慢
- 自建应用/自建库
odoo 可免费注册,使用 14 天,之后可续期,odoo 提供 demo 数据库,导入后应用有数据可供测试
测试示例使用 odoo 应用的销售模块,订单子功能,选取以下字段
name String 号码
date_order datetime 单据日期
commitment_date datetime 送货日期
expected_date datetime 预计日期
partner_id many2one 客户
amount_tax float
amount_untaxed float
amount_total float 合计
invoice_status 发票状态
order_line={name=order_line, type=one2many} 订单明细
note html 说明
测试 1:查找表达式测试
测试不同 运算符 ,逻辑符场景,包括=,<>,like,not like 等运算符,not and or 及其嵌套,优先级
打开注释测试不同测试场景,1~7,其中 6,7 测试 not and or 嵌套和优先级
测试 2:分页拉取测试
演示 count 方法获取总数,for 循环分页拉取所有数据
- 代码下载(收费)
包含连接器和单元测试