Convention 插件

• 从 Struts 2.1 开始, Struts 可以使用 Convention 插件来支持零配置:
• Convention 插件完全抛弃配置信息, 不仅不需要使用 struts.xml 文件进行配置, 甚至不需要使用 Annotation 进行配置. 而是完全根据约定来自动配置.
• 安装 Conversion 插件: 复制 struts-2.2.1\lib\struts2-convention-plugin-2.2.1.jar 到当前当前 WEB 应用的 WEB-INF 的 lib 目录下.

搜索 Action

• 搜索 Action: 对于 Convention 插件, 它会自动搜索位于 action, actions, struts, struts2 包下的所有 Java 类, Convention 会把如下两种 Java 类当成 Acition 处理
  • 所有实现了 Action 接口的 Java 类
  • 所有类名以 Action 结尾的 Java 类
• 下面是符合 Conversion 插件的 Action 类:
  • org.simpleit.actions.LoginAction
  • org.simpleit.actions.book.Books(Books 实现了 Action 接口)
  • org.simpleit.action.LoginAction
  • org.simpleit.struts.action.book.BookAction
  • org.simpleti.struts2.emp.EmployeeAction

按约定映射命名空间

• 找到合适的 Action 类之后, Convention 插件会按约定部署这些 Action, 部署 Action 时, actions, action, struts, struts2 包会被映射为根命名空间, 而这些包下的子包则被映射成对应的命名空间:
  • org.simpleit.actions.LoginAction /
  • org.simpleit.actions.book.Books(Books 实现了 Action 接口) /book
  • org.simpleit.action.LoginAction /
  • org.simpleit.struts.action.book.BookAction /action/book
  • org.simpleti.struts2.emp.EmployeeAction /emp

按约定映射 Action

• Action 的 name 属性(也就是该 Action 所要处理的 URL) 则根据该 Action 的类名映射. 映射 Action 的name 时, 遵循如下规则:
  • 若该 Action 类名包含 Action 后缀, 将该 Action 类名的 Action 后缀去掉. 否则不作任何处理
  • 将 Action 类名的驼峰写法转成中横线 (-) 写法: 所有字母小写, 单词之间使用 – 隔开.
• 例子:
  • org.simpleit.actions.LoginAction -> /login.action
  • org.simpleit.actions.book.Books(Books 实现了 Action 接口) à/book/books
  • org.simpleit.action.LoginAction -> /login.action
  • org.simpleit.struts.action.book.BookAction -> /action/book/book.action
  • org.simpleti.struts2.emp.EmployeeAction /emp/employee.action

按约定映射 Result

• 默认情况下, Convention 总会到 WEB 应用的 WEB-INF/content 路径下定位物理资源, 定位资源的约定是: actionUrl + resultCode suffix. 当某个逻辑视图找不到对应的视图资源时, Conversion 会自动试图使用 actionUrl 作为物理资源.
• 例子:
  • org.simpleit.actions.LoginAction -> /WEB-INF/content/login.jsp 或 login-success.jsp
  • org.simpleit.actions.book.Books(Books 实现了 Action 接口) à/WEB-INF/content/book/books-success.jsp 或 books.jsp
  • org.simpleit.struts.action.book.BookAction -> /WEB-INF/action/book/book-success.jsp 或 book.jsp
  • org.simpleti.struts2.emp.EmployeeAction /WEB-INF/content/emp/employee-success.jsp 或 employee.jsp

Action 链的约定

• 如果希望一个 Action 处理结束后不是进入视图页面, 而是进行另一个 Action 形成 Action 链. 通过 Conversion 插件则只需遵守如下三个约定即可.
  • 第一个 Action 返回的逻辑视图字符串没有对应的视图资源
  • 第二个 Action 与第一个 Action 处于用一个包下
  • 第二个 Action 映射的 URL 为: firstActionUrl + resultCode。

Conversion 插件的常用常量

• Conversion 插件使用 Annotation 来管理拦截器, 异常处理等相关配置. Conversion 还允许使用 Annotation 管理 Action 和 Result 的配置, 从而覆盖 Conversion 的约定.

Action 配置相关的 Annotation

• 与 Action 相关的两个 Annotation 是 @Action 和 @Actions
• @Action 主要用于修饰 Action 类里的方法, 用于将方法映射为指定的 URL.
  • @Action 可以指定一个 value 属性, 用于指定该 Action 映射的URL(类似于在 struts.xml 文件中配置该 Action 时为 <action /> 元素指定的 name 属性值)
  • @Action 还可以指定一个 param 属性, 该属性是一个字符串数组, 用于该 Action 指定参数名和参数值. params 属性值应该遵守如下格式: {“name1”, “value1”, “name2”, “value2”, …}. 该属性用于为该 Action 注入属性值
• @Actions 也用于修饰 Action 类里的方法, 用于将该方法映射到多个 URL. @Actions 用于组织多个 @Action.

Result 配置相关的 Annotation

• 和 Result 配置相关的 3 个 Annotation 是 @Result , @Results 和 @ResultPath
• @Results 用于组织多个 @Result, 因此它只需一个 value 属性值, 该 value 属性值为多个 @Result。
• @Result 用于定义逻辑视图和物理视图之间的对应关系, 也就是相当于 struts.xml 文件里 <result …/> 元素里的作用
  • name*: 指定 result 的名字, 相当于 <result …/> 节点的 name 属性
  • type: 指定视图资源的类型, 相当于 <result …/> 节点的 type 属性
  • locations: 指定实际视图的位置, 相当于 <result …></result> 的中间部分
  • params: 为视图资源指定参数值. 属性值应满足 {name1, value1, name2, value2…} 的格式. 相当于 <result…></result> 的 <param> 子节点
• @Result 有如下两种用法
  • Action 级的 Result 映射: 以 @Actions 组合多个 @Action 后修饰的 Action 类. 这种 Result 映射对该 Action 里的所有方法都有效
  • 方法级的 Result 映射: 将多个 @Result 组成数组后作为 @Action 的 results 属性值. 这种 Result 映射仅对被修饰的方法有效
• @ResultPath 用于改变被修饰 Action所对应的物理视图资源的根路径. 例如: 默认情况下, Conversion 插件会到 WEB-INF/content 路径下寻找物理视图资源. 但若使用 @ResultPath(“/simpleit”) 修饰 Action, 系统将会到 simpleit 目录下寻找物理资源

包和命名空间相关的 Annotation

• 与包和命名空间相关的 Annotation 有如下 2 个
  • @Namespace: 修改 Action. 该 Annotation 只需指定一个 value 属性值, 用于指定被修改的 Action 所在的命名空间.
  • @ Namespaces: 修饰 Action. 用于组合多个 @Namespace.

异常相关的 Annotation

• 与异常相关的 Annotation 有 @ExceptionMapping 和 @ExceptionMappings
• @ExceptionMappings 用于定义异常类和物理视图之间的对应关系, 也就是它只需指定一个 value 属性值, 该 value 属性值为多个 @ExceptionMapping
• @ExceptionMapping: 用于定义异常类和物理视图之间的对应关系, 也就是相当于 struts.xml 文件里 <exception-mapping …/> 元素的作用. 使用 @ExceptionMapping 时必须指定如下两个属性:
  • exception: 用于指定异常类, 相当于 <exception-mapping…/> 元素的 exception
  • result: 用于指定逻辑视图名, 相当于 <exception-mapping …/> 元素的 result
• @ ExceptionMapping 有如下两种用法:
  • Action 级的异常定义: 以 @ExceptionMappings 组合多个 @ExceptionMapping 后修饰 Action 类. 这种异常定义对 Action 里的所有方法都有效.
  • 方法级的异常定义: 将多个 @ExceptionMapping 组成数组后作为 @Action 的 exceptionMappings 属性值. 这种异常定义仅对修饰的方法有效.

拦截器相关的 Annotation

• 拦截器配置相关的 Annotation 有 @InterceptorRef, @InterceptorRefs, @DefaultInterceptorRef
• @InterceptorRefs 用于指定多个 @InterceptorRef, 因此该 Annotation 只需指定一个 value 属性值, 该 value 属性值为多个 @ InterceptorRef
• @InterceptorRef 用于为指定 Action 引用拦截器或者拦截器栈. 也就是 struts.xml 文件中 <action…> 节点内部的 <interceptor-ref …/> 子元素的作用. 属性如下
  • vlaue*: 用于指定所引用拦截器或拦截器栈的名字, 相当于 <interceptor-ref …/> 子元素中的 name 属性
  • params: 用于覆盖所引用该拦截器的默认参数值. 该属性应满足 {name1, value1, name2, value2, …} 的格式. 相当于 <interceptor-ref …/> 元素的 <param> 子元素.
• @InterceptorRef 有如下两种用法
  • Action 级的拦截器配置
  • 方法级的拦截器配置
• @DefaultInterceptorRef: 主要用于修饰包, 用于指定该包的默认拦截器. 这个 Annotation 只有一个 value 属性, 用于指定默认拦截器的名字.