Webx MVC分析

  1. 云栖社区>
  2. 博客>
  3. 正文

Webx MVC分析

技术小阿哥 2017-11-14 22:11:00 浏览1017
展开阅读全文

Webx框架:http://openwebx.org/

petstore:webx3/webx-sample/petstore/tags/3.0/petstore
编译之后:mvn jetty:run即可, 访问:http://localhost:8081/ 

Webx MVC(以webx3为基础)

1、webx3的入口点


  1. <filter> 
  2.        <filter-name>webx</filter-name> 
  3.        <filter-class>com.alibaba.citrus.webx.servlet.WebxFrameworkFilter</filter-class> 
  4.    </filter> 
  5.    <filter-mapping> 
  6.        <filter-name>webx</filter-name> 
  7.        <url-pattern>/*</url-pattern> 
  8.    </filter-mapping> 

 webx.xml:每个webx应用,都需要有一个webx.xml配置文件。这个文件定义了Webx所用到的所有services的配置。

pipeline.xml:即管道,它是由一个或多个“阀门Valve”构成的。可以看做webx框架的总控文件。

log4j.xml:日志系统配置文件。对于程序的排错至关重要。 

典型的webx.xml配置:


  1. <?xml version="1.0" encoding="UTF-8" ?> 
  2. <!-- Webx Root Context Configuration.  --> 
  3. <beans:beans xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
  4.     xmlns:services="http://www.alibaba.com/schema/services" 
  5.     xmlns:request-contexts="http://www.alibaba.com/schema/services/request-contexts" 
  6.     xmlns:session-encoders="http://www.alibaba.com/schema/services/request-contexts/session/encoders" 
  7.     xmlns:model-encoders="http://www.alibaba.com/schema/services/request-contexts/session/model-encoders" 
  8.     xmlns:session-idgens="http://www.alibaba.com/schema/services/request-contexts/session/idgens" 
  9.     xmlns:session-stores="http://www.alibaba.com/schema/services/request-contexts/session/stores" 
  10.     xmlns:ml-adapters="http://www.alibaba.com/schema/services/module-loader/adapters" 
  11.     xmlns:ml-factories="http://www.alibaba.com/schema/services/module-loader/factories" 
  12.     xmlns:beans="http://www.springframework.org/schema/beans" 
  13.     xmlns:p="http://www.springframework.org/schema/p" 
  14.     xsi:schemaLocation=" 
  15.         http://www.alibaba.com/schema/services http://localhost:8080/schema/services.xsd 
  16.         http://www.alibaba.com/schema/services/request-contexts http://localhost:8080/schema/services-request-contexts.xsd 
  17.         http://www.alibaba.com/schema/services/request-contexts/session/encoders http://localhost:8080/schema/services-request-contexts-session-encoders.xsd 
  18.         http://www.alibaba.com/schema/services/request-contexts/session/idgens http://localhost:8080/schema/services-request-contexts-session-idgens.xsd 
  19.         http://www.alibaba.com/schema/services/request-contexts/session/stores http://localhost:8080/schema/services-request-contexts-session-stores.xsd 
  20.         http://www.alibaba.com/schema/services/request-contexts/session/model-encoders http://localhost:8080/schema/services-request-contexts-session-model-encoders.xsd 
  21.         http://www.alibaba.com/schema/services/module-loader/adapters http://localhost:8080/schema/services-module-loader-adapters.xsd 
  22.         http://www.alibaba.com/schema/services/module-loader/factories http://localhost:8080/schema/services-module-loader-factories.xsd 
  23.         http://www.springframework.org/schema/beans http://localhost:8080/schema/www.springframework.org/schema/beans/spring-beans.xsd 
  24.     "> 
  25.  
  26.     <!-- 支持${xxx}替换。 --> 
  27.     <services:property-placeholder> 
  28.         <services:property key="component">common</services:property> 
  29.     </services:property-placeholder> 
  30.  
  31.     <!-- 共享配置。 --> 
  32.     <beans:import resource="common/webx-component-and-root.xml" /> 
  33.  
  34.     <!-- 异常管道。 --> 
  35.     <beans:import resource="common/pipeline-exception.xml" /> 
  36.  
  37.     <!-- 资源装载。 --> 
  38.     <beans:import resource="common/resources.xml" /> 
  39.  
  40.     <!-- URI生成。 --> 
  41.     <beans:import resource="common/uris.xml" /> 
  42.  
  43.     <!-- 综合设置。 --> 
  44.     <services:webx-configuration> 
  45.         <!-- 默认将productionMode设为true,建议在jetty插件中设置-DproductionMode=false。 --> 
  46.         <services:productionMode>${productionMode:true}</services:productionMode> 
  47.         <services:components defaultComponent="app1" /> 
  48.     </services:webx-configuration> 
  49.  
  50.     <!-- 设置request/response/session。 --> 
  51.     <services:request-contexts xmlns="http://www.alibaba.com/schema/services/request-contexts"> 
  52.         <basic /> 
  53.         <buffered /> 
  54.         <lazy-commit /> 
  55.         <parser /> 
  56.         <set-locale defaultLocale="zh_CN" defaultCharset="UTF-8" /> 
  57.         <session> 
  58.             <id> 
  59.                 <cookie path="/" maxAge="0" httpOnly="true" /> 
  60.             </id> 
  61.             <stores> 
  62.                 <session-stores:cookie-store id="temporaryCookie"> 
  63.                     <session-stores:cookie name="tmp" /> 
  64.                 </session-stores:cookie-store> 
  65.             </stores> 
  66.             <store-mappings> 
  67.                 <match name="*" store="temporaryCookie" /> 
  68.             </store-mappings> 
  69.         </session> 
  70.     </services:request-contexts> 
  71.  
  72.     <!-- 支持上传文件。 --> 
  73.     <services:upload sizeMax="5M" /> 
  74.  
  75.     <!-- 将beans暴露给模板。这里定义的tools可被所有components之间共享。 --> 
  76.     <services:pull xmlns="http://www.alibaba.com/schema/services/pull/factories"> 
  77.         <utils /> 
  78.         <page-tool /> 
  79.         <control-tool /> 
  80.         <uris-tool /> 
  81.     </services:pull> 
  82.  
  83.     <!-- 装载模块。 --> 
  84.     <services:module-loader> 
  85.         <ml-factories:class-modules> 
  86.             <ml-factories:search-packages type="$1" packages="com.alibaba.webx.tutorial1.common.module.*" /> 
  87.         </ml-factories:class-modules> 
  88.     </services:module-loader> 
  89.  
  90. </beans:beans> 

2、前端分析

所有和前台展示有关的文件,即模板,放在templates目录下,vm后缀的为Velocity的模板

2

对应的java代码

3

src/main/java/…/module。

Modules是基本编程模块:包括screen,control,action

    Screen — 用来处理页面显示逻辑的module,主要功能就是显示一个页面

    Control — 和screen类似,但可以被别的screen或layout引用,甚至可以跨越car应用

    Action — 处理用户提交表单的module

Webx的页面布局以screen为主导,通过screen来查找其余的页面元素,然后通过一系列查找规则来查找页面元素Screen和control都可以有java类来驱动,但不是必须的,也就是说可以先写模板,后写类 ,也可以只写模板,不用构造对应类。

页面布局如下:

 

• Screen,代表页面的主体。

• Layout,代表页面的布局。

• Control,代表嵌在screen和layout中的页面片段。
3、Webx执行的流程 

可参考:http://qa.taobao.com/?p=7830,http://qa.taobao.com/?p=7604

用户输入URL
http://localhost:7001/petstore/user/login.htm

      1)petstore称为Context Path。服务器把这个请求交给petstore应用来接管。

      2) login.htm称为Servlet Path。在web.xml中把*.htm映射到Webx Controller Servlet,所以Webx Controller Servlet就接管了这个请求。

      3) Webx Controller Servlet激活pipeline,继而调用AnalyzeURLValve来分析/ login.htm是什么意思。根据webx默认的映射规则,/ login.htm被转换成/ login.vm。

分析URL取得target
/login.vm
根据target查找screen模板:
/screen/login.vm
根据target查找screen模块的类:
com.alibaba.sample.petstore.web.user.module.screen.Login(找不到该类)
com.alibaba.sample.petstore.web.user.module.screen.Default(找不到该类)
com.alibaba.turbine.module.screen.TemplateScreen(默认screen类)
执行screen类,并渲染screen模板
根据target查找layout模板:
/layout/login.vm(找不到)
/layout/default.vm(找到)
渲染layout模板
渲染在layout模板中引用的两个control
home:top.vm à home.car中查找/control/top.vm
home:bottom.vm à home.car中查找/control/bottom.vm

4、配置文件分析

参考:http://qa.taobao.com/?p=12800

(1)Webx2 PoolToll

     在velocity模板中经常使用到pulltool,这是一些工具类,方便我们进行页面输出内容的控制,组织页面的展示,或者是直接取得web层相关的 一些对象,直接在vm中调用。pull在概念上可以形象的理解为"拉动",是由页面拉动业务逻辑,获取并控制需要展示的内容,而非应用程序推动 (push),这非常符合webx的页面驱动的模式。在页面进行渲染时,pulltool对象已被预先创建好,并被放入TemplateContext 中,在渲染页面时被调用并输出所需要的内容。      pulltool是由PullService管理的,PullService将pulltool纳入了Service框架的范畴进行管理,理论上我们可以 将任意组件封装为一个pulltool,或者将任意代码逻辑封装在一个pulltool中,只要实现PullTool接口,这个类便可以被 PullService管理起来进而可以在vm模板中直接使用,或者说,pulltool就是一些被PullService管理的组件,这些组件帮助我们控制页面上的内容。pulltool一般都会继承一个抽象类PullToolSupport,这个类方便对PullTool进行配置与调用,它包含了一些 与PullTool的配置与初始化有关的逻辑,它的子类只需要专注于自己需要对外提供的方法即可。而PullService提供了一个自动组装 TemplateContext的机制,通过这个机制,PullTool被put进TemplateContext,可以在模板中被直接使用。     PullTool 有四种不同的作用范围,

  • Global - 全局作用域,此作用域内的tool仅在service被初始化时被创建一次,以后不再改变
  • Request - 请求作用域,此作用域内的tool在每个用户请求到达时被创建
  • Session - 会话作用域,此作用域内的tool在会话的第一个请求到达时被创建,在整个会话期间不再改变
  • Authorized - 验证用户作用域,此作用域内的tool在用户被验证之后创建,随用户的登出而消失
             不同的作用域范围代表了pulltool的生效范围,global作用域的PullTool被放入一个全局的TemplateContext中(这个 Template的上下文只在PullService被初始化的时候被创建,只被创建这一次,作为全局的TemplateContext来使用),其他作 用域的PullTool都是在用户请求之后创建的TemplateContext中有效,而每一个显示组件,如screens和controls,都将继 承上述作用域中的tools,但不会相互覆盖,即依旧在各自的作用域中生效。当screen等显示组件所对应的模板被渲染时,调用pulltool的地方 就能够被调用了。
    PullTool在Webx.xml文件中进行配置,将需要使用的pulltool作为PullService的property,它们会作为PullService的Configuration被读取。以下是一般项目中常用到的一些pulltool的配置
                

  1. <service name="PullService" class="com.alibaba.service.pull.DefaultPullService"> 
  2.           <property name="tool.global"> 
  3.                <property name="util" value="com.alibaba.service.pull.LangToolSet"/> 
  4.                <property name="viewTool" value="com.alibaba.intl.web.webx.pull.IntlViewPullTool"/>  
  5.                <property name="constantTool" value="com.alibaba.turbine.util.template.ConstantTool"/> 
  6.           </property> 
  7.           <property name="tool.request"> 
  8.               <property name="rundata" value="com.alibaba.turbine.util.template.RunDataTool"/> 
  9.               <property name="page" value="com.alibaba.turbine.util.template.HtmlPageAttributeTool"/> 
  10.               <property name="control" value="com.alibaba.turbine.util.template.ControlTool"/> 
  11.               <property name="uri" value="com.alibaba.service.uribroker.URIBrokerTool"/> 
  12.               <property name="form" value="com.alibaba.service.form.FormTool"/> 
  13.               <property name="webuser" value="com.alibaba.intl.web.webx.pull.WebUserPullTool"/> 
  14.           </property> 
  15.       </service> 
全局作用域的pulltool
  • $util,实现类是LangToolSet,它是一个pulltool的集合,包含了com.alibaba.lang包下的一系列基本工具类,如StreamUtil,StringEscapeUtil,StringUtil,ArrayUtil等,这些工具在vm模板里可利用对应的变量名称调用,由于pulltool主要用来控制页面显示内容的,最常用的要数StringEscapeUtil,StringUtil。
    • StringUtil包含对字符串的处理函数,似乎跟字符串判断与字符串比较有关的功能这里都有了,在vm里通过$stringUtil变量调用需要的方法就可以啦。
    • StringEscapeUtil,这个类的用途更大,它可以方便的将字符串转换成适应Java、JavaScript、HTML、XML、SQL、URL语句的形式,当然,在模板里调用,对于HTML、JavaScript及URL的转义肯定是最常见的了。
      • 对于页面上要输出的值,一般都需要进行html转义,以防止要展示的字符串中包含html标签或JavaScript脚本,使得显示格式出错甚至是存在攻击脚本。使用$stringEscapeUtil.escapeHtml($变量名)即可调用相应转义方法。
      • StringEscapeUtil类还包含了反向转义的功能,即将转义后的字符串还原为原来的形式,
      • StringEscapeUtil类提供了URL转义的功能,将字符串按URL编码规则转换为相应格式,即将一些字符转换为%XX的形式,如空格转换为%20。当然也有反向转义的功能,对URL进行解码。在进行URL编解码时,需要注意所使用的编码集,用不同的编码集编解码可能会得到不同的输出结果。在使用escapeURL()方法时可以指定编码集。
  • $viewTool,实现类是IntlViewPullTool,包含了很多国际站页面输出时常用的方法,方便国际站工程师在页面上直接调用,避免重复开发,节省工作量。包括的方法有以下几类
    • 输出值格式化,如formatDate(),formatInt(),getAdjustedString(),截取输出值的一部分显示,还有控制html转义与输出的一些方法。
    • 业务逻辑相关的格式化,getCountryTimeZone(),encryptForAlitalk()等,为了解决一些常见的展示需求,在页面直接使用,方便快捷。
  • 一些很通用的页面输出的控制逻辑,都可以抽取出来作为pulltool工具来使用,提高开发效率。
request作用域的pulltool,在用户提交请求时创建,可以用来直接在vm中使用请求相关的一些对象
  • $page
  • $control
  • $rundata
  • $webuser  

(2)Webx3 pooltool

pullTool的配置

Webx3 PullTool的配置形式上发生了改变、采用的是Spring Xml Schema的配置方式、例子如下:
<services:pull xmlns="http://www.alibaba.com/schema/services/pull/factories">
<!- Webx3 tools。 ->
<utils />
<rundata-tool />
<csrfToken />
<form-tool />
<control-tool />
<uris-tool />
<!- Petstore tools。 ->
<webx2-tool id="bundle"
class="com.alibaba.sample.petstore.web.common.util.ResourceBundleTool" scope="global" />

<webx2-tool id="petstoreUser"
class="com.alibaba.sample.petstore.web.common.util.PetstoreUserTool" scope="request" />
</services:pull>

Webx3对PullTool的配置进行了简化和封装、但是如果缺少文档的话、上面的有些配置可能就不那么容易理解
比如: <utils /> 这个标签其实表示的是开发者可以直接在Vm中使用com.alibaba.common.lang包下的一些工具类:
如ArrayUtil、StringUtil、SystemUtil等

其他的几个标签相对容易理解、如:rundata-tool代表$rundata、csrfToken代表$csrfToken、uris-tool表示的是UriBrokerTool、
可以在Vm使用Uribroker、另外webx2-tool标签表示的是使用Web3的兼容模式集成Web2下自定义的PullTool,scope属性表示的是
PullTool的作用级别

webx3下如何自定义一个PullTool

Webx3下自定义或扩展一个PullTool要比Webx2容易且有多种方法:

1、实现ToolFactory、或者ToolSetFactory接口、实现了后者可以创建一组pullTool
代码示例:

接下来只要将该类配置一下即可使用
<factory id="sampleTool" class="com.alibaba.citrus.service.pull.tool.SampleTool" />

2、采用Webx3提供的BeanTool
BeanTool是可以用于创建一个简单bean的tool factory
你可以将一个工具类或者简单的Spring容器的Bean只需通过简单的配置就可以成为一个PullTool,
BeanTool内部使用AutowireCapableBeanFactory的initializeBean方法将指定的Class动态初始化一个
Bean并注入到Spring容器中、同时该Bean可以作为一个PullTool使用:

配置如下:
<bean-tool id="sampleTool"
class="com.alibaba.citrus.service.pull.tool.SampleTool"
scope="global" />

这种方式的好处:
1你可以方便的将已有的一个工具类配置一下就可以变成PullTool而不需要专门实现任何接口、去除了对原有类的不必要侵入,
2可以将Spring容器的一个Bean作为PullTool使用 

(3)webx3中webx.xml中request context配置 


  1. <services:request-contexts xmlns="http://www.alibaba.com/schema/services/request-contexts"> 
  2.        <basic /> 
  3.        <buffered /> 
  4.        <lazy-commit /> 
  5.        <parser /> 
  6.        <set-locale defaultLocale="zh_CN" defaultCharset="UTF-8" /> 
  7.        <session> 
  8.            <id> 
  9.                <cookie path="/" maxAge="0" httpOnly="true" /> 
  10.            </id> 
  11.            <stores> 
  12.                <session-stores:cookie-store id="temporaryCookie"> 
  13.                    <session-stores:cookie name="tmp" /> 
  14.                </session-stores:cookie-store> 
  15.            </stores> 
  16.            <store-mappings> 
  17.                <match name="*" store="temporaryCookie" /> 
  18.            </store-mappings> 
  19.        </session> 
  20.    </services:request-contexts> 

 


本文转自 tianya23 51CTO博客,原文链接:http://blog.51cto.com/tianya23/683848,如需转载请自行联系原作者

网友评论

登录后评论
0/500
评论