设计自己的MVC框架

事实是最近读《J2EE设计模式》讲述表达层模式的那几章，书中有一个前端控制器+command模式的workflow例子，就琢磨着可以很简单地扩展成一个MVC框架。花了一个下午改写了下，对书中所述的理解更为深入。我想这也许对于学习和理解设计模式，以及初次接触struts等MVC框架的人可能有点帮助。因为整个模型类似于struts，我把它取名叫strutslet^_^。学习性质，切勿认真。

（一）完整的类图如下：


1。前端控制器(FrontController):前端控制器提供了一个统一的位置来封装公共请求处理,它的任务相当简单,执行公共的任务,然后把请求转交给相应的控制器。在strutslet中，前端控制器主要作用也在于此，它初始化并解析配置文件，接受每个请求，并简单地把请求委托给调度器（Dispatcher），由调度器执行相应的动作（Action）。调度器把action返回的url返回给FrontController，FrontController负责转发。

2。Action接口：command模式很好的例子，它是一个命令接口，每一个实现了此接口的action都封装了某一个请求：新增一条数据记录并更新model，或者把某个文件写入磁盘。命令解耦了发送者和接受者之间联系。 发送者调用一个操作，接受者接受请求执行相应的动作，因为使用Command模式解耦，发送者无需知道接受者任何接口。

3。Dispatcher：调度器，负责流程的转发，负责调用action去执行业务逻辑。由调度器选择页面和action，它去除了应用行为和前端控制器间的耦合。调度器服务于前端控制器，它把model的更新委托给action，又提供页面选择给FrontController

4。ActionForward：封装了转向操作所需要信息的一个模型，包括name和转向url

5。ActionModel：解析配置文件后，将每一个Action封装成一个ActionModel对象，所有ActionModel构成一个map，并存储在ServletContext中，供整个框架使用。


（二）源代码简单分析
1。Action接口，只有一个execute方法，任何一个action都只要实现此接口，并实现相应的业务逻辑，最后返回一个ActionForward，提供给Dispacher调用。

2. public interface Action {
3.  public ActionForward execute(HttpServletRequest request,ServletContext context); 
4. }

比如，我们要实现一个登陆系统（demo的例子)，LoginAction验证用户名和密码，如果正确，返回success页面，如果登陆失败，返回fail页面：

2. public class LoginAction implements Action {
4.  private String name="";
5.  public ActionForward execute(HttpServletRequest request,
6.    ServletContext context) {
7.   String userName=request.getParameter("userName");
8.   String password=request.getParameter("password");
9.         if(userName.equals("dennis")&&password.equals("123")){
10.       request.setAttribute("name", name);
11.       return ActionForward.SUCCESS;  //登陆成功,返回success
12.         }else
13.          return ActionForward.FAIL;    //否则，返回fail
14.  }

2.还是先来看下两个模型：ActionForward和ActionModel，没什么东西，属性以及相应的getter,setter方法：

2. /**
3.  * 类说明:转向模型
4.  * @author dennis
5.  *
6.  * */
7. public class ActionForward {
8.  private String name;      //forward的name
9.  private String viewUrl;   //forward的url
10.  public static final ActionForward SUCCESS=new ActionForward("success");
11.  public static final ActionForward FAIL=new ActionForward("fail");
12.  
13.  public  ActionForward(String name){
14.   this.name=name;
15.  }
17.  public ActionForward(String name, String viewUrl) {
18.   super();
19.   this.name = name;
20.   this.viewUrl = viewUrl;
21.  }
23.  //...name和viewUrl的getter和setter方法
25. }   

我们看到ActionForward预先封装了SUCCESS和FAIL对象。

2. public class ActionModel {
3.  private String path; // action的path
5.  private String className; // action的class
7.  private Map<String, ActionForward> forwards; // action的forward
9.  public ActionModel(){}
10.  
11.  public ActionModel(String path, String className,
12.    Map<String, ActionForward> forwards) {
13.   super();
14.   this.path = path;
15.   this.className = className;
16.   this.forwards = forwards;
17.  }
20.  //...相应的getter和setter方法     
22. }

3。知道了两个模型是什么样，也应该可以猜到我们的配置文件大概是什么样的了，与struts的配置文件格式类似：

2. <?xml version="1.0" encoding="UTF-8"?>
3. <actions>
4.   <action path="/login"
5.           class="com.strutslet.demo.LoginAction">
6.      <forward name="success" url="hello.jsp"/>
7.      <forward name="fail" url="fail.jsp"/>
8.    </action>       
9. </actions>

path是在应用中将被调用的路径，class指定了调用的哪个action，forward元素指定了转向，比如我们这里如果是success就转向hello.jsp，失败的话转向fail.jsp，这里配置了demo用到的LoginAction。

4。Dispacher接口，主要是getNextPage方法，此方法负责获得下一个页面将导向哪里，提供给前端控制器转发。

2. public interface Dispatcher {
3.  public void setServletContext(ServletContext context);
4.  public String getNextPage(HttpServletRequest request,ServletContext context);
5. }

5。5。原先书中实现了一个WorkFlow的Dispatcher，按照顺序调用action，实现工作流调用。而我们所需要的是根据请求的path调用相应的action，执行action的execute方法返回一个ActionForward，然后得到ActionForward的viewUrl，将此viewUrl提供给前端控制器转发，看看它的getNextPage方法：

2. public String getNextPage(HttpServletRequest request, ServletContext context) {
3.   setServletContext(context);
5.   Map<String, ActionModel> actions = (Map<String, ActionModel>) context
6.     .getAttribute(Constant.ACTIONS_ATTR);   //从ServletContext得到所有action信息
7.   String reqPath = (String) request.getAttribute(Constant.REQUEST_ATTR);//发起请求的path
8.   ActionModel actionModel = actions.get(reqPath);  //根据path得到相应的action
9.   String forward_name = "";
10.   ActionForward actionForward;
11.   try {
12.    Class c = Class.forName(actionModel.getClassName());  //每个请求对应一个action实例
14.    Action action = (Action) c.newInstance();
15.    actionForward = action.execute(request, context);  //执行action的execute方法
16.    forward_name = actionForward.getName();
17.    
18.   } catch (Exception e) {
19.    log.error("can not find action "+actionModel.getClassName());
20.    e.printStackTrace();
21.   }
23.   actionForward = actionModel.getForwards().get(forward_name);
24.   if (actionForward == null) {
25.    log.error("can not find page for forward "+forward_name);
26.    return null;
27.   } else
28.    return actionForward.getViewUrl();      //返回ActionForward的viewUrl
29.  }

6。前端控制器（FrontController），它的任务我们已经很清楚，初始化配置文件；存储所有action到ServletContext供整个框架使用；得到发起请求的path，提供给Dispachter查找相应的action；调用Dispatcher，执行getNextPage方法得到下一个页面的url并转发：

2. public void init() throws ServletException {
4.   //初始化配置文件
6.   ServletContext context=getServletContext();
7.   String config_file =getServletConfig().getInitParameter("config");
8.   String dispatcher_name=getServletConfig().getInitParameter("dispatcher");
9.   if (config_file == null || config_file.equals(""))
10.    config_file = "/WEB-INF/strutslet-config.xml"; //默认是/WEB-INF/下面的strutslet-config
11.   if(dispatcher_name==null||dispatcher_name.equals(""))
12.    dispatcher_name=Constant.DEFAULT_DISPATCHER;
13.     
14.   try {
15.    Map<String, ActionModel> resources = ConfigUtil.newInstance()  //工具类解析配置文件
16.      .parse(config_file, context);
17.    context.setAttribute(Constant.ACTIONS_ATTR, resources);  //存储在ServletContext中
18.    log.info("初始化strutslet配置文件成功");
19.   } catch (Exception e) {
20.    log.error("初始化strutslet配置文件失败");
21.    e.printStackTrace();
22.   }
24.   //实例化Dispacher
26.   try{
27.    Class c = Class.forName(dispatcher_name);
28.       Dispatcher dispatcher = (Dispatcher) c.newInstance();
29.       context.setAttribute(Constant.DISPATCHER_ATTR, dispatcher); //放在ServletContext
30.       log.info("初始化Dispatcher成功");
31.   }catch(Exception e) {
32.     log.error("初始化Dispatcher失败");
33.       e.printStackTrace();
34.   }
36.   .....

doGet()和doPost方法我们都让它调用process方法：

2. protected void process(HttpServletRequest request,
3.    HttpServletResponse response) throws ServletException, IOException {
4.   ServletContext context = getServletContext();
6.         //获取action的path 
7.   String reqURI = request.getRequestURI();
8.   int i=reqURI.lastIndexOf(".");
9.   String contextPath=request.getContextPath();
10.   String path=reqURI.substring(contextPath.length(),i);
11.   
12.   request.setAttribute(Constant.REQUEST_ATTR, path);
13.   Dispatcher dispatcher = (Dispatcher) context.getAttribute(Constant.DISPATCHER_ATTR);
15.   // make sure we don't cache dynamic data
16.   response.setHeader("Cache-Control", "no-cache");
17.   response.setHeader("Pragma", "no-cache");
19.   // use the dispatcher to find the next page
20.   String nextPage = dispatcher.getNextPage(request, context);//调用Dispatcher的getNextPage
22.   // forward control to the view
23.   RequestDispatcher forwarder = request.getRequestDispatcher("/"
24.     + nextPage);
25.   forwarder.forward(request, response);  //转发页面
26.  }

7。最后，web.xml的配置就非常简单了，配置前端控制器，提供启动参数（配置文件所在位置，为空就查找/WEB-INF/下面的strutslet-config.xml文件），我们把所有以action结尾的请求都交给FrontController处理：

2. <servlet>
3.     <servlet-name>StrutsletController</servlet-name>
4.     <servlet-class>com.strutslet.core.FrontController</servlet-class>
5.     <!--  
6.     <init-param>
7.          <param-name>config</param-name>
8.          <param-value>/WEB-INFstrutslet-config.xml</param-value>
9.     </init-param>
10.     -->
11.        <load-on-startup>0</load-on-startup>
12.   </servlet>
13.  <servlet-mapping>
14.     <servlet-name>StrutsletController</servlet-name>
15.     <url-pattern>*.action</url-pattern>
16.  </servlet-mapping>

最后，让我们看看整个框架图：