Java Structs框架原理案例詳解

Posted on by

1 Struts2框架內部執行過程

Structs請求過程源碼分析參考鏈接http://www.cnblogs.com/liuling/p/2013-8-10-01.html

從上圖來看，整個框架的運行過程是圍繞著核心過濾器StrutsPrepareAndExecuteFilter展開工作，深入到filter的源碼會對理解有所幫助。

一個請求在Struts的處理中大概有以下幾個步驟：

  1. 客戶端初始化一個指向Servlet容器（Tomcat）的請求；
  2. 這個請求經過一系列的過濾器（Filter）例如ActionContextCleanUp的可選過濾器；
  3. 接著StrutsPrepareAndExecuteFilter被調用，StrutsPrepareAndExecuteFilter詢問ActionMapper來決定這個請求是否需要調用某個Action；
  4. ActionMapper決定調用哪個Action,FilterDispatcher把請求的處理交給ActionProxy;
  5. ActionProxy通過Configuration Manager詢問框架的配置文件，找到需要調用的Action類；
  6. ActionProxy創建一個ActionInvocation的實例。
  7. ActionInvocation實例使用命名模式來調用，在調用Action的過程前後，涉及到相關攔截器（Intercepter）的調用。
  8. 一旦Action執行完畢，ActionInvocation負責根據struts.xml中的配置找到對應的返回結果。返回結果通常是（但不總是，也可能是另外的一個Action鏈）一個需要被表示的JSP或者FreeMarker的模版。在表示的過程中可以使用Struts2 框架中繼承的標簽。在這個過程中需要涉及到ActionMapper。

Structs的核心功能就是將請求委托給哪個Action處理。

到structs2官網上下載Structs-src.zip源文件，將其解壓

定位到：E:\structs2源碼\struts-2.5.20\src\core\src\main\java\org\apache\struts2查看源文件

有關包的說明：

  1. org.apache.struts2. components    該包封裝視圖組件，Struts2在視圖組件上有瞭很大加強，不僅增加瞭組件的屬性個數，更新增瞭幾個非常有用的組件，如updownselect、doubleselect、datetimepicker、token、tree等。另外，Struts2可視化視圖組件開始支持主題(theme)，缺省情況下，使用自帶的缺省主題，如果要自定義頁面效果，需要將組件的theme屬性設置為simple。
  2. org.apache.struts2. config
    該包定義與配置相關的接口和類。實際上，工程中的xml和properties文件的讀取和解析都是由WebWork完成的，Struts隻做瞭少量的工作。
  3. org.apache.struts2.dispatcher
    Struts2的核心包，最重要的類都放在該包中。
  4. org.apache.struts2.impl
    該包隻定義瞭3個類，他們是StrutsActionProxy、StrutsActionProxyFactory、StrutsObjectFactory，這三個類都是對xwork的擴展。
  5. org.apache.struts2.interceptor
    定義內置的截攔器。
  6. org.apache.struts2.servlet
    用HttpServletRequest相關方法實現principalproxy接口。
  7. org.apache.struts2.util
    實用包
  8. org.apache.struts2.views
    提供freemarker、jsp、velocity等不同類型的頁面呈現

根目錄下的5個文件說明：

  1. StrutsStatics 
    Struts常數。常數可以用來獲取或設置對象從行動中或其他集合。
  2. RequestUtils 
    請求處理程序類。此類隻有一個方法getServletPath，作用檢索當前請求的servlet路徑
  3. ServletActionContext 
    網站的特定的上下文信息
  4. StrutsConstants
    該類提供瞭框架配置鍵的中心位置用於存儲和檢索配置設置。
  5. StrutsException
    通用運行時異常類

（1）Structs2請求過程源碼分析：

Struts框架都會在web.xml中註冊和映射structs2,配置內容如下：

<filter> 
    <filter-name>struts2</filter-name>  
    <filter-class>org.apache.struts2.dispatcher.ng.filter.StrutsPrepareAndExecuteFilter</filter-class> 
  </filter>  
  <filter-mapping> 
    <filter-name>struts2</filter-name>  
    <url-pattern>/*</url-pattern> 
  </filter-mapping>

StrutsPrepareAndExecuteFilter中的方法：

  1. void init(FilterConfig filterConfig)    繼承自Filter，過濾器的初始化
  2. doFilter(ServletRequest req, ServletResponse res, FilterChain chain) 繼承自Filter，執行過濾器
  3. void destroy()     繼承自Filter，用於資源釋放
  4. 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<String> 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<String, String> params = new HashMap<String, String>();
        //將參數存放到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表達式來取得。

  1. ActionContext是一個map數據結構，其中的key是一些常見的域對象（application,session,request等），而value又是一個map。也就是說ActionContext是一個大的map包裹著一些小map。
  2. ValueStack是一個ArrayList數據結構，並且是一個棧結構，每次都在棧頂存取數據。

5 Controller與Model之間的交互

C與M之間的交互比較簡單，利用Structs框架提供的攔截器：ModelDriven,即可實現將用戶表單提交的數據封裝到對應的javabean中。要點：

  1. javabean類自己編寫。
  2. 動作實現ModelDriven接口。
  3. 實現抽象方法getModel()。

到此這篇關於Java Structs框架原理案例詳解的文章就介紹到這瞭,更多相關Java Structs框架原理內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：