struts2 --- 注解详解

一、引入struts2支持注解开发的jar包

• struts2-convention-plugin-2.3.24.jar
  

二、struts2使用注解开发需要遵循一些规范

• Action必须要继承ActionSuppert父类
• Action所在的包名必须以.action结尾

三、struts2 convention插件的常量介绍

• struts.convention.result.path : 设置Convention插件定位视图资源的根路径。默认值为/WEB-INF/content
• struts.convention.result.flatLayout : 如果是为false则可以将试图放置Action对应的目录下，无需放入WEB-INF/content
• struts.convention.package.locators : 包的结尾名称必须是指定的名称(action,actions,struts,struts2)，这样struts2才能进行进行注解扫描
  
• struts.convention.exclude.packages : 扫描排除的包(org.apache.struts.*,org.apache.struts2.*)
  

四、注解详解

4.1 Convention的Annotation

与Action相关的两个Annotation是@Action和@Actions

(1)@Action中可指定一个value属性。@Action中还可以指定一个params属性，该属性是一个字符串数组，用于该Acion指定的参数名和参数值。params属性应遵守如下格式：{“name1”,”value1”,”name2”,”value2”}

示例：

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

使用@Action的interceptorRefs 属性可以指定action或者方法的interceptor，如下面的例子

package com.example.actions;  
  
import com.opensymphony.xwork2.ActionSupport;   
import org.apache.struts2.convention.annotation.Action;  
import org.apache.struts2.convention.annotation.Actions;  
  
public class HelloWorld extends ActionSupport {  
  @Action(interceptorRefs={@InterceptorRef("validation"), @InterceptorRef("defaultStack")})  
  public String execute() {  
    return SUCCESS;  
  }  
  
  @Action("url")  
  public String doSomething() {  
    return SUCCESS;  
  }  
}  

还可以使用params属性指定要传给拦截器的参数。形式为{键，值，键，值…………}，键值总是会成对出现，如下面的例子

package com.example.actions;  
  
import com.opensymphony.xwork2.ActionSupport;   
import org.apache.struts2.convention.annotation.Action;  
import org.apache.struts2.convention.annotation.Actions;  
  
public class HelloWorld extends ActionSupport {  
  @Action(interceptorRefs=@InterceptorRef(value="validation",params={"programmatic", "false", "declarative", "true}))  
  public String execute() {  
    return SUCCESS;  
  }  
  
  @Action("url")  
  public String doSomething() {  
    return SUCCESS;  
  }  
}  

(2)@Actions 也用于修饰Action类里的方法，用于将该方法映射到多个@Action.因此它可将一个方法映射成多个逻辑Action。

示例：

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

4.2 Result的Annotation

(1)@Results用于组织多个@Result因此它只需指定一个value属性值，该value属性值为多个@Result

示例：

package com.example.actions;  
  
import com.opensymphony.xwork2.ActionSupport;   
import org.apache.struts2.convention.annotation.Action;  
import org.apache.struts2.convention.annotation.Actions;  
import org.apache.struts2.convention.annotation.Result;  
import org.apache.struts2.convention.annotation.Results;  
  
@Results({  
  @Result(name="failure", location="fail.jsp")  
})  
public class HelloWorld extends ActionSupport {  
  @Action(value="/different/url",   
    results={@Result(name="success", location="http://struts.apache.org", type="redirect")}  
  )  
  public String execute() {  
    return SUCCESS;  
  }  
  
  @Action("/another/url")  
  public String doSomething() {  
    return SUCCESS;  
  }  
}  

(2)@Result相当于struts.xml文件中的<result/>元素。

• 使用@Result必须指定一个name属性，相当于<result name=””/>。
• type 相当于<result type=””/>指定返回视图资源的类型
• location 相当于<result>…..</result>中间部分，用于指定实际视图位置
• params：该属性相当于<result/>元素里多个<param../>子元素的作用，用于为该Result指定参数值。该属性应满足{“name1”,”value1”,”name2”,”value2”}格式

@Result有以下两种用法：

• Action级的Result映射：以@Actions组合多个@Action后修饰的Action类。这种Result映射对该Action里的所有方法都有效。
• 方法级Result映射：将多个@Result组成数组后作为@Action的results属性值。这种Result映射仅对被修饰的方法有效。

(3)@ResultPath则用于修饰包和Action类，用于改变被修饰Action所对应的物理视图资源的根路径。举例说：默认情况下，Convention都会到WEB-INF/content路径下找物理视图资源，一旦我们使用@ResultPath(“/abc”)修饰该Action，系统将回到abc目录下寻找物理视图资源。

package com.example.actions;  
  
import com.opensymphony.xwork2.ActionSupport;   
import org.apache.struts2.convention.annotation.Action;  
import org.apache.struts2.convention.annotation.Actions;  
import org.apache.struts2.convention.annotation.Result;  
import org.apache.struts2.convention.annotation.Results;  
  
public class HelloWorld extends ActionSupport {  
  @Action(value="/different/url",   
    results={@Result(name="success", type="httpheader", params={"status", "500", "errorMessage", "Internal Error"})}  
  )  
  public String execute() {  
    return SUCCESS;  
  }  
  
  @Action("/another/url")  
  public String doSomething() {  
    return SUCCESS;  
  }  
}  

4.3 与包和命名空间相关的Annotation

(1)@Namespace：修饰Action类或其所在的包。该Annotation中指定一个value属性值，用于指定被修饰的Action所在的命名空间

(2)@Namespaces：修饰Action类或其所在的包，用于组合多个@Namespace

(3)@ParentPackage: 用于指定被修饰的Action所在包的夫包。

示例：

@Namespace("/")
@ParentPackage("struts-default")
public class UserAction extends ActionSupport implements ModelDriven<User> {

	private User user = new User();

	@Override
	public User getModel() {
		return user;
	}

	@Action(value = "user_login", results = { @Result(name = "success", location = "/product.jsp"),
			@Result(name = "error", location = "/login.jsp") })
	public String login() {

		// 调用service完成操作
		IUserService userService = new UserServiceImpl();
		User _user = userService.login(user.getUsername(), user.getPassword());
		if (_user != null) {
			// 将用户存储到session中
			ServletActionContext.getRequest().getSession().setAttribute("user", _user);
			return "success";
		} else {
			this.addActionError("用户名或密码错误");
			return "error";
		}
	}
}

4.4 异常处理相关的Annotation

(1)@ExceptionMappings 用于组织多个@ExceptionMapping，因此它只需指定一个value属性值，该value属性值为多个@ExceptionMapping。

(2)@ExceptionMapping 用于定义异常类和物理视图之间的对应关系，也相当于struts.xml文件里<exception-mapping../>元素的作用 使用时，必须注意以下两个属性：

• exception: 用于指定异常类
• result ： 用于指定逻辑视图

@ExceptionMpping有如下两种用法

• Action级的异常定义:以@ExceptionMappings组合多个@ExceptionMapping后修饰的Action类。这种异常定义对Action中的所有方法有效
• 方法级的异常定义： 将多个@ExceptionMapping组成数组后作为@Action的exceptionMappings属性值，这种异常定义仅对被修饰的方法有效。

4.5 拦截器相关的Annotation

与拦截器配置的Annotation有@InterceptorRef、@InterceptorRefs和@DefaultInterceptorRef

(1)@InterceptorRefs用于组织多个@InterceptorRef，因此它只需要指定一个value属性值，该value属性值为多个@InterceptorRef

(2)@InterceptorRef用于为指定Action引用拦截器或者是拦截器栈。也就相当于strut.xml中位于<action../>元素内部的<interceptor-ref../>子元素的作用。

(3)@InterceptorRefAnnotation时，必须制定一个value属性，用于指定所引用的拦截器或拦截器栈的名字。相当于<interceptor-ref../>子元素里name属性的作用。

示例：

package com.example.actions;  
  
import com.opensymphony.xwork2.ActionSupport;   
import org.apache.struts2.convention.annotation.Action;  
import org.apache.struts2.convention.annotation.Actions;  
  
@InterceptorRefs({  
    @InterceptorRef("interceptor-1"),  
    @InterceptorRef("defaultStack")  
})  
public class HelloWorld extends ActionSupport {  
  @Action(value="action1", interceptorRefs=@InterceptorRef("validation"))  
  public String execute() {  
    return SUCCESS;  
  }  
  
  @Action(value="action2")  
  public String doSomething() {  
    return SUCCESS;  
  }  
}