抑制Freemarker模板错误

时间:2016-03-21 11:07:51

标签: java struts2 freemarker

我正在使用struts-2.3.16,我必须在我们的应用程序中全局禁止Freemarker模板的异常。这意味着,我必须转发到显示通用消息的全局jsp,而不是带有来自Freemarker的堆栈跟踪的黄色屏幕,因此阻止向用户显示堆栈跟踪。对于struts中的泛型异常,我们在struts.xml中映射了一个全局结果,但它不适用于Freemarker异常。

到目前为止,我已经实施了What are different ways to handle error in FreeMarker template?的解决方案。所以我创建了一个CustomFreemarkerManager和一个CustomTemplateExceptionHandler。

我的CustomFreemarkerManager看起来像这样:

@Override
public void init(ServletContext servletContext) throws TemplateException {
    super.config = super.createConfiguration(servletContext);
    super.config.setTemplateExceptionHandler(new CustomTemplateExceptionHandler(servletContext));
    super.contentType = "text/html";
    super.wrapper = super.createObjectWrapper(servletContext);
    if (LOG.isDebugEnabled()) {
        LOG.debug("Using object wrapper of class " + super.wrapper.getClass().getName(), new String[0]);
    }

    super.config.setObjectWrapper(super.wrapper);
    super.templatePath = servletContext.getInitParameter("TemplatePath");
    if (super.templatePath == null) {
        super.templatePath = servletContext.getInitParameter("templatePath");
    }

    super.configureTemplateLoader(super.createTemplateLoader(servletContext, super.templatePath));
    super.loadSettings(servletContext);
}

@Override
protected Configuration createConfiguration(ServletContext servletContext) throws TemplateException {
    Configuration configuration = new Configuration();
    configuration.setTemplateExceptionHandler(new CustomTemplateExceptionHandler(servletContext));
    if (super.mruMaxStrongSize > 0) {
        configuration.setSetting("cache_storage", "strong:" + super.mruMaxStrongSize);
    }

    if (super.templateUpdateDelay != null) {
        configuration.setSetting("template_update_delay", super.templateUpdateDelay);
    }

    if (super.encoding != null) {
        configuration.setDefaultEncoding(super.encoding);
    }

    configuration.setLocalizedLookup(false);
    configuration.setWhitespaceStripping(true);
    return configuration;
}

从这里我将ServletContext发送到我的CustomTemplateExceptionHandler,这样我就可以创建一个RequestDispatcher来转发到我的exception.jsp。问题是在异常处理程序中我没有请求和响应,我无法转发到我的jsp。

到目前为止,CustomTemplateExceptionHandler类看起来像这样:

private ServletContext servletContext;

public CustomTemplateExceptionHandler(ServletContext servletContext) {
    this.servletContext = servletContext;
}

public void handleTemplateException(TemplateException te, Environment env, Writer out) throws TemplateException {
    if (servletContext != null) {
        RequestDispatcher requestDispatcher = servletContext.getRequestDispatcher("/resources/exception.jsp");

        //HERE I have to forward to my jsp
    }
}

有人知道我该怎么办?我希望只在服务器上记录stacktrace,并在UI中用一般消息替换stacktrace。

2 个答案:

答案 0 :(得分:0)

好的,所以我解决这个问题的方法是在CustomTemplateExceptionHandler中的PrintWriter上打印一个类似于Freemarker提供的标准HTML_DEBUG_HANDLER的响应。看看这个链接:

https://github.com/apache/incubator-freemarker/blob/2.3-gae/src/main/java/freemarker/template/TemplateExceptionHandler.java#L98

在这里您可以看到如何管理HTML_DEBUG_HANDLER。我用一般消息替换了打印堆栈跟踪。 Freemarker文档建议您使用RETHROW_HANDLER,并在调用Template.process()之后在应用程序中捕获异常。见这里:

http://freemarker.org/docs/app_faq.html#misc.faq.niceErrorPage

但是因为Struts2正在使用Freemarker后台,并且Freemarker方法在执行动作后执行,我无法弄清楚如何以及在何处捕获异常。我已经设法在方法handleTemplateException()中获取HttpServlet响应和请求(请参阅问题),但我无法转发到我的exception.jsp,因为响应已经提交,因此它给了我一个例外。

最终代码如下:

Class CustomFreemarkerManager:

@Override
public void init(ServletContext servletContext) throws TemplateException {
    super.config = super.createConfiguration(servletContext);
    super.config.setTemplateExceptionHandler(new CustomTemplateExceptionHandler());
    super.contentType = "text/html";
    super.wrapper = super.createObjectWrapper(servletContext);
    if (LOG.isDebugEnabled()) {
        LOG.debug("Using object wrapper of class " + super.wrapper.getClass().getName(), new String[0]);
    }

    super.config.setObjectWrapper(super.wrapper);
    super.templatePath = servletContext.getInitParameter("TemplatePath");
    if (super.templatePath == null) {
        super.templatePath = servletContext.getInitParameter("templatePath");
    }

    super.configureTemplateLoader(super.createTemplateLoader(servletContext, super.templatePath));
    super.loadSettings(servletContext);
}

@Override
protected Configuration createConfiguration(ServletContext servletContext) throws TemplateException {
    Configuration configuration = new Configuration();
    configuration.setTemplateExceptionHandler(new CustomTemplateExceptionHandler());
    if (super.mruMaxStrongSize > 0) {
        configuration.setSetting("cache_storage", "strong:" + super.mruMaxStrongSize);
    }

    if (super.templateUpdateDelay != null) {
        configuration.setSetting("template_update_delay", super.templateUpdateDelay);
    }

    if (super.encoding != null) {
        configuration.setDefaultEncoding(super.encoding);
    }

    configuration.setLocalizedLookup(false);
    configuration.setWhitespaceStripping(true);
    return configuration;
}

Class CustomTemplateExceptionHandler:

public void handleTemplateException(TemplateException te, Environment env, Writer out) throws TemplateException {

    boolean externalPw = out instanceof PrintWriter;
    PrintWriter pw = externalPw ? (PrintWriter) out : new PrintWriter(out);
    try {
        pw.print("<!-- ERROR MESSAGE STARTS HERE -->"
                + "<!-- ]]> -->"
                + "</table></table></table>"
                + "<div align='left' style='"
                + "background-color:#FFFF7C; "
                + "display:block; "
                + "border-top:double; "
                + "padding:10px; "
                + "'>");
        pw.print("<b style='"
                + "color: red; "
                + "font-size:14px; "
                + "font-style:normal; "
                + "font-weight:bold; "
                + "'>"
                + "Oops! We have encountered a problem. Please try again!"
                + "</b>");
        pw.println("</div></html>");
        pw.flush();  // To commit the HTTP response
    } finally {
        if (!externalPw) pw.close();
    }

    throw te;
}

如果有人对此有更好的回应,请发表您的回答!

答案 1 :(得分:0)

应该更容易。如果您不想要黄色调试模板错误,则必须将TemplateExceptionHandlerHTML_DEBUG_HANDLER切换到RETHROW_HANDLER(因为顶部的freemarker消息提示: FreeMarker模板错误DEBUG模式;在生产中使用RETHROW!

现在,我更喜欢以编程方式(就像您这样做),因为我想根据环境选择TemplateExceptionHandlerPROTESTDEVEL) ,我的解决方案是将环境信息放在上下文中。

public class CustomFreemarkerManager extends FreemarkerManager {    


    public CustomFreemarkerManager(){
        super();
    }

    @Override
    public void init(ServletContext servletContext) throws TemplateException {

        //important!
        super.init(servletContext);

        //other stuff maybe you want to tune...

        //Getting environmentInfo object from the context, it's a personal solution 
        EnvironmentInfo environmentInfo = (EnvironmentInfo)servletContext.getAttribute(EnvironmentInfo.CONTEXT_NAME);

        if (environment.isPro()) {
            config.setTemplateExceptionHandler(TemplateExceptionHandler.RETHROW_HANDLER);
        }else{
            config.setTemplateExceptionHandler(TemplateExceptionHandler.HTML_DEBUG_HANDLER);    
        }

    }
}

告诉struts在struts.properties

中使用您的经理
struts.freemarker.manager.classname=com.jobisjob.northpole.web.core.CustomFreemarkerManager

希望这有帮助。