Java Structs框架原理代码示例解析

本篇文章小编给大家分享一下Java Structs框架原理代码示例解析，文章代码介绍的很详细，小编觉得挺不错的，现在分享给大家供大家参考，有需要的小伙伴们可以来看看。

1 Struts2框架内部执行过程

Structs请求过程源码分析参考链接http://www.cnblogs.com/liuling/p/2013-8-10-01.html

从上图来看，整个框架的运行过程是围绕着核心过滤器StrutsPrepareAndExecuteFilter展开工作，深入到filter的源码会对理解有所帮助。

一个请求在Struts的处理中大概有以下几个步骤：

客户端初始化一个指向Servlet容器（Tomcat）的请求；

这个请求经过一系列的过滤器（Filter）例如ActionContextCleanUp的可选过滤器；

接着StrutsPrepareAndExecuteFilter被调用，StrutsPrepareAndExecuteFilter询问ActionMapper来决定这个请求是否需要调用某个Action；

ActionMapper决定调用哪个Action,FilterDispatcher把请求的处理交给ActionProxy;

ActionProxy通过Configuration Manager询问框架的配置文件，找到需要调用的Action类；

ActionProxy创建一个ActionInvocation的实例。

ActionInvocation实例使用命名模式来调用，在调用Action的过程前后，涉及到相关拦截器（Intercepter）的调用。

一旦Action执行完毕，ActionInvocation负责根据struts.xml中的配置找到对应的返回结果。返回结果通常是（但不总是，也可能是另外的一个Action链）一个需要被表示的JSP或者FreeMarker的模版。在表示的过程中可以使用Struts2 框架中继承的标签。在这个过程中需要涉及到ActionMapper。

Structs的核心功能就是将请求委托给哪个Action处理。

到structs2官网上下载Structs-src.zip源文件，将其解压

定位到：E:structs2源码struts-2.5.20srccoresrcmainjavaorgapachestruts2查看源文件

有关包的说明：

org.apache.struts2. components 该包封装视图组件，Struts2在视图组件上有了很大加强，不仅增加了组件的属性个数，更新增了几个非常有用的组件，如updownselect、doubleselect、datetimepicker、token、tree等。另外，Struts2可视化视图组件开始支持主题(theme)，缺省情况下，使用自带的缺省主题，如果要自定义页面效果，需要将组件的theme属性设置为simple。

org.apache.struts2. config

该包定义与配置相关的接口和类。实际上，工程中的xml和properties文件的读取和解析都是由WebWork完成的，Struts只做了少量的工作。

org.apache.struts2.dispatcher

Struts2的核心包，最重要的类都放在该包中。

org.apache.struts2.impl

该包只定义了3个类，他们是StrutsActionProxy、StrutsActionProxyFactory、StrutsObjectFactory，这三个类都是对xwork的扩展。

org.apache.struts2.interceptor

定义内置的截拦器。

org.apache.struts2.servlet

用HttpServletRequest相关方法实现principalproxy接口。

org.apache.struts2.util

实用包

org.apache.struts2.views

提供freemarker、jsp、velocity等不同类型的页面呈现

根目录下的5个文件说明：

StrutsStatics

Struts常数。常数可以用来获取或设置对象从行动中或其他集合。

RequestUtils

请求处理程序类。此类只有一个方法getServletPath，作用检索当前请求的servlet路径

ServletActionContext

网站的特定的上下文信息

StrutsConstants

该类提供了框架配置键的中心位置用于存储和检索配置设置。

StrutsException

通用运行时异常类

（1）Structs2请求过程源码分析：

Struts框架都会在web.xml中注册和映射structs2,配置内容如下：

 
    struts2  
    org.apache.struts2.dispatcher.ng.filter.StrutsPrepareAndExecuteFilter 
    
   
    struts2  
    /* 
  

StrutsPrepareAndExecuteFilter中的方法：

void init(FilterConfig filterConfig) 继承自Filter，过滤器的初始化

doFilter(ServletRequest req, ServletResponse res, FilterChain chain)继承自Filter，执行过滤器

void destroy() 继承自Filter，用于资源释放

void postInit(Dispatcher dispatcher, FilterConfig filterConfig) Callback for post initialization（一个空的方法，用于方法回调初始化）

web 容器一启动，就会初始化核心过滤器StrutsPrepareAndExecuteFilter,并且执行初始化方法，初始化方法如下：

public void init(FilterConfig filterConfig) throws ServletException {
        InitOperations init = new InitOperations();
        Dispatcher dispatcher = null;
        try {
            //封装filterConfig，其中有个主要方法getInitParameterNames将参数名字以String格式存储在List中
            FilterHostConfig config = new FilterHostConfig(filterConfig);
            //初始化struts内部日志
            init.initLogging(config);
            //创建dispatcher ，并初始化
            dispatcher = init.initDispatcher(config);
            init.initStaticContentLoader(config, dispatcher);
            //初始化类属性：prepare 、execute
            prepare = new PrepareOperations(filterConfig.getServletContext(), dispatcher);
            execute = new ExecuteOperations(filterConfig.getServletContext(), dispatcher);
            this.excludedPatterns = init.buildExcludedPatternsList(dispatcher);
            //回调空的postInit方法
            postInit(dispatcher, filterConfig);
        } finally {
            if (dispatcher != null) {
                dispatcher.cleanUpAfterInit();
            }
            init.cleanup();
        }
    }

关于封装filterConfig,首先看一下FilterHostConfig,源码如下：

public class FilterHostConfig implements HostConfig {
 
    private FilterConfig config;
    //构造方法
    public FilterHostConfig(FilterConfig config) {
        this.config = config;
    }
    //根据init-param配置的param-name获取param-value的值  
    public String getInitParameter(String key) {
        return config.getInitParameter(key);
    }
    //返回初始化参数名的迭代器 
    public Iterator getInitParameterNames() {
        return MakeIterator.convert(config.getInitParameterNames());
    }
    //返回Servlet上下文
    public ServletContext getServletContext() {
        return config.getServletContext();
    }
}

getInitParameterNames是这个类的核心，主要功能就是将Filter初始化参数名称有枚举类型转化为Iterator。

接下来，看下StrutsPrepareAndExecuteFilter中init方法中dispatcher = init.initDispatcher(config);这是初始化dispatcher的，是通过init对象的initDispatcher方法来初始化的，init是InitOperations类的对象，我们看看InitOperations中initDispatcher方法：

public Dispatcher initDispatcher( HostConfig filterConfig ) {
         Dispatcher dispatcher = createDispatcher(filterConfig);
         dispatcher.init();
        return dispatcher;
    }

创建Dispatcher 会读取filterConfig（核心过滤器中最下面以一个）中的配置信息，将配置信息解析出来，封装成为一个Map,然后根据上下文和参数Map构建Dispatcher(见源文件Struts2的核心包，最重要的类都放在该包中)

private Dispatcher createDispatcher( HostConfig filterConfig ) {
        //存放参数的Map
        Map params = new HashMap();
        //将参数存放到Map
        for ( Iterator e = filterConfig.getInitParameterNames(); e.hasNext(); ) {
            String name = (String) e.next();
            String value = filterConfig.getInitParameter(name);
            params.put(name, value);
        }
        //根据servlet上下文和参数Map构造Dispatcher 
        return new Dispatcher(filterConfig.getServletContext(), params);
    }

dispatcher对象创建完成，接着就是dispatchar对象的初始化，打开Dispatcher类，看到它的init方法如下：

public void init() {
 
        if (configurationManager == null) {
            configurationManager = createConfigurationManager(BeanSelectionProvider.DEFAULT_BEAN_NAME);
        }
 
        try {
            init_FileManager();
            //加载org/apache/struts2/default.properties
            init_DefaultProperties(); // [1]
            //加载struts-default.xml,struts-plugin.xml,struts.xml
            init_TraditionalXmlConfigurations(); // [2]
            init_LegacyStrutsProperties(); // [3]
            //用户自己实现的ConfigurationProviders类 
            init_CustomConfigurationProviders(); // [5]
            //Filter的初始化参数 
            init_FilterInitParameters() ; // [6]
            init_AliasStandardObjects() ; // [7]
 
            Container container = init_PreloadConfiguration();
            container.inject(this);
            init_CheckWebLogicWorkaround(container);
 
            if (!dispatcherListeners.isEmpty()) {
                for (DispatcherListener l : dispatcherListeners) {
                    l.dispatcherInitialized(this);
                }
            }
        } catch (Exception ex) {
            if (LOG.isErrorEnabled())
                LOG.error("Dispatcher initialization failed", ex);
            throw new StrutsException(ex);
        }
    }

Structs请求过程源码分析参考链接http://www.cnblogs.com/liuling/p/2013-8-10-01.html

Structs 配置文件加载循序：

3 默认拦截器

struts-default.xml配置文件中定义了一个默认拦截器栈，这些拦截器就是动作方法执行之前的要执行的。常用的有封装用户表单数据到javabean的modelDriven拦截器，用于输入验证的validation拦截器，等等

4 view和controller之间的交互

从视图页面每次发来的用户请求会产生一些数据，每次动作类执行之前，核心过滤器StrutsPrepareAndExecuteFilter都会创建两个对象：ActionContext和ValueStack,这两个对象储蓄了动作访问期间用到的所有数据。这些数据又可以在JSP界面上通过stuct标签和OGNL表达式来取得。

ActionContext是一个map数据结构，其中的key是一些常见的域对象（application,session,request等），而value又是一个map。也就是说ActionContext是一个大的map包裹着一些小map。

ValueStack是一个ArrayList数据结构，并且是一个栈结构，每次都在栈顶存取数据。

5 Controller与Model之间的交互

C与M之间的交互比较简单，利用Structs框架提供的拦截器：ModelDriven,即可实现将用户表单提交的数据封装到对应的javabean中。要点：

javabean类自己编写。

动作实现ModelDriven接口。

实现抽象方法getModel()。