基于SSM3框架FreeMarker自定义指令(标签)实现

通过之前的Spring MVC 3.0.5+Spring 3.0.5+MyBatis3.0.4全注解实例详解系列文章,我们已经成功的整合到了一起,这次大象将在此基础上对框架中的FreeMarker模板做一个扩展,详细说明如何实现自定义指令(标签)功能。
    我们在开发的时候,往往对一些数据字典形式的数据,想将它封装成通用的模块以便于使用,如果使用JSP做展示层,可以创建自定义标签来实现,现在换成FreeMarker视图,我们一样可以达到想要的目的。
    实现FreeMarker指令其实很简单,只要实现TemplateDirectiveModel接口,覆盖里面的方法即可。
    public void execute(Environment env, Map params, TemplateModel[] loopVars, TemplateDirectiveBody body) throws TemplateException, IOException
    大象以select下拉框及显示数据字典文本两个自定义指令为例来进行说明。
    在ssm3工程中按下图创建freemarker package
    
    本例只为了说明如何实现,简便起见,所以用了DictContext这个模拟数据字典类。
    
    我模拟了性别和学历的数据,实际开发中,这些都是从数据库取得,原理都差不多,这里主要是为了演示。xb01、xl01这个标识大家可以随意定义只要保证唯一性就可以了,该类中还有两个取数据的方法,请直接看源码,这里就不再说明了。
    接下来我们就可以来创建DictSelectDirective这个类。
    
    上面这些参数,都是从模板页的自定义指令中获取的,根据我们想创建的这个select FreeMarker指令,可以定义任何我们想要的东西。因为最终生成的就是一段select html代码。
    通过params.get()获得的参数有类型要求,不同的值需要对其转型到相应类型。所以你不能将select的name类型转为SimpleNumber。另外还有一点要注意,FreeMarker对值的类型很敏感,什么意思呢?比如params.get("value");这是获得数据库中对应的字典值,对于这个值请一定要统一定义数据类型,比如都为整型或是字符串型,否则就会转换失败。所以大象在这里为了演示用到了TemplateModel接口,它是所有模板数据类型的超类。虽然这样做可以避免类型转换的错误,但同时会增加类型解析的代码量,所以完全没有必要,因为只要前期规划设计好,这类问题完全可以避免。
    DictSelectDirective里面其它代码就是拼装select,这个请直接看源码,另外代码中用到了一个第三方开源工具commons-lang,所以pom中需要加入这个依赖。
        
    注意红色框部分的代码,我在之前就说过,如果类型不确定,使用TemplateModel,就需要做类型解析的分析。而DictContext.getInstance().getDict(type.getAsString())是获得对应类型的数据字典,for循环将数据拼装到option中,如果是编辑表单,value有值,则会将对应的option选中。
    DictDisplayDirective实现更简单,方法DictSelectDirective一样,这里就不再赘述。
    想让FreeMarker的指令发挥作用,我们还有一些工作要做。下面这些源码中都有,可以直接查看代码。
    1、在servlet-context.xml里面加入红色方框中的内容
    
    2、在数据库的role表中,增加sex和edu两个字段
    3、在Role.java中添加sex与edu属性及getter,setter方法
    4、修改RoleMapper.xml中insert和update语句,增加sex和edu的保存与更新。<sql id="base_column">也要增加sex和edu字段。
    5、修改role_edit.html,增加性别与学历的FreeMarker指令。
    
    6、修改role_list.html,增加性别与学历显示。
    
    7、role_view.html也作相应修改,略。
    整个FreeMarker自定义指令(标签)的实现就这些,非常简单,大家还可以自行扩展,比如根据自身的业务需要,创建checkbox、radio等指令,或者是多个value值的文本显示,这些原理都是一样的。
    源码下载:ssm3_freemarker   
    本文为菠萝大象原创,如要转载请注明出处。http://www.blogjava.net/bolo

时间: 2024-10-24 23:30:53

基于SSM3框架FreeMarker自定义指令(标签)实现的相关文章

freemarker 自定义指令

1 简介 自定义指令可以使用 macro 指令来定义,这是模板设计者所关心的内容. Java 程序员若不想在模板中实 现定义指令 ,而是在 Java 语言中实现指令 的定义,这时 可以使用freemarker.template.TemplateDirectiveModel 类来扩展 2 基本内容 macro 指令自身不打印任何内容,它只是用来创建宏变量,所以就会有一个名为greet 的变量.在 <#macro greet> 和 </#macro> 之间的内容(称为宏定义体)当使用它

AngularJs学习笔记(4)——自定义指令

对指令的第一印象:它是一个自定义标签! 先来看一个简单的指令: <!doctype html> <html ng-app="myApp"> <head> <title> 自定义指令</title> <script type="text/javascript" src="http://localhost:10100/angular.min.js" charset="utf-

freemarker自定义标签(三)-nested指令

freemarker自定义标签 1.nested指令 是可选的,可以在<#macro>和</#macro>之间使用在任何位置和任意次数 2.示例说明 <#macro tag> <#nested/> </#macro> <@tag> <ul> <li>1</li> <li>2</li> <li>3</li> <li>4</li>

freemarker自定义标签

freemarker自定义标签 1.自定义标签说明 宏变量存储模板片段可以被用作自定义指令macro 2.示例说明 <html> <head> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <title>freemarker自定义标签</title> </head> <body> <#--

freemarker自定义标签报错(七)

1.错误描述 六月 09, 2014 11:11:09 下午 freemarker.log.JDK14LoggerFactory$JDK14Logger error 严重: Template processing error: "Expression a is undefined on line 27, column 23 in tag.ftl." Expression a is undefined on line 27, column 23 in tag.ftl. The probl

freemarker自定义标签(与java合用)

自定义类继承FreemarkerManager类,重写protected Configuration createConfiguration(ServletContext servletContext)throws TemplateException方法定义有哪些TemplateDirectiveModel类与它的别名[自定义标签名称],通过Spring来取: import java.util.Map;import javax.servlet.ServletContext;import org.

freemarker自定义标签报错(八)

1.错误描述 freemarker.core.ParseException: Token manager error: freemarker.core.TokenMgrError: Unknown directive: #assgin on line: 18, column: 151, in template: tag.ftl in tag.ftl at freemarker.template.Template.<init>(Template.java:174) at freemarker.c

freemarker自定义标签报错(三)

freemarker自定义标签 1.错误描述 freemarker.core.ParseException: Encountered " " at line 14, column 12 in myself.ftl. Was expecting one of: <STRING_LITERAL> ... <RAW_STRING> ... "false" ... "true" ... <INTEGER> ... &l

freemarker自定义标签报错(四)

freemarker自定义标签 1.错误描述 六月 05, 2014 11:31:35 下午 freemarker.log.JDK14LoggerFactory$JDK14Logger error 严重: Template processing error: "Error executing macro: write\nrequired parameter: nums is not specified." Error executing macro: write required pa