Java中Freemarker TemplateDirectiveModel自定义标签详解
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>;当标签是格式时,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 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中
3. 将spring bean 设置到freemarkerConfig全局变量中
0UTF-8UTF-8zh_CNtrue,falseyyyy-MM-dd HH:mm:ssyyyy-MM-ddHH:mm:ss0.######true
4. ftl文件中引用userList自定义标签
${user.name}
#list>
#if>
@userListTag>
总结
1. Freemarker自定义标签需要自定义一个类,然后实现TemplateDirectiveModel,重写execute方法,完成获取参数,根据参数设置不通属性等等。
2. Freemarker自定义标签中,如果标签内什么也没有,开始标签和结束标签绝对不能再同一行,不然会报错。
版权声明:本文为JAVASCHOOL原创文章,未经本站允许不得转载。