Struts2中的ValueStack详解

最新推荐文章于 2020-12-04 13:46:37 发布

javaPie

最新推荐文章于 2020-12-04 13:46:37 发布

阅读量400

点赞数

分类专栏： Struts

Struts 专栏收录该内容

21 篇文章 0 订阅

订阅专栏

Struts2中的ValueStack详解

2017年02月08日 18:05:09 707人阅读评论(0) 收藏举报

分类：

JAVAEE框架（16）

目录(?)[+]

ValueStack简述

valueStack是一个接口，在struts2中使用OGNL表达式实际上是使用实现了ValueStack接口的类OgnlValueStack.它是ValueStack的默认实现类. 首先看一下，这个接口是怎么定义的。

[java]view plain copy 
     
 package com.opensymphony.xwork2.util;  
   
 import java.util.Map;  
 public interface ValueStack {  
   
     public static final String VALUE_STACK = "com.opensymphony.xwork2.util.ValueStack.ValueStack";  
   
     public static final String REPORT_ERRORS_ON_NO_PROP = "com.opensymphony.xwork2.util.ValueStack.ReportErrorsOnNoProp";  
   
     public abstract Map<String, Object> getContext();  
   
     /** 
      * Sets the default type to convert to if no type is provided when getting a value. 
      * 
      * @param defaultType the new default type 
      */  
     public abstract void setDefaultType(Class defaultType);  
   
     /** 
      * Set a override map containing <code>key -> values</code> that takes precedent when doing find operations on the ValueStack. 
      * <p/> 
      * See the unit test for ValueStackTest for examples. 
      * 
      * @param overrides  overrides map. 
      */  
     public abstract void setExprOverrides(Map<Object, Object> overrides);  
   
     /** 
      * Gets the override map if anyone exists. 
      * 
      * @return the override map, <tt>null</tt> if not set. 
      */  
     public abstract Map<Object, Object> getExprOverrides();  
   
     /** 
      * Get the CompoundRoot which holds the objects pushed onto the stack 
      * 
      * @return the root 
      */  
     public abstract CompoundRoot getRoot();  
   
     /** 
      * Attempts to set a property on a bean in the stack with the given expression using the default search order. 
      * 
      * @param expr  the expression defining the path to the property to be set. 
      * @param value the value to be set into the named property 
      */  
     public abstract void setValue(String expr, Object value);  
   
     /** 
      * Attempts to set a property on a bean in the stack with the given expression using the default search order. 
      * N.B.: unlike #setValue(String,Object) it doesn't allow eval expression. 
      * @param expr  the expression defining the path to the property to be set. 
      * @param value the value to be set into the named property 
      */  
     void setParameter(String expr, Object value);  
   
     /** 
      * 根据顺序查找到表达式对应的值并修改 
      * 
      * @param expr                    表达式 
      * @param value                   值 
      * @param throwExceptionOnFailure 如果没有找到抛出的异常 
      */  
     public abstract void setValue(String expr, Object value, boolean throwExceptionOnFailure);  
   
     public abstract String findString(String expr);  
     public abstract String findString(String expr, boolean throwExceptionOnFailure);  
   
     /** 
      * 按照默认的顺序根据表达式获取值 
      */  
     public abstract Object findValue(String expr);  
     public abstract Object findValue(String expr, boolean throwExceptionOnFailure);  
     public abstract Object findValue(String expr, Class asType);  
     public abstract Object findValue(String expr, Class asType,  boolean throwExceptionOnFailure);  
   
     /** 
      * 获取栈顶元素，不改变栈 
      */  
     public abstract Object peek();  
   
     /** 
      * 获取栈顶元素并将它移除出栈 
      */  
     public abstract Object pop();  
   
     /** 
      * 将这个值放到栈顶 
      */  
     public abstract void push(Object o);  
   
     /** 
      * 修改值栈中键为key的值 
      */  
     public abstract void set(String key, Object o);  
   
     /** 
      * 获取栈中的对象的数量 
      */  
     public abstract int size();  
   
 }  

可以看到，这个接口定义了许多的抽象方法以及方法。就是对值栈中的数据进行相应的操作。

它的默认实现类是OgnlValueStack，查看一下OgnlValueStack的源代码：

[java]view plain copy 
     
 package com.opensymphony.xwork2.ognl;  
   
 import com.opensymphony.xwork2.ActionContext;  
 import com.opensymphony.xwork2.TextProvider;  
 import com.opensymphony.xwork2.XWorkConstants;  
 import com.opensymphony.xwork2.XWorkException;  
 import com.opensymphony.xwork2.conversion.impl.XWorkConverter;  
 import com.opensymphony.xwork2.inject.Container;  
 import com.opensymphony.xwork2.inject.Inject;  
 import com.opensymphony.xwork2.ognl.accessor.CompoundRootAccessor;  
 import com.opensymphony.xwork2.util.ClearableValueStack;  
 import com.opensymphony.xwork2.util.CompoundRoot;  
 import com.opensymphony.xwork2.util.MemberAccessValueStack;  
 import com.opensymphony.xwork2.util.ValueStack;  
 import com.opensymphony.xwork2.util.logging.Logger;  
 import com.opensymphony.xwork2.util.logging.LoggerFactory;  
 import com.opensymphony.xwork2.util.logging.LoggerUtils;  
 import com.opensymphony.xwork2.util.reflection.ReflectionContextState;  
 import ognl.*;  
   
 import java.io.Serializable;  
 import java.util.HashMap;  
 import java.util.Map;  
 import java.util.Set;  
 import java.util.regex.Pattern;  
   
 public class OgnlValueStack implements Serializable, ValueStack, ClearableValueStack, MemberAccessValueStack {  
   
     public static final String THROW_EXCEPTION_ON_FAILURE = OgnlValueStack.class.getName() + ".throwExceptionOnFailure";  
   
     private static final long serialVersionUID = 370737852934925530L;  
   
     private static final String MAP_IDENTIFIER_KEY = "com.opensymphony.xwork2.util.OgnlValueStack.MAP_IDENTIFIER_KEY";  
     private static final Logger LOG = LoggerFactory.getLogger(OgnlValueStack.class);  
       
     //CompoundRoot继承了ArraryList，提供了额外的方法：push()和pop()方法，所以它相当于栈结构  
     <span style="color:#FF0000;">CompoundRoot root;  
     transient Map<String, Object> context;  
     Class defaultType;  
     Map<Object, Object> overrides;  
     transient OgnlUtil ognlUtil;  
     transient SecurityMemberAccess securityMemberAccess;</span>  
   
     private boolean devMode;  
     private boolean logMissingProperties;  
   
     protected OgnlValueStack(XWorkConverter xworkConverter, CompoundRootAccessor accessor, TextProvider prov, boolean allowStaticAccess) {  
         setRoot(xworkConverter, accessor, new CompoundRoot(), allowStaticAccess);  
         push(prov);  
     }  
   
     protected OgnlValueStack(ValueStack vs, XWorkConverter xworkConverter, CompoundRootAccessor accessor, boolean allowStaticAccess) {  
         setRoot(xworkConverter, accessor, new CompoundRoot(vs.getRoot()), allowStaticAccess);  
     }  
   
     @Inject  
     public void setOgnlUtil(OgnlUtil ognlUtil) {  
         this.ognlUtil = ognlUtil;  
     }  
   
     protected void setRoot(XWorkConverter xworkConverter, CompoundRootAccessor accessor, CompoundRoot compoundRoot,  
                            boolean allowStaticMethodAccess) {  
         this.root = compoundRoot;  
         this.securityMemberAccess = new SecurityMemberAccess(allowStaticMethodAccess);  
         this.context = Ognl.createDefaultContext(this.root, accessor, new OgnlTypeConverterWrapper(xworkConverter), securityMemberAccess);  
         context.put(VALUE_STACK, this);  
         Ognl.setClassResolver(context, accessor);  
         ((OgnlContext) context).setTraceEvaluations(false);  
         ((OgnlContext) context).setKeepLastEvaluation(false);  
     }  
   
     @Inject(XWorkConstants.DEV_MODE)  
     public void setDevMode(String mode) {  
         devMode = "true".equalsIgnoreCase(mode);  
     }  
   
     @Inject(value = "logMissingProperties", required = false)  
     public void setLogMissingProperties(String logMissingProperties) {  
         this.logMissingProperties = "true".equalsIgnoreCase(logMissingProperties);  
     }  
   
     /** 
      * @see com.opensymphony.xwork2.util.ValueStack#getContext() 
      */  
     public Map<String, Object> getContext() {  
         return context;  
     }  
   
     /** 
      * @see com.opensymphony.xwork2.util.ValueStack#setDefaultType(java.lang.Class) 
      */  
     public void setDefaultType(Class defaultType) {  
         this.defaultType = defaultType;  
     }  
   
     /** 
      * @see com.opensymphony.xwork2.util.ValueStack#setExprOverrides(java.util.Map) 
      */  
     public void setExprOverrides(Map<Object, Object> overrides) {  
         if (this.overrides == null) {  
             this.overrides = overrides;  
         } else {  
             this.overrides.putAll(overrides);  
         }  
     }  
   
     /** 
      * @see com.opensymphony.xwork2.util.ValueStack#getExprOverrides() 
      */  
     public Map<Object, Object> getExprOverrides() {  
         return this.overrides;  
     }  
   
     /** 
      * @see com.opensymphony.xwork2.util.ValueStack#getRoot() 
      */  
     public CompoundRoot getRoot() {  
         return root;  
     }  
   
     /** 
      * @see com.opensymphony.xwork2.util.ValueStack#setParameter(String, Object) 
      */  
     public void setParameter(String expr, Object value) {  
         setValue(expr, value, devMode, false);  
     }  
   
     /** 
  
     /** 
      * @see com.opensymphony.xwork2.util.ValueStack#setValue(java.lang.String, java.lang.Object) 
      */  
     public void setValue(String expr, Object value) {  
         setValue(expr, value, devMode);  
     }  
   
     /** 
      * @see com.opensymphony.xwork2.util.ValueStack#setValue(java.lang.String, java.lang.Object, boolean) 
      */  
     public void setValue(String expr, Object value, boolean throwExceptionOnFailure) {  
         setValue(expr, value, throwExceptionOnFailure, true);  
     }  
   
     private void setValue(String expr, Object value, boolean throwExceptionOnFailure, boolean evalExpression) {  
         Map<String, Object> context = getContext();  
         try {  
             trySetValue(expr, value, throwExceptionOnFailure, context, evalExpression);  
         } catch (OgnlException e) {  
             handleOgnlException(expr, value, throwExceptionOnFailure, e);  
         } catch (RuntimeException re) { //XW-281  
             handleRuntimeException(expr, value, throwExceptionOnFailure, re);  
         } finally {  
             cleanUpContext(context);  
         }  
     }  
   
     private void trySetValue(String expr, Object value, boolean throwExceptionOnFailure, Map<String, Object> context, boolean evalExpression) throws OgnlException {  
         context.put(XWorkConverter.CONVERSION_PROPERTY_FULLNAME, expr);  
         context.put(REPORT_ERRORS_ON_NO_PROP, (throwExceptionOnFailure) ? Boolean.TRUE : Boolean.FALSE);  
         ognlUtil.setValue(expr, context, root, value, evalExpression);  
     }  
   
     private void cleanUpContext(Map<String, Object> context) {  
         ReflectionContextState.clear(context);  
         context.remove(XWorkConverter.CONVERSION_PROPERTY_FULLNAME);  
         context.remove(REPORT_ERRORS_ON_NO_PROP);  
     }  
   
     private void handleRuntimeException(String expr, Object value, boolean throwExceptionOnFailure, RuntimeException re) {  
         if (throwExceptionOnFailure) {  
             String message = ErrorMessageBuilder.create()  
                     .errorSettingExpressionWithValue(expr, value)  
                     .build();  
             throw new XWorkException(message, re);  
         } else {  
             if (LOG.isWarnEnabled()) {  
                 LOG.warn("Error setting value", re);  
             }  
         }  
     }  
   
     private void handleOgnlException(String expr, Object value, boolean throwExceptionOnFailure, OgnlException e) {  
         String msg = "Error setting expression '" + expr + "' with value '" + value + "'";  
         if (LOG.isWarnEnabled()) {  
             LOG.warn(msg, e);  
         }  
         if (throwExceptionOnFailure) {  
             throw new XWorkException(msg, e);  
         }  
     }  
   
     /** 
      * @see com.opensymphony.xwork2.util.ValueStack#findString(java.lang.String) 
      */  
     public String findString(String expr) {  
         return (String) findValue(expr, String.class);  
     }  
   
     public String findString(String expr, boolean throwExceptionOnFailure) {  
         return (String) findValue(expr, String.class, throwExceptionOnFailure);  
     }  
   
     /** 
      * @see com.opensymphony.xwork2.util.ValueStack#findValue(java.lang.String) 
      */  
     public Object findValue(String expr, boolean throwExceptionOnFailure) {  
         try {  
             setupExceptionOnFailure(throwExceptionOnFailure);  
             return tryFindValueWhenExpressionIsNotNull(expr);  
         } catch (OgnlException e) {  
             return handleOgnlException(expr, throwExceptionOnFailure, e);  
         } catch (Exception e) {  
             return handleOtherException(expr, throwExceptionOnFailure, e);  
         } finally {  
             ReflectionContextState.clear(context);  
         }  
     }  
   
     private void setupExceptionOnFailure(boolean throwExceptionOnFailure) {  
         if (throwExceptionOnFailure) {  
             context.put(THROW_EXCEPTION_ON_FAILURE, true);  
         }  
     }  
   
     private Object tryFindValueWhenExpressionIsNotNull(String expr) throws OgnlException {  
         if (expr == null) {  
             return null;  
         }  
         return tryFindValue(expr);  
     }  
   
     private Object handleOtherException(String expr, boolean throwExceptionOnFailure, Exception e) {  
         logLookupFailure(expr, e);  
   
         if (throwExceptionOnFailure)  
             throw new XWorkException(e);  
   
         return findInContext(expr);  
     }  
   
     private Object tryFindValue(String expr) throws OgnlException {  
         Object value;  
         expr = lookupForOverrides(expr);  
         if (defaultType != null) {  
             value = findValue(expr, defaultType);  
         } else {  
             value = getValueUsingOgnl(expr);  
             if (value == null) {  
                 value = findInContext(expr);  
             }  
         }  
         return value;  
     }  
   
     private String lookupForOverrides(String expr) {  
         if ((overrides != null) && overrides.containsKey(expr)) {  
             expr = (String) overrides.get(expr);  
         }  
         return expr;  
     }  
   
     private Object getValueUsingOgnl(String expr) throws OgnlException {  
         try {  
             return ognlUtil.getValue(expr, context, root);  
         } finally {  
             context.remove(THROW_EXCEPTION_ON_FAILURE);  
         }  
     }  
   
     public Object findValue(String expr) {  
         return findValue(expr, false);  
     }  
   
     /** 
      * @see com.opensymphony.xwork2.util.ValueStack#findValue(java.lang.String, java.lang.Class) 
      */  
     public Object findValue(String expr, Class asType, boolean throwExceptionOnFailure) {  
         try {  
             setupExceptionOnFailure(throwExceptionOnFailure);  
             return tryFindValueWhenExpressionIsNotNull(expr, asType);  
         } catch (OgnlException e) {  
             return handleOgnlException(expr, throwExceptionOnFailure, e);  
         } catch (Exception e) {  
             return handleOtherException(expr, throwExceptionOnFailure, e);  
         } finally {  
             ReflectionContextState.clear(context);  
         }  
     }  
   
     private Object tryFindValueWhenExpressionIsNotNull(String expr, Class asType) throws OgnlException {  
         if (expr == null) {  
             return null;  
         }  
         return tryFindValue(expr, asType);  
     }  
   
     private Object handleOgnlException(String expr, boolean throwExceptionOnFailure, OgnlException e) {  
         Object ret = findInContext(expr);  
         if (ret == null) {  
             if (shouldLogNoSuchPropertyWarning(e)) {  
                 LOG.warn("Could not find property [" + ((NoSuchPropertyException) e).getName() + "]");  
             }  
             if (throwExceptionOnFailure) {  
                 throw new XWorkException(e);  
             }  
         }  
         return ret;  
     }  
   
     private boolean shouldLogNoSuchPropertyWarning(OgnlException e) {  
         return e instanceof NoSuchPropertyException && devMode && logMissingProperties;  
     }  
   
     private Object tryFindValue(String expr, Class asType) throws OgnlException {  
         Object value = null;  
         try {  
             expr = lookupForOverrides(expr);  
             value = getValue(expr, asType);  
             if (value == null) {  
                 value = findInContext(expr);  
             }  
         } finally {  
             context.remove(THROW_EXCEPTION_ON_FAILURE);  
         }  
         return value;  
     }  
   
     private Object getValue(String expr, Class asType) throws OgnlException {  
         return ognlUtil.getValue(expr, context, root, asType);  
     }  
   
     private Object findInContext(String name) {  
         return getContext().get(name);  
     }  
   
     public Object findValue(String expr, Class asType) {  
         return findValue(expr, asType, false);  
     }  
   
     /** 
      * Log a failed lookup, being more verbose when devMode=true. 
      * 
      * @param expr The failed expression 
      * @param e    The thrown exception. 
      */  
     private void logLookupFailure(String expr, Exception e) {  
         String msg = LoggerUtils.format("Caught an exception while evaluating expression '#0' against value stack", expr);  
         if (devMode && LOG.isWarnEnabled()) {  
             LOG.warn(msg, e);  
             LOG.warn("NOTE: Previous warning message was issued due to devMode set to true.");  
         } else if (LOG.isDebugEnabled()) {  
             LOG.debug(msg, e);  
         }  
     }  
   
     /** 
      * @see com.opensymphony.xwork2.util.ValueStack#peek() 
      */  
     public Object peek() {  
         return root.peek();  
     }  
   
     /** 
      * @see com.opensymphony.xwork2.util.ValueStack#pop() 
      */  
     public Object pop() {  
         return root.pop();  
     }  
   
     /** 
      * @see com.opensymphony.xwork2.util.ValueStack#push(java.lang.Object) 
      */  
     public void push(Object o) {  
         root.push(o);  
     }  
   
     /** 
      * @see com.opensymphony.xwork2.util.ValueStack#set(java.lang.String, java.lang.Object) 
      */  
     public void set(String key, Object o) {  
         //set basically is backed by a Map pushed on the stack with a key being put on the map and the Object being the value  
         Map setMap = retrieveSetMap();  
         setMap.put(key, o);  
     }  
   
     private Map retrieveSetMap() {  
         Map setMap;  
         Object topObj = peek();  
         if (shouldUseOldMap(topObj)) {  
             setMap = (Map) topObj;  
         } else {  
             setMap = new HashMap();  
             setMap.put(MAP_IDENTIFIER_KEY, "");  
             push(setMap);  
         }  
         return setMap;  
     }  
   
     /** 
      * check if this is a Map put on the stack  for setting if so just use the old map (reduces waste) 
      */  
     private boolean shouldUseOldMap(Object topObj) {  
         return topObj instanceof Map && ((Map) topObj).get(MAP_IDENTIFIER_KEY) != null;  
     }  
   
     /** 
      * @see com.opensymphony.xwork2.util.ValueStack#size() 
      */  
     public int size() {  
         return root.size();  
     }  
   
     private Object readResolve() {  
         // TODO: this should be done better  
         ActionContext ac = ActionContext.getContext();  
         Container cont = ac.getContainer();  
         XWorkConverter xworkConverter = cont.getInstance(XWorkConverter.class);  
         CompoundRootAccessor accessor = (CompoundRootAccessor) cont.getInstance(PropertyAccessor.class, CompoundRoot.class.getName());  
         TextProvider prov = cont.getInstance(TextProvider.class, "system");  
         boolean allow = "true".equals(cont.getInstance(String.class, "allowStaticMethodAccess"));  
         OgnlValueStack aStack = new OgnlValueStack(xworkConverter, accessor, prov, allow);  
         aStack.setOgnlUtil(cont.getInstance(OgnlUtil.class));  
         aStack.setRoot(xworkConverter, accessor, this.root, allow);  
   
         return aStack;  
     }  
   
   
     public void clearContextValues() {  
         //this is an OGNL ValueStack so the context will be an OgnlContext  
         //it would be better to make context of type OgnlContext  
         ((OgnlContext) context).getValues().clear();  
     }  
   
     public void setAcceptProperties(Set<Pattern> acceptedProperties) {  
         securityMemberAccess.setAcceptProperties(acceptedProperties);  
     }  
   
     public void setPropertiesJudge(PropertiesJudge judge) {  
         securityMemberAccess.setPropertiesJudge(judge);  
     }  
   
     public void setExcludeProperties(Set<Pattern> excludeProperties) {  
         securityMemberAccess.setExcludeProperties(excludeProperties);  
     }  
   
 }  

由这个源代码的红色部分，发现值栈中的数据分俩部分村储：root（栈结构，CompoundRoot）和context（map形式,OgnlContext）：

ValueStack的生命周期

ValueStack的是保存着request的请求域中的，因此它的生命周期与request的生命周期是相同的。当Struts2接收到一个请求时，会迅速创建ActionContext、Action、ValueStack,然后将Action存放到ValueStack中，所以Action中的所有实例变量都是可以通过OGNL表达式访问的。当请求来的时候，Action，ValueStack的生命周期开始。当请求结束的时候，生命周期结束。

ValueStack的传送带机制

Struts2的Action类通过属性就可以获得所有相关的值，如请求参数，action配置参数，向其他Action传递属性值等。要获得这些值，我们需要做的就是在Action类中声明与参数同名的属性，在Action执行默认的execute方法之前，Struts2就为Action中的属性进行了赋值。要完成这个功能很大程度上依赖于ValueStack对象。当 Struts 2接收到一个.action的请求后，会先建立Action类的对象实例，并且将Action类的对象实例压入ValueStack对象中（实际上，ValueStack对于相当一个栈），而ValueStack类的setValue和findValue方法可以设置和获得Action对象的属性值。Struts 2中的某些拦截器正是通过ValueStack类的setValue方法来修改Action类的属性值的。如params拦截器用于将请求参数值映射到相应成Action类的属性值。在params拦截器中在获得请求参数值后，会使用setValue方法设置相应的Action类的属性。从这一点可以看出，ValueStack对象就象一个传送带，当客户端请求.action时，Struts 2在创建相应用Action对象后就将Action对象放到了ValueStack传送带上，然后ValueStack传送带会带着Action对象经过若干拦截器，在每一拦截器中都可以通过ValueStack对象设置和获得Action对象中的属性值。实际上，这些拦截器就相当于流水线作业。如果要对 Action对象进行某项加工，再加一个拦截器即可，当不需要进行这项工作时，直接将该拦截器去掉即可。

javaPie

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
Struts2中的ValueStack详解

Struts2中的ValueStack详解2017年02月08日 18:05:09707人阅读评论(0) 收藏举报分类：JAVAEE框架（16）版权声明：本文为博主原创文章，未经博主允许不得转载。 https://blog.csdn.net/qq_28663043/article/details/54926516目录(
复制链接

扫一扫