将Flex集成到Java EE应用程序的最佳实践

传统的 Java EE 应用程序通常使用某种 MVC 框架（例如Struts）作为前端用户界面随着 Flex 的兴起基于 RIA 的客户端能够给用户带来更酷的界面更短的响应时间以及更接近于桌面应用程序的体验本文将讲述如何将 Flex 集成至一个现有的 Java EE 应用程序中以及如何应用最佳实践高效率地并行开发 Java EE 和 Flex

开发环境

本文的开发环境为 Windows UltimateEclipse Flex Builder （从 参考资源 获得下载链接）Java EE 服务器使用 Resin 当然您也可以使用 Tomcat 等其他 Java EE 服务器

现有的 Java EE 应用

假定我们已经拥有了一个管理雇员信息的 Java EE 应用名为 EmployeeMgmtServer结构如 图 所示

图 Java EE 工程结构

这是一个典型的 Java EE 应用使用了流行的 Spring 框架为了简化数据库操作我们使用了内存数据库 HSQLDB对这个简单的应用省略了 DAO直接在 Fa？ade 中通过 Spring 的 JdbcTemplate 操作数据库最后EmployeeMgmt 应用通过 Servlet 和 JSP 页面为用户提供前端界面

图 EmployeeMgmt Web 界面

该界面为传统的 HTML 页面用户每次点击某个链接都需要刷新页面由于 Employee Management 系统更接近于传统的桌面应用程序因此用 Flex 重新编写界面会带来更好的用户体验

集成 BlazeDS

如何将 Flex 集成至该 Java EE 应用呢？现在我们希望用 Flex 替换掉原有的 Servlet 和 JSP 页面就需要让 Flex 和 Java EE 后端通信Flex 支持多种远程调用方式包括 HTTPWeb Services 和 AMF不过针对 Java EE 开发的服务器端应用可以通过集成 BlazeDS充分利用 AMF 协议并能轻易与 Flex 前端交换数据这种方式是 Java EE 应用程序集成 Flex 的首选

BlazeDS 是 Adobe LifeCycle Data Services 的开源版本遵循 LGPL v 授权可以免费使用BlazeDS 为 Flex 提供了基于 AMF 二进制协议的远程调用支持其作用相当于 Java 的 RMI有了 BlazeDS通过简单的配置一个 Java 接口就可以作为服务暴露给 Flex供其远程调用

尽管现有的 EmployeeMgmt 应用程序已经有了 Fa？ade 接口但这个接口是暴露给 Servlet 使用的最好能再为 Flex 定义另一个接口 FlexService并隐藏 Java 语言的特定对象（如 清单 所示）

清单 FlexService interface

public interface FlexService {

Employee createEmployee(String name String title boolean gender Date birth);

void deleteEmployee(String id);

Employee[] queryByName(String name);

Employee[] queryAll();

}

现在Java EE 后端与 Flex 前端的接口已经定义好了要完成 Java EE 后端的接口实现类非常容易利用 Spring 强大的依赖注入功能可以通过几行简单的代码完成

清单 FlexServiceImpl class

public class FlexServiceImpl implements FlexService {

private static final Employee[] EMPTY_EMPLOYEE_ARRAY = new Employee[];

private Facade facade;

public void setFacade(Facade facade) {

thisfacade = facade;

}

public Employee createEmployee(String name String title boolean gender

Date birth) {

return facadecreateEmployee(name title gender birth);

}

public void deleteEmployee(String id) {

facadedeleteEmployee(id);

}

public Employee[] queryAll() {

return facadequeryAll()toArray(EMPTY_EMPLOYEE_ARRAY);

}

public Employee[] queryByName(String name) {

return facadequeryByName(name)toArray(EMPTY_EMPLOYEE_ARRAY);

}

}

然后我们将 BlazeDS 所需的 jar 包放至 /WEBINF/lib/BlazeDS 需要如下的 jar

清单 BlazeDS 依赖的 Jar

backportutilconcurrentjar

commons

commonsloggingjar

flexmessagingcommonjar

flexmessagingcorejar

flexmessagingproxyjar

flexmessagingremotingjar

在 webxml 中添加 HttpFlexSession 和 Servlet 映射HttpFlexSession 是 BlazeDS 提供的一个 Listener负责监听 Flex 远程调用请求并进行一些初始化设置

清单 定义 Flex Listener

<listener>

<listenerclass>ssagingHttpFlexSession</listenerclass>

</listener>

MessageBrokerServlet 是真正处理 Flex 远程调用请求的 Servlet我们需要将其映射到指定的 URL

清单 定义 Flex servlet

<servlet>

<servletname>messageBroker</servletname>

<servletclass>ssagingMessageBrokerServlet</servletclass>

<initparam>

<paramname>nfigurationfile</paramname>

<paramvalue>/WEBINF/flex/servicesconfigxml</paramvalue>

</initparam>

<loadonstartup></loadonstartup>

</servlet>

<servletmapping>

<servletname>messageBroker</servletname>

<urlpattern>/messagebroker/*</urlpattern>

</servletmapping>

BlazeDS 所需的所有配置文件均放在 /WEBINF/flex/ 目录下BlazeDS 将读取 servicesconfigxml 配置文件该配置文件又引用了 remotingconfigxmlproxyconfigxml 和 messagingconfigxml 这 个配置文件所以一共需要 个配置文件

由于 BlazeDS 需要将 Java 接口 FlexService 暴露给 Flex 前端因此我们在配置文件 remotingconfigxml 中将 FlexService 接口声明为一个服务

清单 定义 flexService 服务

<destination id=flexService>

<properties>

<source>orgexpressmeemployeemgmtflexFlexServiceImpl</source>

<scope>application</scope>

</properties>

</destination>

服务名称通过 destination 的 id 属性指定Flex 前端通过该服务名称来进行远程调用scope 指定为 application表示该对象是一个全局对象

然而按照默认的声明BlazeDS 会去实例化 FlexService 对象对于一个 Java EE 应用来说通常这些服务对象都是被容器管理的（例如Spring 容器或 EJB 容器）更合适的方法是查找该服务对象而非直接实例化因此需要告诉 BlazeDS 通过 Factory 来查找指定的 FlexService 对象修改配置如下

清单 通过 factory 定义 flexService

<destination id=flexService>

<properties>

<factory>flexFactory</factory>

<source>flexService</source>

<scope>application</scope>

</properties>

</destination>

现在Flex 如何才能通过 BlazeDS 调用 FlexService 接口呢？由于 FlexService 对象已经被 Spring 管理因此我们需要编写一个 FlexFactory 告诉 BlazeDS 如何找到 Spring 管理的 FlexService 的实例flexFactory 在 servicesconfigxml 中指定

清单 定义 flexFactory

<factories>

<factory id=flexFactory class=orgexpressmeemployeemgmtflexFlexFactoryImpl/>

</factories>

FlexFactoryImpl 实现了 FlexFactory 接口该接口完成两件事情

创建 FactoryInstance 对象

通过 FactoryInstance 对象查找我们需要的 FlexService

因此需要一个 FactoryInstance 的实现类我们编写一个 SpringFactoryInstance以便从 Spring 的容器中查找 FlexService

清单 SpringFactoryInstance class

class SpringFactoryInstance extends FactoryInstance {

private Log log = LogFactorygetLog(getClass());

SpringFactoryInstance(FlexFactory factory String id ConfigMap properties) {

super(factory id properties);

}

public Object lookup() {

ApplicationContext appContext = WebApplicationContextUtils

getRequiredWebApplicationContext(

FlexContextgetServletConfig()getServletContext()

);

String beanName = getSource();

try {

(Lookup bean from Spring ApplicationContext: + beanName);

return appContextgetBean(beanName);

}

catch (NoSuchBeanDefinitionException nex) {

}

catch (BeansException bex) {

}

catch (Exception ex) {

}

}

}

FlexFactoryImpl 负责实例化 SpringFactoryInstance 并通过 SpringFactoryInstance 的 lookup（） 方法查找 FlexService 接口对象

清单 FlexFactoryImpl class

public class FlexFactoryImpl implements FlexFactory {

private Log log = LogFactorygetLog(getClass());

public FactoryInstance createFactoryInstance(String id ConfigMap properties) {

(Create FactoryInstance);

SpringFactoryInstance instance = new SpringFactoryInstance(this id properties);

instancesetSource(propertiesgetPropertyAsString(SOURCE instancegetId()));

return instance;

}

public Object lookup(FactoryInstance instanceInfo) {

(Lookup service object);

return instanceInfolookup();

}

public void initialize(String id ConfigMap configMap) {

}

}

以下是 BlazeDS 查找 FlexService 接口的过程

BlazeDS 将首先创建 FlexFactory 的实例—— FlexFactoryImpl

当接收到 Flex 前端的远程调用请求时BlazeDS 通过 FlexFactory 创建 FactoryInstance 对象并传入请求的 Service ID在这个应用程序中被创建的 FactoryInstance 实际对象是 SpringFactoryInstance

FactoryInstance 的 lookup（） 方法被调用在 SpringFactoryInstance 中首先查找 Spring 容器然后通过 Bean 的 ID 查找 Bean最终FlexService 接口的实例被返回

注意到 destination 的 id 并没有写死在代码中而是通过以下语句获得的

清单 获取 destination 的 ID

propertiesgetPropertyAsString(SOURCE instancegetId())

Property 的 SOURCE 属性由 BlazeDS 读取 XML 配置文件获得

清单 配置 destination 的 id

<destination id=flexService>

<properties>

<factory>flexFactory</factory>

<source>flexService</source>

<scope>application</scope>

</properties>

</destination>

如果您没有使用 Spring 框架也不要紧只需修改 FactoryInstance 的 lookup（） 方法例如对于一个 EJB 来说lookup（） 方法应该通过 JNDI 查找返回远程接口无论应用程序结构如何我们的最终目标是向 BlazeDS 返回一个 FlexService 的实例对象

开发 Flex 客户端

首先安装 Flex Builder 可以在 Adobe 的官方网站获得 天免费试用版然后打开 Flex Builder 创建一个新的 Flex Project命名为 EmployeeMgmtFlex

图 新建 Flex 工程 第一步

Flex Project 需要指定 Server 端的配置文件地址

图 新建 Flex 工程 第二步

因此需要填入 EmployeeMgmtServer 项目的 web 根目录该目录下必须要存在 /WEBINF/flex/点击Validate Configuration验证配置文件是否正确只有通过验证后才能继续默认地Flex Builder 将会把生成的 Flash 文件放到 EmployeeMgmtServer 项目的 web/EmployeeMgmtFlexdebug 目录下

一个 Flex Project 的目录结构如下

图 Flex 工程的目录结构

用 Flex Builder 做出漂亮的用户界面非常容易Flex Builder 提供了一个可视化的编辑器通过简单的拖拽一个毫无经验的开发人员也能够设计出漂亮的布局如果熟悉一点 XML 的知识编辑 MXML 也并非难事我们设计的 Employee Management 系统界面的最终效果如下

图 用 Flex Builder 的可视化编辑器设计界面

本文不打算讨论如何编写 Flex 界面而是把重点放在如何实现远程调用

为了能在 Flex 中实现远程调用我们需要定义一个 RemoteObject 对象可以通过 ActionScript 编码创建该对象也可以直接在 MXML 中定义一个 RemoteObject 对象并列出其所有的方法

清单 定义 flexServiceRO

<mx:RemoteObject id=flexServiceRO destination=flexService>

<mx:method name=queryAll result=handleQueryAll(result : ResultEvent)/>

</mx:RemoteObject>

现在就可以调用这个名为 flexServiceRO 的 RemoteObject 对象的方法了

清单 调用 FlexServiceROqueryAll（）

flexServiceROqueryAll(function(result : ResultEvent) {

var employees = resultresult as Array;

});

运行该 Flex Application雇员信息已经被正确获取了

图 在浏览器中运行 Flex application

增强 RemoteObject 对象

通过 RemoteObject 进行调用虽然简单但存在不少问题首先RemoteObject 是一个 Dynamic ClassFlex Builder 的编译器无法替我们检查参数类型和参数个数这样在编写 ActionScript 代码时极易出错此外接口变动时（这种情况常常发生）需要重新修改 RemoteObject 的定义此外Flex 团队需要一份随时修订的完整的 FlexService 接口文档才能工作

因此最好能使用强类型的 RemoteObject 接口让 Flex Builder 的编译器及早发现错误这个强类型的 RemoteObject 最好能通过 Java EE 应用的 FlexService 接口自动生成这样就无需再维护 RemoteObject 的定义

为了能完成自动生成 RemoteObject 对象我编写了一个 JavaActionScript 的 Ant 任务来自动转换 FlexService 接口以及相关的所有 JavaBeanJavaInterfaceRemoteObjectTask 完成一个 Java 接口对象到 RemoteObject 对象的转换使用如下的 Ant 脚本

清单 生成 ActionScript class 的 Ant 脚本

<taskdef name=genactionscript classname=orgexpressmeantJavaBeanActionScriptTask>

<classpath refid=buildclasspath />

</taskdef>

<taskdef name=genremoteobject

classname=orgexpressmeantJavaInterfaceRemoteObjectTask>

<classpath refid=buildclasspath />

</taskdef>

<genactionscript

packageName=orgexpressmeemployeemgmt

includes=Employee

orderByName=true

encoding=UTF

outputDir=${gendir}

/>

<genremoteobject

interfaceClass=orgexpressmeemployeemgmtflexFlexService

encoding=UTF

outputDir=${gendir}

destination=flexService

/>

转换后的 FlexServiceRO 类拥有 Java 接口对应的所有方法每个方法均为强类型签名并添加额外的两个可选的函数处理 result 和 fault 事件例如queryByName 方法

清单 自动生成的 queryByName（） 方法

public function queryByName(arg : String result : Function = null

fault : Function = null) : void {

var op : AbstractOperation = rogetOperation(queryByName);

if (result!=null) {

opaddEventListener(ResultEventRESULT result);

}

if (fault!=null) {

opaddEventListener(FaultEventFAULT fault);

}

var f : Function = function() : void {

opremoveEventListener(ResultEventRESULT f);

opremoveEventListener(FaultEventFAULT f);

if (result!=null) {

opremoveEventListener(ResultEventRESULT result);

}

if (fault!=null) {

opaddEventListener(FaultEventFAULT fault);

}

}

opaddEventListener(ResultEventRESULT f);

opaddEventListener(FaultEventFAULT f);

opsend(arg);

}

转换 Java 接口是通过 Interfaceas 和 InterfaceMethodas 两个模板文件完成的此外所有在 Java EE 后端和 Flex 之间传递的 JavaBean 对象也通过 JavaBeanActionScriptTask 自动转换成对应的 ActionScript 类这是通过 Beanas 模板完成的

有了 Java 类到 ActionScript 的自动转换我们在编写 ActionScript 时就能享受到编译器检查和 ActionScript 类方法的自动提示了

图 Flex Builder 的代码自动补全

唯一的缺憾是通过反射读取 FlexService 接口时我们失去了方法的参数名称因此FlexServiceRO 的方法参数名只能变成 argarg …… 等要读取 FlexService 接口的方法参数名只能通过解析 Java 源代码实现

现在Java EE 后端开发团队和 Flex 前端开发团队只需协商定义好 FlexService 接口然后利用 JavaActionScriptFlex 团队就得到了强类型的 FlexServiceRO 类而 Java EE 团队则只需集中精力实现 FlexService 接口

在开发的前期甚至可以用硬编码的 FlexService 的实现类每当 FlexService 变动时只需再次运行 Ant 脚本就可以获得最新的 FlexServiceRO 类这样两个团队都可以立刻开始工作仅需要通过 FlexService 接口就可以完美地协同开发

下载