odoo connector,数据拉取,Java xml-rpc
背景
odoo数据拉取,创建,更新
参考
官方external api文档
https://www.odoo.com/documentation/14.0/zh_CN/developer/misc/api/odoo.html
术语
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 增删改记录
开发指南
以下代码来源于单元测试
构建连接器
odooConnector = new Connector(host, dbParams, false);
host = "http://xxx.odoo.com" xxx申请时填写
user = "???@?????.com" 邮箱地址
database ="xxx" 同host的域名
password 支持密码,app key两种方式,推荐使用app key,不需要发布密码,防止别人登录,一个账号可以发布多个key,用名称识别,区分谁调用接口
其中,后3个参数封装到DatabaseParams类,即dbParams
若使用demo库,需要先用setupTestDataBase接口方法获取动态demo库的DatabaseParams
认证
userID = odooConnector.authenticate();
userId用于后面查找api
构建查找表达式
QueryExpBuilder eb = newQueryExpBuilder();
eb.or().and().left("amount_total",Operator.GT, 1000)
.right("amount_total",Operator.LT, 2000)
.right("amount_total",Operator.LT, 1000)
逆波兰表达式
构建查找请求
QueryRequestBuilderbuilder=newQueryRequestBuilder();
builder
.sort("date_order", SortOrder.DESC) //排序
.offset(0)
.limit(5) // offset/limit分页, 也可使用page
.requestFileds(…) //请求返回的字段
.queryExp(eb)//查询表达式,参考4
;
QueryRequest qr = builder.build();
最后调用build方法生成查询请求QueryRequest
执行查找
Object[]orders=odooConnector.search(orderModel, qr);
返回map数组,应用需转换成具体业务对象
单元测试
代码包提供完整单元测试,覆盖各种场景,包括not /and/or嵌套和优先级
代码包提供两个测试类,OdooConnectorDemoTest和OdooConnectorTest
分别用于odoo提供的demo数据库和自建数据库
demo库
odoo提供,不需要自己创建应用和导入数据,直接可以使用,但demo是动态,每次测试可能连不同的库,数据不能延续,速度慢
自建应用/自建库
odoo可免费注册,使用14天,之后可续期,odoo提供demo数据库,导入后应用有数据可供测试
测试示例使用odoo应用的销售模块,订单子功能,选取以下字段
/**
*字段
name String号码
date_orderdatetime单据日期
commitment_datedatetime送货日期
expected_datedatetime预计日期
partner_id many2one 客户
amount_tax float
amount_untaxed float
amount_total float合计
invoice_status发票状态
order_line={name=order_line,type=one2many}订单明细
notehtml说明
*/
测试1:查找表达式测试
测试不同运算符,逻辑符场景,包括=,<>,like,not like等运算符,not and or及其嵌套,优先级
打开注释测试不同测试场景,1~7,其中6,7测试not and or嵌套和优先级
测试2:分页拉取测试
演示count方法获取总数,for循环分页拉取所有数据
代码下载(收费)
https://download.csdn.net/download/szlhj/36717794