`

【转】freemarker中实现自定义标签(包含处理参数以及循环变量)(2.3.11版本以后的方式)

 
阅读更多

 

Java代码  收藏代码
  1. import  java.io.IOException;  
  2. import  java.io.Writer;  
  3. import  java.util.Iterator;  
  4. import  java.util.Map;  
  5.   
  6. import  freemarker.core.Environment;  
  7. import  freemarker.template.SimpleNumber;  
  8. import  freemarker.template.TemplateBooleanModel;  
  9. import  freemarker.template.TemplateDirectiveBody;  
  10. import  freemarker.template.TemplateDirectiveModel;  
  11. import  freemarker.template.TemplateException;  
  12. import  freemarker.template.TemplateModel;  
  13. import  freemarker.template.TemplateModelException;  
  14. import  freemarker.template.TemplateNumberModel;  
  15.   
  16. /**  
  17.  * FreeMarker 自定义标签实现重复输出内容体。  
  18.  *   
  19.  *   
  20.  * 参数:  
  21.  * count: 重复的次数,必须的且非负整数。  
  22.  * hr: 设置是否输出HTML标签 "hr" 元素. Boolean. 可选的默认为fals.  
  23.  *   
  24.  *   
  25.  * 循环变量: 只有一个,可选的. 从1开始。  
  26.  *   
  27.  *   
  28.  */   
  29. public   class  RepeatDirective  implements  TemplateDirectiveModel {  
  30.   
  31.     private   static   final  String PARAM_NAME_COUNT =  "count" ;  
  32.     private   static   final  String PARAM_NAME_HR =  "hr" ;  
  33.   
  34.     public   void  execute(Environment env, Map params, TemplateModel[] loopVars,  
  35.             TemplateDirectiveBody body) throws  TemplateException, IOException {  
  36.   
  37.         // ---------------------------------------------------------------------   
  38.         // 处理参数   
  39.   
  40.         int  countParam =  0 ;  
  41.         boolean  countParamSet =  false ;  
  42.         boolean  hrParam =  false ;  
  43.   
  44.         Iterator paramIter = params.entrySet().iterator();  
  45.         while  (paramIter.hasNext()) {  
  46.             Map.Entry ent = (Map.Entry) paramIter.next();  
  47.   
  48.             String paramName = (String) ent.getKey();  
  49.             TemplateModel paramValue = (TemplateModel) ent.getValue();  
  50.   
  51.             if  (paramName.equals(PARAM_NAME_COUNT)) {  
  52.                 if  (!(paramValue  instanceof  TemplateNumberModel)) {  
  53.                     throw   new  TemplateModelException( "The \""  + PARAM_NAME_HR  
  54.                             + "\" parameter "  +  "must be a number." );  
  55.                 }  
  56.                 countParam = ((TemplateNumberModel) paramValue).getAsNumber()  
  57.                         .intValue();  
  58.                 countParamSet = true ;  
  59.                 if  (countParam <  0 ) {  
  60.                     throw   new  TemplateModelException( "The \""  + PARAM_NAME_HR  
  61.                             + "\" parameter "  +  "can't be negative." );  
  62.                 }  
  63.             } else   if  (paramName.equals(PARAM_NAME_HR)) {  
  64.                 if  (!(paramValue  instanceof  TemplateBooleanModel)) {  
  65.                     throw   new  TemplateModelException( "The \""  + PARAM_NAME_HR  
  66.                             + "\" parameter "  +  "must be a boolean." );  
  67.                 }  
  68.                 hrParam = ((TemplateBooleanModel) paramValue).getAsBoolean();  
  69.             } else  {  
  70.                 throw   new  TemplateModelException( "Unsupported parameter: "   
  71.                         + paramName);  
  72.             }  
  73.         }  
  74.         if  (!countParamSet) {  
  75.             throw   new  TemplateModelException( "The required \""   
  76.                     + PARAM_NAME_COUNT + "\" paramter"  +  "is missing." );  
  77.         }  
  78.   
  79.         if  (loopVars.length >  1 ) {  
  80.             throw   new  TemplateModelException(  
  81.                     "At most one loop variable is allowed." );  
  82.         }  
  83.   
  84.         // Yeah, it was long and boring...   
  85.   
  86.         // ---------------------------------------------------------------------   
  87.         // 真正开始处理输出内容   
  88.   
  89.         Writer out = env.getOut();  
  90.         if  (body !=  null ) {  
  91.             for  ( int  i =  0 ; i < countParam; i++) {  
  92.                 // 输出  <hr> 如果 参数hr 设置为true   
  93.                 if  (hrParam && i !=  0 ) {  
  94.                     out.write("<hr>" );  
  95.                 }  
  96.   
  97.                 // 设置循环变量   
  98.                 if  (loopVars.length >  0 ) {  
  99.                     loopVars[0 ] =  new  SimpleNumber(i +  1 );  
  100.                 }  
  101.   
  102.                 // 执行标签内容(same as <#nested> in FTL).    
  103.                 body.render(env.getOut());  
  104.             }  
  105.         }  
  106.     }  
  107.   
  108. }  

 

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  RepeatTest {  
  10.     public   static   void  main(String[] args) {  
  11.         Map<String,Object> root=new  HashMap<String, Object>();  
  12.   
  13.         root.put("repeat" new  RepeatDirective());  
  14.           
  15.         FreeMarkertUtil.processTemplate("src/templates" , "repeat.ftl" "UTF-8" , root,  new  OutputStreamWriter(System.out));  
  16.           
  17.     }  
  18. }  

 

 模板文件repeat.ftl如下:

 

Java代码  收藏代码
  1. <#assign x =  1 >  
  2.   
  3. 一个参数:  
  4. <@repeat  count= 4 >  
  5.   Test ${x}  
  6.   <#assign x = x + 1 >  
  7. </@repeat >  
  8.   
  9. 二个参数:  
  10. <@repeat  count= 3  hr= true >  
  11.   Test  
  12. </@repeat >  
  13.   
  14. 循环变量:  
  15. <@repeat  count= 3 ; cnt>  
  16.   ${cnt}. Test  
  17. </@repeat >    

 

 输出结果:

Java代码  收藏代码
  1. 一个参数:  
  2.   Test 1   
  3.   Test 2   
  4.   Test 3   
  5.   Test 4   
  6.   
  7. 二个参数:  
  8.   Test  
  9. <hr>  Test  
  10. <hr>  Test  
  11.   
  12. 循环变量:  
  13.   1 . Test  
  14.   2 . Test  
  15.   3 . Test  

摘自:http://lovewhzlq.iteye.com/blog/614092

分享到:
评论

相关推荐

    freemarker 自定义freeMarker标签

    这个类将定义你的自定义标签的行为,包括如何处理输入参数,如何处理模板模型数据,以及如何生成输出。 2. 注册自定义指令:在你的应用程序中,你需要将自定义指令类注册到FreeMarker配置中。这通常是通过`...

    Freemarker 自定义标签 简单案例

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

    spring mvc freemarker 自定义标签

    这个项目可能还包括了如何设置Spring MVC配置以支持自定义标签的步骤,以及如何在实际应用中调用这些自定义标签的示例。 自定义标签的灵活性非常高,你可以为任何复杂的业务逻辑或UI组件创建自定义标签。例如,你...

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

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

    freemark 自定义标签 总结

    通过上述内容,我们了解了Freemarker自定义标签的基本概念、创建与使用方法,以及如何在实际项目中发挥作用。自定义标签极大地增强了Freemarker的灵活性,使得模板语言可以更好地适应各种应用场景。在阅读...

    freemarker自定义分页标签宏

    总结起来,FreeMarker自定义分页标签宏的实现涉及到前端模板的宏定义与调用,以及后端的数据处理和链接生成。通过这种方式,我们可以创建出灵活且可复用的分页组件,方便地应用于各种项目中。理解并熟练掌握宏的使用...

    Struts2、Spring、Freemarker自定义标签

    Freemarker支持条件判断、循环结构、内置函数,以及自定义标签,增强了模板的灵活性。与JSP相比,Freemarker通常被认为更简洁、易读且更易于维护。 将这三个框架结合使用,可以构建出高效、灵活的Java Web应用。...

    freemarker及jeecms标签使用学习文档

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

    使用freemarker扩展struts标签

    5. `说明.txt`: 这个文件可能包含了关于如何使用这些自定义标签的详细说明,包括如何在FreeMarker模板中引用它们以及它们的功能。 要扩展Struts2的FreeMarker标签库,你需要遵循以下步骤: 1. **创建模型类**: 定义...

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

    在JSP(JavaServer Pages)中,自定义标签是通过TLD(Tag Library Descriptor)文件来定义的,它描述了标签的行为、属性、变量等信息。TLD文件通常以`.tld`为扩展名,是XML格式的,用于告诉JSP引擎如何处理特定的...

    Freemarker简介及标签详解大全

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

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

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

    freemarker替换变量实例

    freemarker替换变量实例

    freemarker模板导出word循环图片表格源码和详细教程

    在本教程中,我们将探讨如何利用Freemarker模板来导出Word文档,并实现循环插入图片和表格的功能。这对于需要批量生成定制化报告或者文档的应用场景非常有用。 首先,我们需要了解Freemarker的基本语法。在...

    Java html转word 使用FreeMarker

    通常,Word模板会遵循Open XML标准,这样FreeMarker就能识别并处理其中的标签。同时,这个描述中还提到了转换为PDF格式,虽然FreeMarker本身不直接支持PDF生成,但可以结合其他库,如Apache POI或iText,先用...

    自定义分页标签源代码

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

    freemarker实现一行两列算法

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

    freemarker中文文档与包

    例如,`&lt;#if&gt;`用于条件判断,`&lt;#foreach&gt;`用于循环,`&lt;#assign&gt;`用于变量赋值,`&lt;#function&gt;`定义自定义函数。这些元素使得开发者可以在模板中灵活地控制输出内容。 2. **数据模型与变量**: 在Freemarker中,数据...

    freemarker格式化缩进文本或include指令

    在自定义指令中,你可以根据需要处理模板输出的文本,添加适当的空格、换行符,甚至可以实现更复杂的格式规则,如基于特定的代码风格指南进行格式化。 2. **模板包含(include指令)**: FreeMarker的`&lt;#include&gt;`...

Global site tag (gtag.js) - Google Analytics