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

最新推荐文章于 2023-01-06 14:31:29 发布

宋玮-深圳

最新推荐文章于 2023-01-06 14:31:29 发布

阅读量69

点赞数

文章标签： XML Struts freemarker Apache Webwork

本文介绍三种在Struts2框架中返回String和XML的方法：使用PlainTextResult、扩展StrutsResultSupport及利用VelocityResult、FreeMarkerResult。通过实例演示如何实现。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

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。

举例如下：

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

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

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

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

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

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

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

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

代码如下：

应该很容易懂了。。嘿嘿

package commons.struts2;

import java.io.PrintWriter;

import javax.servlet.http.HttpServletResponse;

import org.apache.struts2.dispatcher.StrutsResultSupport;

import com.opensymphony.xwork2.ActionInvocation;

/**
 * result type for output string in action
 * 
 * @author songwei,yaolei <b>Example:</b>
 * 
 * <pre>
 * <!-- START SNIPPET: example -->
 * <result name="success" type="string">
 *   <param name="stringName">stringName</param>
 * </result>
 * <!-- END SNIPPET: example -->
 * </pre>
 * 
 */
public class StringResultType extends StrutsResultSupport {
    private static final long serialVersionUID = 1L;
    private String contentTypeName;
    private String stringName = "";

    public StringResultType() {
        super();
    }

    public StringResultType(String location) {
        super(location);
    }

    protected void doExecute(String finalLocation, ActionInvocation invocation)
            throws Exception {
        HttpServletResponse response = (HttpServletResponse) invocation
                .getInvocationContext().get(HTTP_RESPONSE);
        // String contentType = (String) 
        // invocation.getStack().findValue(conditionalParse(contentTypeName, 
        // invocation)); 
        String contentType = conditionalParse(contentTypeName, invocation);
        if (contentType == null) {
            contentType = "text/plain; charset=UTF-8";
        }
        response.setContentType(contentType);
        PrintWriter out = response.getWriter();
        // String result = conditionalParse(stringName, invocation); 
        String result = (String) invocation.getStack().findValue(stringName);
        out.println(result);
        out.flush();
        out.close();

    }

    public String getContentTypeName() {
        return contentTypeName;
    }

    public void setContentTypeName(String contentTypeName) {
        this.contentTypeName = contentTypeName;
    }

    public String getStringName() {
        return stringName;
    }

    public void setStringName(String stringName) {
        this.stringName = stringName;
    }

}

使用的方法：

1.Action

package test;
import com.opensymphony.xwork2.ActionSupport;
public class MyAction extends ActionSupport{
    String  result="abc";
    public String ajax() {
        return "ajaxResponse";
    }
    // getter && setter 
    public String getResult() {
        return result;
    }
    public void setResult(String result) {
        this.result = result;
    }
    
}

2.定义struts.xml

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE struts PUBLIC
    "-//Apache Software Foundation//DTD Struts Configuration 2.0//EN"
    "http://struts.apache.org/dtds/struts-2.0.dtd">
<struts>
    <package name="test" extends="struts-default">
        <result-types>
            <result-type name="string" class="test.StringResultType"></result-type>
        </result-types>
        
        <action name="myAction" class="test.MyAction" >
            <result name="ajaxResponse" type="string">
                <param name="stringName">result</param>
            </result>
        </action>
    </package>
</struts>