Object Graph Navigation Language,是一门功能强大的表达式语言,类似于EL。
OGNL表达式功能很强大,后面我们会重点阐述。而Struts2默认采用OGNL表达式访问Action的数据,实际上是通过ValueStack用封装后的OGNL来访问的Action。
OGNL是独立的开源组件,Struts2对其进行了改造及封装,要想了解Struts2中OGNL的运行原理,需参考ValueStack。
Struts2中,OGNL表达式要结合Struts2标签来访问数据,即OGNL表达式要写在Struts2标签内,因此我们先来介绍第一个Struts2的标签——显示标签。
1、语法
<s:property value="OGNL"/>
2、解释
该标签的作用是根据OGNL表达式访问Action,并将取出的数据替换标签本身。如下图,实际上该标签类似于EL表达式中的${ }。
图-1
OGNL表达式一共有8种使用方法,其中前2种要求大家必须掌握,是经常要用到的方式,后6种了解即可,下面我们来介绍这2种必须掌握的OGNL。
1、访问基本属性
2、访问实体对象
可以看出,这两种访问Action的方式实际上与EL表达式用法完全一致,是最常用的,也是最容易掌握的2种方式。
ValueStack是Struts2中,Action向页面传递数据的媒介,ValueStack封装了Action的数据,并允许JSP通过OGNL来对其进行访问。
如下图,Struts2使用了ValueStack对OGNL组件进行了封装,其封装的实际上是改造后的OGNL,当然我们不关注改造的过程,只需要掌握改造后的OGNL在ValueStack中的运行原理即可。
ValueStack中首先封装了OGNL解析引擎,用于解析传入的OGNL表达式,其目的就是在页面上以标签+字符串的方式访问Java对象,从而降低了页面代码的开发难度,提升了页面代码的维护效率,而OGNL表达式传入引擎的时机我们在后面的Action基本原理中会讲到。
OGNL引擎可以访问2种类型的对象,一种是栈类型,另一种是Map类型。
1、栈
2、Map
总体来说,由于context对象中的数据固定了,因此对context对象的访问比较简单和直接。而栈中数据是会有所变化的,并且访问时也是自顶向下动态访问的,因此我们在学习ValueStack时要重点关注栈的结构和变化。
图-2
ValueStack的原理是比较抽象的,对于其结构的理解也不够直观。对于这种情况,Struts2提供了一个调试标签,可以用于观察ValueStack的结构,该标签的效果如下图。
图-3
可以看出,该标签会在页面上生成一个debug链接,点击后会展开ValueStack的结构描述内容,其中包括栈的结构及数据、context对象的结构及数据。
该标签的语法比较简单,即<s:debug/>。其作用仅仅是用于调试的,是给开发人员来使用的,当项目提交测试以及上线时,要删除该标记。
值得注意的是,该标签存在互斥性,在页面上如果写多个调试标签,实际上只有第一个是准确的,其他的标签内容有问题。但鉴于该标签仅仅是给开发人员调试使用的,因此我们在了解这个规则的前提下,只要保持页面上只有一个调试标签即可正常使用。
前面我们介绍了Struts2的显示标签,即<s:property value="OGNL"/>。这个标签有一种特殊的用法,可以直接输出栈顶的内容,语法为<s:property />。
也就是说,将显示标签的value属性去掉,那么该标签将默认输出栈顶的内容。
Context对象是一个Map类型的对象,我们使用OGNL访问它的方式是固定的,即#key,返回的值是当前key在Map中对应的值。
我们可以使用Struts2的迭代标签结合着OGNL,来迭代Action中的集合属性,迭代集合标签的语法如下:
<s:iterator value="users"> <s:property value="userName"/> </s:iterator>
users是OGNL表达式,自顶向下访问ValueStack栈中root对象的users属性,这里会从栈顶的Action对象取到该集合属性(List<User> users)值 。
需要注意的是,在迭代的过程中,ValueStack的栈顶会发生变化,循环变量User会被压入栈顶,此时Action被压到栈的第二位,即栈顶由由原来的Action变为循环变量User,如下图
图-4
userName是OGNL表达式,自顶向下访问ValueStack栈中root对象的userName属性,这里会从栈顶的User对象取到userName属性值。
可以看出,这种动态访问栈中数据的方式,对我们的理解增加了一些难度,但是却可以简化循环内部的OGNL表达式,因为在循环时栈顶即为循环变量,我们以它为root写OGNL不用关注变量的名字了,而这部分代码在项目中是十分频繁出现的,因此牺牲一些理解难度的代价是完全值得的。
有时候我们也需要按照数字的方式进行迭代,比如资费列表的分页功能。对于这种方式,Struts2也有对应的标签支持,按照数字迭代的标签语法如下:
<s:iterator begin="from" end="to" var="k"> <s:property value="#k"/> </s:iterator>
from/to是OGNL表达式,自顶向下访问ValueStack栈中root对象的from/to属性,这里会从栈顶的Action对象取到属性(int from=1, to=3)值。
与迭代集合一样,按数字迭代时,栈顶也会变为循环变量。即在循环过程中,循环变量会被压入栈顶,此时Action被压到栈的第二位,如下图
图-5
需要注意的是,我们不能以数字做root对象,因此无法写OGNL访问栈顶的整数(数字内部没东西了,而访问root需要写其内部属性名)。此时可以声明循环变量k,该声明会将循环变量加入context对象中(如k=2),这样我们就可以写#k这样的OGNL表达式来访问context对象,从而得到循环变量的值。
其实,我们也可以不写OGNL表达式,而是直接输出栈顶的值,即<s:property/>。
ValueStack结构看似复杂,但是需要我们重点关注的无非是栈顶的变化,而此变化也仅仅是在循环时发生,因此记住这唯一的变化情况即可,该情况我总结如下:
1、默认情况下栈顶为Action。
2、循环过程中,栈顶为循环变量。
迭代集合时,循环变量是集合中的对象,通常都是实体对象,即栈顶为实体对象,我们可以以实体对象为root来写OGNL表达式。
按数字迭代时,循环变量是数字,我们不能以数字为实体对象写OGNL,如果需要引用该数字,需要通过var声明变量名,然后以“#变量名”来引用它,这种情况下,我们是从context对象中取出的值。
3、循环结束后,栈顶变回Action。
Struts2将数据封装于ValueStack,默认使用OGNL表达式来取值,而在此之前我们却使用了EL表达式取Action的值,那么EL表达式是从哪里取的值,如何取的值呢?
实际上EL表达式也是从ValueStack中取到的值,因为Struts2把传递的数据都放于ValueStack中了。但我们知道EL表达式的取值范围是page、request、session、application,而我们并没有把数据放入上述任何一个对象中,Struts2实现支持EL表达式的方式是以一个request的包装类来替代request,该包装类是request的子类,并覆写了它的getAttribute方法,在取值方法中先试图从原始request对象中取值,如果没有再从ValueStack中取值。
该request包装类的部分源码如下:
我们可以使用Struts2的迭代标签结合着OGNL,来迭代Action中的集合属性,迭代集合标签的语法如下:
<s:iterator value="users"> <s:property value="userName"/> </s:iterator>
users是OGNL表达式,自顶向下访问ValueStack栈中root对象的users属性,这里会从栈顶的Action对象取到该集合属性(List<User> users)值 。
需要注意的是,在迭代的过程中,ValueStack的栈顶会发生变化,循环变量User会被压入栈顶,此时Action被压到栈的第二位,即栈顶由由原来的Action变为循环变量User,如下图
图-6
userName是OGNL表达式,自顶向下访问ValueStack栈中root对象的userName属性,这里会从栈顶的User对象取到userName属性值。
可以看出,这种动态访问栈中数据的方式,对我们的理解增加了一些难度,但是却可以简化循环内部的OGNL表达式,因为在循环时栈顶即为循环变量,我们以它为root写OGNL不用关注变量的名字了,而这部分代码在项目中是十分频繁出现的,因此牺牲一些理解难度的代价是完全值得的。
有时候我们也需要按照数字的方式进行迭代,比如资费列表的分页功能。对于这种方式,Struts2也有对应的标签支持,按照数字迭代的标签语法如下:
<s:iterator begin="from" end="to" var="k"> <s:property value="#k"/> </s:iterator>
from/to是OGNL表达式,自顶向下访问ValueStack栈中root对象的from/to属性,这里会从栈顶的Action对象取到属性(int from=1, to=3)值。
与迭代集合一样,按数字迭代时,栈顶也会变为循环变量。即在循环过程中,循环变量会被压入栈顶,此时Action被压到栈的第二位,如下图
图-7
需要注意的是,我们不能以数字做root对象,因此无法写OGNL访问栈顶的整数(数字内部没东西了,而访问root需要写其内部属性名)。此时可以声明循环变量k,该声明会将循环变量加入context对象中(如k=2),这样我们就可以写#k这样的OGNL表达式来访问context对象,从而得到循环变量的值。
其实,我们也可以不写OGNL表达式,而是直接输出栈顶的值,即<s:property/>。
ValueStack结构看似复杂,但是需要我们重点关注的无非是栈顶的变化,而此变化也仅仅是在循环时发生,因此记住这唯一的变化情况即可,该情况我总结如下:
1、默认情况下栈顶为Action。
2、循环过程中,栈顶为循环变量。
迭代集合时,循环变量是集合中的对象,通常都是实体对象,即栈顶为实体对象,我们可以以实体对象为root来写OGNL表达式。
按数字迭代时,循环变量是数字,我们不能以数字为实体对象写OGNL,如果需要引用该数字,需要通过var声明变量名,然后以“#变量名”来引用它,这种情况下,我们是从context对象中取出的值。
3、循环结束后,栈顶变回Action。
Struts2将数据封装于ValueStack,默认使用OGNL表达式来取值,而在此之前我们却使用了EL表达式取Action的值,那么EL表达式是从哪里取的值,如何取的值呢?
实际上EL表达式也是从ValueStack中取到的值,因为Struts2把传递的数据都放于ValueStack中了。但我们知道EL表达式的取值范围是page、request、session、application,而我们并没有把数据放入上述任何一个对象中,Struts2实现支持EL表达式的方式是以一个request的包装类来替代request,该包装类是request的子类,并覆写了它的getAttribute方法,在取值方法中先试图从原始request对象中取值,如果没有再从ValueStack中取值。
该request包装类的部分源码如下:
重构资费列表页面,我们可以分2步进行。
首先重构数据显示区域,将原来的JSTL+EL替换成Struts2标签+OGNL,完成后刷新页面做单元测试。
然后重构分页部分,将原来你的JSTL+EL替换成Struts2标签+OGNL,完成后刷新做单元测试。
Struts2中包含6大核心组件,它们彼此关联、相互协作,共同处理了一次请求。Struts2理论课实际上就是围绕这6大核心组件展开的,因此我们需要深刻的理解这6大核心组件的关系,这实际上也就是说明了Struts2的基本原理。
如下图,是Struts2中6大核心组件(红色)的关系:
图-8
针对这张图,我们再进一步解释6大核心组件的关系,这里我按照6大核心组件调用的顺序来加以说明。
值得注意的是,每次请求都会重新初始化除了FC之外的其他5大核心组件,即这些组件不是单例的,因此是线程安全的。并且在最终请求结束时销毁这些组件,但在请求未结束之前,这些组件是存活的,因此在JSP的标签中,我们是可以使用OGNL表达式访问ValueStack对象中的数据的。
1、FC
前端控制器,负责统一的分发请求。
2、Action
业务控制器,负责处理某一类业务。
3、ValueStack
Action与JSP数据交互的媒介。
4、Interceptor
拦截器,负责扩展Action,处理Action的共通事务。
5、Result
负责输出的组件。
6、Tags
标签,负责显示数据、生成框体。