欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

Java中Freemarker TemplateDirectiveModel自定义标签详解

程序员文章站 2022-06-09 12:58:14
...

java中freemarker通过实现TemplateDirectiveModel接口,用户可以自定义标签(指令)进行任意操作,任意文本写入模板的输出。

定义

public void execute(Environment env, Map params, TemplateModel[] loopVars, TemplateDirectiveBody body) throws TemplateException, IOException;

env:系统环境变量,通常用它来输出相关内容,如Writer out = env.getOut()。

params:自定义标签传过来的对象,其key=自定义标签的参数名,value值是TemplateModel类型,而TemplateModel是一个接口类型,通常我们都使用TemplateScalarModel接口来替代它获取一个String 值,如TemplateScalarModel.getAsString();当然还有其它常用的替代接口,如TemplateNumberModel获取number,TemplateHashModel等。

loopVars 循环替代变量。

body 用于处理自定义标签中的内容,如<@myDirective>将要被处理的内容/@myDirective;当标签是<@myDirective />格式时,body=null。

创建自定义标签
1. 实现TemplateDirectiveModel这个接口中的execute方法

public class UserListDirective implements TemplateDirectiveModel{
    @Autowired
    private UserDAO  userDao;
    @Override
    public void execute(Environment env, Map params, TemplateModel[] loopVars,
            TemplateDirectiveBody body) throws TemplateException, IOException {
        String name = params.get("name").toString();
        List<User> userlist = userDao.findByProperty("name", name);

        env.setVariable("userList", getBeansWrapper().wrap(userlist));
        body.render(env.getOut());
    }
    public static BeansWrapper getBeansWrapper(){
        BeansWrapper beansWrapper = new BeansWrapperBuilder(Configuration.VERSION_2_3_21).build();
        return beansWrapper;
    }
}

2. 配置UserListDirective 到spring bean xml中

<bean id="userListDirective" class="com.action.directive.UserListDirective"></bean>

3. 将spring bean 设置到freemarkerConfig全局变量中

<bean id="freemarkerConfig2" class="org.springframework.web.servlet.view.freemarker.FreeMarkerConfigurer">
<property name="templateLoaderPath" value="/" />
<property name="freemarkerVariables">
    <map >  <entry key="userListDirective" value="userListTag" />
    </map>
</property>
<property name="freemarkerSettings">
    <props>  <prop key="template_update_delay">0</prop>  <prop key="defaultEncoding">UTF-8</prop>  <prop key="url_escaping_charset">UTF-8</prop>  <prop key="locale">zh_CN</prop>  <prop key="boolean_format">true,false</prop>  <prop key="datetime_format">yyyy-MM-dd HH:mm:ss</prop>  <prop key="date_format">yyyy-MM-dd</prop>  <prop key="time_format">HH:mm:ss</prop>  <prop key="number_format">0.######</prop>  <prop key="whitespace_stripping">true</prop>
    </props>
</property>
</bean>

4. ftl文件中引用userList自定义标签

<@userListTag name="51gjie">
    <#if userList?? && userList?size gt 0>
        <#list userList as user>
            ${user.name}
        </#list>
    </#if>
</@userListTag>

总结

  1. Freemarker自定义标签需要自定义一个类,然后实现TemplateDirectiveModel,重写execute方法,完成获取参数,根据参数设置不通属性等等。

  2. Freemarker自定义标签中,如果标签内什么也没有,开始标签和结束标签绝对不能再同一行,不然会报错。