AppFuse改造之Struts框架隔離

關鍵字: Struts

進入新的項目組，
checkout項目下來，
看了一下其整體結構與代碼，哎，比較亂。
經過我的建議，部門經理讓我對該項目進行全面重構。

首先，此項目是以AppFuse作為基礎的，還記得robin說它就一toy
選擇的模板是iBatis + Spring + Struts
我的第一步工作是要隔離Struts。

Struts是老牌的MVC實現，那個年代IoC和輕量級還沒現在流行，框架侵入性也沒有得到重視。
所以Struts的實現讓應用程序嚴重依賴它：
1.所有控制器都必需繼承Action類
2.所有數據封裝類必需繼承ActionForm
3.控制器方法execute必需返回ActionForward，與Struts藕合
4.控制器方法execute的參數ActionMapping，與Struts藕合
5.控制器方法execute的參數HttpServletRequest，HttpServletResponse，與Servlet容器藕合
6.由于Action類是Struts管理的，不支持Service類的IoC注入，除非將控制權委托給IoC容器，再配一遍(如：org.springframework.web.struts.DelegatingActionProxy)。

目標：
1.控制器不繼承任何類，也不實現任何接口
2.數據封裝Form類應為簡單的POJO，不要繼承ActionForm
3.execute返回值可以是任意對象（包括基本類型和void），
標準返回String，即forward的索引值，
如果返回其它類型對象就調用其toString。
如果返回類型為void或返回值為null，forward到默認的"success"
4和5.execute只傳入POJO的Form，
如果該動作不需要Form數據，也可以保持空的參數列表。
如果有多個參數，第一個參數為Form(作為傳入，也作為傳出，這個是struts已經實現的規則)，后面的都為傳出對象，必需保證為POJO，傳出對象會根據struts的action配置的scope，放入相應域。
6.支持IoC注入Service，即然IoC，當然不能依賴某個具體IoC容器，沒有Spring一樣運行。要不然會被ajoo一頓臭罵，什么什么? IoC還：容器類.getXXX()?
7.當然，還要實現一個線程安全的容器類，持有與Servlet相關的信息，
這樣，若有特殊要求需要訪問HttpServletRequest，HttpServletResponse
則可以通過：容器類.get當前線程容器().getRequest()方式獲取。

最后類應該像這樣：

不用說，這樣的類是易于測試的。
例如：

java 代碼

public void testRightAllViewItems() {
ItemAction itemAction = new ItemAction();
ItemService itemService = new ItemServiceMock();
itemAction.setItemService(itemService);
ItemsForm itemsForm = new ItemsForm();
String forward = itemAction.viewAllItems(itemsForm);
assertEquals("沒有正確跳轉！", "success", forward);
assertNotNull("沒有向itemsForm寫入數據！", itemsForm.getItems());
// 下面這些斷言是判斷和ItemServiceMock中寫硬編碼的值是否一樣
assertEquals("取得的items大小與ItemServiceMock中的不一致！", 1, itemsForm.getItems().size());
Item item = (Item) itemsForm.getItems().iterator().next();
assertEquals("獲取的item的Id不對！", new Long(5), item.getId());
assertEquals("獲取的item的CategoryId不對！", new Long(2), item.getCategoryId());
assertEquals("獲取的item的Name不對！", "aaa", item.getName());
assertEquals("獲取的item的Price不對！", new Float(1.2), item.getPrice());
}

當然還有測試傳入一個null的ItemsForm等的其它測試，這里就不例舉了。

好，明確目標后，開始重構，重構后要先保證以前的代碼也能運行。

由于要使Action徹底獨立，我暫時想到的辦法是反射回調。
我先寫一個通用的Action,然后回調具體的控制器類。
實現如下：
通用Action

java 代碼

package com.ynmp.webapp.frame;
import java.lang.reflect.Method;
import java.util.Map;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.struts.action.Action;
import org.apache.struts.action.ActionForm;
import org.apache.struts.action.ActionForward;
import org.apache.struts.action.ActionMapping;
import com.ynmp.webapp.frame.provider.ServiceProvider;
import com.ynmp.webapp.frame.provider.SpringServiceProvider;
import com.ynmp.webapp.frame.util.ClassUtils;
public class BaseAction extends Action {
private static final Log log = LogFactory.getLog(BaseAction.class);
private static final String UNCALL_METHOD = "*";
private static final String SUCCESS_FORWARD = "success";
private static final String ERROR_FORWARD = "error";
public ActionForward execute(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception {
String forward;
try {
ActionContext.initCurrentContext(request, response);
forward = getActionForward(mapping.getScope(), mapping.getParameter(), form);
} catch (Exception e) {
e.printStackTrace();
log.warn(e);
forward = ERROR_FORWARD;
request.setAttribute("BeanActionException", e);
}
return mapping.findForward(forward);
}
// 處理forward
private String getActionForward(String scope, String config, Object model) throws Exception { // TODO Exception處理待重構
String forward = SUCCESS_FORWARD;
ActionConfig actionConfig = new ActionConfig(config);
Object actionObject = populateActionClass(actionConfig.getClassName());
Object returnObject = callActionMethod(actionObject, actionConfig.getMethodName(), model, scope);
if (returnObject!= null && String.valueOf(returnObject) != null) {
forward = String.valueOf(returnObject);
}
return forward;
}
// 處理action類
private Object populateActionClass(String className) throws Exception {
Class actionClass = Class.forName(className);
Object action = actionClass.newInstance();
injectService(action);
return action;
}
// 簡單實現IoC
private void injectService(Object action) throws Exception {
ServiceProvider serviceProvider = new SpringServiceProvider(getServlet()); // TODO 待重構為策略
Method[] methods = action.getClass().getMethods();
for (int i = 0; i < methods.length; i ++) {
if (methods[i].getName().startsWith("set")) {
Class[] parameters = methods[i].getParameterTypes();
if (parameters != null && parameters.length == 1) {
String methodName = methods[i].getName();
String serviceName = methodName.substring(3,4).toLowerCase() + methodName.substring(4);
methods[i].invoke(action, new Object[]{serviceProvider.getService(serviceName, parameters[0])});
}
}
}
}
// 處理action方法
private Object callActionMethod(Object action, String methodName, Object model, String scope) throws Exception {
if (UNCALL_METHOD.equals(methodName)) return null;
Method actionMethod = ClassUtils.findMethodByName(action.getClass(), methodName);
Object[] parameters = initParameters(actionMethod, model);
Object returnObject = actionMethod.invoke(action, parameters);
outParameters(getScopeMap(scope), parameters);
return returnObject;
}
// 組裝action方法的參數列表
private Object[] initParameters(Method actionMethod, Object model) throws Exception {
Class[] parameterTypes = actionMethod.getParameterTypes();
int parameterSize = parameterTypes.length;
if (parameterSize == 0) {
return new Object[0];
} else if (parameterSize == 1) {
return new Object[] {model};
} else {
Object[] parameters = new Object[parameterSize];
parameters[0] = model;
for (int i = 1; i < parameterSize; i ++) {
parameters[i] = parameterTypes[i].newInstance();
}
return parameters;
}
}
// 向指定范圍域輸出參數
private void outParameters(Map scopeMap, Object[] parameters) throws Exception {
if (parameters.length < 2) return ;
for (int i = 1; i < parameters.length; i ++) {
String name = ClassUtils.getLowerClassName(parameters[i].getClass());
scopeMap.put(name, parameters[i]);
}
}
// 通過scope配置找到相應域Map
private Map getScopeMap(String scope) {
if ("request".equals(scope)) {
return ActionContext.getActionContext().getRequestMap();
} else if ("session".equals(scope)) {
return ActionContext.getActionContext().getSessionMap();
} else if ("application".equals(scope)) {
return ActionContext.getActionContext().getApplicationMap();
}
throw new RuntimeException("不合法的scope:" + scope + ",scope必需為request,session,application中的一個!");
}
}

IoC的Service供給接口

java 代碼

package com.ynmp.webapp.frame.provider;
public interface ServiceProvider {
public Object getService(String serviceName, Class serviceClass) throws Exception;
}

Spring的Service供給實現，依賴Spring，作為一種策略應該不成問題。

java 代碼

package com.ynmp.webapp.frame.provider;
import javax.servlet.http.HttpServlet;
import org.springframework.context.ApplicationContext;
import org.springframework.web.context.support.WebApplicationContextUtils;
public class SpringServiceProvider implements ServiceProvider {
private HttpServlet servlet;
public SpringServiceProvider(HttpServlet servlet) {
this.servlet = servlet;
}
public Object getService(String serviceName, Class serviceClass) throws Exception {
ApplicationContext ctx = WebApplicationContextUtils.getRequiredWebApplicationContext(servlet.getServletContext());
Object serviceObject = ctx.getBean(serviceName);
if (serviceObject == null) {
throw new RuntimeException("在IoC容器中未找到引用：" + serviceName);
}
return serviceObject;
}
}

線程安全的Servlet相關信息持有類，
還有幾個Map的封裝，不貼也應該猜得到，
就是map.put時調用request,session,cookie,application相應的setAttribute等，get也類似

代碼

package com.ynmp.webapp.frame;
import java.util.HashMap;
import java.util.Map;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import com.ynmp.webapp.frame.map.ApplicationMap;
import com.ynmp.webapp.frame.map.CookieMap;
import com.ynmp.webapp.frame.map.ParameterMap;
import com.ynmp.webapp.frame.map.RequestMap;
import com.ynmp.webapp.frame.map.SessionMap;
public class ActionContext {
private static final ThreadLocal localContext = new ThreadLocal();
private HttpServletRequest request;
private HttpServletResponse response;
private Map cookieMap;
private Map parameterMap;
private Map requestMap;
private Map sessionMap;
private Map applicationMap;
private ActionContext() {
cookieMap = new HashMap();
parameterMap = new HashMap();
requestMap = new HashMap();
sessionMap = new HashMap();
applicationMap = new HashMap();
}
static void initCurrentContext(HttpServletRequest request,
HttpServletResponse response) {
ActionContext ctx = getActionContext();
ctx.request = request;
ctx.response = response;
ctx.cookieMap = null;
ctx.parameterMap = null;
ctx.requestMap = null;
ctx.sessionMap = null;
ctx.applicationMap = null;
}
public static ActionContext getActionContext() {
ActionContext ctx = (ActionContext) localContext.get();
if (ctx == null) {
ctx = new ActionContext();
localContext.set(ctx);
}
return ctx;
}
public Map getCookieMap() {
if (cookieMap == null) {
cookieMap = new CookieMap(request, response);
}
return cookieMap;
}
public Map getParameterMap() {
if (parameterMap == null) {
parameterMap = new ParameterMap(request);
}
return parameterMap;
}
public Map getRequestMap() {
if (requestMap == null) {
requestMap = new RequestMap(request);
}
return requestMap;
}
public Map getSessionMap() {
if (sessionMap == null) {
sessionMap = new SessionMap(request);
}
return sessionMap;
}
public Map getApplicationMap() {
if (applicationMap == null) {
applicationMap = new ApplicationMap(request);
}
return applicationMap;
}
public HttpServletRequest getRequest() {
return request;
}
public HttpServletResponse getResponse() {
return response;
}
public String getAppURL() {
StringBuffer url = new StringBuffer();
int port = request.getServerPort();
if (port < 0) {
port = 80;
}
String scheme = request.getScheme();
url.append(scheme);
url.append("://");
url.append(request.getServerName());
if ((scheme.equals("http") && (port != 80))
|| (scheme.equals("https") && (port != 443))) {
url.append(':');
url.append(port);
}
url.append(request.getContextPath());
return url.toString();
}
}

Struts配置中，parameter屬性是作為擴展用的，所以我們可以利用它。
改動：
parameter指定控制器類的類名和方法名，格式為：包名.類名:函數名
type固定為com.ynmp.webapp.frame.BaseAction
如：

xml 代碼

<action path="/item_list" parameter="com.ynmp.webapp.action.ItemAction:viewAllItems" name="itemsForm" type="com.ynmp.webapp.frame.BaseAction">
<forward name="success" path="/item_list.jsp" />
</action>

配置管理類：

java 代碼

package com.ynmp.webapp.frame;
public class ActionConfig {
private static final String ACTION_CONFIG_REGEX = "^([A-Z|a-z|_]+\\.)+[A-Z|a-z|_]+\\:(([A-Z|a-z|_]+)|\\*)$";
private String className;
private String methodName;
public ActionConfig(String config) {
if (config == null
|| config.length() == 0
|| ! config.replaceAll(" ", "").matches(ACTION_CONFIG_REGEX)) {
throw new RuntimeException("Parameter=\"" + config + "\" 格式不合法！應為：包名.類名:方法名，如：com.company.UserAction:login");
}
int index = config.indexOf(":");
className = config.substring(0, index).trim();
methodName = config.substring(index + 1).trim();
}
public ActionConfig(String className, String methodName) {
this.className = className;
this.methodName = methodName;
}
public String getClassName() {
return className;
}
public String getMethodName() {
return methodName;
}
public void setClassName(String className) {
this.className = className;
}
public void setMethodName(String methodName) {
this.methodName = methodName;
}
}

Class輔助工具類

java 代碼

package com.ynmp.webapp.frame.util;
import java.lang.reflect.Method;
public class ClassUtils {
public static Method findMethodByName(Class clazz, String methodName) {
int count = 0;
Method actionMethod = null;
Method[] methods = clazz.getMethods();
for (int i = 0; i < methods.length; i ++) {
if (methods[i].getName().equals(methodName)) {
// 其實也可以不檢查函數是否重載，直接返回第一個定義的，
// 但這樣有可能會使程序員迷惑，還是檢查一下重載。
count ++;
if (count > 1) {
throw new RuntimeException(clazz + " 類中有重載的同名方法: " + methodName + ",無法判定使用哪一個！");
}
actionMethod = methods[i];
}
}
if (count == 0 || actionMethod == null) {
throw new RuntimeException(clazz + " 類中找到不方法: " + methodName);
}
return actionMethod;
}
public static String getLowerClassName(Class clazz) {
String className = clazz.getName();
int index = className.lastIndexOf(".");
if (index != -1) {
className = className.substring(index + 1);
}
return className.substring(0,1).toLowerCase() + className.substring(1);
}
}

其它JUnit的測試類就不貼了。

現在Action解放了，Form對象還沒解放
還是必需繼承ActionForm，
因為<form-bean配置會檢查該對象是否繼承于ActionForm，否則報錯。
驗證框架和ActionForm也有點藕合。
我現在還沒有想到好的辦法，先搞個權宜之計，
寫了一個BaseForm，繼承于ActionForm，然后將從ActionForm中繼承來的方法全給final掉
其它Form都繼承于BaseForm，這樣先保證Form不會重寫ActionForm中的方法，
看起來像個POJO，若以后能去掉ActionForm，就只要改BaseForm

posted on 2007-04-23 07:09 NG 閱讀(282) 評論(0) 編輯收藏

新用戶注冊刷新評論列表


只有注冊用戶登錄后才能發表評論。




網站導航: 博客園 IT新聞 Chat2DB C++博客博問管理

2007年4月

日

一

二

三

四

五

六

AppFuse改造之Struts框架隔離

常用鏈接

留言簿(1)

隨筆檔案(35)

文章分類(5)

文章檔案(2)

新聞檔案(5)

java link

搜索

最新評論

閱讀排行榜

評論排行榜