（二）Struts2——action和Action类——精讲&案例

阳光穿透心脏的1/2处 2021-06-22 15:37 453阅读 0赞

# 一、action VS Action 类 #

action:代表一个struts2的请求。  
Action类:能够处理Struts2请求的类。比如我们上篇文章中写的Product类，就是一个Action类，因为他有一个save()方法，可以处理一些请求。

我们可以描述的详细一点：

### **action：** ###

*  应用程序可以完成的每一个操作. 例如: 显示一个登陆表单; 把产品信息保存起来。

### **Action类：** ###

*  **属性的名字必须遵守与 JavaBeans 属性名相同的命名规则.** 属性的类型可以是任意类型. 从字符串到非字符串(基本数据库类型)之间的数据转换可以自动发生
 *  必须**有一个不带参的构造器**
 *  **至少有一个供 struts 在执行这个 action 时调用的方法**
 *  **同一个 Action 类可以包含多个 action 方法.**
 *  **Struts2 会为每一个 HTTP 请求创建一个新的 Action 实例**，即Action不是单例的，是线程安全的。

# 二、在Action中访问WEB资源 #

## 1. 什么是web资源？ ##

HttpServletRequest, HttpSession, ServletContext 等原生的Servlet API.

## 2. 为什么访问WEB资源？ ##

B\\S的应用的Controller中必然需要访问web资源，例如：

*  向域对象中读写属性，
 *  读写cookie，
 *  获取realPath，
 *  …

## 3. 如何访问web资源？ ##

### Ⅰ.和Servlet API解耦的方式 ###

为了避免与 Servlet API 耦合在一起, 方便 Action 做单元测试, Struts2 对 HttpServletRequest, HttpSession 和 ServletContext 进行了封装, 构造了 3 个 Map 对象来替代这 3 个对象, 在 Action 中可以直接使用 HttpServletRequest, HttpServletSession, ServletContext 对应的 **Map 对象来保存和读取数据.**

这种方式只能访问有限的ServletAPI对象，且只能访问其有限的方法（读取请求参数，读取域对象的属性，使session失效…）。

#### ① 使用`ActionContext` ####

**ActionContext 是 Action 执行的上下文对象, 在 ActionContext 中保存了 Action 执行所需要的所有对象, 包括 parameters, request, session, application 等.**

*  **获取 HttpSession 对应的 Map 对象:** `public Map getSession()`
 *  **获取 ServletContext 对应的 Map 对象:** `public Map getApplication()`
 *  **获取请求参数对应的 Map 对象:** `public Map getParameters()`
 *  **获取 HttpServletRequest 对应的 Map 对象:** `public Object get(Object key)`。  
    ActionContext 类中没有提供类似 getRequest() 这样的方法来获取 HttpServletRequest 对应的 Map 对象. 要得到HttpServletRequest 对应的 Map 对象, 可以通过为 get() 方法传递 “request” 参数实现

##### 示例程序： #####

*  index.jsp
    
        <body>
        	<a href="TestActionContext.action?name=veeja">Test ActionContext</a>
        	<%
        		if (application.getAttribute("date") == null)
        			application.setAttribute("date", new Date());
        	%>
        	<br>
        </body>
 *  test-actionContext.jsp
    
        <body>
        	<h1>Test ActionContext Page</h1>
        	application: ${applicationScope.applicationKey }
        	<br>
        	<br> 
        	session: ${sessionScope.sessionKey }
        	<br>
        	<br> 
        	request: ${requestScope.requestKey }
        </body>
 *  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>
        	<package name="default" namespace="/" extends="struts-default">
        		<action name="TestActionContext" class="com.veeja.struts2.action.TestActionContextAction">
        			<result>/test-actionContext.jsp</result>
        		</action>
        	</package>
        </struts>
 *  TestActionContextAction.java
    
        package com.veeja.struts2.action;
        
        import java.util.Map;
        
        import com.opensymphony.xwork2.ActionContext;
        
        public class TestActionContextAction { 
        	public String execute() { 
        		System.out.println("TestActionContextAction#execute()...");
        		/* * 0. 获取ActionContext对象 */
        		// ActionContext是Action的上下文对象，可以从中获取到当前Action需要的一切信息
        		ActionContext actionContext = ActionContext.getContext();
        		/* * 1. 获取application对应的map，并向其中添加一个属性 */
        		// 通过调用ActionContext对象的getApplication()方法来获取application对应的Map对象
        		Map<String, Object> applicationMap = actionContext
        				.getApplication();
        		// 设置属性
        		applicationMap.put("applicationKey", "applicationValue");
        		// 获取属性
        		Object date = applicationMap.get("date");
        		System.out.println("date:" + date);
        
        		/* * 2. 获取session对应的map，并向其中添加一个属性 */
        		Map<String, Object> sessionMap = actionContext.getSession();
        		sessionMap.put("sessionKey", "sessionValue");
        
        		/* * 3. 获取request对应的map，并向其中添加一个属性 */
        		Map<String, Object> requestMap = null;
        		// 获取request对应的map稍微有些不同，这里要额外注意一下。
        		// ActionContext中并没有提供getRequest方法来获取request对应的Map
        		// 需要手工调用get()方法，传入"request"字符串来获取。
        		requestMap = (Map<String, Object>) actionContext
        				.get("request");
        		requestMap.put("requestKey", "requestValue");
        
        		// 4. 获取请求参数对应的map，并获取指定的参数值
        		// 键值对：
        		// 键：请求参数的名字
        		// 值：请求参数的值对应的字符串数组
        		// 注意：1.getParameters的返回值为在Map<String,Object>，而不是Map<String, String[]>
        		// 注意：2.parameters这个Mao只能读，不能写入数据，如果写入数据，不会出现错误，但是同样不起作用
        		Map<String, Object> parameters = actionContext
        				.getParameters();
        		String[] object = (String[]) parameters.get("name");
        		System.out.println(object[0]);
        
        		return "success";
        	}
        }
 *  页面显示  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTQ1NjUxMjc_size_16_color_FFFFFF_t_70]
 *  控制台输出
    
        TestActionContextAction#execute()...
        date:Mon Mar 09 19:43:14 CST 2020
        veeja

#### ② 实现`XxxAware`接口 ####

Action类通过可以实现某些特定的接口, 让Struts2框架在运行时向 Action 实例注入parameters, request, session 和 application 对应的 Map 对象。  
选用的建议:**若一个Action 类中有多个action 方法，且多个方法都需要使用域对象的Map或parameters, 则建议使用实现Aware接口的方式。**

package com.veeja.struts2.action;
    
    import java.util.Map;
    
    import org.apache.struts2.interceptor.ApplicationAware;
    import org.apache.struts2.interceptor.ParameterAware;
    import org.apache.struts2.interceptor.RequestAware;
    import org.apache.struts2.interceptor.SessionAware;
    
    public class TestAwareAction implements ApplicationAware, SessionAware, RequestAware, ParameterAware { 
    	public String execute() { 
    		// 1. 向application中加入一个属性：applicationKey2 - applicationValue2
    		application.put("applicationKey2", "applicationValue2");
    		// 2. 从application中读取一个属性date，并且打印
    		System.out.println(application.get("date"));
    		/* * 这些方法只是在创建上有些不同，使用方法上与上面介绍的ActionContext并无不同，在这里就不再赘述了。 */
    		return "success";
    
    	}
    
    	/* * 创建类内私有变量 */
    	private Map<String, Object> application;
    	private Map<String, String[]> parameters;
    	private Map<String, Object> request;
    	private Map<String, Object> session;
    
    	public void setApplication(Map<String, Object> application) { 
    		this.application = application;
    	}
    
    	public void setParameters(Map<String, String[]> parameters) { 
    		this.parameters = parameters;
    
    	}
    
    	public void setRequest(Map<String, Object> request) { 
    		this.request = request;
    	}
    
    	public void setSession(Map<String, Object> session) { 
    		this.session = session;
    	}
    }

#### 特别注意：session对应的Map的特殊之处 ####

session对应的Map实际上是`sessionMap类`。  
强转后调用它的`invalidate()`方法可以使session失效。

/* * 2. 获取session对应的map，并向其中添加一个属性 */
    Map<String, Object> sessionMap = actionContext.getSession();
    
    /* * 使session失效 */
    if (sessionMap instanceof SessionMap) { 
    	SessionMap sm = (SessionMap) sessionMap;
    	sm.invalidate();
    	System.out.println("session失效了！");
    }

### Ⅱ.和Servlet API耦合的方式 ###

可以访问更多的ServletAPI对象，且可以调用其原生的方法。  
但是直接访问 Servlet API 将使 Action 与 Servlet 环境耦合在一起, 测试时需要有 Servlet 容器, 不便于对 Action 的单元测试.

#### ① 使用`ServletActionContext` ####

*  **直接获取 HttpServletRequest 对象：** `ServletActionContext.getRequest()`
 *  **直接获取 HttpSession 对象：** `ServletActionContext.getRequest().getSession()`
 *  **直接获取 ServletContext 对象：** `ServletActionContext.getServletContext()`

这种方式很简单，我们按照上面的方法拿到相应的对象之后，按照以前Javaweb中的操作就可以了。

**例如：**

public class TestServletActionContextAction { 
    	public String execute() { 
    		HttpServletRequest request = ServletActionContext.getRequest();
    		HttpSession session = ServletActionContext.getRequest().getSession();
    		ServletContext servletContext = ServletActionContext.getServletContext();
    
    		System.out.println("request:" + request);
    		System.out.println("session:" + session);
    		System.out.println("servletContext:" + servletContext);
    		return "seccess";
    	}
    }

#### ② 实现`ServletXxxAware`接口 ####

**通过实现ServletXxxAware接口的方式可以由Struts2注入需要的Servlet相关的对象**  
`ServletRequestAware`：注入HttpServletRequest对象(比较常用)  
`ServletContextAware`：注入ServletContext对象(比较常用)  
`ServletResponseAware`：注入HttpServletResponse对象

**这种方法与上面的实现接口大同小异，只要我们拿到原生的对象，就可以“为所欲为”了。**

**例如：**

public class TestServletAwareAction implements ServletRequestAware, ServletContextAware, ServletResponseAware { 
    	public String execute() { 
    		System.out.println(response);
    		System.out.println(servletContext);
    		System.out.println(request);
    		return "success";
    	}
    
    	private HttpServletResponse response;
    	private ServletContext servletContext;
    	private HttpServletRequest request;
    
    	public void setServletResponse(HttpServletResponse response) { 
    		this.response = response;
    	}
    
    	public void setServletContext(ServletContext servletContext) { 
    		this.servletContext = servletContext;
    	}
    
    	public void setServletRequest(HttpServletRequest request) { 
    		this.request = request;
    	}
    
    }

# 三、`ActionSupport类` #

`com.opensymphony.xwork2.ActionSupport` 类是默认的 Action 类。  
ActionSupport 是默认的Action 类:若某个action 节点没有配置class属性,则ActionSupport就是待执行的Action类。而execute方法即为要默认执行的action方法。

**也就是如下的代码**

<action name="testActionSupport">
    	<result>/testActionSupport.jsp</result>
    </action>

**就相当于**

<action name="testActionSupport" class="com.opensymphony.xwork2.ActionSupport" method="execute">
    	<result>/testActionSupport.jsp</result>
    </action>

ActionSupport实现了很多接口，我们可以继承这个类，来方便我们的开发。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTQ1NjUxMjc_size_16_color_FFFFFF_t_70 1]  
在手工完成字段验证的，显示错误消息，国际化等情况下，推荐继承ActionSupport

--------------------

## 关于Struts2请求的扩展名的问题 ##

1.  `org.apache.struts2` 包下的`default.properties`中配置了Struts2应用的一些常量。
2.  `struts.action.extension`定义了当前Struts2应用可以接受的请求的扩展名。
3.  可以在`struts.xml`文件中以常量配置的方式修改default.properties所配置的常量。

**例如：**

上述代码指定了struts2受理的请求扩展名可以为`action`,`do`,或者为`无扩展名`。

--------------------

# 练习 #

实现如下流程框图的效果。![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTQ1NjUxMjc_size_16_color_FFFFFF_t_70 2]

*  index.jsp
    
        <a href="<c:url value='Login_Ui'/>">用户登录</a>
 *  login.jsp
    
        <form action="<c:url value='User_login.action'/>">
        	username:<input type="text" name="username">
        	<br>
        	password:<input type="password" name="password">
        	<br>
        	<button type="submit">submit</button>
        </form>
 *  success.jsp
    
        <body>
        	Welcome: ${sessionScope.username }
        	<br><br>
        	Welcome! Number of users online: ${applicationScope.count }
        	<br><br>
        	<a href="<c:url value='User_Logout.action'/>">Log out</a>
        </body>
 *  struts.xml
    
        <struts>
        	<constant name="struts.action.extension" value="action,do,"></constant>
        	<package name="default" namespace="/" extends="struts-default">
        		<action name="Login_Ui">
        			<result>/login.jsp</result>
        		</action>
        		<action name="User_login" class="com.veeja.struts2.action.UserAction">
        			<result name="login-success">/success.jsp</result>
        		</action>
         		<action name="User_Logout" class="com.veeja.struts2.action.UserAction" method="logout">
        			<result name="logout-success">/success.jsp</result>
        		</action>
        	</package>
        </struts>
 *  核心`UserAction.java`
    
        package com.veeja.struts2.action;
        
        import java.util.Map;
        
        import org.apache.struts2.dispatcher.SessionMap;
        import org.apache.struts2.interceptor.ApplicationAware;
        import org.apache.struts2.interceptor.SessionAware;
        
        public class UserAction implements SessionAware, ApplicationAware { 
        
        	private String username;
        
        	public void setUsername(String username) { 
        		this.username = username;
        	}
        
        	public String logout() { 
        		System.out.println("UserAction#logout()...");
        		// 从application中获取在线人数。
        		Integer count = (Integer) application.get("count");
        		if (count != null && count > 0) { 
        			count--;
        		}
        		application.put("count", count);
        
        		// 让session失效,强转为SessionMap,调用invalidate方法
        		if (session instanceof SessionMap) { 
        			SessionMap sm = (SessionMap) session;
        			sm.invalidate();
        		}
        		return "logout-success";
        	}
        
        	public String execute() { 
        
        		System.out.println("UserAction#execute()...");
        		/* * 把用户信息存入Session域中,在线人数 +1 */
        		// 1. 获取session,实现SessionAware接口
        		// 2. 获取登录信息：通过在Action中添加setter方法
        		// 3. 把用户信息存入session域中
        		session.put("username", username);
        
        		/* * 在线人数+1 */
        		// 获取当前的在线人数，从application中获取
        		Integer count = (Integer) application.get("count");
        		if (count == null) { 
        			count = 0;
        		}
        		// 使在线人数+1
        		count++;
        		application.put("count", count);
        
        		return "login-success";
        	}
        
        	private Map<String, Object> application;
        	private Map<String, Object> session;
        
        	public void setApplication(Map<String, Object> application) { 
        		this.application = application;
        	}
        
        	public void setSession(Map<String, Object> session) { 
        		this.session = session;
        	}
        }

--------------------

END.

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTQ1NjUxMjc_size_16_color_FFFFFF_t_70]: /images/20210615/08b2f8a8eb6a4bdaa82e5b3bdf842674.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTQ1NjUxMjc_size_16_color_FFFFFF_t_70 1]: /images/20210615/ca69523e3ddb4a08a4687f2533a02a21.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTQ1NjUxMjc_size_16_color_FFFFFF_t_70 2]: /images/20210615/72d64107fe8e4614aecccd7d4e02d814.png