检测FreeMarker中的未定义变量

Question

我正在使用FreeMarker构建一个基于模板的代码生成器。由于用户可以用任何语言生成代码，因此在数据模型中提供语言特定的设置（例如包）是不合适的。但是，如果它们在FreeMarker模板中定义，则必须定义它们（除非它们是可选的）。

此代码利用FreeMarker引发的异常来查找缺失值。然后用临时值填充它们，以便找到其他缺失的值。

当值在根数据模型中时，这很好用（除了我似乎无法抑制FreeMarker的错误消息）。但是，只要其中一个缺失变量处于更深层次，似乎有必要解析整个模板以找出问题。

这样做的原因是，我可以检测到缺失值并提示用户即时。如果他们正在生成Java，它可能会提示打包。 C++？也许编译指示。

无论如何，有没有人有任何想法如何更有效地做到这一点？

工作代码和模板如下。

来源FMCodeGenTest.java：

package codegen; 

import freemarker.cache.*; 
import freemarker.core.ParseException; 
import freemarker.template.*; 
import java.io.*; 
import java.util.*; 

public class FMCodeGenTest { 
    private Configuration mConfig = null; 
    private HashMap mDataModel = null; 
    private Template mTemplate = null; 


    public void init() { 
     mConfig = new Configuration(Configuration.VERSION_2_3_22); 

     try { 
      mConfig.setDirectoryForTemplateLoading(new File("./templates")); 
      mConfig.setDefaultEncoding("UTF-8"); 
      mConfig.setTemplateExceptionHandler(TemplateExceptionHandler.RETHROW_HANDLER); 
     } catch (IOException ie) { 
      System.out.println("Error reading templates."); 
     }  
    } 

    public void buildDataModel() { 
     mDataModel = new HashMap(); 
     mDataModel.put("user", "Foo"); 

     ArrayList vars = new ArrayList(); 
     mDataModel.put("vars", vars); 

     HashMap var = new HashMap(); 
     vars.add(var); 
     var.put("name", "apple"); 
     var.put("type", "String"); 
    } 

    public void getTemplate() { 
     try { 
      mTemplate = mConfig.getTemplate("java_error.ftl"); 

     } catch (MalformedTemplateNameException ex) { 
      System.out.println("Malformed Template Name : " + ex.getMessage()); 

     } catch (ParseException ex) { 
      System.out.println("Parse Error : " + ex.getMessage()); 

     } catch (IOException ex) { 
      System.out.println("IO Exception : " + ex.getMessage()); 
     } 

    } 

    public void detectUndefinedVariables() { 
     boolean hasBadVars = false; 

     do { 
      hasBadVars = false; 

      try { 
       mTemplate.process(mDataModel, new NullWriter()); 

      } catch (TemplateException ex) { 
       hasBadVars = true; 

       mDataModel.put(ex.getBlamedExpressionString(), "<temporary value>"); 

      } catch (IOException ex) { 
       System.out.println("IO Exception : " + ex.getMessage()); 
      } 
     } while (hasBadVars); 
    } 


    public void generateCode() { 
     /* Merge data-model with template */ 
     Writer out = new OutputStreamWriter(System.out); 
     try { 
      mTemplate.process(mDataModel, out); 

     } catch (TemplateException ex) { 
      System.out.println("Template Exception : " + ex.getMessage()); 

     } catch (IOException ex) { 
      System.out.println("IO Exception : " + ex.getMessage()); 
     } 
    } 

    static public void main(String [] args) { 
     FMCodeGenTest test = new FMCodeGenTest(); 

     test.init(); 

     test.buildDataModel(); 

     test.getTemplate(); 

     test.detectUndefinedVariables(); 

     test.generateCode(); 
    } 
} 

模板java_error.ftl：

package ${package}; 

/** 
* 
* @author ${user} 
*/ 
public class ${name} { 
    <#list vars as var> 
    private ${var.type} _${var.name}; 
    nontrivial ${var.notthere}; 
    </#list> 
} 

Answer 1

我觉得这不应该追赶InvalidReferenceException例外来完成，而是通过使用特殊的数据模型。数据模型本身应该提示输入缺失的变量。因此，您总是知道用户提供的值应该添加到数据模型中的哪个位置，并且您不需要处理模板本身。