CN104317591A - 一种基于OSGi的web界面框架系统及web业务处理方法 - Google Patents

Abstract

本发明公开了一种基于OSGi的web界面框架系统及web业务处理方法，包括全局配置模块、Http处理模块、地址映射模块、模型处理模块、视图处理模块、模板处理模块、模板引擎模块以及辅助类模块，其中所述Http处理模块包括Http请求处理模块、Http响应处理模块及Http异常处理模块。本发明的基于OSGi的web界面框架系统，实现了OSGi与web服务消息交互，可自动通过JSON与java对象相互转换，利于有效实现构件管理，方便程序开发人员的开发，开发人员通过继承相应接口，便可实现OSGi web构件的开发，而且复用性强，出现问题容易追踪，并降低了开发成本。

Description

一种基于OSGi的web界面框架系统及web业务处理方法

技术领域

本发明属于构件化开发技术领域，具体涉及一种基于OSGi的web界面框架系统，还涉及上述基于OSGi的web界面框架系统的web业务处理方法。

背景技术

OSGi(Open Service Gateway Initiative，公共开放服务网关标准)联盟建立于1999年，是一个非赢利机构，旨在建立一个开放的服务规范。OSGi规范为网络服务定义了一个标准的、面向组件的计算环境，它最初的目的就是为各种嵌入式设备提供通用的软件运行平台，屏蔽设备操作系统与硬件区别的中间件平台，通过这个平台，可以对不同软件商提供的应用(OSGi中称为Bundle)进行组件的生命周期管理的能力，如应用组件可以从运行中被安装、升级或者移除而不需要中断设备的操作，应用组件可以动态的发现和使用其他库或者应用程序。由于OSGi技术具有服务组件模块化、动态加载应用等优点，正被越来越多的领域关注，如嵌入设备制造业、汽车制造业、企业应用等。在构件化开发领域中，OSGi(Open Service GatewayInitiative)提供了一个标准的、面向服务的计算环境，为用户提供了开放的、面向服务组件的、易于部署的、可插拔的编程模型，这个编程模型允许用户将定义好的接口规范部署到OSGi运行环境中，并发布成特定服务。由于传统的JEE模块类加载体系与OSGi类加载体系不一致，导致传统JEE模块不能直接在OSGi容器中运行。

基于OSGi进行web开发，公知的方法是将OSGi业务构件服务(java接口)转化为标准的RestFul或标准的webService服务或传统的web组件进行消费服务。这种做法实质上分离了web组件与OSGi构件的统一部署，不利于有效实现构件管理，同时给程序开发人员带来不便，增加了开发成本。另外一种方法是利用Struts2 MVC(model-view-control)框架，保留java web开发人员的习惯，但这种方案存在两个问题：一是OSGi web构件过于臃肿，二是复杂的java数据对象很难转化，导致出现问题难以追踪。因而，需要一种轻量级的OSGi web框架来实现OSGi web构件与OSGi业务构件的有效通信协作，同时能够处理web相关元素，如请求-响应-异常等，那么就需要采用一种框架机制来统一处理请求、响应、异常、URL地址映射。

发明内容

本发明提供了一种基于OSGi的web界面框架系统，解决了现有的在基于OSGi进行web构件化开发中，展现层构件开发难度大，复用性不强、开发成本高的问题。

本发明还提供了上述基于OSGi的web框架系统处理web业务的方法。

本发明第一技术方案是，一种基于OSGi的web界面框架系统，包括以下功能模块，全局配置模块、Http处理模块、地址映射模块、模型处理模块、视图处理模块、模板(template)处理模块、模板引擎模块以及辅助类模块，其中所述Http处理模块包括Http请求处理模块、Http响应处理模块及Http异常处理模块；

全局配置模块，用于数据库连接池配置、国际化文件配置、过滤器配置、模板文件路径的配置的解析与处理；地址映射模块，用于根据用户的请求解析地址，采用正则表达式将URL地址与视图方法对应，进行逻辑调用与处理；Http处理模块用于预处理或后处理请求对象与响应对象的模块，包括对Http请求、响应、异常处理；模型处理模块，用于数据处理，数据库数据与面向对象的数据一一对应和映射；视图处理模块，用于业务逻辑处理，是整个框架的核心，也是用户扩展的部分，通过地址映射模块找到对应的视图逻辑，然后通过视图逻辑调用的相关的模板；模板处理模块，用于用户数据展示，通过处理逻辑产生的数据渲染到相关页面，以一定的方式展示给用户，并定义了模板编排规则；模板引擎模块，用于页面展现与数据内容分离；辅助模块，用于归类公用的类和方法。

本发明第一方案的特点还在于，

地址映射模块采用正则表达式将URL地址与视图方法对应，定义URL处理器。

Http处理模块由Http处理器组成，基于java拦截机制技术实现；在Http请求处理模块，定义请求处理拦截器，负责编码转化、数据格式转化，调用用户定义视图方法；在Http响应处理模块，定义响应处理拦截器，负责完成数据与模板组装，并调用模板引擎处理；在Http异常处理模块，定义异常处理拦截器，负责视图方法异常处理，并跳转用户定义友好错误界面。

在视图处理模块，定义了若干基类方法，开发人员编写视图类，用来继承框架提供的用户接口。

在模板处理模块，定义了模板编排规则，模板为标准jsp页面和html页面。

本发明那个的另一技术方案是，上述基于OSGi的web界面框架系统的Web业务处理方法，包括以下步骤：

步骤1，OSGi开放服务网关通过Command类启动OSGi web界面框架，全局配置模块加载解析全局配置文件，并初始化，全局配置都在“settings.xml”中定义；

步骤2，地址映射模块根据url.xml进行地址与函数关系映射初始化；

步骤3，Http处理模块处理Request

当有Http请求来时，HttpHandler为每个请求创建一个MyHttpRequest实例，HttpHandler从BaseHandler继承而来，而MyHttpRequest是从http.HttpRequest继承而来；

步骤4，Http处理模块创建Response

BaseHandler采用get_response方法根据request创建response；

步骤5，Http处理模块处理Response

将返回的Response内容返回给Web服务器，由后者返回给浏览器；

步骤6，Http处理模块生成Response

具体的方法为执行urls.xml中对应的视图处理模块中的视图方法，每个视图方法都返回一个Response实例；

步骤7，模板处理模块通过loader加载template并生成页面内容，并通过Model模型将视图渲染到模板，然后模板引擎模块将页面展现与数据内容分离，从而生成具体的页面，实现基于OSGI的Web界面框架的web业务处理，具体步骤如下，

7.1.模板处理模块根据get_template方法加载需要渲染的模板，get_template方法返回一个Template实例，其中包含经过解析的模板和用到的方法；

7.2.实例化一个Context用来渲染模板；

7.3.调用Template实例的render方法，Context对象作为第一个位置参数。

本发明的另一技术方案的特点还在于，

在进行Web业务处理时所用的方法如下：

a.初始化方法，仅在服务进程启动的时候调用，而在针对单个request处理时并不执行；

b.请求预处理方法，在界面框架接收到request之后，但仍未解析URL以确定应当运行的视图方法之前调用；

c.视图处理模块执行视图预处理方法，这个方法的调用时机在框架执行完request预处理方法并确定待执行的视图方法之后，但在视图方法实际执行之前；

d.响应后处理方法，这个方法的调用时机在框架执行视图方法并生成response之后调用；

e.模型处理模块执行格式转化方法，该方法主要属于工具类，将JSON字符串转化java对象，或将java对象转化为字符串；

f.Http异常处理模块执行行异常后处理方法，在request处理过程中出了问题并且视图方法抛出了一个未捕获的异常时被调用；

请求预处理方法具体为基于OSGi的web界面框架系统向预处理函数传入相应的HttpRequest对象，process_request()返回None或HttpResponse对象，如果返回None，框架将继续处理这个request，执行后续的拦截器，然后调用相应的视图方法，如果返回HttpResponse对象，框架将不再执行任何其它的拦截器以及相应的视图方法，立即返回HttpResponse。

全局配置模块在settings.xml中定义了拦截器，到来一个Http请求，将被定义的拦截器处理一遍，如果链中某个处理器处理后没有返回response，就把请求传递给下一个处理器；如果链中某个处理器返回了response，直接跳出处理链，由response中间件处理后返回给客户端，如有异常，则跳入异常处理器。

Template的render方法的返回值是一个字符串，由Template中所有Nodes的render方法的返回值连接而成，调用顺序为Nodes出现在Template中的顺序。

本发明的有益效果是，(1)本发明提供了一种轻量级的基于OSGi的web界面框架系统，利于有效实现构件管理，方便程序开发人员的开发，开发人员通过继承相应接口，便可实现OSGi web构件的开发，并降低了开发成本；

(2)本发明的OSGi web框架，实现了OSGi与web服务交互，自动通过JSON与java对象相互转换，实现服务消息互换；

(3)通过本发明的OSGi web框架，可以实现OSGi构件快速开发、实现构件复用与扩展。

附图说明：

图1是本发明的基于OSGi的web界面框架系统图；

图2是本发明基于OSGi的web界面框架系统web业务处理流程图。

具体实施方式:

下面结合附图和实施例，对本发明的具体实施方式作进一步描述。

参见图1，本发明的基于OSGi的web界面框架系统包括：全局配置模块、地址映射模块、Http处理模块、模型处理模块、视图处理模块、模板(template)处理模块、模板引擎模块以及辅助模块。

全局配置模块负责整个框架全局性配置、数据库连接池配置、过滤器配置、国际化配置、模板文件位置路径配置等。

地址映射模块采用正则表达式将URL地址与视图方法对应，用户请求首先解析地址，进而找到对应的视图处理方式，进行逻辑调用与处理。在该模块OSGi web框架系统定义URL处理器，框架顺序处理每个URL模式，直到找到一个与请求URL的相匹配的模式为止。一旦匹配成功，框架导入并调用对应的视图方法，也就是相应的java类方法。

Http处理模块包括Http请求处理模块、Http响应处理模块及Http异常处理模块，是用于预处理或后处理请求对象与响应对象的模块，包括对Http请求、响应、异常处理，由Http处理器组成，它们基于java拦截机制技术实现。在Http请求处理模块，OSGi web界面框架系统定义若干请求处理拦截器，负责编码转化、数据格式转化，调用用户定义视图方法；在Http响应处理模块，OSGi web界面框架系统定义若干响应处理拦截器，负责完成数据与模板组装，并调用模板引擎处理；在Http异常处理模块，OSGi web界面框架系统定义若干异常处理拦截器，负责视图方法异常处理，并跳转用户定义友好错误界面。

模型处理模块为数据库数据与面向对象的数据一一对应和映射，是与数据处理相关的部分。

视图处理模块主要负责业务逻辑处理，是整个框架的核心，也是用户扩展的部分，通过地址映射模块找到对应的视图逻辑，然后通过视图逻辑调用相关的模板。在该模块，OSGi web界面框架系统定义了若干基类方法，开发人员可以编写视图类，用来继承框架提供的用户接口。视图类的方法必须实现相关post和get方法，这些方法接受参数为HttpRequest，返回对象为HttpResponse。

模板处理模块负责用户数据展示，模板是一个纯文本文件，一个模板可以包含区块标签和变量，在本系统中模板特指标准jsp页面、html页面，通过处理逻辑产生的数据渲染到相关页面，以一定的方式展示给用户，在该模块OSGi web界面框架系统定义了模板编排规则，框架根据响应，将模板上下文数据与模板名称交给Velocity模板引擎处理。

模版引擎是实现页面展现与数据内容分离的重要手段，让各类人员分工明确，使用页面设计人员与程序员分工协作。

辅助模块，很多公用的类与方法都归类于此，如进行url分析、处理请求、缓存、JSON与java数据对象转换等。

另外，开发人员为一个OSGi web程序设计URLs，用于在URL模式(简单的正则表达式)及java回调方法(用户开发views)之间建立映射。

开发基于OSGi的web界面框架系统一般方法为：

(1)新建OSGi web组件工程，自动生成默认OSGi web组件模板，包括URL.xml地址映射模板、settings.xml配置文件模板、模型模板、视图模板、静态文件。

(2)配置全局文件settings.xml，完成数据库连接池配置、国际化文件配置工作。

(3)模型定义，依据业务需求完成业务模型定义。

(4)视图定义，依据需求在视图控制层编写业务逻辑。

(5)展现层模板定义，根据需求完成模型内容在模板文件上展示。

(6)组件部署到OSGi容器中，进行测试与运行。

本发明采用了MVC的软件设计模式，即M，Model层，是数据访问层，处理与数据相关的操作，如如何存取、如何确认有效性，哪些行为用到哪些数据等等，用于处理业务逻辑；V，View层，决定系统显示什么以及如何显示内容，用于与用户进行交互；C，Controller层，是Model层与View层沟通的桥梁，通过View层接收的输入选择相应Model进行处理并再使用合理的View展示给用户。把所有部分拼起来是这样的，收到的Http请求被应用服务器转发给基于OSGi的web界面框架系统，基于OSGi的web界面框架系统根据URL映射模式匹配分派到适合的视图上去，视图会执行相关展现逻辑，用模型和模板按需生成响应，通过Http响应反馈给用户。为实现展示与内容分离，引入模版引擎技术来处理模版相关的操作的。通过模版引擎，可以使代码显得简洁，同时代码和逻辑分离使程序员协同工作时不会互相干涉，造成混乱。

参见图2，上述基于OSGi的web界面框架系统进行web业务处理的流程图，本发明的基于OSGi的web界面框架系统处理流程如下：

步骤1：OSGi开放服务网关通过Command类启动OSGi web界面框架，全局配置模块加载解析全局配置文件，并初始化，全局配置都在“settings.xml”中定义。

步骤2：地址映射模块根据url.xml进行地址与函数关系映射初始化。

步骤3：Http处理模块处理Request

当有Http请求来时，HttpHandler就开始工作了，它从BaseHandler继承而来。HttpHandler为每个请求创建一MyHttpRequest实例，而MyHttpRequest是从http.HttpRequest继承而来。

步骤4：Http处理模块创建Response

BaseHandler采用get_response方法根据request创建response。

步骤5：Http处理模块处理Response

框架返回Response内容返回给Web服务器，由后者返回给浏览器。

步骤6：Http处理模块生成response

具体的动作为执行urls.xml中对应的视图处理模块中的视图方法，每个视图方法都要返回一个Response实例。

步骤7：模板处理模块通过loader加载template并生成页面内容，并通过Model模型将视图渲染到模板，然后模板引擎模块将页面展现与数据内容分离，从而生成具体的页面，实现基于OSGi的Web界面框架的web业务处理，具体步骤如下，

(1)模板处理模块加载需要渲染的模板。这是由get_template方法完成的，它能利用这许多方法中的任意一个来定位需要的模板文件。get_template方法返回一个Template实例，其中包含经过解析的模板和用到的方法。

(2)实例化一个Context用来渲染模板。如果用的是Context的子类RequestContext，那么附带的上下文处理方法就会自动添加在视图中没有定义的变量。Context的构建器方法用一个键/值对的字典(对于模板，它将变为名/值变量)作为它唯一的参数，RequestContext则用HttpRequest的一个实例和一个字典。

(3)调用Template实例的render方法(具体说明)，Context对象作为第一个位置参数。Template的render方法的返回值是一个字符串，它由Template中所有Nodes的render方法返回的值连接而成，调用顺序为它们出现在Template中的顺序。

其中，处理流程主要用到的方法如下：

a.初始化方法:init()

出于性能的考虑，每个已启用的拦截器在每个服务器进程中只初始化一次。也就是说init()仅在服务进程启动的时候调用，而在针对单个request处理时并不执行。

对一个拦截器而言，定义init()方法的通常原因是检查自身的必要性。如果init()抛出异常InterceptorNotUsed，则框架将从拦截器链中移出该拦截器，拦截器通常采用单例模式。

b.请求预处理方法:process_request(request)

在界面框架接收到request之后，但仍未解析URL以确定应当运行的视图方法之前。框架向该预处理函数传入相应的HttpRequest对象，以便在方法中修改相应数据。process_request()应当返回None或HttpResponse对象。如果返回None，框架将继续处理这个request，执行后续的拦截器，然后调用相应的视图方法。如果返回HttpResponse对象，框架将不再执行任何其它的拦截器(无视其种类)以及相应的视图方法，框架将立即返回HttpResponse.

c.视图预处理方法:process_view(request,callback,callback_args,callback_kwargs)

这个方法的调用时机在框架执行完request预处理方法并确定待执行的视图方法之后，但在视图方法实际执行之前。其中，request代表HttpRequest对象。Callback是框架将调用的处理request的java方法。args将传入视图的位置参数列表，但不包括request参数，kwargs，将传入视图方法的关键字参数字典。

d.响应后处理方法:process_response(request,response)

这个方法的调用时机在框架执行视图方法并生成response之后。该拦截器能修改response的内容；一个常见的用途是内容压缩，如gzip所请求的HTML页面。这个方法的参数相当直观:request是request对象，而response则是从视图中返回的respons对象。process_response()必须返回HttpResponse对象。

e.格式转化方法:JSON_Java(json,object)

该方法主要属于工具类，将JSON字符串转化为Java对象，或将java对象转化为字符串。

f.异常后处理方法:process_exception(request,exception)

这个方法只有在request处理过程中出了问题并且视图方法抛出了一个未捕获的异常时才会被调用。这个钩子可以用来发送错误通知，将现场相关信息输出到日志文件,或者甚至尝试从错误中自动恢复。这个函数的参数除了request对象之外，还包括视图方法抛出的实际的异常对象exception。process_exception()应当返回Null或HttpResponse对象。如果返回Null，框架内置的异常处理机制继续处理相应request。如果返回HttpResponse对象，框架将使用该response对象，而短路框架内置的异常处理机制。

如图2框架处理web业务的流程图所示，拦截器需要在settings.xml INTECEPTOR_CLASSES中定义，到来一个Http请求，将被定义的拦截器处理一遍，如果链中某个处理器处理后没有返回response，就把请求传递给下一个处理器；如果链中某个处理器返回了response，直接跳出处理链由response中间件处理后返回给客户端，可以称之为短路处理，如有异常，则跳入异常处理器。

本发明提供了一种轻量级的基于OSGi的web界面框架系统，利于有效实现构件管理，方便程序开发人员的开发，开发人员通过继承相应接口，便可实现OSGi web构件的开发，并降低了开发成本；实现了OSGi与web服务交互，自动通过JSON与java对象相互转换，实现服务消息互换；还实现了OSGi构件快速开发、实现构件复用与扩展。

Claims (10)

1.一种基于OSGi的web界面框架系统，其特征在于，包括以下功能模块，全局配置模块、Http处理模块、地址映射模块、模型处理模块、视图处理模块、模板处理模块、模板引擎模块以及辅助类模块，其中所述Http处理模块包括Http请求处理模块、Http响应处理模块及Http异常处理模块； 

全局配置模块，用于数据库连接池配置、国际化文件配置、过滤器配置、模板文件路径的配置的解析与处理； 

地址映射模块，用于根据用户的请求解析地址，采用正则表达式将URL地址与视图方法对应，进行逻辑调用与处理； 

Http处理模块用于预处理或后处理请求对象与响应对象的模块，包括对Http请求、响应、异常处理； 

模型处理模块，用于数据处理，数据库数据与面向对象的数据一一对应和映射； 

视图处理模块，用于业务逻辑处理，是整个框架的核心，也是用户扩展的部分，通过地址映射模块找到对应的视图逻辑，然后通过视图逻辑调用的相关的模板； 

模板处理模块，用于用户数据展示，通过处理逻辑产生的数据渲染到相关页面，以一定的方式展示给用户，并定义了模板编排规 则； 

模板引擎模块，用于页面展现与数据内容分离； 

辅助模块，用于归类公用的类和方法。 

2.如权利要求1所述的一种基于OSGi的web界面框架系统，其特征在于，地址映射模块采用正则表达式将URL地址与视图方法对应，定义URL处理器。 

3.如权利要求1所述的一种基于OSGi的web界面框架系统，其特征在于，所述Http处理模块由Http处理器组成，基于java拦截机制技术实现；在Http请求处理模块，定义请求处理拦截器，负责编码转化、数据格式转化，调用用户定义视图方法；在Http响应处理模块，定义响应处理拦截器，负责完成数据与模板组装，并调用模板引擎处理；在Http异常处理模块，定义异常处理拦截器，负责视图方法异常处理，并跳转用户定义友好错误界面。 

4.如权利要求1所述的一种基于OSGi的web界面框架系统，其特征在于，在视图处理模块，定义了若干基类方法，开发人员编写视图类，用来继承框架提供的用户接口。 

5.如权利要求1所述的一种基于OSGi的web界面框架系统，其特征在于，在模板处理模块，定义了模板编排规则，模板为标准jsp页面和html页面。 

6.一种基于OSGi的web界面框架系统的Web业务处理方法，其特征在于，采用基于OSGi的web界面框架系统，包括以下功能模块：全局配置模块、地址映射模块、Http处理模块、模型处理模块、视图处理模块、模板处理模块、模板引擎模块以及辅助模块，其中所述Http处理模块包括Http请求处理模块、Http响应处理模块及Http异常处理模块； 

其Web业务处理方法，包括以下步骤： 

步骤1，OSGi开放服务网关通过Command类启动OSGi web界面框架，全局配置模块加载解析全局配置文件，并初始化，全局配置都在“settings.xml”中定义； 

步骤2，地址映射模块根据url.xml进行地址与函数关系映射初始化； 

步骤3，Http处理模块处理Request； 

当有Http请求来时，HttpHandler为每个请求创建一个MyHttpRequest实例，HttpHandler从BaseHandler继承而来，而MyHttpRequest是从http.HttpRequest继承而来； 

步骤4，Http处理模块创建Response； 

BaseHandler采用get_response方法根据request创建response； 

步骤5，Http处理模块处理Response； 

将返回的Response内容返回给Web服务器，由后者返回给浏览器； 

步骤6，Http处理模块生成Response； 

具体的方法为执行urls.xml中对应的视图处理模块中的视图方法，每个视图方法都返回一个Response实例； 

步骤7，模板处理模块通过loader加载template并生成页面内容，并通过Model模型将视图渲染到模板，然后模板引擎模块将页面展现与数据内容分离，从而生成具体的页面，实现基于OSGI的Web界面框架的web业务处理，具体步骤如下： 

7.1.模板处理模块根据get_template方法加载需要渲染的模板，get_template方法返回一个Template实例，其中包含经过解析的模板和用到的方法； 

7.2.实例化一个Context用来渲染模板； 

7.3.调用Template实例的render方法，Context对象作为第一个位置参数。 

7.如权利要求6所述的一种基于OSGi的web界面框架系统的Web业务处理方法，其特征在于，在进行Web业务处理时所用的方法如下： 

a.初始化方法，仅在服务进程启动的时候调用，而在针对单个 request处理时并不执行； 

b.请求预处理方法，在界面框架接收到request之后，但仍未解析URL以确定应当运行的视图方法之前调用； 

c.视图处理模块执行视图预处理方法，这个方法的调用时机在框架执行完request预处理方法并确定待执行的视图方法之后，但在视图方法实际执行之前； 

d.响应后处理方法，这个方法的调用时机在框架执行视图方法并生成response之后调用； 

e.模型处理模块执行格式转化方法，该方法主要属于工具类，将JSON字符串转化java对象，或将java对象转化为字符串； 

f.Http异常处理模块执行行异常后处理方法，在request处理过程中出了问题并且视图方法抛出了一个未捕获的异常时被调用。 

8.如权利要求7所述的一种基于OSGi的web界面框架系统的Web业务处理方法，其特征在于，所述请求预处理方法具体为基于OSGi的web界面框架系统向预处理函数传入相应的HttpRequest对象，process_request()返回None或HttpResponse对象，如果返回None，框架将继续处理这个request，执行后续的拦截器，然后调用相应的视图方法，如果返回HttpResponse对象，框架将不再执行任何其它的拦截器以及相应的视图方法，立即返回HttpResponse。 

9.如权利要求6所述的一种基于OSGi的web界面框架系统的Web业务处理方法，其特征在于，全局配置模块在settings.xml中定义了拦截器，到来一个Http请求，将被定义的拦截器处理一遍，如果链中某个处理器处理后没有返回response，就把请求传递给下一个处理器；如果链中某个处理器返回了response，直接跳出处理链，由response中间件处理后返回给客户端，如有异常，则跳入异常处理器。 

10.如权利要求6所述的一种基于OSGi的web界面框架系统的Web业务处理方法，其特征在于，Template的render方法的返回值是一个字符串，由Template中所有Nodes的render方法的返回值连接而成，调用顺序为Nodes出现在Template中的顺序。