`

【转】freemarker中实现自定义标签(2.3.11版本以后的方式)

 
阅读更多

FreeMarker 2.3.11版本以后提供了新的自定义标签接口TemplateDirectiveModel 以替代TemplateTransformModel

下面是一个转换自定义标签的内容体中字母为大写字母的例子:

 

Java代码  收藏代码
  1. import  java.io.IOException;  
  2. import  java.io.Writer;  
  3. import  java.util.Map;  
  4.   
  5. import  freemarker.core.Environment;  
  6. import  freemarker.template.TemplateDirectiveBody;  
  7. import  freemarker.template.TemplateDirectiveModel;  
  8. import  freemarker.template.TemplateException;  
  9. import  freemarker.template.TemplateModel;  
  10. import  freemarker.template.TemplateModelException;  
  11.   
  12. /**  
  13.  * FreeMarker 自定义指令,用于转换指令内容体中的字母为大写字母。  
  14.  *   
  15.  */   
  16. public   class  UpperDirective  implements  TemplateDirectiveModel {  
  17.   
  18.     public   void  execute(Environment env, Map params, TemplateModel[] loopVars,  
  19.             TemplateDirectiveBody body) throws  TemplateException, IOException {  
  20.         // 检查是否传递参数,此指令禁止传参!   
  21.         if  (!params.isEmpty()) {  
  22.             throw   new  TemplateModelException(  
  23.                     "This directive doesn't allow parameters." );  
  24.         }  
  25.         // 禁用循环变量   
  26.         /*  
  27.          * 循环变量  
  28.                  用户定义指令可以有循环变量,通常用于重复嵌套内容,基本用法是:作为nested指令的参数传递循环变量的实际值,而在调用用户定义指令时,在${"<@…>"}开始标记的参数后面指定循环变量的名字  
  29.                  例子:  
  30.             <#macro repeat count>  
  31.               <#list 1..count as x>  
  32.                 <#nested x, x/2, x==count>  
  33.               </#list>  
  34.             </#macro>  
  35.             <@repeat count=4 ; c, halfc, last>  
  36.               ${c}. ${halfc}<#if last> Last!</#if>  
  37.             </@repeat>   
  38.         */   
  39.         if  (loopVars.length !=  0 ) {  
  40.             throw   new  TemplateModelException(  
  41.                     "This directive doesn't allow loop variables." );  
  42.         }  
  43.   
  44.         // 指令内容体不为空   
  45.         if  (body !=  null ) {  
  46.             // Executes the nested body. Same as <#nested> in FTL, except   
  47.             // that we use our own writer instead of the current output writer.   
  48.             body.render(new  UpperCaseFilterWriter(env.getOut()));  
  49.         } else  {  
  50.             throw   new  RuntimeException( "missing body" );  
  51.         }  
  52.     }  
  53.   
  54.     /**  
  55.      * 输出流的包装器(转换大写字母)  
  56.      */   
  57.     private   static   class  UpperCaseFilterWriter  extends  Writer {  
  58.   
  59.         private   final  Writer out;  
  60.   
  61.         UpperCaseFilterWriter(Writer out) {  
  62.             this .out = out;  
  63.         }  
  64.   
  65.         public   void  write( char [] cbuf,  int  off,  int  len)  throws  IOException {  
  66.             char [] transformedCbuf =  new   char [len];  
  67.             for  ( int  i =  0 ; i < len; i++) {  
  68.                 transformedCbuf[i] = Character.toUpperCase(cbuf[i + off]);  
  69.             }  
  70.             out.write(transformedCbuf);  
  71.         }  
  72.   
  73.         public   void  flush()  throws  IOException {  
  74.             out.flush();  
  75.         }  
  76.   
  77.         public   void  close()  throws  IOException {  
  78.             out.close();  
  79.         }  
  80.     }  
  81.   
  82. }  

 

Java代码  收藏代码
  1. import  java.io.File;  
  2. import  java.io.IOException;  
  3. import  java.io.Writer;  
  4. import  java.util.Map;  
  5.   
  6. import  freemarker.template.Configuration;  
  7. import  freemarker.template.DefaultObjectWrapper;  
  8. import  freemarker.template.Template;  
  9. import  freemarker.template.TemplateException;  
  10.   
  11. /**  
  12.  *   
  13.  * 模板工具类  
  14.  */   
  15. public   class  FreeMarkertUtil {  
  16.     /**  
  17.      * @param templatePath 模板文件存放目录   
  18.      * @param templateName 模板文件名称   
  19.      * @param root 数据模型根对象  
  20.      * @param templateEncoding 模板文件的编码方式  
  21.      * @param out 输出流  
  22.      */   
  23.     public   static   void  processTemplate(String templatePath, String templateName, String templateEncoding, Map<?,?> root, Writer out){  
  24.         try  {  
  25.             Configuration config=new  Configuration();  
  26.             File file=new  File(templatePath);  
  27.             //设置要解析的模板所在的目录,并加载模板文件   
  28.             config.setDirectoryForTemplateLoading(file);  
  29.             //设置包装器,并将对象包装为数据模型   
  30.             config.setObjectWrapper(new  DefaultObjectWrapper());  
  31.               
  32.             //获取模板,并设置编码方式,这个编码必须要与页面中的编码格式一致   
  33.             Template template=config.getTemplate(templateName,templateEncoding);  
  34.             //合并数据模型与模板   
  35.               
  36.             template.process(root, out);  
  37.             out.flush();  
  38.             out.close();  
  39.         } catch  (IOException e) {  
  40.             e.printStackTrace();  
  41.         }catch  (TemplateException e) {  
  42.             e.printStackTrace();  
  43.         }  
  44.           
  45.     }   
  46. }  

 

 

Java代码  收藏代码
  1. import  java.io.OutputStreamWriter;  
  2. import  java.util.HashMap;  
  3. import  java.util.Map;  
  4.   
  5. /**  
  6.  *   
  7.  * 客户端测试模板输入类  
  8.  */   
  9. public   class  ClientTest {  
  10.     public   static   void  main(String[] args) {  
  11.         Map<String,Object> root=new  HashMap<String, Object>();  
  12.   
  13.         root.put("upper" new  UpperDirective());  
  14.           
  15.         FreeMarkertUtil.processTemplate("src/templates" , "demo01.ftl" "UTF-8" , root,  new  OutputStreamWriter(System.out));  
  16.           
  17.     }  
  18. }  

 

 模板文件demo01.ftl如下:

Java代码  收藏代码
  1. < @upper >  
  2.   bar  
  3.   <#-- All kind of FTL is allowed here -->  
  4.   <#list ["red" "green" "blue" ] as color>  
  5.     ${color}  
  6.   </#list>  
  7.   baaz  
  8. </@upper >  

 

 

分享到:
评论

相关推荐

    freemarker 自定义freeMarker标签

    总的来说,自定义FreeMarker标签是提高模板引擎灵活性和扩展性的有效方式,也是Java开发中的一个重要技能。通过深入理解FreeMarker的工作原理和API,开发者可以构建出更强大、更符合项目需求的模板解决方案。

    Freemarker 自定义标签 简单案例

    在提供的"TestFreemarkerDiy"示例中,可能包含了一个简单的自定义标签实现以及一个演示如何使用该标签的Freemarker模板文件。通过分析这个示例,我们可以学习如何在实际项目中应用自定义标签,以提高模板的可维护性...

    实现通过jfinal框架自动扫描freemarker的自定义标签.zip

    本资源包的核心内容是教你如何在JFinal项目中实现FreeMarker自定义标签的自动扫描和注册,从而提升模板引擎的功能和灵活性。 首先,我们需要理解自定义标签的概念。在FreeMarker中,自定义标签允许开发者扩展其内置...

    spring mvc freemarker 自定义标签

    在`WebMvcConfigurer`的实现中,添加`freemarkerConfiguration` bean,并使用`freemarkerConfigurer`的`setCustomTags`方法添加自定义标签: ```java @Configuration public class WebConfig implements ...

    freemark 自定义标签 总结

    自定义标签在Freemarker中被称为`Custom Tags`,它们通过`&lt;@...&gt;`语法来调用。这些标签通常是由Java代码实现的,它们可以处理复杂的逻辑,如数据库查询、业务处理等,然后返回一个可渲染的字符串给Freemarker模板。...

    freemarker自定义分页标签宏

    在这个主题“freemarker自定义分页标签宏”中,我们将深入探讨如何在FreeMarker中创建自定义的分页标签宏,以便更有效地管理和展示大量数据。 首先,分页是一种常见的网页设计技术,用于将大量数据分割成小块,使...

    Struts2、Spring、Freemarker自定义标签

    而在Freemarker中,可以通过扩展其API创建自定义指令,实现更复杂的逻辑或功能。 总结一下,Struts2、Spring和Freemarker的组合为Java Web开发提供了强大的工具集,涵盖了MVC模式的各个方面。它们的自定义标签功能...

    freemarker自定义的通用分页指令(标签)源码和使用示例

    一个用FTL定义的非常通用数据分页指令,有源码,有使用示例。使用效果图可以参看本人博客中的相关文章:http://blog.csdn.net/qjyong/archive/2009/10/18/4693142.aspx

    使用freemarker扩展struts标签

    6. **在模板中使用标签**: 最后,在你的FreeMarker模板文件中,你可以像使用其他内置标签一样使用你的自定义标签。 通过这种方式,开发者可以创建出高度定制的UI组件,提高代码的可读性和可维护性。自定义标签使得...

    freemarker及jeecms标签使用学习文档

    Freemarker是一个强大的模板...通过这些文档的学习,你将能够熟练地运用Freemarker来编写模板,以及在Jeecms中利用其自定义标签来构建高效、灵活的网站内容管理。不断实践和探索,将使你在Web开发领域更加游刃有余。

    非常好用的自定义分页标签

    总的来说,这个自定义分页标签提供了一种便捷的方式,使得开发者可以在项目中快速集成分页功能,而无需从零开始编写复杂的分页逻辑。它体现了Java Web开发中组件化和重用的思想,提高了开发效率和代码质量。对于那些...

    Freemarker简介及标签详解大全

    5. 通用数据模型:FreeMarker 不是直接反射到 Java 对象,Java 对象通过插件式对象封装,以变量方式在模板中显示。 6. 为 Web 准备:在模板语言中内建处理典型 Web 相关任务(如 HTML 转义)的结构。 7. 智能的国际...

    Java html转word 使用FreeMarker

    要实现这个功能,首先需要在Java项目中添加FreeMarker的依赖。通常,这可以通过Maven或Gradle的配置文件完成,添加对应的依赖项。然后,你需要创建一个HTML模板,这个模板可以包含静态内容和一些特定的FreeMarker...

    freemarker实现一行两列算法

    ### Freemarker实现一行两列布局算法 在Web开发中,数据展示经常需要按照特定的格式进行排列,例如常见的列表项按行对齐显示等。Freemarker作为一种强大的模板引擎,可以方便地处理这类布局需求。本文将详细介绍...

    freemarker的shiro标签

    将FreeMarker与Shiro结合,可以方便地在Web应用中实现动态权限控制和用户界面的渲染。 1. **Shiro标签库**:Shiro提供了与FreeMarker集成的标签库,使得在FreeMarker模板中可以直接使用Shiro的权限控制功能。例如,...

    自定义分页标签源代码

    综上所述,这个自定义分页标签源代码提供了一种便捷的分页解决方案,通过自定义标签的方式简化了页面逻辑,使得开发者可以更专注于业务逻辑的实现,而不是分页的细节。理解并掌握这些知识点对于提升Java Web开发能力...

    spring boot 集成 shiro 自定义密码验证 自定义freemarker标签根据权限渲染不同页面(推荐

    在这个示例中,我们将介绍如何将 Shiro 集成到 Spring Boot 项目中,并实现自定义密码验证和 Freemarker 标签根据权限渲染不同页面。 首先,需要在 pom.xml 文件中添加 Shiro 的依赖项: ```xml &lt;groupId&gt;org....

    freemarker 中文乱码解决

    在处理Freemarker模板引擎时,中文乱码问题是一个常见的挑战,尤其是在国际化应用中。Freemarker是一款功能强大的模板引擎,被广泛应用于Web开发中,用于动态生成HTML、XML等文本格式的页面。然而,当涉及到非英文...

    Struts2_自定义标签的方法

    本文将深入探讨如何在Struts2中创建自定义标签,特别是基于`UITag`的实现方法,以及其背后的原理和步骤。 #### 二、Struts2自定义标签的构成 Struts2的自定义`UITag`由三部分组成: 1. **UIBean**:用于定义标签...

Global site tag (gtag.js) - Google Analytics