Struts2输出XML格式的Result

 

扩展Struts2--自定义String和XML格式的Result 

struts2虽然继承了webwork优秀的MVC分离，可是有很多地方让人百思不得其解！最让人离谱的是，返回的结果集中居然没有String，xml这两种非常常用的类型。还是自己动手，丰衣足食：

 

第一种方式：使用“PlainText Result”

 

    先看官方文档对plain text结果的定义：“A result that send the content out as plain text. Usefull typically when needed to display the raw content of a JSP or Html file for example.”这是一个纯扯蛋的说法。。。貌似感觉只能返回jsp页面似的，最起码他误导了我。

 

    其实使用“PlainText Result” ，返回的结果是未进行格式和编码定义的字符串 。 什么意思？就类似于“FreeMarker Result”  ，返回一个*.ftl格式的模板，你完全可以在*.ftl写string，那么结果就是string；也可以在里面写xml，那么结果就是xml。

 

   举例如下：

1. <? xml   version = "1.0"   encoding = "UTF-8"   ?>
2. <!DOCTYPE struts PUBLIC
3.         "-//Apache Software Foundation//DTD Struts Configuration 2.0//EN"
4.         "http://struts.apache.org/dtds/struts-2.0.dtd">
5. < struts >
6.      < package   name = "example"   namespace = "/example"
7.          extends = "struts-default" >
8.          < action   name = "outputXml"    method = "outxml"   class = "example.OutputXml" >
9.              < result   name = "xmlMessage"   type = "plaintext" > </ result >
10.          </ action >
11.      </ package >
12. </ struts >

这里定义了xmlMessage为plain text结果，至于它具体是什么，看下面的Action类：

 

1. public   class  OutputXml  extends  ActionSupport {
2.      public   void  outxml()  throws  Exception {
3.         HttpServletResponse response = ServletActionContext.getResponse();
4.         response.setContentType( "text/xml " );
5.         PrintWriter pw = response.getWriter();
6.         pw.print( "<cc>cccccc</cc>" );
7.     }

    在代码中，我们显式的给response定义了ContentType。 那么返回去的内容"<cc>cccccc</cc>"就会被接收方按xml进行解析。

 而如果需要返回的是String类型，那么contentType = "text/plain”。

如果进一步需要指明编码，那么contentType = "text/plain; charset=UTF-8";

 

    到这里理解“ plain text的结果是未进行格式和编码定义的字符串”应该就不困难了。基于http的内容传输实际都是字符串型，类型的定义是放在response的contentType 中。

 

 

第二种方式： 直接扩展struts2的结果集StrutsResultSupport  ：

 

代码如下：

应该很容易懂了。。嘿嘿

1. package  commons.struts2;
3. import  java.io.PrintWriter;
5. import  javax.servlet.http.HttpServletResponse;
7. import  org.apache.struts2.dispatcher.StrutsResultSupport;
9. import  com.opensymphony.xwork2.ActionInvocation;
11. /**
12.  * result type for output string in action
13.  * 
14.  * @author songwei,yaolei <b>Example:</b>
15.  * 
16.  * <pre>
17.  * <!-- START SNIPPET: example -->
18.  * <result name="success" type="string">
19.  *   <param name="stringName">stringName</param>
20.  * </result>
21.  * <!-- END SNIPPET: example -->
22.  * </pre>
23.  * 
24.  */
25. public   class  StringResultType  extends  StrutsResultSupport {
26.      private   static   final   long  serialVersionUID = 1L;
27.      private  String contentTypeName;
28.      private  String stringName =  "" ;
30.      public  StringResultType() {
31.          super ();
32.     }
34.      public  StringResultType(String location) {
35.          super (location);
36.     }
38.      protected   void  doExecute(String finalLocation, ActionInvocation invocation)
39.              throws  Exception {
40.         HttpServletResponse response = (HttpServletResponse) invocation
41.                 .getInvocationContext().get(HTTP_RESPONSE);
42.          // String contentType = (String)
43.          // invocation.getStack().findValue(conditionalParse(contentTypeName,
44.          // invocation));
45.         String contentType = conditionalParse(contentTypeName, invocation);
46.          if  (contentType ==  null ) {
47.             contentType =  "text/plain; charset=UTF-8" ;
48.         }
49.         response.setContentType(contentType);
50.         PrintWriter out = response.getWriter();
51.          // String result = conditionalParse(stringName, invocation);
52.         String result = (String) invocation.getStack().findValue(stringName);
53.         out.println(result);
54.         out.flush();
55.         out.close();
57.     }
59.      public  String getContentTypeName() {
60.          return  contentTypeName;
61.     }
63.      public   void  setContentTypeName(String contentTypeName) {
64.          this .contentTypeName = contentTypeName;
65.     }
67.      public  String getStringName() {
68.          return  stringName;
69.     }
71.      public   void  setStringName(String stringName) {
72.          this .stringName = stringName;
73.     }
75. }

 

使用的方法：

1.Action

1. package  test;
3. import  com.opensymphony.xwork2.ActionSupport;
5. public   class  MyAction  extends  ActionSupport{
7.     String  result= "abc" ;
9.      public  String ajax() {
10.          return   "ajaxResponse" ;
11.     }
13.      // getter && setter
14.      public  String getResult() {
15.          return  result;
16.     }
17.      public   void  setResult(String result) {
18.          this .result = result;
19.     }
20.     
21. }

2.定义struts.xml

1. <? xml   version = "1.0"   encoding = "UTF-8"   ?>
2. <!DOCTYPE struts PUBLIC
3.     "-//Apache Software Foundation//DTD Struts Configuration 2.0//EN"
4.     "http://struts.apache.org/dtds/struts-2.0.dtd">
6. < struts >
7.      < package   name = "test"   extends = "struts-default" >
8.          < result-types >
9.              < result-type   name = "string"   class = "test.StringResultType" > </ result-type >
10.          </ result-types >
11.         
12.          < action   name = "myAction"   class = "test.MyAction"   >
13.              < result   name = "ajaxResponse"   type = "string" >
14.                  < param   name = "stringName" > result </ param >
15.              </ result >
16.          </ action >
17.      </ package >
18. </ struts >

无非也就是将string结果集进行申明，然后给返回“ajaxResponse”的结果绑定变量名。这里定义返回Action的String  result 变量，即“abc”。