007--在Struts2的Action中访问Servlet API三种形式

清疚 2022-05-26 06:16 195阅读 0赞

> 前面已经对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等。

下面，简单列举一下常用方法：

<table> 
 <thead> 
  <tr> 
   <th>方法声明</th> 
   <th align="center">功能描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>void put(String key,Object value)</td> 
   <td align="center">将key-value键值对放入ActionContext中，模拟Servlet API中的HttpServletRequest的setAttribute()方法</td> 
  </tr> 
  <tr> 
   <td>Object get(String key)</td> 
   <td align="center">通过参数key查找当前ActionContext中的值</td> 
  </tr> 
  <tr> 
   <td>Map<code>&lt;</code>String,Object<code>&gt;</code> getApplication()</td> 
   <td align="center">返回Application级别的Map对象</td> 
  </tr> 
  <tr> 
   <td>static ActionContext getContext()</td> 
   <td align="center">获取当前线程的ActionContext对象</td> 
  </tr> 
  <tr> 
   <td>Map<code>&lt;String,Object&gt;</code> getParameters()</td> 
   <td align="center">返回一个包含所有HttpServletRequest参数信息的map对象</td> 
  </tr> 
  <tr> 
   <td>Map<code>&lt;String,Object&gt;</code> getSession()</td> 
   <td align="center">返回Session级别的Map对象</td> 
  </tr> 
  <tr> 
   <td>void setApplication(Map<code>&lt;String,Object&gt;</code> application)</td> 
   <td align="center">设置上下文对象</td> 
  </tr> 
  <tr> 
   <td>Map<code>&lt;String,Object&gt;</code> setSession()</td> 
   <td align="center">设置一个map类型的session值</td> 
  </tr> 
 </tbody> 
</table>

示例：

// 获取当前线程的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][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耦合。

[http_localhost_8080_hello_request2]: http://localhost:8080/hello/request2