zoukankan      html  css  js  c++  java

  • struts2拦截器源码分析

    前面博客我们介绍了开发struts2应用程序的基本流程（开发一个struts2的实例），通过前面我们知道了struts2实现请求转发和配置文件加载都是拦截器进行的操作，这也就是为什么我们要在web.xml配置struts2的拦截器的原因了。我们知道，在开发struts2应用开发的时候我们要在web.xml进行配置拦截器org.apache.struts2.dispatcher.ng.filter.StrutsPrepareAndExecuteFilter（在一些老版的一般配置org.apache.struts2.dispatcher.FilterDispatcher），不知道大家刚开始学的时候有没有这个疑问，为什么通过这个拦截器我们就可以拦截到我们提交的请求，并且一些配置文件就可以得到加载呢？不管你有没有，反正我是有。我想这个问题的答案，我们是非常有必要去看一下这个拦截器的源码去找。

    打开StrutsPrepareAndExecuteFilter拦截器源码我们可以看出以下类的信息

    属性摘要：

    Protected List<Pattern> excludedPatterns

    protected ExecuteOperations execute 
    protected PrepareOperations prepare

    我们可以看出StrutsPrepareAndExecuteFilter与普通的Filter并无区别，方法除继承自Filter外，仅有一个回调方法，第三部分我们将按照Filter方法调用顺序，init—>doFilter—>destroy顺序地分析源码。

    提供的方法：

    destroy()

    继承自Filter，用于资源释放

    doFilter(ServletRequest req, ServletResponse res, FilterChain chain)

    继承自Filter，执行方法

    init(FilterConfig filterConfig)

    继承自Filter，初始化参数

    postInit(Dispatcher dispatcher, FilterConfig filterConfig)

    Callback for post initialization（一个空的方法，用于方法回调初始化）

    下面我们一一对这些方法看一下：

    1.init方法：我们先整体看一下这个方法：

    [java] view plaincopyprint?

    1. public void init(FilterConfig filterConfig) throws ServletException {

    3. InitOperations init = new InitOperations();

    5. try {

    7. //封装filterConfig，其中有个主要方法getInitParameterNames将参数名字以String格式存储在List中

    9. FilterHostConfig config = new FilterHostConfig(filterConfig);

    11. // 初始化struts内部日志

    13. init.initLogging(config);

    15. //创建dispatcher ，并初始化，这部分下面我们重点分析，初始化时加载那些资源

    17. Dispatcher dispatcher = init.initDispatcher(config);

    19. init.initStaticContentLoader(config, dispatcher);

    21. //初始化类属性：prepare 、execute

    23. prepare = new PrepareOperations(filterConfig.getServletContext(), dispatcher);

    25. execute = new ExecuteOperations(filterConfig.getServletContext(), dispatcher);

    27. this.excludedPatterns = init.buildExcludedPatternsList(dispatcher);

    29. //回调空的postInit方法

    31. postInit(dispatcher, filterConfig);

    33. } finally {

    35. init.cleanup();

    37. }

    39. }


    首先开一下FilterHostConfig 这个封装configfilter的类： 这个类总共不超过二三十行代码getInitParameterNames是这个类的核心，将Filter初始化参数名称有枚举类型转为Iterator。此类的主要作为是对filterConfig 封装。具体代码如下：

    [java] view plaincopyprint?

    1. public Iterator<String> getInitParameterNames() {

    3. return MakeIterator.convert(config.getInitParameterNames());

    5. }

    下面咱接着一块看Dispatcher dispatcher = init.initDispatcher(config);这是重点，创建并初始化Dispatcher ，看一下具体代码：

    [html] view plaincopyprint?

    1. public Dispatcher initDispatcher( HostConfig filterConfig ) {

    3. Dispatcher dispatcher = createDispatcher(filterConfig);

    5. dispatcher.init();

    7. return dispatcher;

    9. }

    12. span style="FONT-SIZE: 18px"><span style="color:#000000;BACKGROUND: rgb(255,255,255)"> </span><span style="color:#000000;BACKGROUND: rgb(255,255,255)"><span style="color:#cc0000;"><strong>创建<span style="font-family:Verdana;">Dispatcher</span><span style="font-family:宋体;">，会读取 </span><span style="font-family:Verdana;">filterConfig </span><span style="font-family:宋体;">中的配置信息，将配置信息解析出来，封装成为一个</span><span style="font-family:Verdana;">Map</span></strong></span><span style="font-family:宋体;">，然后</span></span><span style="color:#000000;BACKGROUND: rgb(255,255,255)">根据</span><span style="color:#000000;BACKGROUND: rgb(255,255,255)">servlet<span style="font-family:宋体;">上下文和参数</span><span style="font-family:Verdana;">Map</span><span style="font-family:宋体;">构造</span><span style="font-family:Verdana;">Dispatcher </span><span style="font-family:宋体;">：</span></span></span>

    [java] view plaincopyprint?

    1. private Dispatcher createDispatcher( HostConfig filterConfig ) {

    3. Map<String, String> params = new HashMap<String, String>();

    5. for ( Iterator e = filterConfig.getInitParameterNames(); e.hasNext(); ) {

    7. String name = (String) e.next();

    9. String value = filterConfig.getInitParameter(name);

    11. params.put(name, value);

    13. }

    15. return new Dispatcher(filterConfig.getServletContext(), params);

    17. }


    Dispatcher构造玩以后，开始对他进行初始化，加载struts2的相关配置文件，将按照顺序逐一加载：default.properties，struts-default.xml,struts-plugin.xml,struts.xml，……我们一起看看他是怎么一步步的加载这些文件的 dispatcher的init()方法：

    [html] view plaincopyprint?

    1. public void init() {

    4. if (configurationManager == null) {

    6. configurationManager = createConfigurationManager(BeanSelectionProvider.DEFAULT_BEAN_NAME);

    8. }

    9. try {

    11. init_DefaultProperties(); // [1]

    13. init_TraditionalXmlConfigurations(); // [2]

    15. init_LegacyStrutsProperties(); // [3]

    17. init_CustomConfigurationProviders(); // [5]

    19. init_FilterInitParameters() ; // [6]

    21. init_AliasStandardObjects() ; // [7]

    24. Container container = init_PreloadConfiguration();

    26. container.inject(this);

    28. init_CheckConfigurationReloading(container);

    30. init_CheckWebLogicWorkaround(container);

    33. if (!dispatcherListeners.isEmpty()) {

    35. for (DispatcherListener l : dispatcherListeners) {

    37. l.dispatcherInitialized(this);

    39. }

    41. }

    43. } catch (Exception ex) {

    45. if (LOG.isErrorEnabled())

    47. LOG.error("Dispatcher initialization failed", ex);

    49. throw new StrutsException(ex);

    51. }

    53. }


    下面我们一起来看一下【1】，【2】，【3】，【5】，【6】的源码，看一下什么都一目了然了：

    1.这个方法中是将一个DefaultPropertiesProvider对象追加到ConfigurationManager对象内部的ConfigurationProvider队列中。 DefaultPropertiesProvider的register()方法可以载入org/apache/struts2/default.properties中定义的属性。

    [html] view plaincopyprint?

    1. try {

    3. defaultSettings = new PropertiesSettings("org/apache/struts2/default");

    5. } catch (Exception e) {

    7. throw new ConfigurationException("Could not find or error in org/apache/struts2/default.properties", e);

    9. }


    2. 调用init_TraditionalXmlConfigurations()方法，实现载入FilterDispatcher的配置中所定义的config属性。 如果用户没有定义config属性，struts默认会载入DEFAULT_CONFIGURATION_PATHS这个值所代表的xml文件。它的值为"struts-default.xml,struts-plugin.xml,struts.xml"。也就是说框架默认会载入这三个项目xml文件。如果文件类型是XML格式，则按照xwork-x.x.dtd模板进行读取。如果，是Struts的配置文件，则按struts-2.X.dtd模板进行读取。

    private static final String DEFAULT_CONFIGURATION_PATHS = "struts-default.xml,struts-plugin.xml,struts.xml";

    3.创建一个LegacyPropertiesConfigurationProvider类，并将它追加到ConfigurationManager对象内部的ConfigurationProvider队列中。LegacyPropertiesConfigurationProvider类载入struts.properties中的配置，这个文件中的配置可以覆盖default.properties中的。其子类是DefaultPropertiesProvider类

    5.init_CustomConfigurationProviders()此方法处理的是FilterDispatcher的配置中所定义的configProviders属性。负责载入用户自定义的ConfigurationProvider。

    [html] view plaincopyprint?

    1. String configProvs = initParams.get("configProviders");

    3. if (configProvs != null) {

    5. String[] classes = configProvs.split("\s*[,]\s*");

    7. for (String cname : classes) {

    9. try {

    11. Class cls = ClassLoaderUtils.loadClass(cname, this.getClass());

    13. ConfigurationProvider prov = (ConfigurationProvider)cls.newInstance();

    15. configurationManager.addConfigurationProvider(prov);

    17. } catch (InstantiationException e) {

    19. throw new ConfigurationException("Unable to instantiate provider: "+cname, e);

    21. } catch (IllegalAccessException e) {

    23. throw new ConfigurationException("Unable to access provider: "+cname, e);

    25. } catch (ClassNotFoundException e) {

    27. throw new ConfigurationException("Unable to locate provider class: "+cname, e);

    29. }

    31. }

    33. }


    6.init_FilterInitParameters()此方法用来处理FilterDispatcher的配置中所定义的所有属性

    7. init_AliasStandardObjects()，将一个BeanSelectionProvider类追加到ConfigurationManager对象内部的ConfigurationProvider队列中。BeanSelectionProvider类主要实现加载org/apache/struts2/struts-messages。

    [html] view plaincopyprint?

    1. private void init_AliasStandardObjects() {

    2. configurationManager.addConfigurationProvider(

    3. new BeanSelectionProvider());

    4. }



    相信看到这大家应该明白了，struts2的一些配置的加载顺序和加载时所做的工作，其实有些地方我也不是理解的很清楚。其他具体的就不在说了，init方法占时先介绍到这

    2、doFilter方法

    doFilter是过滤器的执行方法，它拦截提交的HttpServletRequest请求，HttpServletResponse响应，作为strtus2的核心拦截器，在doFilter里面到底做了哪些工作，我们将逐行解读其源码，大体源码如下：

    [html] view plaincopyprint?

    1. public void doFilter(ServletRequest req, ServletResponse res, FilterChain chain) throws IOException, ServletException {

    3. //父类向子类转：强转为http请求、响应

    5. HttpServletRequest request = (HttpServletRequest) req;

    7. HttpServletResponse response = (HttpServletResponse) res;

    9. try {

    11. //设置编码和国际化

    13. prepare.setEncodingAndLocale(request, response);

    15. //创建Action上下文（重点）

    17. prepare.createActionContext(request, response);

    19. prepare.assignDispatcherToThread();

    21. if ( excludedPatterns != null && prepare.isUrlExcluded(request, excludedPatterns)) {

    23. chain.doFilter(request, response);

    25. } else {

    27. request = prepare.wrapRequest(request);

    29. ActionMapping mapping = prepare.findActionMapping(request, response, true);

    31. if (mapping == null) {

    33. boolean handled = execute.executeStaticResourceRequest(request, response);

    35. if (!handled) {

    37. chain.doFilter(request, response);

    39. }

    41. } else {

    43. execute.executeAction(request, response, mapping);

    45. }

    47. }

    49. } finally {

    51. prepare.cleanupRequest(request);

    53. }

    55. }


    下面我们就逐句的来的看一下：设置字符编码和国际化很简单prepare调用了setEncodingAndLocale，然后调用了dispatcher方法的prepare方法：

    [html] view plaincopyprint?

    1. /**

    3. * Sets the request encoding and locale on the response

    5. */

    7. public void setEncodingAndLocale(HttpServletRequest request, HttpServletResponse response) {

    9. dispatcher.prepare(request, response);

    11. }


    看下prepare方法，这个方法很简单只是设置了encoding 、locale ，做的只是一些辅助的工作：

    [html] view plaincopyprint?

    1. public void prepare(HttpServletRequest request, HttpServletResponse response) {

    3. String encoding = null;

    5. if (defaultEncoding != null) {

    7. encoding = defaultEncoding;

    9. }

    11. Locale locale = null;

    13. if (defaultLocale != null) {

    15. locale = LocalizedTextUtil.localeFromString(defaultLocale, request.getLocale());

    17. }

    19. if (encoding != null) {

    21. try {

    23. request.setCharacterEncoding(encoding);

    25. } catch (Exception e) {

    27. LOG.error("Error setting character encoding to '" + encoding + "' - ignoring.", e);

    29. }

    31. }

    33. if (locale != null) {

    35. response.setLocale(locale);

    37. }

    39. if (paramsWorkaroundEnabled) {

    41. request.getParameter("foo"); // simply read any parameter (existing or not) to "prime" the request

    43. }

    45. }


    下面咱重点看一下创建Action上下文重点

    Action上下文创建（重点）

    ActionContext是一个容器，这个容易主要存储request、session、application、parameters等相关信息.ActionContext是一个线程的本地变量，这意味着不同的action之间不会共享ActionContext，所以也不用考虑线程安全问题。其实质是一个Map，key是标示request、session、……的字符串，值是其对应的对象：

    static ThreadLocal actionContext = new ThreadLocal();

    Map<String, Object> context;

    下面我们看起来下创建action上下文的源码：

    [html] view plaincopyprint?

    1. /**

    3. *创建Action上下文，初始化thread local

    5. */

    7. public ActionContext createActionContext(HttpServletRequest request, HttpServletResponse response) {

    9. ActionContext ctx;

    11. Integer counter = 1;

    13. Integer oldCounter = (Integer) request.getAttribute(CLEANUP_RECURSION_COUNTER);

    15. if (oldCounter != null) {

    17. counter = oldCounter + 1;

    19. }

    23. //注意此处是从ThreadLocal中获取此ActionContext变量

    25. ActionContext oldContext = ActionContext.getContext();

    27. if (oldContext != null) {

    29. // detected existing context, so we are probably in a forward

    31. ctx = new ActionContext(new HashMap<String, Object>(oldContext.getContextMap()));

    33. } else {

    35. ValueStack stack = dispatcher.getContainer().getInstance(ValueStackFactory.class).createValueStack();

    37. stack.getContext().putAll(dispatcher.createContextMap(request, response, null, servletContext));

    39. //stack.getContext()返回的是一个Map<String，Object>，根据此Map构造一个ActionContext

    41. ctx = new ActionContext(stack.getContext());

    43. }

    45. request.setAttribute(CLEANUP_RECURSION_COUNTER, counter);

    47. //将ActionContext存如ThreadLocal

    49. ActionContext.setContext(ctx);

    51. return ctx;

    53. }


    一句句来看：

    ValueStackstack= dispatcher.getContainer().getInstance(ValueStackFactory.class).createValueStack();

    dispatcher.getContainer().getInstance(ValueStackFactory.class)根据字面估计一下就是创建ValueStackFactory的实例。这个地方我也只是根据字面来理解的。ValueStackFactory是接口，其默认实现是OgnlValueStackFactory，调用OgnlValueStackFactory的createValueStack()：

    下面看一下OgnlValueStack的构造方法

    [html] view plaincopyprint?

    1. protected OgnlValueStack(XWorkConverter xworkConverter, CompoundRootAccessor accessor, TextProvider prov, boolean allowStaticAccess) {

    3. //new一个CompoundRoot出来

    5. setRoot(xworkConverter, accessor, new CompoundRoot(), allowStaticAccess);

    7. push(prov);

    9. }


    接下来看一下setRoot方法：

    [html] view plaincopyprint?

    1. protected void setRoot(XWorkConverter xworkConverter, CompoundRootAccessor accessor, CompoundRoot compoundRoot,

    3. boolean allowStaticMethodAccess) {

    5. //OgnlValueStack.root = compoundRoot;

    7. this.root = compoundRoot;

    9. 1 //方法/属性访问策略。

    11. this.securityMemberAccess = new SecurityMemberAccess(allowStaticMethodAccess);

    13. //创建context了，创建context使用的是ongl的默认方式。

    15. //Ognl.createDefaultContext返回一个OgnlContext类型的实例

    17. //这个OgnlContext里面，root是OgnlValueStack中的compoundRoot，map是OgnlContext自己创建的private Map _values = new HashMap(23);

    19. this.context = Ognl.createDefaultContext(this.root, accessor, new OgnlTypeConverterWrapper(xworkConverter), securityMemberAccess);

    23. //不是太理解，猜测如下：

    25. //context是刚刚创建的OgnlContext，其中的HashMap类型_values加入如下k-v:

    27. //key:com.opensymphony.xwork2.util.ValueStack.ValueStack

    29. //value:this,这个应该是当前的OgnlValueStack实例。

    31. //刚刚用断点跟了一下，_values里面是：

    33. //com.opensymphony.xwork2.ActionContext.container=com.opensymphony.xwork2.inject.ContainerImpl@96231e

    35. //com.opensymphony.xwork2.util.ValueStack.ValueStack=com.opensymphony.xwork2.ognl.OgnlValueStack@4d912

    37. context.put(VALUE_STACK, this);

    39. //此时：OgnlValueStack中的compoundRoot是空的；

    41. //context是一个OgnlContext，其中的_root指向OgnlValueStack中的root，_values里面的东西，如刚才所述。

    43. //OgnlContext中的额外设置。

    45. Ognl.setClassResolver(context, accessor);

    47. ((OgnlContext) context).setTraceEvaluations(false);

    49. ((OgnlContext) context).setKeepLastEvaluation(false);

    51. }

    上面代码中dispatcher.createContextMap，如何封装相关参数：，我们以RequestMap为例，其他的原理都一样：主要方法实现：

    [html] view plaincopyprint?

    1. //map的get实现

    3. public Object get(Object key) {

    5. return request.getAttribute(key.toString());

    7. }

    9. //map的put实现

    11. public Object put(Object key, Object value) {

    13. Object oldValue = get(key);

    15. entries = null;

    17. request.setAttribute(key.toString(), value);

    19. return oldValue;

    21. }


    到此，几乎StrutsPrepareAndExecuteFilter大部分的源码都涉及到了。自己感觉都好乱，所以还请大家见谅，能力有限，希望大家可以共同学习

    本文来自：曹胜欢博客专栏。转载请注明出处：http://blog.csdn.net/csh624366188
  • 相关阅读:
    代理支持
    CGI
    SSI（服务器端嵌入）
    SSL/TLS 配置
    JSPs
    类加载机制
    JDBC 数据源
    安全管理
    Realm 配置
    Js将序列化成Json格式后日期（毫秒数）转成日期格式
  • 原文地址：https://www.cnblogs.com/jgig11/p/4162197.html
Copyright © 2011-2022 走看看