自制MVC框架：TonyMVC

MVC框架已经使用的非常广泛了，现在我也自制一个MVC框架来加深我对MVC框架的理解。

 

首先MVC共分三个内容，Ｍ（ＭＯＤＥＬ）Ｖ（ＶＩＥＷ）Ｃ（ｃｏｎｔｒｏｌｌｅｒ）。

Ｍ：主要就是一些Ａｃｔｉｏｎ，用来处理业务内容和数据库的操作。

Ｖ：视图，用于向用户显示内容。

Ｃ：所有的请求由这里来管理，进行分配。分发业务请求。

 

 

 

１　在ｗｅｂ．ｘｍｌ文件中加入一个ｓｅｒｖｌｅｔ，去拦截所有的满足条件请求，这些请求由控制键（Ｃ）来进行分发管理。

 <servlet>
    <description>DispatchServlet</description>
    <display-name>DispatchServlet</display-name>
    <servlet-name>DispatchServlet</servlet-name>
    <servlet-class>com.hrbust.mvc.controller.DispatchServlet</servlet-class>
    <init-param>
      <description>Configuration File</description>
      <param-name>configFile</param-name>
      <param-value>WEB-INF/mvc-config.xml</param-value>
    </init-param>
  </servlet>
  <servlet-mapping>
    <servlet-name>DispatchServlet</servlet-name>
    <url-pattern>*.do</url-pattern>
  </servlet-mapping>

 其中具有自制ＭＶＣ框架的配置文件：ｍｖｃ－ｃｏｎｆｉｇ．ｘｍｌ，当做参数设置在ｓｅｒｖｌｅｔ中。

 

２　ｃｏｎｔｒｏｌｌｅｒ文件：

 

　　初始化：读取配置文件，把相应的Ａｃｔｉｏｎ信息加入到ＡｃｔｉｏｎＭａｐ中。

　　　　　　并获取ＡｃｔｉｏｎＭａｐ。此时ＡｃｔｉｏｎＭａｐ为缓存。

　　ｄｏＧｅｔ方法：　取得请求ＵＲＬ，把它进行拆分。

 

　　Ｃｏｎｔｒｏｌｌｅｒ中使用了ＣｏｎｆｉｇＨｅｌｐｅｒ类来加载缓存。

 

package com.hrbust.mvc.controller;

import java.io.IOException;
import java.lang.reflect.Method;
import java.util.Map;

import javax.servlet.ServletConfig;
import javax.servlet.ServletContext;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import com.hrbust.mvc.action.ActionPackager;
import com.hrbust.mvc.config.ConfigHelper;
import com.hrbust.mvc.util.RegexUtil;

/**
 * Action分发类<br>
 * 将请求分派给指定Action处理
 * 
 * @author Welkin
 *
 */
public class DispatchServlet extends HttpServlet {

	private static final long serialVersionUID = 1131523345611250389L;

	private static final String CONTENT_TYPE="text/html;charset=UTF-8";
	
	private Map<String,ActionPackager> actionsMap;
	
	/*public static String DataURL=null;
	public static String MarkURL=null;
	public static String PastePicsURL=null;*/
	
	/**
	 * Constructor of the object.
	 */
	public DispatchServlet() {
		super();
	}
	
	/**
	 * Initialization of the servlet. <br>
	 *
	 * @throws ServletException if an error occurs
	 */
	public void init() throws ServletException {
		//read config values from the web.xml
		
		// 通过ServletContext取得工程的绝对物理路径
        ServletContext sct = getServletContext();
        String realPath = sct.getRealPath("/");
		
        // 通过ServletConfig实例取得初始化参数configFile
        ServletConfig config=this.getServletConfig();        
        String CfgFile=config.getInitParameter("configFile");

        // 组合配置文件全物理路径
        CfgFile=realPath+CfgFile;
        
        //创建ConfigHelper对象，初始化actionsMap
        ConfigHelper configHelper=new ConfigHelper(CfgFile,config);
        actionsMap=configHelper.getActionsMap();
		
	}
	
	/**
	 * Destruction of the servlet. <br>
	 */
	public void destroy() {
		super.destroy(); // Just puts "destroy" string in log
		actionsMap=null;
	}

	/**
	 * The doGet method of the servlet. <br>
	 *
	 * This method is called when a form has its tag value method equals to get.
	 * 
	 * @param request the request send by the client to the server
	 * @param response the response send by the server to the client
	 * @throws ServletException if an error occurred
	 * @throws IOException if an error occurred
	 */
	public void doGet(HttpServletRequest request, HttpServletResponse response)
			throws ServletException, IOException {

		response.setContentType(CONTENT_TYPE);
		
		// 取得请求的URL
        String reqURL=request.getServletPath();
        
        // 取得模式匹配字符串，取得请求后缀
        String patternStr;
        if(reqURL.contains("?")){
            patternStr=RegexUtil.getMatchedString("([.])(.*)?",reqURL);
        }
        else{
            patternStr=RegexUtil.getMatchedString("([.])(.*)$",reqURL);
        }
        
        // 取得请求的Action名称
        String actionName=RegexUtil.getMatchedString("/(.*)[.]"+patternStr,reqURL);
        
        ActionPackager actionPackager=actionsMap.get(actionName);
        
        //如果请求的Action为空，则返回404错误
        if(actionPackager==null)
        	response.sendError(HttpServletResponse.SC_NOT_FOUND);
        else{
        	String methodName=request.getParameter(actionPackager.getMethodName());

            //执行Action中的方法
            Class<?> actionClass=actionPackager.getActionClass();
    		Object actionObj=actionPackager.getActionObj();
    		
    		try {
				Method method = actionClass.getMethod(methodName, HttpServletRequest.class,HttpServletResponse.class);
				method.invoke(actionObj, request,response);
			} catch (NoSuchMethodException e) {
				//如果请求方法不存在，抛出404错误
				response.sendError(HttpServletResponse.SC_NOT_FOUND);
			} catch (Exception e) {
				// TODO Auto-generated catch block
				e.printStackTrace();
			}
        }
        
	}

	/**
	 * The doPost method of the servlet. <br>
	 *
	 * This method is called when a form has its tag value method equals to post.
	 * 
	 * @param request the request send by the client to the server
	 * @param response the response send by the server to the client
	 * @throws ServletException if an error occurred
	 * @throws IOException if an error occurred
	 */
	public void doPost(HttpServletRequest request, HttpServletResponse response)
			throws ServletException, IOException {

		this.doGet(request, response);
	}

}

 

 

３　ＣｏｎｆｉｇＨｅｌｐｅｒ文件：

 

　　用来加载配置文件。

　　创建Ａｃｔｉｏｎ的包装类ＡｃｔｉｏｎＰａｃｋａｇｅｒ和Ａｃｔｉｏｎ的工厂类ＡｃｔｉｏｎＦａｃｔｏｒｙ。

 

package com.hrbust.mvc.config;

import java.io.File;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import javax.servlet.ServletConfig;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.dom4j.Document;
import org.dom4j.DocumentException;
import org.dom4j.Element;
import org.dom4j.io.SAXReader;

import com.hrbust.mvc.ActionFactory;
import com.hrbust.mvc.action.Action;
import com.hrbust.mvc.action.ActionPackager;

/**
 * 配置文件Helper类<br>
 * 用于获取配置文件相关
 * 
 * @author Welkin
 *
 */
public class ConfigHelper {
	
	public static Log log=LogFactory.getLog(ConfigHelper.class);
	
	private ActionFactory actionFactory;
	
	private Document document;
	
	
	/**
	 * 构造函数,加载配置文件,初始化document
	 * @param configFile
	 */
	public ConfigHelper(String configFile,ServletConfig servletConfig){

		log.info("加载mvc配置文件...");
		
		try {
			File file = new File(configFile);
			SAXReader reader = new SAXReader();
			document = reader.read(file);
		} catch (DocumentException e) {
			log.error("配置文件不存在或格式不正确");
			e.printStackTrace();
		}
		
		log.info("初始化ActionFactory...");
		if(servletConfig==null){
			try {
				throw new Exception();
			} catch (Exception e) {
				log.error("ServletConfig参数为Null，ActionFactory初始化失败");
				e.printStackTrace();
			}
		}else{
			actionFactory=new ActionFactory(servletConfig);
		}
	}
	
	public Map<String,ActionPackager> getActionsMap(){
		
		log.info("读取mvc配置文件,装载至缓存中...");
		
		Map<String,ActionPackager> actionsMap=new HashMap<String,ActionPackager>();
		
		Element root = document.getRootElement();
		List<?> actionElms=root.elements("action");
		
		//遍历所有action元素
		for(int i=0;i<actionElms.size();i++){
			Element actionElm  = (Element)actionElms.get(i);
			ActionPackager action=new ActionPackager();
			
			String actionClassPath=actionElm.attributeValue("class");
			Action actionObj=actionFactory.getActionInstance(actionClassPath);
			

			action.setName(actionElm.attributeValue("name"));
			action.setClassPath(actionClassPath);
			action.setMethodName(actionElm.attributeValue("method"));
			
			action.setActionClass(actionObj.getClass());
			action.setActionObj(actionObj);
			
			actionsMap.put(action.getName(), action);
		}
		
		log.info("装载完成");
		
		return actionsMap;
	}
	
	
}

 

 

４　ＡｃｔｉｏｎＦａｃｔｏｒｙ

 

　　ＡｃｔｉｏｎＦａｃｔｏｒｙ的工厂类。用来创建Ａｃｔｉｏｎ。

package com.hrbust.mvc.action;

import javax.servlet.ServletConfig;

/**
 * SuperAction<br>
 * 所有Action的父类
 * 
 * @author Welkin
 */
public abstract class Action{
	
	private static ServletConfig config;
	
	/**
	 * 注入servletConfig
	 * 
	 * @param servletConfig
	 */
	public static void setServletConfig(ServletConfig servletConfig){
		config=servletConfig;
	}
	
	/**
	 * 得到ServletConfig
	 * 
	 * @return
	 */
	protected ServletConfig getServletConfig(){
		return config;
	}
}

 

 

５　ＡｃｔｉｏｎＰａｃｋａｇｅｒ

　Ａｃｔｉｏｎ相关信息的包装类。

 

package com.hrbust.mvc;

import javax.servlet.ServletConfig;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

import com.hrbust.mvc.action.Action;

/**
 * Action 工厂
 * 
 * @author Welkin
 *
 */
public class ActionFactory {
	
	public static Log log=LogFactory.getLog(ActionFactory.class);
	private ServletConfig servletConfig;
	
	public ActionFactory(ServletConfig servletConfig){
		this.servletConfig=servletConfig;
	}
	
	/**
	 * 得到Action实例
	 * @return
	 */
	public Action getActionInstance(String actionClassPath){
		
		Class<?> actionClass=null;
		Action actionObj=null;
		
		try {
			
			//向Action中注入servletConfig
			Action.setServletConfig(servletConfig);
			
			//实例化Action子类
			actionClass=Class.forName(actionClassPath);
			actionObj= (Action)actionClass.newInstance();
			log.debug("创建"+actionClassPath+"实例");
			
		}catch (ClassNotFoundException e) {
			log.error("Action相关类没有找到");
			e.printStackTrace();
		}catch (Exception e) {
			e.printStackTrace();
		}
		return actionObj;
	}
	
}

 

 

评论

1 楼 hardPass 2010-05-06  

能看看你的ｍｖｃ－ｃｏｎｆｉｇ．ｘｍｌ 啊？