007--在Struts2的Action中訪問Servlet API三種形式

前面已經對Struts2的流程執行完了，如果提交表單中有引數應該如何接收呢？又或者需要向頁面儲存資料，又要如何操作呢？接下來，我們通過學習Struts2訪問Servlet的API來實現這樣的功能。
在Struts2中，Action並沒有和Servlet API進行耦合，也就是說在Action中不能直接訪問Servlet API。雖然Struts2中Action訪問Servlet API麻煩一些，但這確實Struts2中Action的重要改良之一，方便對Action進行單元測試。
儘管Action和Servlet API解耦會帶來很多好處，但是在Action中卻需要經常訪問Servlet中物件，比如session request application等。
下面就介紹一下通過以下三種方法訪問Servlet API。

通過ActionContext訪問

Struts2提供了ActionContext物件來訪問Servlet API，ActionContext是Action執行的上下文物件，在ActionContext中儲存了Action執行所需要的物件，比如request session parameters application等。

下面，簡單列舉一下常用方法：

方法宣告	功能描述
void put(String key,Object value)	將key-value鍵值對放入ActionContext中，模擬Servlet API中的HttpServletRequest的setAttribute()方法
Object get(String key)	通過引數key查詢當前ActionContext中的值
Map<String,Object> getApplication()	返回Application級別的Map物件
static ActionContext getContext()	獲取當前執行緒的ActionContext物件
Map<String,Object> getParameters()	返回一個包含所有HttpServletRequest引數資訊的map物件
Map<String,Object> getSession()	返回Session級別的Map物件
void setApplication(Map<String,Object> application)	設定上下文物件
Map<String,Object> setSession()	設定一個map型別的session值

示例：

        // 獲取當前執行緒的actionContetx
        ActionContext actionContext = ActionContext.getContext();
        // 在application級別設定name屬性
        actionContext.getApplication().put("name", "wangcai");
        // 在session級別設定name屬性
        actionContext.getSession().put("name", "小明");
        // 在request級別設定name屬性
        actionContext.put("name", "飛飛");

新增使用者示例

jsp:

<h1>通過ActionContext訪問Servlet API</h1>
<form method="post" action="${pageContext.request.contextPath}/user/user_add.action">
    姓名：<input type="text" name="name"/><br>
    年齡：<input type="text" name="age"/><br>
    <input type="submit" value="提交"/>
</form>

java:

public String add() {
        System.out.println("add");
        ActionContext actionContext = ActionContext.getContext();
        Map<String, Object> session = actionContext.getSession();
        Map<String, Object> application = actionContext.getApplication();
        Map<String, Object> parameters = actionContext.getParameters();
        System.out.println("************** session start **************");
        for (Map.Entry<String, Object> entry : session.entrySet()) {
            System.out.println(entry.getKey());
        }
        System.out.println("************** session end **************");
        System.out.println("************** application start **************");
        for (Map.Entry<String, Object> entry : application.entrySet()) {
            System.out.println(entry.getKey());
        }
        System.out.println("************** application end **************");
        System.out.println("************** parameters start **************");
        for (Map.Entry<String, Object> entry : parameters.entrySet()) {
            System.out.println(entry.getKey());
        }
        System.out.println("************** parameters end **************");
        return NONE;
    }

輸出為：

add
************** session start **************
************** session end **************
************** application start **************
javax.servlet.context.tempdir
javax.websocket.server.ServerContainer
org.apache.catalina.resources
org.apache.tomcat.util.scan.MergedWebXml
org.apache.catalina.jsp_classpath
org.apache.jasper.compiler.ELInterpreter
freemarker.Configuration
org.apache.jasper.compiler.TldCache
org.apache.tomcat.InstanceManager
org.apache.tomcat.JarScanner
org.apache.jasper.runtime.JspApplicationContextImpl
************** application end **************
************** parameters start **************
age
name
************** parameters end **************

如上，分別列印了通過ActionContext獲取到的parameters session application等相關資料資訊。

通過特定介面訪問

Struts2可以讓開發者通過ActionContext去訪問關心的資料物件，但是卻無法直接獲得Servlet API。
為了在Action中直接訪問ServletAPI，Struts2還提供了一系列介面，具體如下：

• ServletRequestAware：實現該介面的Action可以直接訪問Web應用的HttpServletRequest例項
• ServletResponseAware：實現該介面的Action可以直接訪問Web應用的HttpServletResponse例項
• SessionAware：實現該介面的Action可以直接訪問Web應用的HttpSession例項
• ServletContextAware：實現該介面的Action可以直接訪問Web應用的ServletContext例項

示例：
Action：

public class RequestDemo2Action extends ActionSupport implements ServletRequestAware {
    HttpServletRequest request;

    @Override
    public void setServletRequest(HttpServletRequest httpServletRequest) {
        this.request = httpServletRequest;
    }

    @Override
    public String execute() throws Exception {
        System.out.println("request 2 called");
        request.setAttribute("message", "通過ServletRequestAware介面實現訪問Servlet API");
        return SUCCESS;
    }
}

struts.xml：

<action name="request2" class="com.happ.demo.RequestDemo2Action" method="execute">
            <result name="success">request2.jsp</result>
        </action>

jsp:

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>Request 2</title>
</head>
<body>
${requestScope.message}
</body>
</html>

接下來，通過url訪問"http://localhost:8080/hello/request2"，成功跳轉到request2.jsp頁面，並先顯示出在Action中設定的message資訊。

通過ServletActionContext訪問

為了直接訪問Servlet API，Struts2框架還提供了ServletActionContext類，該類常用的幾個靜態方法如下：

• static HttpServletRequest getRequest()：獲取web應用的HttpServletRequest物件
• static HttpServletResponse getResponse()：獲取web應用的HttpServletResponse物件
• static ServletContext getServletContext()：獲取web應用的ServletContext物件
• static PageContext getPageContext()：獲取web應用的PageContext物件

示例：
Action：

public class RequestDemo3Action extends ActionSupport {
    @Override
    public String execute() throws Exception {
        HttpServletRequest request = ServletActionContext.getRequest();
        Map<String, String[]> parameterMap = request.getParameterMap();
        for (String key : parameterMap.keySet()) {
            String[] value = parameterMap.get(key);
            System.out.println("key:" + key + ",value:" + Arrays.toString(value));
        }
        // 向request域中存值
        request.setAttribute("reqName", "xiaoqiang");
        // 向session域中存值
        request.getSession().setAttribute("sessionName", "wangcai");
        // 向application域中存值
        ServletActionContext.getServletContext().setAttribute("appName", "xiaohong");

        return SUCCESS;
    }
}

struts.xml：

 <action name="request3" class="com.happ.demo.RequestDemo3Action" method="execute">
            <result name="success">request3.jsp</result>
        </action>

如上，完成通過ServletActionContext對Servlet API的訪問。

小結

藉助於ServletActionContext類，可以在Action中直接訪問Servlet API，避免了Action類實現ServletRequestAware ServletResponse SessionAware ServletContextAware等XxxAware介面，雖然如此，該Action依然與Servlet API直接耦合，不利於程式解耦。

綜上三種方式，開發中建議優先選擇ActionContext，以避免和Servlet API耦合。