【转】Convention Plugin 学习（二）

时间：2010-07-19 来源：dazhilao

原文地址：http://dazhilao.javaeye.com/admin/blogs/new
1.action配置

   按照第一篇中的配置，设置locator为action，则默认一个类的命名空间为：

               类路径                                             命名空间
com.example.action.MainAction         ->    /
com.example.action.products.Display ->    /products

    完整url为：

                类路径                                                                                      完整url
com.example.action.MainAction                                       -> /main
com.example.action.products.Display                               -> /products/display
com.example.action.company.ShowCompanyDetailsAction -> /company/details/show_company_details

3.action类写法
    如果要实现基本零配置，命名空间和action名称按照默认的类路径搜索。默认执行方法是execute。方法返回值是success，就会找。

package com.example.action;   
  
import com.opensymphony.xwork2.ActionSupport;   
  
public class HelloWorld extends ActionSupport {   
  
    private String message;   
  
    public String getMessage() {   
        return message;   
    }   
  
    public String execute() {   
        message = "Hello World! excute";   
        return SUCCESS;   
    }   
  
    public String edit() {   
            message = "Hello World! edit";   
        return "xyz";   
    }   
  
    public String delete() {   
        message = "Hello World! delete";   
        return "depp";   
    }   
  
}

    返回结果对应：

               类路径                                   实际url(WEB-INF/pages)
/hello_world                                     /hello_world.jsp或/hello_world_success.jsp
/hello_world!edit                               /hello_world_xyz.jsp
/hello_world!delete                            /hello_world_depp.jsp

    基本的零配置就是这样，如果要有redirect、chain等跳转方式，interceptor的配置，就要加入annotation。

2.action类中的annotation

convention插件的annotation都在annotation这个包中，基本和xml配置相对应。

    annotation           意义                                                                        作用域
ParentPackage   指定继承的包(struts2)名                                              包，类
Namespaces      给一个action指定多个命名空间(一般不用)                      包，类
Namespace       指定一个命名空间(一般不用，按默认的类路径即可)         包，类，Namespaces注解中
actions              给一个action指定多个名称                                            方法
action               指定一个action名称                                                      类，方法，actions注解中
InterceptorRefs 一组拦截器集合(只能是名称，必须先在xml文件中配置好) 类，action注解中
InterceptorRef   一个拦截器                                                                  类，InterceptorRefs注解中
ResultPath        结果映射的路径(已经在struts.xml文件中指定)                 包，类
Results             多个结果集合                                                               类，action注解中
Result              一个结果定义                                                                类，Results注解中

    需要注意：

1）包(java)级别是在package-info.java这个文件中配置，可以配置整个包的定义，但是命名空间就不能按默认的类路径扫描了，必须也要显式的配置。所以这个文件最好不要使用。

2）不在包(java)级别配置就要在类(java)级别配置，可能每个类都要写一句ParentPackage，指定继承的包(struts2)，以获得父包中的拦截器配置及其他公用配置。如果没有特殊的拦截器配置则不用配置ParentPackage。

3）最好把annotation配到类级别，因为这样action名称及命名空间都可用默认的类路径扫描，不用我们显式的配置。只要配置特殊的result和拦截器即可。类中的其他方法使用动态方法调用的方式使用同一个配置。我们知道struts2所有配置都是启动加载到map中的，减少配置，会提高一定性能。而动态方法这种模式是零配置必不可少的，但我很不喜欢叹号出现在地址栏中，所以在后面的文章中我会结合restful插件及自己修改源代码实现意义上的动态方法调用，但形式上是别的方式，地址栏会比较美观。

package com.example.action;   
  
import com.opensymphony.xwork2.ActionSupport;   
import org.apache.struts2.convention.annotation.Result;   
import org.apache.struts2.convention.annotation.Results;   
import org.apache.struts2.convention.annotation.InterceptorRef;   
import org.apache.struts2.convention.annotation.InterceptorRefs;   
  
@InterceptorRefs({   
    @InterceptorRef("interceptor-1"),   
    @InterceptorRef("defaultStack")   
})   
@Results({   
    @Result(name="reload",location="hello_world",type="redirectAction",params={key1,value1,key2,value2}),   
    @Result(name="chainact",location="hello_world!edit",type="chain")   
})   
public class HelloWorld extends MyBaseAction {   
  
    private String message;   
  
    public String getMessage() {   
        return message;   
    }   
  
    public String execute() {   
        message = "Hello World! excute";   
        return SUCCESS;   
    }   
  
    public String edit() {   
            message = "Hello World! edit";   
        return RELOAD;   
    }   
           
    public String delete() {   
            message = "Hello World! delete";   
        return CHAINACT;   
    }   
}  
4）如果有极其特殊的情况需要为action的每个方法单独配置，这时就不能用默认的类扫描了，必须是先配置action，指定名称，再在action中配置result和interceptor。这就会使配置增多，违背的零配置的初衷。有时我们为了性能原因想把拦截器细化到具体的action上，我想如果真是这样，我们还不如再写一个action类。还有struts2.1.6原有的配置是如果action名称中有“/”，会认为这是一个命名空间，不会再按照类扫描的默认值。例如： 

package com.example.action;   
  
import com.opensymphony.xwork2.ActionSupport;   
import org.apache.struts2.convention.annotation.Action;   
  
public class HelloWorld extends ActionSupport {   
  
    @Action("/different/url")   
    public String execute() {   
        return SUCCESS;   
    }   
  
    @Action("url")   
    public String doSomething() {   
        return SUCCESS;   
    }   
}  

    调用方法execute的url为 :       /different/url (命名空间已经更换) 
    调用方法doSomething的url为 :   /url 

5）比较别扭的地方就是拦截器的配置，必须用名称，而名称和实际拦截器类的对应关系是在struts.xml文件中声明的，如果用struts2以前的annotation是可以直接配置拦截器类的，但是我没有和convention插件结合使用，这个问题我正在研究，看看有没有好的办法。 

6）还有一种默认的chain跳转，实际是在struts2.1.6中新增的unknownHandleder中设定的，没有什么太大作用，我们可以不使用。而unknownHandleder我们可以自定义为其他，这在后面的文章中会有说明。