WebX框架是阿里巴巴集团开发的,它建立在SpringEx的基础上,具有超强的扩展能力。
一、Webx的层次结构(从里到外)
(1)SpringExt:基于Spring,提供扩展组件的能力
(2)Webx Framework:基于Servlet API,提供基础服务
(3)Webx Turbine:基于Webx Framework,实现具体的网页功能
二、Webx的初始化
位置:/WEB-INF/web.xml文件
<!-- 装载/WEB-INF/webx.xml, /WEB-INF/webx-*.xml -->
<listener>
<listener-class>com.alibaba.citrus.webx.context.WebxContextLoaderListener</listener-class>
</listener>
结果:自动搜索/WEB-INF目录下的XML配置文件,并创建级联的Spring容器。
/WEB-INF/webx.xml->/WEB-INF/web-app1.xml->/WEB-INF/webx-app2.xml
三、初始化日志系统
添加方式:
初始化日志系统
<listener>
<listener-class>com.alibaba.citrus.logconfig.LogConfiguratorListener</listener-class>
</listener>
四、Webx响应请求
Webx响应请求的流程:
(1)WebxFrameworkFilter接收请求
(2)WebxRootController创建和处理request context,路由到子应用,并提供处理异常、开发模式功能。
(3)WebxController进行apps' pipeline
当一个HTTP请求到达时,WebxFrameworkFilter接收请求的模板配置(/WEB-INF/webx.xml)如下:
<filter>
<filter-name>webx</filter-name>
<filter-class>com.alibaba.citrus.webx.servlet.WebxFrameworkFilter</filter-class>
<init-param>
<param-name>excludes</param-name>
<param-value><!-- 需要被“排除”的URL路径,以逗号分隔,如/static, *.jpg。适合于映射静态页面、图片。 --></param-value>
</init-param>
<init-param>
<param-name>passthru</param-name>
<param-value><!-- 需要被“略过”的URL路径,以逗号分隔,如/myservlet, *.jsp。适用于映射servlet、filter。
对于passthru请求,webx的request-contexts服务、错误处理、开发模式等服务仍然可用。 --></param-value>
</init-param>
</filter>
为什么使用filter而不是servlet?如果webx发现某个请求不应该由webx来处理,就会把控制“返还”给原来的控制器,而Servlet不具备“返还控制”的机制。
RequestContext对象的标准模板如下:
<!-- 设置request/response/session。 -->
<services:request-contexts>
<request-contexts:basic />
<request-contexts:buffered />
<request-contexts:lazy-commit />
<request-contexts:parser />
<request-contexts:set-locale defaultLocale="zh_CN" defaultCharset="UTF-8" />
<request-contexts:session>
<id>
<cookie path="/" maxAge="0" httpOnly="true" />
</id>
<stores>
<session-stores:cookie-store id="temporaryCookie">
<cookie name="tmp" />
</session-stores:cookie-store>
</stores>
<store-mappings>
<match name="*" store="temporaryCookie" />
</store-mappings>
</request-contexts:session>
</services:request-contexts>
五、Webx Turbine
它的基本准则是:约定胜于配置,即:工程师只需要根据一定的规则,将模板放在指定的目录、按照预定的方式命令module(也就是screen、action、control等),就不再需要额外的配置。
Turbine的基本页面组成为:
(1)Screen:代表页面的主体
(2)Layout:代表页面的布局
(3)Control:代表嵌在screen和layout中的页面片段
页面布局图如下:
六、Webx Turbine处理页面的基本流程
Webx Turbine的处理流程被定义在pipeline中,pipeline推荐的配置如下:
<?xml version="1.0" encoding="UTF-8"?>
<beans:beans xmlns:beans="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:p="http://www.springframework.org/schema/p"
xmlns:services="http://www.alibaba.com/schema/services"
xmlns:pl-conditions="http://www.alibaba.com/schema/services/pipeline/conditions"
xmlns:pl-valves="http://www.alibaba.com/schema/services/pipeline/valves"
xsi:schemaLocation="
http://www.alibaba.com/schema/services http://localhost:8080/schema/services.xsd
http://www.alibaba.com/schema/services/pipeline/conditions http://localhost:8080/schema/services-pipeline-conditions.xsd
http://www.alibaba.com/schema/services/pipeline/valves http://localhost:8080/schema/services-pipeline-valves.xsd
http://www.springframework.org/schema/beans http://localhost:8080/schema/www.springframework.org/schema/beans/spring-beans.xsd
">
<services:pipeline>
<!-- 初始化turbine rundata,并在pipelineContext中设置可能会用到的对象(如rundata、utils),以便valve取得。 -->
<pl-valves:prepareForTurbine />
<!-- 设置日志系统的上下文,支持把当前请求的详情打印在日志中。 -->
<pl-valves:setLoggingContext />
<!-- 分析URL,取得target。 -->
<pl-valves:analyzeURL />
<!-- 检查csrf token,防止csrf攻击和重复提交。假如request和session中的token不匹配,则出错,或显示expired页面。 -->
<pl-valves:checkCsrfToken />
<pl-valves:loop>
<pl-valves:choose>
<when>
<!-- 执行带模板的screen,默认有layout。 -->
<pl-conditions:target-extension-condition extension="null" />
<pl-valves:performAction />
<pl-valves:performTemplateScreen />
<pl-valves:renderTemplate />
</when>
<when>
<!-- 执行不带模板的screen,无layout。 -->
<pl-conditions:target-extension-condition extension="do" />
<pl-valves:performAction />
<pl-valves:performScreen />
</when>
<when>
<!-- 创建JSON,无模板,无layout。 -->
<pl-conditions:target-extension-condition extension="json" />
<pl-valves:performScreen />
<pl-valves:renderResultAsJson />
</when>
<otherwise>
<!-- 将控制交还给servlet engine。 -->
<pl-valves:exit />
</otherwise>
</pl-valves:choose>
<!-- 假如rundata.setRedirectTarget()被设置,则循环,否则退出循环。 -->
<pl-valves:breakUnlessTargetRedirected />
</pl-valves:loop>
</services:pipeline>
</beans:beans>
流程具体解读如下:
(1) 分析URL::用户访问的主页target
(2) 进入choose,进行多重分支选择
(3)performAction执行action
(4) performTemplateScreen查找并执行screen
假设target为xxx/yyy/zzz,那么Webx Turbine查找screen模块的顺序为:
Screen.xxx.yyy.zzz
Screen.xxx.yyy.Default
Screen.xxx.Default
Screen.Default
(5) 渲染模板
首先映射成screen template,以及映射成layout template
假设target为xxx/yyy/zzz,那么Webx Turbine会查找下面的screen模板:/templates/screen/xxx/yyy/zzz。Screen模板如果未找到,就会报404 Not Found错误。 找到screen模板以后,Webx Turbine还会试着查找下面的layout模板:
/templates/layout/xxx/yyy/zzz
/templates/layout/xxx/yyy/default
/templates/layout/xxx/default
/templates/layout/default
Layout模板如果找不到,就直接渲染screen模板;如果存在,则把渲染screen模板后的结果嵌入到layout模板中。
七、Filter的用途
页面授权:根据登录用户的权限,阻止或许可用户访问特定的页面。
日志和审计:记录和检查用户访问WEB应用的情况。
图片转换:改变图片的格式、精度、尺寸等。
页面压缩:压缩页面内容,加快下载速度。
本地化:显示本地语言和风格的页面。
XSLT转换:对XML内容进行XSLT转换,使之适用于多种客户端。
高速缓存:高速缓存页面,提高响应速度。
Webx提供了Request Contexts服务以及Pipeline作为对Filter功能缺陷的补充,作用分别如下:
(1) Request Contexts:负责访问和修改request和response,但不负责改变应用执行的流程
(2) Pipeline:提供应用执行的流程,但不关心和request和response
八、Spring中依赖注入的限制
小作用域的对象不能被注入到大作用域的对象。你不能把request和response作用域的对象注入到singleton对象中。前者在每次WEB请求时,均会创建新的实例,每个线程独享这个request/session作用域的对象;后者是在Spring初始化或第一次使用时被创建,然后被所有的线程共享。假如把某个request/session作用域的对象意外注入到singleton对象中,将可能产生致命的应用错误,甚至导致数据库的错乱。
在Webx中,这样做是可以的!奥秘在于Request Contexts服务对上表所列的这些短期对象作了特殊的处理,使它们可以被注入到singleton对象中。事实上,被注入的只是一个“空壳”,真正的对象是在被访问到的时候才会从线程中取得的。
九、buffered缓存response中内存的实现原理
Webx支持用layout/screen/control等部件共同构成一个页面。其中,每个layout可包含一个screen和多个control,每个screen可包含多个control,每个control还可以在包含其他的control。
一般页面比如通过out.println("
hello world
");就直接输出了,为了还能分开然后再一起显示呢。例如,一个screen中包含了一个control,那么screen可以获得它所调用的control的完整的渲染内容。
这个玄机就是靠来实现的。改变了response的输出流,包括output stream和writer,使写到输出流中的内容被暂存在内存中。当需要时,可以取得缓存中的所有内容。
Buffered机制会延迟服务器对用户的响应,所以某些场景需要关闭该服务。
十、表单验证的模板
该文件form.xml位于WEB-INF的每个子目录中,用于表单的验证
<?xml version="1.0" encoding="UTF-8"?>
<beans:beans xmlns:beans="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:p="http://www.springframework.org/schema/p"
xmlns:services="http://www.alibaba.com/schema/services"
xmlns:fm-conditions="http://www.alibaba.com/schema/services/form/conditions"
xmlns:fm-validators="http://www.alibaba.com/schema/services/form/validators"
xsi:schemaLocation="
http://www.alibaba.com/schema/services http://localhost:8080/schema/services.xsd
http://www.alibaba.com/schema/services/form/conditions http://localhost:8080/schema/services-form-conditions.xsd
http://www.alibaba.com/schema/services/form/validators http://localhost:8080/schema/services-form-validators.xsd
http://www.springframework.org/schema/beans http://localhost:8080/schema/www.springframework.org/schema/beans/spring-beans.xsd
">
<services:form postOnlyByDefault="true">
<!--
- ===============================================
- 用来检查csrf token。
- ===============================================
-->
<group name="csrfCheck">
<field name="csrfToken">
<fm-validators:csrf-validator>
<message>提交的数据已过期</message>
</fm-validators:csrf-validator>
</field>
</group>
<!--
- ===============================================
- Simple form
- ===============================================
-->
<group name="register" extends="csrfCheck">
<field name="name" displayName="你的名字">
<fm-validators:required-validator>
<message>必须填写 ${displayName}</message>
</fm-validators:required-validator>
</field>
</group>
</services:form>
</beans:beans>
十一、Eclipse中开发Webx应用
(1)Webx工程目录结构
src\main:存放开发代码
src\test:存放开发自测代码,如单元测试代码
main\java:存放java代码
main\resources:存放资源定义文件
main\webapp:web应用配置文件
webapp目录包含(举例):
1)子应用模板目录admin、home、store、user,每个模板目录又由layout、control、screen三个子目录组成,包含对应的模板文件(.vm文件)
2)通用模板目录common
3)WEB-INF目录
这是java web应用必备的配置目录,包含了web.xml(java web应用必备的配置文件)、webx.xml(webx配置文件)、日志配置文件(log4j.xml、logback.xml)、子应用配置文件(webx-admin.xml、webx-home.xml、webx-store.xml、webx-user.xml);另外还有对应每个子应用的文件夹,用于存放form定义文件(form.xml)和访问权限定义文件(access.xml);common文件夹中的pipeline.xml和pipeline-exception.xml定义了相关的管道操作流程。
(2)页面获取JAVA层的数据PullTool
在velocity模板中使用pulltool方便我们进行页面输出内容的控制,组织页面的展示,或者是直接取得web层相关的一些对象,直接在vm中调用。由页面拉动业务逻辑,获取并控制需要展示的内容,而非应用程序推动push,这符合webx的页面驱动的模式。
1)是否启动pull服务:
在webx.xml文件中进行总的控制
2)指定获取数据的JAVA处理模块
指定了获取的数据位于com.xx.web.ui.module.*
3)在/xx/templates/screen下创建testMain.vm(M需要大写)文件,内容如下:
4)在/src/main/java/com/web/ui/module/screen下创建文件TestMain.java(webx会自动匹配同名的文件),内容如下:
package com.yunos.tv.openbase.web.ui.module.screen;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import com.alibaba.citrus.turbine.Context;
public class TestMain {
public void execute(HttpServletRequest request, HttpServletResponse response, Context context) throws Exception{
context.put("name", "Hugh");
}
}
execute方法就是专门用来处理对应请求的,是webx潜规则的地方,它是页面渲染之前处理的方法。
有些参数为:public void execute(@Param("systemVersion") String systemVersion,HttpServletRequest request, HttpServletResponse response, Context context, Navigator nav),说明如下:第一个参数为传进来的信息,context对象负责页面渲染时部分数据的修改。
(2)实现form表单功能
实现用户账号登陆的功能,如果用户不输入则提示用户输入相关信息,效果如下:
其具体代码如下:
login.vm文件:
关键点说明如下:
这表示提交之后执行的是LoginAction.java,这里的value值login_action在程序内部会被处理成 LoginAction,因此这里如果写成value="LoginAction",结果是一样的
这里提交后表示执行的方法是doUserInfoSumbit方法,如果你要执行其他方法请修改name值name="event_submit_你的方法"
3.关联form.xml:首先 #set ($group = $form.loginInfoGroup.defaultInstance)[固定写法,loginInfoGroup对应form.xml中的services:group name="loginInfoGroup"],然后
name对应到form.xml中的规则,group.username.message就是需要显示的错误信息。
4.$csrfToken.hiddenField是必须要添加的,防止跨站请求伪造攻击。如果不添加的话,数据是不会从显示层传送给JAVA层的。
(3)实现form表单往JAVA层传送数据功能
1、构造与表单对应的类LoginInfo:
package com.yunos.tv.openbase.biz.dataobject;
public class LoginInfo {
private String username;
private String password;
public String getUsername() {
return username;
}
public void setUsername(String username) {
this.username = username;
}
public String getPassword() {
return password;
}
public void setPassword(String password) {
this.password = password;
}
}
、1q 其中username和password的值需要和form.xml中定义的保持一致,否则两者无法建立联系。
(2) 2.编辑业务功能LoginAction.java:
import com.alibaba.citrus.turbine.dataresolver.FormGroup;
import com.yunos.tv.openbase.biz.dataobject.LoginInfo;
public class LoginAction {
public void doUserInfoSumbit(@FormGroup("loginInfoGroup")LoginInfo userLoginInfo, HttpServletResponse response, Context context, Navigator nav) throws Exception{
System.out.println("hello");
System.out.println(userLoginInfo.getUsername());
3.
3.如果数据模型LoginInfo和LoginAction不在同一个工程中,则LoginAction应该探测不到LoginInfo.class,需要LoginInfo先编译生成class文件,然后LoginAction才可以使用LoginInfo类。在LoginInfo所在的工程使用mvn clean install命令重新进行编译,然后在LoginAction刷新下引入该类。