如今社会,科技的发达带给了人们日益快捷便利化的生活,有了支付宝等手机端的快捷支付,再也不必出门前检查自己是否忘东忘西,只需手机不离身,便可事事通;有了各种手机APP,不必特意出门,只要手机在身,我们就可享受衣食住行等各种服务;当然,对于通信开放平台来说,有了ApiBuilder,就如同我们生活中有了手机,它可以帮助能力提供者设计统一风格的API接口。那ApiBuilder是什么呢?今天,我们就来探讨下:
概念介绍:
ApiBuilder能够使能力提供者实现能力的快速接入,主要用于http请求响应消息的格式转换,逻辑处理。通过图形化界面帮助能力提供者将不同风格的接口快速统一封装,具备安全认证、使用简单、接入周期短等特点。
我们先从API的三种开放模式讲起:
API的三种开放模式:
在创建Api时,会有三种模式选择,即代理模式、直接响应模式、Mashup模式。
代理模式
最为常用的模式,平台能力的url(前端url)接收到APP发送过来的消息,进行处理后发送给能力提供者的url(即后端url);能力提供者有了响应之后,再进行处理,发送给开发者的服务端,服务端再响应给开发者的APP。
直接响应模式
该模式下没有能力提供者,API商城就是服务端,获取到开发者的请求,经过脚本处理得到响应,然后返回给APP。
Mashup模式
最为复杂的,功能最强大的模式,可以按照编排的流程来调用接口,并根据条件进行判断、分支。其中主要是消息发送图元(相当于一个代理模式)和条件分支图元。
Mashup模式在创建时不需要后端url,但是在设置消息发送图元时需要,可以同时有多个消息发送图元:
基于MVEL的策略编排
Mvel 与 java 语言十分类似,脚本中可以直接调用jar包,代码结构和一些代码细节略有差别。
在脚本中使用上下文对象时,最好全部使用msgContext对象,而不是messageContext。
每个API都需要对开发者的请求和提供者的响应做判空处理,以免抛出mvel执行失败(空指针)的错误。
例:
if(null == msgContext.getRequestAsJson())
{
//抛出异常
}
在脚本中,每当捕获到异常,设置异常标识和返回消息后,都要加上return语句(在mvel中有效),以终止脚本继续执行,防止逻辑混乱。
PS:方法体中的return不能结束流程
例:
buildInHttpResponse(messageContext,resultCode,resultDesc);
return;
在脚本中使用for循环时,可能出现invalid variable错误。这时需要将循环下标的定义放在for循环外面。如果还不行,把j++换成j=j+1
例:
int j = 0;
for(; j < inReqs.length; j++)
{….}
在if…else语句中,if语句块和else语句块不能定义同名变量,否则会报语法解析错误。
例:
import com.alibaba.fastjson.JSONObject;
if(true)
{
String a = "";
}
else
{
JSONObject a = new JSONObject();
}
报错:Compile mvel expression failed: Error: statically-typed variable already defined in scope: a
提供者的请求最好带上Content-Type消息头制定消息类型,否则提供者读取请求消息会超时。
例:outHttpRequest.httpHead["Content-Type"]="application/json;charset=UTF-8";
Ps:常用的Content-Type:
application/xml
application/json
application/x-www-form-urlencoded
application/soap+xml
注意:当提供者是soap格式消息时,提供者请求的消息头contenttype用text/xml,而不是application/xml。
当遇到urlencode格式的消息时,要注意参数值是经过urldecode编码的,使用时记得解码,传递时记得加码,以免参数传递不正确。
Mvel脚本不支持java的泛型,所以使用时不要指定类型。
例:
执行结果:
Mvel脚本不支持try-catch语句。
目前,通信开放平台有了ApiBuilder这个神器,给能力提供者带去了方便,但研发更好的能力任重而道远,高品质的服务也不能止步不前,相信在平台团队的努力下,我们会给用户带来更多更好的产品。
相关概念:
1. App端:即Apiconsumer,Api的调用方,也称为开发者。
2. Server端:即Apiprovider,能力提供方,为实际请求处理服务器,也称为能力提供者。
3. APIUrl:Api开放给外部使用的地址,也称平台能力的url。
4. 后端Url:提供者提供服务的地址。
5. API调用流程:
· Apiconsumer发送HTTP消息到Apiurl,消息头中携带鉴权消息头,此请求称为开发者的请求(inHttpRequest)。
· AEP接受发送到Api的请求,按照流程中的图元进行消息处理和校验,处理完成后的请求发送给提供者服务端,此请求称为AEP的请求(outHttpRequest)。
· 提供者接收到请求后,经过实际的业务处理,返回响应给AEP,此响应称为提供者的响应(outHttpResponse)。
· AEP接收到后端服务器的处理结果,经过流程图中的图元处理之后,继续响应给开发者Apiconsumer,此响应称为AEP的响应(inHttpResponse)。