Dispatch Action

关于Dispatch Action (转)（给action传参数）

Struts 的 Dispatch Action 已經行之有年了，有 Dispatch, Lookup, MappingDispatch... 好幾種可以用。但設定方法都很囉嗦 (網頁，程式，struts-config三者都要 hard-code String 在上面)，而且適用的了 A ，就不能用在 B。例如雖然 DispatchAction 可以寫在 URL 上： /foo.do?method=saveOrder ，但是遇到一個 form 需要利用多個 submit button dispatch 時，就不行了。你得轉用 LookupDispatch，可是 LookupDispatch 又需要在 Action 定義一個很醜的 getKeyMethodMap() (裡面全部是 hard-code string)。接下來要分享一個通用 URL/submit button/struts-config.xml 三者設定的 SimpleDispatchAction:

/*
* created on 2005/4/23
*
* $Author: ingram $
* $Revision: 1.5 $
* $Date: 2005/05/13 02:09:21 $
*/
package org.bioinfo.util.struts;

import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.util.HashMap;
import java.util.Map;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.apache.struts.action.Action;
import org.apache.struts.action.ActionForm;
import org.apache.struts.action.ActionForward;
import org.apache.struts.action.ActionMapping;

/**
* 簡化的 DispatchAction，並支援Spring的 ActionSupport, 本 class 可以 *獨自* 使用，不需搭配
* SimpleDispatchActionForm。
*
* 使用方法：
*
* 繼承此 class，並定義各個 action method，比方說有兩個 method 分別做儲存和刪除：
*
*

 
 			 * public ActionForward save(ActionMapping mapping, ActionForm form, 
 			 *         HttpServletRequest request, HttpServletResponse response) 
 			 *         throws Exception { 
 			 * // orderService.save(....)  
 			 * } 
 			 *  
 			 * public ActionForward delete(ActionMapping mapping, ActionForm form, 
 			 *         HttpServletRequest request, HttpServletResponse response) 
 			 *         throws Exception { 
 			 * // orderService.delete(....)  
 			 * } 
 			 * 

*
* 有三種方式可以設定 dispatch 到哪個 method 上。
*
* (1) submit button 法，直接寫在 submit 的 property 上：
*
*
* <html:form action="/some/work">
* .... some thing ....
*
* <html:submit property="dispatch=save" value="儲存"/>
* <html:submit property="dispatch=delete" value="刪除"/>
* </html:form>
*
* 或者如果需要 i18n 的話，可以用 bean:message：
*
* <html:form action="/some/work">
* <html:submit property="dispatch=save" >
* <bean:message key="button.save" />
* </html:submit>
* <html:submit property="dispatch=delete" >
* <bean:message key="button.delete" />
* </html:submit>
* </html:form>
*
*
* 注意 property 裡面的值是 'dispatch=xxxx' 記得要寫等號與 method 名稱，而且大小寫要對，不能空白。當網頁按下 "儲存"
* 時，則會執行 /some/work.do 的 save(...) 的 method。 如果按下 "刪除" 則執行 delete(...)，
*
* 建議 -- 這種寫法通常是用在一個 Action 有多個 dispatch method，而每個 method 都共用同個 ActionForm
*
* (2) URL 法，接在 URL 後面：
*
*
* <html:form action="/some/work?dispatch=save">
* 或是用 link 也可以
* <html:link action="/some/work?dispatch=save" />
*
*
* 建議 -- 通常用在不需要 ActionForm 的 Action，或者是要將 submit button 法寫成 url 時使用。
*
* (3) struts-config 法，直接寫死在 parameter='dispatch=foo' 上
*
*
* <action
* path="/saveOrder"
* name="SaveOrderForm"
* type="antar.order.web.OrderDispatchAction"
* parameter="dispatch=save" >
* </action>
* <action
* path="/deleteOrder"
* name="DeleteOrderForm"
* type="antar.order.web.OrderDispatchAction"
* parameter="dispatch=delete" >
* </action>
*
*
* 建議 -- 這種寫法通常是為了讓 Action 中每個 dispatch method 使用不同的 ActionForm。一旦寫死在
* struts-config 裡，該 mapping 的 path 就不能與 URL 法 或是 submit button 法同時使用。
*
* 最後請注意同一個 request 上，URL 法不能與 submit button 法同時使用 (但可以連續 forward)：
*
*
* ...........錯誤範例...........
* <html:form action="/some/work?dispatch=save">
* .... some thing ....
* <html:submit property="dispatch=delete" value="刪除"/>
* </html:form>
*
*
* @author ingram
*
*/
public abstract class SimpleDispatchAction extends Action{

private static final String SIMPLE_DISPATCH_ACTION_KEY = "__SIMPLE_DISPATCH_ACTION_KEY";

private DispatchMethodHelper dispatchMethodHelper = new DispatchMethodHelper(
SIMPLE_DISPATCH_ACTION_KEY);

private Class clazz = this.getClass();

private Class[] argTypes = new Class[] { ActionMapping.class,
ActionForm.class, HttpServletRequest.class,
HttpServletResponse.class };

private Map dispatchMethods = new HashMap();

public final ActionForward execute(ActionMapping mapping, ActionForm form,
HttpServletRequest request, HttpServletResponse response)
throws Exception {

String methodName = dispatchMethodHelper
.getMethodName(request, mapping);

Method method = null;
try {
Object[] args = { mapping, form, request, response };
method = obtainDispatchMethod(methodName);
return (ActionForward) method.invoke(this, args);
} catch (NoSuchMethodException e) {
throw dealWithMethodProblem(methodName, e);
} catch (IllegalAccessException e) {
throw dealWithMethodProblem(methodName, e);
} catch (InvocationTargetException e) {
if (e.getCause() instanceof Exception) {
throw (Exception) e.getCause();
} else {
throw new RuntimeException(
"invoke " + methodName + "() failed",
(e.getCause() != null ? e.getCause() : e));
}
}
}

private RuntimeException dealWithMethodProblem(String methodName,
Exception e) {
return new RuntimeException(
"can not access dispatching method:["
+ methodName
+ "]. possible cause is :/n"
+ "(1) wrong parameter value, the correct format is 'dispatch=methodName' /n"
+ " or/n"
+ "(2) wrong method in your DispatchAction, it should like /n"
+ " public ActionForward methodName(ActionMapping,ActionForm,HttpServletRequest,HttpServletResponse)/n/n",
e);
}

private Method obtainDispatchMethod(String methodName)
throws NoSuchMethodException {
Method method = (Method) dispatchMethods.get(methodName);
if (method == null) {
method = clazz.getMethod(methodName, argTypes);
dispatchMethods.put(methodName, method);
}
return method;
}

}