Freemarker中Configuration的setClassForTemplateLoading方法參數問題


今天使用freemarker中Configuration的setClassForTemplateLoading方法遇到了加載模板目錄的一個小問題。

由於網上的其他論壇,博客寫的有點亂,故記錄一下。

 

Freemarker是一個模板框架,主要是為了加快染速度而產生的。它與web容器無關,只要是關於模板生成一些代碼的都可以使用它完成。

比如xml,Java代碼的生成等。 其他類似的模板框架還有velocity。

 

本文主要講的是Freemarker的加載模板目錄問題,它的語法就不描述了。具體的語法可在官網下載參考手冊參考即可。

加載模板目錄方法

Freemarker提供了3種加載模板目錄的方法。 它使用Configuration類加載模板

3種方法分別是:

public void setClassForTemplateLoading(Class clazz, String pathPrefix);

public void setDirectoryForTemplateLoading(File dir) throws IOException;

public void setServletContextForTemplateLoading(Object servletContext, String path);

看名字也就知道了,分別基於類路徑、文件系統以及Servlet Context。

 

第二,三種沒啥好說的。

第二種基於文件系統。 比如加載/home/user/template下的模板文件。

Configuration cfg = new Configuration();
cfg.setDirectoryForTemplateLoading(new File("/home/user/template"));
cfg.getTemplate("Base.ftl");

這樣就獲得了/home/user/template/Base.ftl這個模板文件。

 

第三種基於web project。 第二個參數是基於WebRoot下的。

比如: setServletContextForTemplateLoading(context, "/ftl") 就是 /WebRoot/ftl目錄。

 

第一種基於類路徑的方法有點小坑,其實看下源碼代碼就知道了。

比如 :

Configuration cfg = new Configuration();
cfg.setClassForTemplateLoading(FreemarkerUtil.class, "/template");
cfg.getTemplate("Base.ftl");

其實這個方法是根據類加載路徑來判斷的,最終會執行以下代碼:

FreemarkerUtil.class.getClassLoader().getResource("/template/");

 

這里注意一下第二個參數需要以 "/" 開頭。

 

其實我們看下源碼就知道了:

 

 

可以看到,prefix如果最后1個字符不是 "/" 會默認加上。 但是第一個不是 "/" 字符 並不會自動加上。

最后獲得的URL方法:

我們可以看到URL是通過loaderClass.getResource(fullPath) 獲得的。

 

最終的具體生成代碼是通過FMParser這個類生成的。  FMParser是使用JavaCC寫的,由於時間有限,就沒有具體研究了。

參考資料

http://my.oschina.net/flashsword/blog/160747


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM