浅谈Struts2登录拦截器

1、 拦截器原理

大部分时候，拦截器方法都是通过代理的方式来调用的。Struts 2的拦截器实现相对简单。当请求到达Struts 2的ServletDispatcher时，Struts 2会查找配置文件，并根据其配置实例化相对的拦截器对象，然后串成一个列表（list），最后一个一个地调用列表中的拦截器。事实上，我们之所以能够如此灵活地使用拦截器，完全归功于“动态代理”的使用。动态代理是代理对象根据客户的需求做出不同的处理。对于客户来说，只要知道一个代理对象就行了。那Struts2中，拦截器是如何通过动态代理被调用的呢？当Action请求到来的时候，会由系统的代理生成一个Action的代理对象，由这个代理对象调用Action的execute()或指定的方法，并在struts.xml中查找与该Action对应的拦截器。如果有对应的拦截器，就在Action的方法执行前（后）调用这些拦截器；如果没有对应的拦截器则执行Action的方法。其中系统对于拦截器的调用，是通过ActionInvocation来实现的。



2、struts.xml配置（仅参考）

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE struts PUBLIC "-//Apache Software Foundation//DTD Struts Configuration 2.3//EN" "http://struts.apache.org/dtds/struts-2.3.dtd">
<struts>
<constant name="struts.convention.default.parent.package"
value="cmcc-default" />
<constant name="struts.convention.package.locators" value="web" />
<constant name="struts.convention.result.path" value="/WEB-INF/jsp/" />
<constant name="struts.convention.package.locators.basePackage"
value="com.cmcc.monitor.web" />
<constant name="struts.i18n.encoding" value="utf-8" />
<constant name="struts.enable.DynamicMethodInvocation" value="true" />
<package name="cmcc-default" extends="convention-default">
<interceptors>
<interceptor name="loginInter" class="com.cmcc.monitor.base.LoginInterceptor" />
<interceptor name="CSRFInter" class="com.cmcc.monitor.base.CSRFTokenInterceptor"/>
<interceptor name="authInter" class="com.cmcc.monitor.base.AuthInterceptor" />

<interceptor-stack name="webStack">
<!-- 基于paramsPrepareParamsStack,增加store interceptor保证actionMessage在redirect后不会丢失 -->

<interceptor-ref name="store">
<param name="operationMode">AUTOMATIC</param>
</interceptor-ref>
<interceptor-ref name="paramsPrepareParamsStack" />
<interceptor-ref name="loginInter" />
<interceptor-ref name="authInter" />
<interceptor-ref name="CSRFInter" />
<!--大字体部分是添加的拦截器-->
</interceptor-stack><!--拦截器链，按顺序由ActionInvocation的invoke()执行调用各拦截器-->
</interceptors>

<default-interceptor-ref name="webStack" />

<global-exception-mappings>
<exception-mapping exception="java.lang.Exception"
result="error" />
</global-exception-mappings>
</package>

<!-- 使用Convention插件,实现约定大于配置的零配置文件风格. 特殊的Result路径在Action类中使用@Result设定. -->
</struts>

Struts.xml配置解析

1）常用constant解析

1.<!-- 把它设置为开发模式，发布时要设置为false -->
<constant name="struts.devMode" value="true" />
2.<!-- 设置在class被修改时是否热加载，发布时要设置为false -->
<constant name="struts.convention.classes.reload" value="true"/>
3.<!-- 自动动态方法的调用，使用这个设置后可以这样调用：action!method -->
<constant name="struts.enable.DynamicMethodInvocation" value="true" />
4.<!-- 指定jsp文件所在的目录地址 -->
<constant name="struts.convention.result.path" value="/WEB-INF/content/" />
5.<!-- 使用struts-default默认的转换器，如果是rest的使用：rest-default，rest需要rest的jar插件 -->
<constant name="struts.convention.default.parent.package" value="struts-default"/>
6.<!-- 用于配置包名后缀。默认为action、actions、struts-->
<constant name="struts.convention.package.locators" value="actions" />
7.<!-- 用于配置类名后缀，默认为Action，设置后，Struts2只会去找这种后缀名的类做映射 -->
<constant name="struts.convention.action.suffix" value="Action"/>
8.<!-- 设置即使没有@Action注释，依然创建Action映射。默认值是false。因为Convention-Plugin是约定优于配置的风格，可以不通过注解根据预先的定义就能访问相应Action中的方法 -->
<constant name="struts.convention.action.mapAllMatches" value="true"/>
9.<!-- 自定义jsp文件命名的分隔符 -->
<constant name="struts.convention.action.name.separator" value="-" />
10.<!-- 国际化资源文件名称 -->
<constant name="struts.custom.i18n.resources" value="i18n" />
11.<!-- 是否自动加载国际化资源文件  -->
<constant name="struts.i18n.reload" value="true" />
12.<!-- 浏览器是否缓存静态内容 -->
<constant name="struts.serve.static.browserCache" value="false" />
13.<!-- 上传文件大小限制设置 -->
<constant name="struts.multipart.maxSize" value="-1" />
14.<!-- 主题，将值设置为simple，即不使用UI模板。这将不会生成额外的html标签 -->
<constant name="struts.ui.theme" value="simple" />
15.<!-- 编码格式 -->
<constant name="struts.i18n.encoding" value="UTF-8" />

基础Constants

• struts.devMode 可选值true,false （默认false），在开发模式下，struts2的动态重新加载配置和资源文件的功能会默认生效。同时开发模式下也会提供更完善的日志支持。

• struts.i18n.reload 可选值true,false（默认值依赖于struts.devMode），是否自动重新加载本地的资源文件。

• struts.i18n.encoding 主要用于设置请求编码（默认值（UTF-8）） ，Head和Include标签的解析编码。 资源和配置文件的解析编码。

• struts.configuration.xml.reload 可选值true,false（默认值依赖于struts.devMode）是否自动重新加载XML配置文件

• struts.action.extension 设置struts的Action请求的后缀，支持多个时以逗号隔开。

• struts.action.excludePattern 设置struts所排除的url（通过正则表达式匹配）（支持多个，以逗号隔开）

• struts.tag.altSyntax 可选值true，false（默认true） 是否支持ognl表达式

• struts.url.http.port 设置生成URL所对应的http端口

• struts.url.https.port 设置生成URL所对应的https端口

• struts.url.includeParams 可选值 none, get, all (默认get)，设置URL是否包含参数，以及是否只包含GET方式的参数。

• struts.locale 设置struts2默认的locale，决定使用哪个资源文件。

• struts.ui.templateDir 该属性指定视图主题所需要模板文件的位置，该属性的默认值是template，即默认加载template路径下的模板文件

• struts.ui.theme 该属性指定视图标签默认的视图主题，该属性的默认值是xhtml。

• struts.ui.templateSuffix 该属性指定模板文件的后缀，该属性的默认属性值是ftl。该属性还允许使用ftl、vm或jsp，分别对应FreeMarker、Velocity和JSP模板

• struts.multipart.saveDir 设置上传临时文件的默认目录

• struts.multipart.maxSize 设置上传的临时文件的最大限制

• struts.objectFactory.spring.autoWire 可选值（name, type, auto, constructor,name）（默认name），设置spring的自动装配方式，只有引入spring插件后才有效。

• struts.objectFactory.spring.autoWire.alwaysRespect （默认false）设置是否总是以自动装配策略创建对象。

• struts.objectFactory.spring.useClassCache （默认false）对象工厂是否使用类缓存，开发模式无效。

• struts.xslt.nocache （默认为false）设置XsltResult是否不是用缓存。

• struts.custom.properties 设置用户的自定义属性文件名列表（用，隔开）

• struts.custom.i18n.resources 设置用户自定义的资源文件路径列表（用，隔开）

• struts.serve.static （默认false） 设置是否支持静态资源请求（要求url在struts或static下）

• struts.serve.static.browserCache （默认false） 是否在静态资源响应中设置缓存。只有在支持静态资源时有效。

• struts.el.throwExceptionOnFailure （默认false）是否在解析el表达式或无法找到属性时抛出RuntimeException

• struts.ognl.logMissingProperties （默认false）是否日志无发找到的属性

• struts.ognl.enableExpressionCache 是否缓存ognl解析的表达式。

• struts.enable.DynamicMethodInvocation （默认false）是否支持动态的方法调用,在URL上通过!method指定方法。

• struts.enable.SlashesInActionNames 在URL中的Action段中是否支持斜线

• struts.mapper.alwaysSelectFullNamespace （默认false） 是否总是用最后一个斜线前的URL段作为namespace

核心对象Constants

• struts.actionProxyFactory 设置ActionProxy的实体工厂，该工厂同时也生成默认的ActionInvoctation

• struts.xworkConverter 设置XWorkConverter对象，该对象用于获取各种类型的转换器。

• struts.unknownHandlerManager 设置UnknownHandlerManager的实现类，用于处理无法找到方法等异常。

• struts.multipart.handler 设置mutipartRequest的handler （默认是jakarta）对应类，org.apache.struts2.dispatcher.multipart.JakartaMultiPartRequest

• struts.mapper.class 可选值（struts，composite，restful，restful2）设置URL解析且映射到ACTION的实现，（默认struts）.

• struts.mapper.prefixMapping 通过URL前缀映射到对应的Mapper，格式为urlPrefix1:mapperName2,urlPrefix2:mapperName2。必须添加mapperClass为org.apache.struts2.dispatcher.mapper.PrefixBasedActionMapper，并指定struts.mapper.class为该mapper。

• struts.mapper.composite 设置是否支持复合（多个）actionMapper，mapperName用逗号隔开。必须配置struts.mapper.class 为composite 才会生效

• struts.mapper.idParameterName 用于Restful2ActionMapper作为URL中id所对应的parameterName

• struts.ognl.allowStaticMethodAccess （默认false）设置ognl表达式是否支持静态方法。

• struts.configuration 设置struts2的Settings类。（2.1.2后不再使用）

• struts.urlRenderer 设置struts2的URL render（用于生成的URL），（默认struts），类名org.apache.struts2.components.ServletUrlRenderer

• struts.objectFactory 设置struts2的对象工厂，默认（struts），类名org.apache.struts2.impl.StrutsObjectFactory，当引入struts2-spring插件之后，则被修改为org.apache.struts2.spring.StrutsSpringObjectFactory

• struts.xworkTextProvider 设置struts2的资源文件内容提供类的实现。默认为com.opensymphony.xwork2.TextProviderSupport

• struts.actionValidatorManager 设置ActionValidatorManager 的实现类。

• struts.valueStackFactory 设置struts2的ValueStack工厂的实现。

• struts.reflectionProvider 设置ReflectionProvider的实现类

• struts.reflectionContextFactory 设置ReflectionContextFactory的实现类

• struts.patternMatcher 设置PatternMatcher的实现类

• struts.staticContentLoader 设置StaticContentLoader的实现类

2)解释

<interceptor-ref name="store"><param name="operationMode">AUTOMATIC</param>

</interceptor-ref>

隐藏了

<interceptor name="store"          class="org.apache.struts2.interceptor.MessageStoreInterceptor" />

由 MessageStoreInterceptor 的 API 可以知道: 若 Action 类实现了 ValidationAware 接口, MessageStoreInterceptor 拦截器可以把和该 Action 相关的 messages, errors 和 field errors(下称 “消息”) 保存到 session 中(默认放在 Action 中, 而 Action 在 request 中). 以使可以跨请求访问 messages, errors 和 field errors.

2. 从文档上知道 operationMode 的合法取值有: NONE, STORE, RETRIEVE 和 AUTOMATIC. 其中 NONE 为默认值.

①. STORE: MessageStoreInterceptor 拦截器会把 “消息” 放入 session 域中.

②. RETRIEVE: MessageStoreInterceptor 拦截器会把 “消息” 从 session 中取出来, 放入 Action 中.

③. AUTOMATIC: MessageStoreInterceptor 拦截器会把 “消息” 从 session 中取出来, 放入 Action 中. 而且若响应结果的类型的 redirect, Action 中的 “消息” 会被放入 session 中.

3)

解释

<interceptor-ref name="paramsPrepareParamsStack" />

从字面上理解来说，这个stack的拦截器调用的顺序为：首先params，然后prepare，接下来modelDriven，最后再params。Struts 2.0的设计上要求modelDriven在params之前调用，而业务中prepare要负责准备model，准备model又需要参数，这就需要在prepare之前运行params拦截器设置相关参数，这个也就是创建paramsPrepareParamsStack的原因。

流程如下：

1. params拦截器首先给action中的相关参数赋值，如id

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

3. modelDriven拦截器将model对象压入value stack，这里的model对象就是在prepare中创建的

4. params拦截器再将参数赋值给model对象，所以在Action中参数从ParamUtil中获取

Integer scenicId = ParamUtil.getIntParameter(request, “scenicId”, null);// 景区id

5. action的业务逻辑执行 依据此stack

4）LoginInterceptor**参考代码**

public class LoginInterceptor extends AbstractInterceptor {
@Override
public String intercept(ActionInvocation arg0) throws Exception {

HttpServletRequest request = (HttpServletRequest) arg0.getInvocationContext().get(ServletActionContext.HTTP_REQUEST);
HttpServletResponse response = (HttpServletResponse) arg0.getInvocationContext().get(ServletActionContext.HTTP_RESPONSE);
// 继承UserActionSupport的action需要进行权限验证
if (arg0.getAction() instanceof UserActionSupport) {
Object o = request.getSession().getAttribute(CommonConstants.USER_BIND);
ActionProxy proxy = arg0.getProxy();
String actionString = proxy.getNamespace() + "/" + proxy.getActionName() + "!" + proxy.getMethod() + ".action";
if (o == null) {
// Ajax调用
if (actionString.startsWith("/member/password!changePassword.action") || actionString.startsWith("/member/address!saveAddress.action")
|| actionString.startsWith("/member/address!deletePassword.action") || actionString.startsWith("/member/promote!sendSms.action")
|| actionString.startsWith("/gift/index!gift.action") || actionString.startsWith("/member/address!setDefault.action")) {

WebUtil.returnJSON(response, "{\"successSign\":false,\"errorMsg\":\"您尚未登录或登录已超时，请重新登录后操作\"}", "json");
return null;
} else {
return WebActionSupport.LOIGIN;
}
} else
return arg0.invoke();
} else {
return arg0.invoke();//ActionInvocation实现调用拦截器栈（声明在struts.xml下）对象的下一个拦截器
}
}
}

此文乃参考前辈们知识的总结，用于学习笔记，若有错误，请一定要吐槽下哦~(^__^) 嘻嘻