Mule ESB是一个基于Java的轻量级企业服务总线和集成平台,允许开发人员快速便利地连接多个应用,并支持应用间的数据交换。Mule ESB支持集成现有系统而无论其底层采用何种技术,如JMS、Web Services、JDBC、HTTP以及其他技术。
2. 整体结构
图 整体结构
从上图可见,Mule通过Transports/Connectors与外围的异构系统连接,提供Routing(路由)、Transaction Management(事务管理)、Transformation(转换)、Message Broker(消息代理)、Transportation Management(传输管理)、Security(安全)等核心模块。Mule可以单独使用,也可以架设在常用的应用服务器上。
图 架构简图
外围系统的服务请求通过Mule ESB的Transport接入,Mule通过Transformer进行数据的格式转换,然后经过Inbound Router进行消息过滤(内部通过配置filter实现)后交给Mule的Component进行业务逻辑处理,处理后的结果通过Outbound Router确定传递给哪个接收方,然后通过Transformer进行数据格式转换,通过Transport连接至接收方,传递信息。
此图描述的是Mule中的一个典型场景的处理过程,涵盖了Mule中的各个关键组件。其中某些处理步骤不是必须的,如Inbound Router、Transformer。后续可以看到一些其他场景的处理。
3. 功能
a. 服务中介
b. 数据转换
Mule ESB中有一些基本的概念,理解这些基本概念后才能理解Mule的内部机制。从中也可以看到Mule解决问题的基本思路。
4. 基本概念
4.1 Model
Model表示托管各个服务的运行时环境。
图 Model
4.2 Service
Service是用来处理服务请求的基本单位,它调用各个组件进行服务请求的处理。
图 Service
4.3 Transport
Transport管理消息的接收和发送,数据转换的过程也是在Transport中通过调用Transformer完成的。
图 Transport
4.3.1 Connector
Connector用于管控特定协议的使用,如HTTP Connector、JMS Connector等。
4.3.2 End-Point
Endpoint用于表示一种协议的特定使用方式,如listening/polling、从中读取、向指定地址写入等,定义了发送和接收消息的通道。Endpoint控制的是底层的实体在Connector中如何被使用。
Endpoint定义于Inbound和Outbound Router中。
4.4 Transformer
Transformer用于转换消息的内容。
图 Transformer
4.5 Router
Router使用Filter基于消息中的属性信息进行消息的分发。
图 Router
Router在Service中的位置决定了Router的性质(inbound、outbound和response)和担任的角色(pass-through、aggregator等)。
4.6 Component
Component是Service的核心部件,是Service的业务逻辑的实现。
图 Component: implicit bridge component
Component可以是Java Class(POJO、Spring Bean)、Web Service、Script等。
Component可定义自己的生命周期:initialise、start、stop、dispose,不过需要实现Mule的LifeCycle接口。Mule 3.0版本开始提供@PostConstruct和@PreDestroy的注解,对应生命周期的initialise和dispose阶段,不需要实现Mule的LifeCycle接口了。
4.7 Flow(@since 3.0)
Flow是Mule 3.0新引入的,包含一个消息源(Message Source)和多个消息处理器组成的处理器链。
图 Flow
根据实际需求着重检查了一下Mule ESB的消息传递方式。Mule支持常用的几种消息传递方式,能够满足要求。
5. 消息传递方式
5.1 异步方式
异步方式是一种单向调用,调用者不需要获得响应。
图 Asynchronous
异步方式通过inbound和outbound endpoint的exchange-pattern=”one-way”实现。
使用基本的Stdio Transport验证,通过标准输入传输字符串,将其原样传递给标准输出进行显示。相应配置如下:
异步方式适用于简单的消息传递的场景。
5.2 请求-响应方式
请求-响应方式即请求方调用服务后,服务立即处理并返回响应结果,不需将消息再次传递。
图 Request-Response
请求-响应方式通过input endpoint的exchange-pattern=”request-response”实现,相应配置如下:
在浏览器中输入“http://localhost:7007/services/Echo/echo/text/hello,world”,浏览器中会显示“hello,world”的输出信息。
请求-响应方式适用于单次服务调用的场景。
5.3 同步方式
同步方式即请求方调用服务后,component将处理结果发送给另一个外部服务处理,并将处理结果反方向返回。
图 Synchronous
同步方式通过inbound和outbound endpoint的exchange-pattern=”request-response”实现,相应配置如下:
同步方式适用于通过Mule调用远程服务的场景。
5.4 异步请求-响应方式
异步请求-响应方式即请求方调用服务后不需要立即获得返回结果,component将请求发送给其他外围系统处理(可能有多个),全部处理完毕后通过指定的异步应答Router返回给请求方。
图 Asynchronous Request-Response
异步请求-响应方式通过在OutBound Endpoint中增加reply-to以及增加async-reply节点实现,响应配置如下:
异步请求-响应方式适用于请求需要被多个远程服务并行处理,结果需要汇总处理后返回的场景。
注:上述代码未运行通过,queue1和queue2获得了请求消息并正常处理,但返回至async-reply时抛出异常,暂未定位到问题。
后将collection-async-reply-router改为single-async-reply-router未报异常,代码示例如下:
6. 配置模式
Mule 3.0版本提供了“pattern”的机制。Pattern总结了实际使用过程中的常见场景,以简化的服务配置方式提供。
6.1 简单服务模式(simple service pattern)
简单服务模式用于简化同步服务调用的配置,对应消息传递方式中的请求-响应方式。
图 简单服务模式
简单服务模式通过simple-service 元素配置,主要的元素属性包括:
属性 | 说明 |
address | 服务监听的地址,如vm:in |
component-class | Component的实现类 |
type | direct: 默认; jax-ws: 将component暴露为soap式的web service(component必须基于jax-ws的注解),address一般为Http Transport; jax-rs: 将component暴露为rest式的web service(component必须基于@Path的注解),address一般为Http或Servlet Transport |
代码示例:
Mule针对服务请求接入可以做额外的处理,比如增加Transformer配置进行数据转换。
6.2 桥接模式(bridge pattern)
桥接模式用于在inbound endpoint和outbound endpoint之间建立直接连接,不需要component提供业务逻辑。
图 桥接模式
桥接模式通过bridge元素配置,主要属性包括:
属性 | 说明 |
inboundAddress | 服务请求接入地址 |
outboundAddress | 服务接出的实际地址 |
exchange-pattern | request-response: 默认,返回处理结果; one-way: 单向 |
transacted | true: 在向outbound endpoint分发时使用事务; false: 不使用事务 |
代码示例:
Mule在接入、接出的过程中可以做额外的处理,比如增加Transformer配置进行数据转换。如果使用事务控制,对于异构的协议之间的事务需要有支持XA的事务控制器。
6.3 校验器模式(validator pattern)
校验器模式通过定义一个校验过滤器过滤服务请求,并同步返回ACK(ACKnowledge)或NACK(Not Acknowledge)结果。通过校验的服务请求被异步分发给处理方。
图 校验器模式
校验器模式通过validator元素配置,主要属性包括:
属性 | 说明 |
inboundAddress | 服务请求接入地址 |
outboundAddress | 服务接出地址 |
ackExpression | 表达式,用于构建服务请求被接收时的信息 |
nackExpression | 表达式,用于构建服务请求被拒绝时的信息 |
errorExpression | @since 3.0.1 表达式,用于构建在服务请求分发出错时的信息 |
validationFilter-ref | 过滤器的引用,也可以使用子元素指定 用于确定服务请求是否被接收 |
代码示例:
注:Mule的表达式后续补充。
6.4 web服务代理模式(web service proxy pattern)
Web服务代理模式用于将Web Service请求直接转发至远程目标Web Service服务端,Mule本身不提供实际的Web Service。
图 web服务代理模式
Web服务代理模式通过ws-proxy元素配置,主要属性包括:
属性 | 说明 |
inboundAddress | Mule对外提供的地址 |
outboundAddress | Web Service的实际地址 |
代码示例:
Mule在转发的过程中可以做额外的处理,比如增加Transformer配置进行数据转换。
写之前的内容时,Mule刚刚3.0.1版本,很多官方文档还没有更新(尤其示例代码),维持在V2的状态。经过了一年多的时间,Mule社区版发展至了3.2版本,并且推出了Mule Studio可视化开发工具(当前beta状态,支持Mule 3.1.2)。
将以前自己验证的示例代码在3.1.2版本上又跑了一遍(有些变化),在此做一下记录。
一. 服务调用
1. Mule实现并提供Web Service
在Mule上开发并发布一个Web Service供客户端调用。
<flow name="local-ws">
<core:inbound-endpoint address="http://localhost:65082/services/Echo1"
exchange-pattern="request-response" doc:name="Generic" doc:description="Generic endpoint specified by address URI" />
<cxf:jaxws-service serviceClass="demo.mule.component.Echo" doc:name="SOAP"
doc:description="Make a web service available via CXF" />
<component doc:name="Component" doc:description="Invoke a Java component">
<singleton-object class="demo.mule.component.Echo" />
component>
flow >
2. Web Service Proxy
Web Service Proxy用来将客户端的WS请求直接转发至相应的远程WS服务端处理,并返回处理结果。Mule本身不做任何处理。
2.1 配置方式1
<flow name="local2remote-ws">
<http:inbound-endpoint keep-alive="false" address="http://localhost:65000"
encoding="UTF-8" disableTransportTransformer="false" exchange-pattern="request-response" doc:name="HTTP"
doc:description="" />
<http:outbound-endpoint method="GET" keep-alive="false"
address="http://localhost:5050#[header:INBOUND:http.request]" responseTimeout="10000" encoding="UTF-8"
disableTransportTransformer="false" followRedirects="false" exchange-pattern="request-response"
doc:name="HTTP" doc:description="" />
flow >
2.2 配置方式2
<pattern:web-service-proxy name="ws-proxy" inboundAddress="http://localhost:65082/services/Echo2"
outboundAddress="http://localhost:65082/services/Echo1?method=echo">
pattern:web-service-proxy>
3. Web Service to Web Service
Web Service To Web Service用于在Mule中提供Web Service供客户端调用,Mule接收请求后调用远端的Web Service进行处理,并返回结果。
<flow name="local-ws2remote-ws">
<core:inbound-endpoint address="http://localhost:65082/services/Echo8"
disableTransportTransformer="false" exchange-pattern="request-response" doc:name="Generic"
doc:description="Generic endpoint specified by address URI" />
<cxf:jaxws-service serviceClass="demo.mule.component.Echo" doc:name="SOAP"
doc:description="Make a web service available via CXF" />
<core:outbound-endpoint
address="wsdl-cxf:http://server1:5050/mule-business/webservice/EchoService?wsdl&method=Echo" />
flow >
4. Socket to Socket
Socket To Socket用于将客户端的Socket请求转发至远程的Socket服务端处理,并返回处理结果。
<flow name="tcp2tcp">
<tcp:inbound-endpoint host="localhost" port="7100" responseTimeout="10000"
encoding="UTF-8" disableTransportTransformer="false" exchange-pattern="request-response" doc:name="TCP"
doc:description="The TCP transport enables events to be sent and received over TCP sockets." />
<tcp:outbound-endpoint host="localhost" port="7000" responseTimeout="10000"
encoding="UTF-8" disableTransportTransformer="false" exchange-pattern="request-response" doc:name="TCP"
doc:description="The TCP transport enables events to be sent and received over TCP sockets." />
flow >
5. JMS Topic
客户端发送Web Service请求,Mule将请求消息发送至远程JMS的Topic中。
<flow name="local-ws2jms-topic">
<core:inbound-endpoint address="http://localhost:65082/services/Echo3"
responseTimeout="10000" encoding="UTF-8" disableTransportTransformer="false" mimeType="text/plain"
exchange-pattern="one-way" doc:name="Generic" doc:description="Generic endpoint specified by address URI" />
<cxf:jaxws-service serviceClass="demo.mule.component.Echo" doc:name="SOAP"
doc:description="Make a web service available via CXF" />
<jms:outbound-endpoint topic="topic1" responseTimeout="10000" encoding="UTF-8"
disableTransportTransformer="false" disableTemporaryReplyToDestinations="false" exchange-pattern="one-way"
connector-ref="activemqConnector" doc:name="JMS" doc:description="Send or receive messages from a JMS queue" />
flow>
<flow name="jms-topic2echo">
<jms:inbound-endpoint topic="topic1" responseTimeout="10000" encoding="UTF-8"
disableTransportTransformer="false" disableTemporaryReplyToDestinations="false" exchange-pattern="one-way"
connector-ref="activemqConnector" doc:name="JMS" doc:description="Send or receive messages from a JMS queue" />
<echo-component doc:name="Echo" doc:description="Echoes message payload." />
flow >
二. 基于消息内容的路由
Mule提供基于消息内容的路由机制,根据消息中的指定信息,将消息发送至不同的服务端进行处理。
1. Socket to Socket 路由
<flow name="tcp2tcp-router">
<tcp:inbound-endpoint host="localhost" port="7101" responseTimeout="10000"
encoding="UTF-8" disableTransportTransformer="false" exchange-pattern="request-response" doc:name="TCP"
doc:description="The TCP transport enables events to be sent and received over TCP sockets." />
<choice>
<when evaluator="jxpath" expression="(req/area)='bj'">
<tcp:outbound-endpoint host="server1" port="7101"
responseTimeout="10000" encoding="UTF-8" disableTransportTransformer="false" exchange-pattern="request-response"
doc:name="TCP" doc:description="The TCP transport enables events to be sent and received over TCP sockets." />
when>
<when evaluator="jxpath" expression="(req/area)='sh'">
<tcp:outbound-endpoint host="server1" port="7102"
responseTimeout="10000" encoding="UTF-8" disableTransportTransformer="false" exchange-pattern="request-response"
doc:name="TCP" doc:description="The TCP transport enables events to be sent and received over TCP sockets." />
when>
choice>
flow >
2. Web Service to JMS Topic 路由
<flow name="local-ws2jms-topic-router">
<core:inbound-endpoint address="http://localhost:65082/services/Echo7"
disableTransportTransformer="false" exchange-pattern="request-response" doc:name="Generic"
doc:description="Generic endpoint specified by address URI" />
<cxf:jaxws-service serviceClass="demo.mule.component.Echo" doc:name="SOAP"
doc:description="Make a web service available via CXF" />
<choice>
<when evaluator="jxpath" expression="(req/area)='bj'">
<jms:outbound-endpoint topic="topic1" responseTimeout="10000" encoding="UTF-8"
disableTransportTransformer="false" disableTemporaryReplyToDestinations="false"
exchange-pattern="one-way" connector-ref="activemqConnector" doc:name="JMS"
doc:description="Send or receive messages from a JMS queue" />
when>
<when evaluator="jxpath" expression="(req/area)='sh'">
<jms:outbound-endpoint topic="topic2" responseTimeout="10000" encoding="UTF-8"
disableTransportTransformer="false" disableTemporaryReplyToDestinations="false"
exchange-pattern="one-way" connector-ref="activemqConnector" doc:name="JMS"
doc:description="Send or receive messages from a JMS queue" />
when>
choice>
flow >
3. Web Service to Web Service 路由
<flow name="local-ws2jms-topic-router">
<core:inbound-endpoint address="http://localhost:65082/services/Echo9"
disableTransportTransformer="false" exchange-pattern="request-response" doc:name="Generic"
doc:description="Generic endpoint specified by address URI" />
<cxf:jaxws-service serviceClass="demo.mule.component.Echo" doc:name="SOAP"
doc:description="Make a web service available via CXF" />
<choice>
<when evaluator="jxpath" expression="(req/area)='bj'">
<core:outbound-endpoint
address="wsdl-cxf:http://server1:5050/mule-business/webservice/CalcService?wsdl&method=processXml" />
when>
<when evaluator="jxpath" expression="(req/area)='sh'">
<core:outbound-endpoint
address="wsdl-cxf:http://server2:5050/mule-business/webservice/CalcService?wsdl&method=processXml" />
when>
choice>
flow >
三. 数据转换
1. 压缩解压
Mule原生提供了gzip压缩方式的Transformer。
<flow name="gzip">
<stdio:inbound-endpoint ref="stdioInEndpoint" />
<core:string-to-byte-array-transformer encoding="UTF-8" />
<component class="demo.mule.component.Passthrough" />
<core:gzip-compress-transformer encoding="UTF-8" />
<component class="demo.mule.component.Passthrough" />
<core:gzip-uncompress-transformer encoding="UTF-8" />
<component class="demo.mule.component.Passthrough" />
<core:byte-array-to-string-transformer encoding="UTF-8" />
<stdio:outbound-endpoint ref="stdioOutEndpoint" />
flow >
2. 加密解密
加密、解密是一种特定的数据转换方式,因此通过自定义Transformer的形式支持。
<flow name="encrypt">
<core:inbound-endpoint address="http://localhost:65082/services/Echo11"
responseTimeout="10000" encoding="UTF-8" disableTransportTransformer="false" mimeType="text/plain"
exchange-pattern="one-way" />
<cxf:jaxws-service serviceClass="demo.mule.component.Echo" />
<component>
<singleton-object class="demo.mule.component.Echo" />
component>
<core:custom-transformer class="demo.mule.transformer.DesEncryptTransformer" encoding="UTF-8" />
<component class="demo.mule.component.Passthrough" />
<core:custom-transformer class="demo.mule.transformer.DesDecryptTransformer" encoding="UTF-8" />
<stdio:outbound-endpoint ref="stdioOutEndpoint" />
flow >
3. 自定义Transformer
import demo.mule.dto.Envelope;
publicclassString2EnvelopeTransformerextendsAbstractTransformer{
privatestaticLoglog=LogFactory.getLog(String2EnvelopeTransformer.class);
@Override
protectedObjectdoTransform(Objectsrc,Stringenc)throws TransformerException {
Envelopeenv=newEnvelope();
if(srcinstanceofString){
StringTokenizerst=newStringTokenizer((String)src,",");
Stringarea=st.nextToken();
Stringdata=st.nextToken();
env.create(area,data);
}
log.debug(env);
returnenv;
}
}
<flow name="local-ws">
<core:inbound-endpoint address="http://localhost:65082/services/Echo1"
exchange-pattern="request-response" doc:name="Generic" doc:description="Generic endpoint specified by address URI" />
<cxf:jaxws-service serviceClass="demo.mule.component.Echo" doc:name="SOAP"
doc:description="Make a web service available via CXF" />
<component doc:name="Component" doc:description="Invoke a Java component">
<singleton-object class="demo.mule.component.Echo" />
component>
<core:custom-transformer class="demo.mule.transformer.String2EnvelopeTransformer">core:custom-transformer>
<core:outbound-endpoint address="stdio://System.out" exchange-pattern="one-way" />
flow >
仅以上述示例代码作为这一段时间Mule文档阅读及试用的总结。