菜鸟学Struts2——Results

　　在对Struts2的Action学习之后，对Struts2的Result进行学习。主要对Struts2文档Guides中的Results分支进行学习，如下图：

1、Result Types(Result类型)

Struts2的Action处理用户请求后返回一个字符串，在struts.xml配置文件中进行字符串与实际视图的映射，在配置文件中是通过action的子元素result来完成此功能的，result的格式如下：

 <result name="字符串" type="视图类型">实际视图</result>

Struts2的result类型主要有以下几种：

对以上Result Type几种常见的进行学习，其中Freemarker、Velocity、XSL、JSON等几个暂不学习。

（1）Chain Result

这个在对Action进行学习的时候已经使用过，Chain Result有4个参数，actionName (default) 、namespace 、method 、skipActions ，关于Chain Result的学习已经在 菜鸟学习Struts2——Actions 记录。配置列子如下：

 <result type="chain">
      <param name="actionName">chain</param>
      <param name="namespace">/chain</param>
 </result>

（2）Dispatcher Result

Dispatcher Result 负责转发到指定的JSP页面，效果跟<jsp:forword page=".."/>是一样的，这是Result默认的类型，所以可以在result中指定<result name="success">a.jsp</result>而不用指定其类型。Dispatcher Result有两个参数配置location (default) 、parse ，其中location执行jsp所在的位置，parse默认是true，如果将parse设置成false，则localtion的Url中挂着的参数将不会被解析到OGNL值栈中，配置列子如下：

 <result name="input">/index.jsp</result>

（3）HttpHeader Result

HttpHeader Result允许开发自定义返回http header的参数或者返回一个错误信息，HttpHeader Result有5个参数status、parse(跟dispatcher的parse一样)、headers 、error、errorMessage ，配置列子如下：

 <result name="success" type="httpheader">
   <param name="status">204</param>
   <param name="headers.a">a custom header value</param>
   <param name="headers.b">another custom header value</param>
 </result>

 <result name="proxyRequired" type="httpheader">
   <param name="error">305</param>
   <param name="errorMessage">this action must be accessed through a proxy</param>
 </result>

（4）Redirect Result

Redirect Result跟response.sendRedirect("")的效果是一致的，也就是重定向，页面重定向是一个新的请求，上一个request中的值都将消息，如果需要在重定向之后保持上一次请求的值，那个可以将上一次request的值放到session中，或者在result中配置param。 Redirect Result有3个参数location (default) 、parse (跟dispatcher的parse一样)、anchor(指定该值则会出现在url中，如http://www.xx.com#anchor)，配置例子如下：

 <result name="success" type="redirect">
   <param name="location">foo.jsp</param>
   <param name="parse">false</param>
   <param name="anchor">FRAGMENT</param>
 </result>

上面的列子最后的url将会是：foo.jsp#FRAGMENT

 <result name="showReportResult" type="redirect">
     <param name="location">generateReport.jsp</param>
     <param name="reportType">pie</param>
     <param name="width">100</param>
     <param name="height">100</param>
     <param name="parse">false</param>
     <param name="anchor">summary</param>
 </result>

上面的列子最后的url将会是：generateReport.jsp?reportType=pie&width=100&height=100#summary

（5）Redirect Action Result

Redirect Action Result与Redirect Result有点一样，Redirect通过location指定重定向的url，而Redirect Action Result通过actionName和namespace指定重定向的Url，Redirect Result不会将空值的param挂在Url上，但Redirect Action Result可以通过配置suppressEmptyParameters决定是否将空值的param挂在Url上（但是测试过程中，不管是将suppressEmptyParameters设置成为false，还是设置成为true，都不会将控制的param挂着在Url上，chrome浏览器环境!!!  后续在研究研究，还是自己理解错了??），Redirect Action Result 有5个参数配置actionName (default) 、namespace 、suppressEmptyParameters、parse 、anchor，配置列子如下：

 <result name="redirect" type="redirectAction">
     <param name="actionName">result-target</param>
     <param name="width"></param>
     <param name="height">100</param>
     <param name="suppressEmptyParameters">false</param>
 </result>

（6）Stream Result

Stream Result用于返回一个InputStream，原始数据直接传递给HttpServletResponse，可以用于文件下载等，Stream Result有7个参数contentType 、contentLength、contentDisposition、inputName 、bufferSize 、allowCaching 、contentCharSet 。完整的列子如下：

 <!DOCTYPE struts PUBLIC
     "-//Apache Software Foundation//DTD Struts Configuration 2.3//EN"
     "http://struts.apache.org/dtds/struts-2.3.dtd">
 <struts>
     <package name="result" extends="struts-default" namespace="/result">
         <action name="result-*" class="yaolin.core.action.ResultAction" method="{1}">
             <result name="stream" type="stream">
                 <param name="contentType">image/jpeg</param>
                 <param name="inputName">stream</param>
                 <param name="contentDisposition">attachment;filename="yaolin.jpg"</param>
                 <param name="bufferSize">1024</param>
             </result>
         </action>
     </package>
 </struts>

 package yaolin.core.action;

 import java.io.File;
 import java.io.FileInputStream;
 import java.io.InputStream;

 public class ResultAction {

     // 文件流
     private InputStream stream;
     // Stream Result
     public String stream() throws Exception {
         File img = new File("E:/yaolin.jpg");
         stream = new FileInputStream(img);
         return "stream";
     }

     // getter and setter
     public InputStream getStream() {
         return stream;
     }
 }

（7）PlainText Result

PlainText Result是直接将JSP/HTML中的源代码内容输入到页面中，PlaintText Result有两个参数location、charset。配置例子如下：

 <result name="text" type="plainText">
     <param name="location">/index.jsp</param>
     <param name="charset">utf-8</param>
 </result>

2、DispatcherListener

以下是官网DOC给的例子，暂时没搞明白怎么用?? 后续研究一下。

 //Use a DispatcherListener object to execute code when a Dispatcher is initalized or destroyed. A DispatcherListener is an easy way to associate customizable components like a ConfigurationManager with a Dispatcher.
 static {
    Dispatcher.addDispatcherListener(new DispatcherListener() {
        public void dispatcherInitialized(Dispatcher du) {
           // do something to Dispatcher after it is initialized eg.
           du.setConfigurationManager(....);
        }

        public void dispatcherDestroyed(Dispatcher du) {
           // do some cleanup after Dispatcher is destroyed.
        }
    });
 }

3、PreResultListener

PreResultListener暂时没有想到实际的用法，后续研究一下，以下是DOC中的说明&列子：

描述：A PreResultListener can affect an action invocation between the interceptor/action phase and the result phase. Typical uses include switching to a different Result or somehow modifying the Result or Action objects before the Result executes.

例子：

 // 在Action中使用
 public class MyAction extends ActionSupport {
    ...
    public String execute() throws Exception {
        ActionInvocation invocation = ActionContext.getContext().getActionInvocation();
        invocation.addPreResultListener(new PreResultListener() {
             public void beforeResult(ActionInvocation invocation,
                                      String resultCode) {
                 // perform operation necessary before Result execution
             }
        });
    }
    ...
 }

// 在拦截器中使用
public class MyInterceptor extends AbstractInterceptor {
   ...
    public String intercept(ActionInvocation invocation) throws Exception {
       invocation.addPreResultListener(new PreResultListener() {
            public void beforeResult(ActionInvocation invocation,
                                     String resultCode) {
                // perform operation necessary before Result execution
            }
       });
    }
   ...
}

对于Result这一块仍有DispatcherListener、PreResultListener需要进行研究。

未完，待续。