从源代码剖析modelDriven拦截器和params拦截器和拦截器prepare 和paramsPrepareParamsStack拦截器栈(使您的Struts2代码更加简洁——怎样培养框架设计能力

源代码文件出处:Web App Libraries/struts2-core-2.3.15.3.jar/struts-default.xml


拦截器modelDriven

<interceptor
name="modelDriven"
class="com.opensymphony.xwork2.interceptor.ModelDrivenInterceptor"/>


拦截器params

<interceptor
name="params"
class="com.opensymphony.xwork2.interceptor.ParametersInterceptor"/>


拦截器prepare:

<interceptor
name="prepare"
class="com.opensymphony.xwork2.interceptor.PrepareInterceptor"/>


拦截器栈:

<interceptor-stack
name="paramsPrepareParamsStack">

<interceptor-ref
name="exception"/>

<interceptor-ref
name="alias"/>

<interceptor-ref
name="i18n"/>

<interceptor-ref
name="checkbox"/>

<interceptor-ref
name="multiselect"/>

<interceptor-ref
name="params">

<param
name="excludeParams">dojo\..*,^struts\..*,^session\..*,^request\..*,^application\..*,^servlet(Request|Response)\..*,parameters\...*</param>

</interceptor-ref>

<interceptor-ref
name="servletConfig"/>

<interceptor-ref
name="prepare"/>

<interceptor-ref
name="chain"/>

<interceptor-ref
name="modelDriven"/>

<interceptor-ref
name="fileUpload"/>

<interceptor-ref
name="staticParams"/>

<interceptor-ref
name="actionMappingParams"/>

<interceptor-ref
name="params">

<param
name="excludeParams">dojo\..*,^struts\..*,^session\..*,^request\..*,^application\..*,^servlet(Request|Response)\..*,parameters\...*</param>

</interceptor-ref>

<interceptor-ref
name="conversionError"/>

<interceptor-ref
name="validation">

<param
name="excludeMethods">input,back,cancel,browse</param>

</interceptor-ref>

<interceptor-ref
name="workflow">

<param
name="excludeMethods">input,back,cancel,browse</param>

</interceptor-ref>

</interceptor-stack>

ModelDriven拦截器的作用

当用户触发每个请求时,ModelDriven拦截器将调用JavaBean对象的getModel()方法,并把返回值类型压入到ValueStack栈

Params拦截器的作用:

将表单的字段映射到ValueStack栈的栈顶对象的各个属性中,因为此时ValueStack栈的栈顶元素是刚被压入的模型(JavaBean)对象(先用到ModelDriven拦截器,才有这句话),所以该模型将被填充,如果每个字段在模型里没有匹配的属性,Params拦截器将尝试ValueStack栈中的下一个对象。

PrepareInterceptor拦截器的作用:

u  若Action实现Preparable接口,则Action方法需实现prepare()方法

u  PrepareInterceptor拦截器将调用prepare()方法、prepareActionMethodName()方法和prepareDoActionMethodName()方法

u  PrepareInterceptor拦截器根据firstCallPrepareDo属性决定获取prepareActionMethodName、prepareDoActionNam的顺序。默认情况下先获取prepareDoActionName(),如果没有该方法,就寻找prepareDoActionMethodName()。如果找到了对应的方法就调用该方法。

u  PrepareInterceptor拦截器会根据alwaysInvokePrepare属性决定是否执行prepare()方法

paramsPrepareParamsStack拦截器栈的作用:(参考struts-default.xml配置文件的结构,就知道具体的含义了),现在详细解析一下:

u  paramsPrepareParamsStack从字面上理解来说,这里Stack的拦截器调用的顺序为:首先params,然后prepare,接下来modelDriven,最后在params

u  Struts2.0的设计上要求modelDriven在params之前调用,而业务中prepare要负责准备model,准备model又需要参数,这就需要在prepare之前运行params拦截器设置相关参数,这个也就是创建paramsPrepareParamsStack的原因。

u  流程如下:

A.       Params拦截器首先给action中的相关参数赋值,如id

B.       Prepare拦截器执行prepare方法,prepare方法中会根据参数,如id,去调用业务逻辑,设置model对象

C.       ModelDriver拦截器将model对象压入ValueStack,这里的model对象就是在prepare中创建的

D.       Params拦截器再将参数赋值给model对象

E.        Action的业务逻辑执行

请参考下面源代码解析:(第一部分是PrepareInterceptor拦截器的操作流程)


package com.opensymphony.xwork2.interceptor;

import com.opensymphony.xwork2.ActionInvocation;

import com.opensymphony.xwork2.Preparable;

import com.opensymphony.xwork2.util.logging.Logger;

import com.opensymphony.xwork2.util.logging.LoggerFactory;

import java.lang.reflect.InvocationTargetException;

public
class
PrepareInterceptor extends MethodFilterInterceptor {

private
static final
long
serialVersionUID = -5216969014510719786L;

private
final static
String PREPARE_PREFIX =
"prepare";

private
final static
String ALT_PREPARE_PREFIX =
"prepareDo";

private
boolean
alwaysInvokePrepare =
true
;

private
boolean
firstCallPrepareDo =
false
;

public
void
setAlwaysInvokePrepare(String alwaysInvokePrepare) {

this.alwaysInvokePrepare = Boolean.parseBoolean(alwaysInvokePrepare);

}

public
void
setFirstCallPrepareDo(String firstCallPrepareDo) {

this.firstCallPrepareDo = Boolean.parseBoolean(firstCallPrepareDo);

}

@Override

public String doIntercept(ActionInvocation invocation)
throws Exception {

    //获取Action对象

Object action = invocation.getAction();

//判断Action是否实现了preparable接口

if (action
instanceof Preparable) {

try {

String[] prefixes;

//根据当前拦截器的 firstCallPrepareDo(默认为 false)
属性确定 prefixes

if (firstCallPrepareDo) {

prefixes = new String[] {ALT_PREPARE_PREFIX,
PREPARE_PREFIX};

} else {

prefixes = new String[] {PREPARE_PREFIX,
ALT_PREPARE_PREFIX};

}

//若为 false,
则 prefixes: prepare, prepareDo

            //调用前缀方法.

PrefixMethodInvocationUtil.invokePrefixMethod(invocation, prefixes);

}

catch (InvocationTargetException e) {

Throwable cause = e.getCause();

if (cause
instanceof Exception) {

throw (Exception) cause;

} else
if
(cause instanceof Error) {

throw (Error) cause;

} else {

throw e;

}

}

//根据当前拦截器的 alwaysInvokePrepare(默认是 true)
决定是否调用 Action
的 prepare
方法

if (alwaysInvokePrepare) {

((Preparable) action).prepare();

}

}

return invocation.invoke();

}

}


PrefixMethodInvocationUtil.invokePrefixMethod(invocation, prefixes) 方法:


package com.opensymphony.xwork2.interceptor;

import com.opensymphony.xwork2.ActionInvocation;

import com.opensymphony.xwork2.util.logging.Logger;

import com.opensymphony.xwork2.util.logging.LoggerFactory;

import java.lang.reflect.InvocationTargetException;

import java.lang.reflect.Method;

public
class
PrefixMethodInvocationUtil {

private
static final
Logger LOG = LoggerFactory.getLogger(PrefixMethodInvocationUtil.class);

private
static final
String DEFAULT_INVOCATION_METHODNAME =
"execute";

private
static final
Class[] EMPTY_CLASS_ARRAY =
new Class[0];

public
static void
invokePrefixMethod(ActionInvocation actionInvocation, String[] prefixes)
throws InvocationTargetException, IllegalAccessException {

//获取 Action
实例

Object action = actionInvocation.getAction();

//获取要调用的 Action
方法的名字(update)

String methodName = actionInvocation.getProxy().getMethod();

if (methodName ==
null) {

// if null returns (possible according to the docs), use the default execute

methodName = DEFAULT_INVOCATION_METHODNAME;

}

//获取前缀方法

Method method = getPrefixedMethod(prefixes, methodName, action);

//若方法不为 null,
则通过反射调用前缀方法

if (method !=
null) {

method.invoke(action, new Object[0]);

}

}

public
static
Method getPrefixedMethod(String[] prefixes, String methodName, Object action) {

assert(prefixes !=
null);

//把方法的首字母变为大写

String capitalizedMethodName =capitalizeMethodName(methodName);

//遍历前缀数组

for (String prefixe : prefixes) {

String prefixedMethodName = prefixe + capitalizedMethodName;

//通过拼接的方式,
得到前缀方法名:
第一次 prepareUpdate,
第二次prepareDoUpdate

try {

//利用反射获从 action
中获取对应的方法,
若有直接返回. 并结束循环.

return action.getClass().getMethod(prefixedMethodName,
EMPTY_CLASS_ARRAY);

}

catch (NoSuchMethodException e) {

// hmm -- OK, try next prefix

if (LOG.isDebugEnabled()) {

LOG.debug("cannot find method [#0] in action [#1]", prefixedMethodName, action.toString());

}

}

}

return
null
;

}

public
static
String capitalizeMethodName(String methodName) {

assert(methodName !=
null);

return methodName.substring(0, 1).toUpperCase() + methodName.substring(1);

}

}

第二部分(ModelDriver拦截器的源代码解析)


package com.opensymphony.xwork2.interceptor;

import com.opensymphony.xwork2.ActionInvocation;

import com.opensymphony.xwork2.ModelDriven;

import com.opensymphony.xwork2.util.CompoundRoot;

import com.opensymphony.xwork2.util.ValueStack;

public
class
ModelDrivenInterceptor
extends AbstractInterceptor {

protected
boolean
refreshModelBeforeResult =
false;

public
void
setRefreshModelBeforeResult(boolean val) {

this.refreshModelBeforeResult = val;

}

@Override

public String intercept(ActionInvocation invocation)
throws Exception {

//获取 Action
对象: EmployeeAction
对象,
此时该 Action
已经实现了 ModelDriven
接口

    //public class EmployeeAction implements RequestAware, ModelDriven<Employee>

Object action = invocation.getAction();

//判断 action
是否是 ModelDriven
的实例

if (action
instanceof ModelDriven) {

//强制转换为 ModelDriven
类型

ModelDriven modelDriven = (ModelDriven) action;

//获取值栈

ValueStack stack = invocation.getStack();

//调用 ModelDriven
接口的 getModel()
方法

            //即调用 EmployeeAction
的 getModel()
方法

            /*

            public Employee getModel() {

              employee = new Employee();

              return employee;

           }

            */

Object model = modelDriven.getModel();

if (model != 
null) {

//把 getModel()
方法的返回值压入到值栈的栈顶.
实际压入的是 EmployeeAction
的 employee
成员变量

stack.push(model);

}

if (refreshModelBeforeResult) {

invocation.addPreResultListener(new RefreshModelBeforeResult(modelDriven, model));

}

}

return invocation.invoke();

}

/**

* Refreshes the model instance on the value stack, if it has changed

*/

protected
static class
RefreshModelBeforeResult
implements PreResultListener {

private Object
originalModel = null;

protected ModelDriven
action;

public RefreshModelBeforeResult(ModelDriven action, Object model) {

this.originalModel = model;

this.action = action;

}

public
void
beforeResult(ActionInvocation invocation, String resultCode) {

ValueStack stack = invocation.getStack();

CompoundRoot root = stack.getRoot();

boolean needsRefresh =
true;

Object newModel = action.getModel();

// Check to see if the new model instance is already on the stack

for (Object item : root) {

if (item.equals(newModel)) {

needsRefresh = false;

}

}

// Add the new model on the stack

if (needsRefresh) {

// Clear off the old model instance

if (originalModel !=
null) {

root.remove(originalModel);

}

if (newModel !=
null) {

stack.push(newModel);

}

}

}

}

}

细节注释:

细节一:执行 ParametersInterceptor 的 intercept 方法: 把请求参数的值赋给栈顶对象对应的属性. 若栈顶对象没有对应的属性, 则查询值栈中下一个对象对应的属性...

细节二:getModel 方法不能提供以下实现. 的确会返回一个 Employee 对象到值栈的栈顶. 但当前 Action 的 employee 成员变量却是 null.


@Override

public
Employee getModel() {

return
new
Employee();

}

时间: 2024-08-29 10:32:57

从源代码剖析modelDriven拦截器和params拦截器和拦截器prepare 和paramsPrepareParamsStack拦截器栈(使您的Struts2代码更加简洁——怎样培养框架设计能力的相关文章

使用 paramsPrepareParamsStack 拦截器栈后的运行流程

2. 使用 paramsPrepareParamsStack 拦截器栈后的运行流程 1). paramsPrepareParamsStack 和 defaultStack 一样都是拦截器栈. 而 struts-default 包默认使用的是defaultStack 2). 可以在 Struts 配置文件中通过以下方式修改使用的默认的拦截器栈 <default-interceptor-ref name="paramsPrepareParamsStack"></defau

[原创]java WEB学习笔记6:Struts2 学习之路--Struts的CRUD操作( 查看 / 删除/ 添加) 使用 paramsPrepareParamsStack 重构代码 ,PrepareInterceptor拦截器,paramsPrepareParamsStack 拦截器栈

本博客的目的:①总结自己的学习过程,相当于学习笔记 ②将自己的经验分享给大家,相互学习,互相交流,不可商用 内容难免出现问题,欢迎指正,交流,探讨,可以留言,也可以通过以下方式联系. 本人互联网技术爱好者,互联网技术发烧友 微博:伊直都在0221 QQ:951226918 -----------------------------------------------------------------------------------------------------------------

【Java EE 学习第69天】【struts2】【paramsPrepareParamsStack拦截器栈解决model对象和属性赋值冲突问题】

昨天有同学问我问题,他告诉我他的Action中的一个属性明明提供了get/set方法,但是在方法中却获取不到表单中传递过来的值.代码如下(简化后的代码) 1 public class UserAction implements modelDriven<User>(){ 2 private String name; 3 private User model; 4 public void setName(String name){ 5 this.name=name; 6 } 7 public St

《STL源代码剖析》---stl_deque.h阅读笔记(2)

看完,<STL源代码剖析>---stl_deque.h阅读笔记(1)后.再看代码: G++ 2.91.57,cygnus\cygwin-b20\include\g++\stl_deque.h 完整列表 /* * * Copyright (c) 1994 * Hewlett-Packard Company * * Permission to use, copy, modify, distribute and sell this software * and its documentation f

STL源代码剖析(一) - 内存分配

Allocaor allocator 指的是空间配置器,用于分配内存.STL中默认使用SGI STL alloc作为STL的内存分配器,尽管未能符合标准规格,但效率上更好.SGI STL也定义有一个符合标准,名为allocator的配置器,但SGI自己从未使用过它,主要原因是它仅仅把C++的new操作符和delete操作符做了一层薄薄的封装. C++的new操作符和delete操作符进行内存配置时,new:先配置内存,然后构造对象.delete:先析构对象,然后释放内存.SGI STL将内存配置

【Java集合源代码剖析】TreeMap源代码剖析

转载请注明出处:http://blog.csdn.net/ns_code/article/details/36421085 前言 本文不打算延续前几篇的风格(对全部的源代码加入凝视),由于要理解透TreeMap的全部源代码.对博主来说.确实须要耗费大量的时间和经历.眼下看来不大可能有这么多时间的投入.故这里意在通过于阅读源代码对TreeMap有个宏观上的把握,并就当中一些方法的实现做比較深入的分析. 红黑树简单介绍 TreeMap是基于红黑树实现的,这里仅仅对红黑树做个简单的介绍,红黑树是一种特

菜鸟nginx源代码剖析数据结构篇(八) 缓冲区链表ngx_chain_t

菜鸟nginx源代码剖析数据结构篇(八) 缓冲区链表 ngx_chain_t Author:Echo Chen(陈斌) Email:[email protected]mail.com Blog:Blog.csdn.net/chen19870707 Date:Nov 6th, 2014 1.缓冲区链表结构ngx_chain_t和ngx_buf_t nginx的缓冲区链表例如以下图所看到的.ngx_chain_t为链表.ngx_buf_t为缓冲区结点: 2.源码位置 头文件:http://trac.

Qt中事件分发源代码剖析(一共8个步骤,顺序非常清楚:全局的事件过滤器,再传递给目标对象的事件过滤器,最终传递给目标对象)

Qt中事件分发源代码剖析 Qt中事件传递顺序: 在一个应该程序中,会进入一个事件循环,接受系统产生的事件,并且进行分发,这些都是在exec中进行的.下面举例说明: 1)首先看看下面一段示例代码: [cpp] view plaincopy int main(int argc, char *argv[]) { QApplication a(argc, argv); MouseEvent w; w.show(); return a.exec(); } 2)a.exec进入事件循环,调用的是QAppli

Android多线程研究(1)——线程基础及源代码剖析

从今天起我们来看一下Android中的多线程的知识,Android入门easy,可是要完毕一个完好的产品却不easy,让我们从线程開始一步步深入Android内部. 一.线程基础回想 package com.maso.test; public class TraditionalThread { public static void main(String[] args) { /* * 线程的第一种创建方式 */ Thread thread1 = new Thread(){ @Override p