Freemarker模板引擎:解决NonHashException字符串比较问题

本文旨在解决在使用Apache Freemarker模板引擎时,遇到的freemarker.core.NonHashException: Expected a hash, but this has evaluated to a string 错误,并提供正确的字符串比较方法。该错误通常发生在尝试访问对象属性时,Freemarker将其误判为字符串。通过理解Freemarker的字符串处理方式,可以有效避免此类问题。

问题分析

在使用Freemarker模板引擎进行开发时,当尝试访问一个对象的属性,并进行字符串比较时,可能会遇到NonHashException。例如,在Spring MVC项目中,从Controller传递一个Java对象到Freemarker模板,并尝试访问该对象的String类型的属性时,可能会出现如下错误:

freemarker.core.NonHashException: For "." left-hand operand: Expected a hash, but this has evaluated to a string (wrapper: f.t.SimpleScalar):
==> previousSearch.status  [in template "ticket/search.ftlh" at line 22, column 66]

这个错误表明Freemarker期望.左边的操作数是一个Hash(类似于Java中的Map),但实际却是一个字符串。

原因探究

出现这种问题的原因在于Freemarker对字符串的处理方式与Java有所不同。在Java中,我们通常使用.equals()方法来比较字符串的内容。但在Freemarker中,推荐使用==运算符来进行字符串比较。

解决方案

将Freemarker模板中的.equals()方法替换为==运算符即可解决此问题。

例如,将以下代码:

修改为:

通过这种方式,Freemarker可以正确地比较字符串,从而避免NonHashException。

示例代码

假设有一个Java类 TicketSearchForm:

import lombok.Data;

@Data
public class TicketSearchForm {
    private String status = "ALL";
}

在Spring MVC Controller中,将该对象传递到Freemarker模板:

import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.GetMapping;

@Controller
public class TicketController {

    @GetMapping("/search")
    public String search(Model model) {
        TicketSearchForm previousSearch = new TicketSearchForm();
        previousSearch.setStatus("OPEN"); // 设置状态为OPEN
        model.addAttribute("previousSearch", previousSearch);
        return "ticket/search"; // 假设模板文件为 ticket/search.ftlh
    }
}

对应的Freemarker模板 ticket/search.ftlh:

在这个例子中,使用previousSearch.status == "ALL" 来比较字符串,可以正确地根据previousSearch对象的status属性值来设置

注意事项

  • 始终使用==运算符在Freemarker模板中比较字符串。
  • 确保传递到Freemarker模板的对象属性类型与模板中使用的类型一致。
  • 在复杂的场景下,可以使用Freemarker提供的内置函数,如?string 将其他类型转换为字符串后再进行比较。

总结

解决Freemarker模板引擎中NonHashException的关键在于理解Freemarker对字符串的处理方式。通过使用==运算符代替.equals()方法进行字符串比较,可以避免该错误的发生,并确保模板的正确执行。 记住,Freemarker的语法与Java有所不同,需要仔细区分。