freeMarker模板加载

最新推荐文章于 2024-05-22 14:28:57 发布

siqilou

最新推荐文章于 2024-05-22 14:28:57 发布

阅读量5.8k

点赞数

分类专栏： freeMarker 文章标签： freemarker 模板引擎页面静态化模板加载

本文链接：https://blog.csdn.net/siqilou/article/details/44311107

版权

本文详细介绍了FreeMarker模板加载的过程，包括模板加载器的概念和内建的加载方式，如设置目录、类加载模板。同时，讨论了如何从多个位置加载模板，以及如何自定义模板加载器，特别是当需要通过URL访问模板时，如何继承`URLTemplateLoader`并实现关键方法`getURL`。最后，文章提到了`SessionURLTemplateSource`类，用于在加载模板时添加特定的Cookie。

摘要由CSDN通过智能技术生成

1、一些概念

（1）模板加载器：模板加载器是加载基于抽象模板路径下，比如"index.ftl"或"products/catalog.ftl"的原生文本数据对象。这由具体的模板加载器对象来确定它们取得请求数据时使用了什么样的数据来源（文件夹中的文件，数据等等）。当调用cfg.getTemplate（这里的cfg就是Configuration实例）时，FreeMarker询问模板加载器是否已经为cfg建立返回给定模板路径的文本，之后FreeMarker解析文本生成模板。

（2）内建模板加载器

在Configuration中可以使用下面的方法来方便建立三种模板加载。（每种方法都会在其内部新建一个模板加载器对象，然后创建Configuration实例来使用它。）

void setDirectoryForTemplateLoading(File dir);

void setClassForTemplateLoading(Class cl, String prefix);

void setServletContextForTemplateLoading(Object servletContext, String path);

（3）从多个位置加载模板

如果需要从多个位置加载模板，那就不得不为每个位置都实例化模板加载器对象，将它们包装到一个被称为MultiTemplateLoader的特殊模板加载器，最终将这个加载器传递给Configuration对象的setTemplateLoader(TemplateLoader loader)方法。下面给出一个使用类加载器从两个不同位置加载模板的示例：

import freemarker.cache.*; // 模板加载器在这个包下
...
FileTemplateLoader ftl1 = new FileTemplateLoader(new File("/tmp/templates"));
FileTemplateLoader ftl2 = new FileTemplateLoader(new File("/usr/data/templates"));
ClassTemplateLoader ctl = new ClassTemplateLoader(getClass(), "");
TemplateLoader[] loaders = new TemplateLoader[] { ftl1, ftl2, ctl };
MultiTemplateLoader mtl = new MultiTemplateLoader(loaders);
cfg.setTemplateLoader(mtl);

现在，FreeMarker将会尝试从/tmp/templates目录加载模板，如果在这个目录下没有发现请求的模板，它就会继续尝试从/usr/data/templates目录下加载，如果还是没有发现请求的模板，那么它就会使用类加载器来加载模板。

（4）从其他资源加载模板

如果内建的类加载器都不适合使用，那么就需要来编写自己的类加载器了，这个类需要实现freemarker.cache.TemplateLoader接口，然后将它传递给Configuration对象的setTemplateLoader(TemplateLoader loader)方法。

如果你的模板需要通过URL访问其他模板，那么就不需要实现TemplateLoader接口了，可以选择子接口freemarker.cache.URLTemplateLoader来替代，只需实现URL getURL(String templateName)方法即可。

2、自定义freemarker的模板加载

从（4）从其他资源加载模板，我们已经知道自定义模板加载器的思路了。我们这里讨论的是模板需要通过URL访问其他模板，因此，我们会继承freemarker.cache.URLTemplateLoader类，并实现URL getURL(String templateName)方法。当然，我们也会实现所有TemplateLoader接口的方法。

（1）controller类