Waterfall framework 开发日志

TODO:
继续测试和改进,不满意的地方:@ToSession标签

更新日志:

2006-06-18 增加和改进 @ToList 标签,用来修饰一个参数为java.util.List<T>的setter方法 
2006-05-23 增加 VelocityView接口,方便velocity视图调用.
2006-05-23 增加 WebParam接口,封装掉request和response以及ServletContext

2006-05-22 增加 5.1 初始化 velocity
2006-05-21 增加 4.1 - 4.2 HttpSession操作


更新note:
1.HttpServletRequest的getParameterNames() 方法返回的Enumeration相对于页面参数的物理顺序刚好是相反的,所以实现@ToList标签时候需要先用一个Stack来对所有参数进行反转.不知tomcat在这个api方法上是怎么实现的,为什么就倒过来。c语言函数可以根据不同的call类型来指定不同的压栈的顺序，莫非这个惯例也被用到servlet里面来了，挺有意思的东西，看来需要留意一下。

问题和解决方式:

1.关于@ToSession标签.如果是登陆的话,那么就有个判断条件决定某个login token是否应该被加到session中,这时候可以在@ToSession标记的getter方法中加入逻辑判断,来决定返回一个token实体或者null(这样做有点古怪..).

2.路径的问题.比如一个http://host/logic/bbs/admin/ListUsers.wff 摸版的相关资源目录(比如,图片,css,js等)就必须存在webproject/bbs/admin响应的目录下,有点像struts的多模块.

开始:

Ruby on Rails有个设计思想是用编码规定代替繁琐的配置文件。jvm平台已经有一些类似ror的实现，比如
grails(http://docs.codehaus.org/display/GRAILS/2006/03/29/Groovy+on+Rails+(Grails)+0.1+Released)

虽然由于java自身的局限，它很难做出像ruby或者groovy那样动态语言那样随心所欲的动作，但是利用它的运行时反射、动态代理等特性来尽可能实现“用编码规定代替繁琐的配置文件”这一思想。
下面转入正题。

ServletAPI对HTTP协议进行了封装,通过配置Web.xml来把不同的请求转发给不同的servlet来处理。Web框架则用一个ActionServlet，根据自己的对Action的定义来转发请求。
抛开那些繁琐的配置文件，设想一下这样一种方法:

1.Web动作的处理和响应

假设这样一个POST请求:

  <form action="logic/group/NewTopic.wff" method="post">

Web动作实现Bean:
   org.qqsns.web.logic.group.NewTopic  
注意后面的logic/group/NewTopic和logic.group.NewTopic, 动作类和Web动作是通过请求路径和包名相互关联。
这样，对Web动作的响应就依赖于编译期的代码的组织结构而不是执行期的配置文件。这样的好处是避免了维护繁琐的配置文件,特别是在没有IDE支持的情况下。

org.qqsns.web.logic.group.NewTopic类是一个实现net.wff.servlet.WebAction接口的POJO，下面是NewTopic中execute的方法片段:  
 
 //Only method must be implemented for interface net.wff.servlet.WebAction
 public String execute(WebParam param, VelocityView view)
 throws ServletException, IOException{
  ...
  //return "redirect /success.html";  //请求重定向
  return "/success.jsp";              //请求转发
}
execute方法的返回值手动指定了一个转发或重定向的路径。

2.输入验证

普通的Web框架都带数据输入验证功能,一般复杂程度和功能强大与否成正比。
这里简单地要求从setter方法里抛出一个包含验证信息的异常，以此来实现输入异常处理。
      
普通setter方法
public void setName(String name){ 
  this.name = name;
}

添加输入验证后的setter方法

public void setName(String name) throws InputException{   
 if(name.length()<3)
    throw new InputException("Topic name must has a length greater than 3"); 
  this.name = name;
}

在WaterFallServlet如何中处理验证信息:

    WebAction wa =
    (WebAction)Class.forName(classPath).newInstance();
          //procces forwarding
          try {
    ActionHelper.setProperties(request,wa);
   } catch (InputException e) {
    //return to input view
    //header:referer
    String rtn = request.getHeader("referer");
    //clear old errors
    if(rtn.indexOf("?")!=1){
     rtn = rtn.substring(0,rtn.indexOf("?"));
    }
    rtn=rtn+"?error="+URLEncoder.encode(e.getMessage(),"UTF-8");
    response.sendRedirect(rtn);
    return;
   }

这样验证信息通过请求参数传回到输入页面.

3.数据绑定

假设有这样的html输入:

    <input type="text" name="name"/>
    <input type="text" name="number"/>
    <input type="text" name="price"/>
   
 下面是NewTopic中execute的方法全部:  
 
 public String execute(WebParam param, VelocityView view)
 throws ServletException, IOException{
  System.out.println(getName());
  System.out.println(getNumber());
  System.out.println(getPrice());
  System.out.println(getLength());
  return "/success.html";
}
   
自动从request注入parameter,这也是Struts DynamicActionForm的好处之一。
不过这里实现更类似多了类型转换的<jsp:setProperty name="bean" property="*"/>
因为Name的类型是String,Number的类型是Integer,Price的类型是float,length的类型是double.至于其他复杂的类型,也许jsf的转换器是个更好的主意。
这样就初步解决了数据的输入绑定和验证。余下的就是业务逻辑的问题。

4.如何操作Session中的信息
 
 获取session中的信息:

  @FromSession(
     sessionKey=User.key
     )
 public void setCurrentUser(String currentUser) {
  this.currentUser = currentUser;
 }

 信息保存到session中: 

  @ToSession(
      sessionKey = User.key  
    )
 public String getName() {
  if(login())return name;
  else return null;
 }

 这2个方法定义在WebAction的实现类中。
 框架在execute()之前执行@FromSession动作，在execute()之后执行@ToSession动作。
 这里使用了annotation,所以要求必须是jdk5.0以上版本.
 
 5.1 Velocity
  waterfall启动时候自动在WEB-INF目录下寻找并初始化Velocity.properties文件
 操作:
 public String execute(WebParam param, VelocityView view)
 throws ServletException, IOException{
  view.addElement("msg","Hello");
  view.go("index.vm");
  return null;
}