Struts2 下拦截器的简单使用

GitHub 地址

访问GitHub下载最新源码：https://github.com/JYG0723/Struts2_Action

---

简介：

环境与基本配置与上一篇一致。这里简单的利用一个拦截器拦截一个对 Aciton 的请求，计算了一下访问一次该 Action 所花费的时间。拦截器的作用还请自行百度

---

第一个拦截器实例：访问 Action 时间记录

TimerAction

public class TimerAction extends ActionSupport {

    @Override
    public String execute() throws Exception {

        for (int i = 0; i < 10000; i++) {
            System.out.println("I LOVE IMOOC");
        }
        return SUCCESS;
    }
}

TimerInteceptor

public class TimerInterceptor extends AbstractInterceptor {

    // 执行 Action 的时候，会自动调用该方法
    public String intercept(ActionInvocation actionInvocation) throws Exception {
        // 执行 Action 之前，获取当前系统时间
        long start = System.currentTimeMillis();

        // 执行下一个拦截器，如果已经是最后一个拦截器，则执行目标 Action
        String result = actionInvocation.invoke();

        // 执行 Action 之后，获取当前系统时间
        long end = System.currentTimeMillis();

        System.out.println("执行Action花费的时间: " + (end - start));
        return result;
    }

}

struts.xml

<package name="default" namespace="/" extends="struts-default">
    <!-- 注册拦截器 -->
    <interceptors>
        <interceptor name="timerInterceptor" class="interceptor.TimerInterceptor"></interceptor>
    </interceptors>

    <action name="timer" class="action.TimerAction">
        <!-- 引用拦截器 -->
        <interceptor-ref name="timerInterceptor"></interceptor-ref>
        <result>/success.jsp</result>
    </action>
</package>

index.jsp

<a href="timer">点击计算访问一次 Action 所花费的时间</a>

---

Struts2 内建拦截器

• params 拦截器
  • 负责将请求参数设置为 Action 属性
• staticParams 拦截器
  • 将配置文件中 action 元素的子元素 param 参数设置为 Action 属性
• servletConfig 拦截器
  • 将源于 Servlet API 的各种对象注入到 Action，必须实现对应接口
• fileUpload 拦截器
  • 对文件上传提供支持，将文件和元数据设置到对应的 Action 属性中
• exception 拦截器
  • 捕获 Struts2 中发生的异常， 并且将异常映射到用户自定义的页面
• validation 拦截器
  • 调用验证框架进行数据验证

struts-default.xml

<interceptor name="alias" class="com.opensymphony.xwork2.interceptor.AliasInterceptor"/>
<interceptor name="autowiring" class="com.opensymphony.xwork2.spring.interceptor.ActionAutowiringInterceptor"/>
<interceptor name="chain" class="com.opensymphony.xwork2.interceptor.ChainingInterceptor"/>
<interceptor name="conversionError" class="org.apache.struts2.interceptor.StrutsConversionErrorInterceptor"/>
<interceptor name="cookie" class="org.apache.struts2.interceptor.CookieInterceptor"/>
<interceptor name="cookieProvider" class="org.apache.struts2.interceptor.CookieProviderInterceptor"/>
<interceptor name="clearSession" class="org.apache.struts2.interceptor.ClearSessionInterceptor" />
<interceptor name="createSession" class="org.apache.struts2.interceptor.CreateSessionInterceptor" />
<interceptor name="debugging" class="org.apache.struts2.interceptor.debugging.DebuggingInterceptor" />
<interceptor name="execAndWait" class="org.apache.struts2.interceptor.ExecuteAndWaitInterceptor"/>
<interceptor name="exception" class="com.opensymphony.xwork2.interceptor.ExceptionMappingInterceptor"/>
<interceptor name="fileUpload" class="org.apache.struts2.interceptor.FileUploadInterceptor"/>
<interceptor name="i18n" class="org.apache.struts2.interceptor.I18nInterceptor"/>
<interceptor name="logger" class="com.opensymphony.xwork2.interceptor.LoggingInterceptor"/>
<interceptor name="modelDriven" class="com.opensymphony.xwork2.interceptor.ModelDrivenInterceptor"/>
<interceptor name="scopedModelDriven" class="com.opensymphony.xwork2.interceptor.ScopedModelDrivenInterceptor"/>
<interceptor name="params" class="com.opensymphony.xwork2.interceptor.ParametersInterceptor"/>
<interceptor name="actionMappingParams" class="org.apache.struts2.interceptor.ActionMappingParametersInteceptor"/>
<interceptor name="prepare" class="com.opensymphony.xwork2.interceptor.PrepareInterceptor"/>
<interceptor name="staticParams" class="com.opensymphony.xwork2.interceptor.StaticParametersInterceptor"/>
<interceptor name="scope" class="org.apache.struts2.interceptor.ScopeInterceptor"/>
<interceptor name="servletConfig" class="org.apache.struts2.interceptor.ServletConfigInterceptor"/>
<interceptor name="timer" class="com.opensymphony.xwork2.interceptor.TimerInterceptor"/>
<interceptor name="token" class="org.apache.struts2.interceptor.TokenInterceptor"/>
<interceptor name="tokenSession" class="org.apache.struts2.interceptor.TokenSessionStoreInterceptor"/>
<interceptor name="validation" class="org.apache.struts2.interceptor.validation.AnnotationValidationInterceptor"/>
<interceptor name="workflow" class="com.opensymphony.xwork2.interceptor.DefaultWorkflowInterceptor"/>
<interceptor name="store" class="org.apache.struts2.interceptor.MessageStoreInterceptor" />
<interceptor name="checkbox" class="org.apache.struts2.interceptor.CheckboxInterceptor" />
<interceptor name="datetime" class="org.apache.struts2.interceptor.DateTextFieldInterceptor" />
<interceptor name="profiling" class="org.apache.struts2.interceptor.ProfilingActivationInterceptor" />
<interceptor name="roles" class="org.apache.struts2.interceptor.RolesInterceptor" />
<interceptor name="annotationWorkflow" class="com.opensymphony.xwork2.interceptor.annotations.AnnotationWorkflowInterceptor" />
<interceptor name="multiselect" class="org.apache.struts2.interceptor.MultiselectInterceptor" />
<interceptor name="noop" class="org.apache.struts2.interceptor.NoOpInterceptor" />

可以看到 Struts2 的内建拦截器有很多。当然有的我们会用到，有的不会用到。但其还为我们声明了许多的拦截器栈，方便我们以组合的形式来使用。默认的，只要你的struts.xml文件中的package标签的extends="struts-default"。那么下面的defaultStack默认拦截器栈已经被你这个包下的所有 Action 所使用。

defaultStack

<interceptor-stack name="defaultStack">
    <interceptor-ref name="exception"/>
    <interceptor-ref name="alias"/>
    <interceptor-ref name="servletConfig"/>
    <interceptor-ref name="i18n"/>
    <interceptor-ref name="prepare"/>
    <interceptor-ref name="chain"/>
    <interceptor-ref name="scopedModelDriven"/>
    <interceptor-ref name="modelDriven"/>
    <interceptor-ref name="fileUpload"/>
    <interceptor-ref name="checkbox"/>
    <interceptor-ref name="datetime"/>
    <interceptor-ref name="multiselect"/>
    <interceptor-ref name="staticParams"/>
    <interceptor-ref name="actionMappingParams"/>
    <interceptor-ref name="params"/>
    <interceptor-ref name="conversionError"/>
    <interceptor-ref name="validation">
        <param name="excludeMethods">input,back,cancel,browse</param>
    </interceptor-ref>
    <interceptor-ref name="workflow">
        <param name="excludeMethods">input,back,cancel,browse</param>
    </interceptor-ref>
    <interceptor-ref name="debugging"/>
</interceptor-stack>

注意：

需要注意的就是，当为包中的某个 Action 显示的指定了某个拦截器，则默认的拦截器将不再起作用。

struts.xml

<action name="timer" class="action.TimerAction">
    <!--在拦截器调用的时候，配置的先后顺序决定了该 Action 的拦截器的调用顺序，一般先调用默认的拦截器栈-->
    <interceptor-ref name="defaultStack"></interceptor-ref>
    <!-- 引用拦截器 -->
    <interceptor-ref name="timerInterceptor"></interceptor-ref>
    <result>/success.jsp</result>
</action>

---

第二个拦截器实例：权限验证

LoginAction

public class LoginAction extends ActionSupport implements SessionAware {

    private String username;
    private String password;
    // 封装了 session 的 Map 集合，需要实现 SessionAware 接口
    private Map<String, Object> session;

    public void setSession(Map<String, Object> session) {
        this.session = session;
    }

    // getter/setter

    /**
     * 处理登录请求
     */
    public String login() {
        if ("admin".equals(username) && "admin".equals(password)) {
            session.put("loginInfo", username);
            return SUCCESS;
        } else {
            session.put("loginError", "用户名和密码不正确");
            return ERROR;
        }
    }
}

AuthInterceptor

public class AuthInterceptor extends AbstractInterceptor {

    public String intercept(ActionInvocation actionInvocation) throws Exception {

        ActionContext actionContext = ActionContext.getContext();
        Map<String, Object> session = actionContext.getSession();

        if (session.get("loginInfo") != null) {
            String result = actionInvocation.invoke();
            return result;
        } else {
            return "login";
        }
    }
}

struts.xml

<struts>
    <constant name="struts.enable.DynamicMethodInvocation" value="false"></constant>
    <constant name="struts.devMode" value="true"></constant>

    <package name="default" namespace="/" extends="struts-default">

        <interceptors>
            <interceptor name="auth" class="interceptor.AuthInterceptor"></interceptor>
            <!-- 自定义拦截器栈，组合了 auth Inteceptor 和 defaultStack -->
            <interceptor-stack name="myStack">
                <interceptor-ref name="defaultStack"></interceptor-ref>
                <interceptor-ref name="auth"></interceptor-ref>
            </interceptor-stack>
        </interceptors>

        <!-- 通过该 Action 访问后台管理页面，需要判断用户是否已登录，如果未登录则跳转到登录页面 -->
        <action name="auth"> 
            <!-- 这里没有实现类，会默认调用 ActionSupport 类,则结果一定返回 `success`,但经过拦截器就会被修改规则判定如果没有登录则返回 `login` -->
            <interceptor-ref name="myStack"></interceptor-ref>
            <result>/WEB-INF/page/admin.jsp</result>
            <result name="login">/login.jsp</result>
        </action>
        
        <!-- 通过该 Action 处理表单登录验证，如果用户名和密码有误则跳转到登录页面 -->
        <action name="login" class="action.LoginAction" method="login">
            <result>/WEB-INF/page/admin.jsp</result>
            <result name="error">/login.jsp</result>
        </action>

    </package>
</struts>

login.jsp

${loginError}
<form action="login.action" method="post">
    用户名: <input type="text" name="username">
    密码: <input type="password" name="password">
    <input type="submit" value="提交">
</form>