Freemarker进阶（二）

分手后的思念是犯贱 2022-05-16 13:54 151阅读 0赞

上接[Freemarker20分钟入门Demo(一)][Freemarker20_Demo]

## 2.1import指令 ##

该指令用于导入FreeMarker模板中的所有变量,并将该变量放置在指定的Map对象中,import指令的语法格式如下:   
<\#import “/lib/common.ftl” as xxx>   
上面的代码将导入/lib/common.ftl模板文件中的所有变量,交将这些变量放置在一个名为xxx的Map对象中.

## 2.2 macro的使用 ##

这个可以用来实现自定义指令，一般用来做公共组件，我们称之为宏

## 2.3macro与import组合实现下拉列表模板组件 ##

### *2.3.1需求说明* ###

很多网站都有会员等级，这里我们假设有三个等级，【金牌会员，银牌会员，普通会员】，这只是显示的text，真正存储会员等级字段应该是一个字符编码，比如数字或一个字符串，我们成为编码cd。

现在我们使用macro与import组合实现下拉列表模板组件，并会员等级实现下拉列表。这种统一的模板组件对于开发效率来说是非常有必要的。

2.3.1下拉列表宏构建

新建一个\_custom\_macros.ftl文件，内容如下

说明：

（1）<\#macro select id  name="" value="" mode="" class="drop" style="width:100px" disabled="">

定义了这个宏接受的参数列表并对某些参数进行了初始化，其中，mode为控制下拉列表默认显示样式，逻辑一眼就能看出来，就不多说了。

（2）<\#macro 后跟的第一个字符会被认为是该宏的别名，调用的时候会根据这个别名调用，这里起名为select。

（2）我们这里写死了，取参数codeList中的值作为下拉列表的内容填充，真正这个地方的数据填充从什么地方获取，我们稍后再说，这里先写死。

### *2.3.2codeList数据准备* ###

（1）在项目中我们根据会员的codecd及codetest设计一个pojo名为code

/**
     * @author suyouliang
     * @version v1.0 2018年08月21日 18:00
     * 这是一个字典对象
     */
    
    public class Code {
        private String codeCd;
        private String codeText;
    
        public String getCodeCd() {
            return codeCd;
        }
    
        public void setCodeCd(String codeCd) {
            this.codeCd = codeCd;
        }
    
        public String getCodeText() {
            return codeText;
        }
    
        public void setCodeText(String codeText) {
            this.codeText = codeText;
        }
    }

（2）数据准备

import freemarker.template.Configuration;
    import freemarker.template.Template;
    
    import java.io.File;
    import java.io.FileWriter;
    import java.io.Writer;
    import java.util.ArrayList;
    import java.util.HashMap;
    import java.util.List;
    import java.util.Map;
    /**
     * @author suyouliang
     * @version v1.0 2018年08月21日 17:17
     */
    public class FreemarkerDemo {
        public static void main(String[] args) throws Exception {
            //1.创建配置类
            Configuration configuration=new Configuration(Configuration.getVersion());
            //2.设置模板所在的目录
            configuration.setDirectoryForTemplateLoading(new File("D:\\freemarkerdemo"));
            //3.设置字符集
            configuration.setDefaultEncoding("utf-8");
            //4.加载模板
            Template template = configuration.getTemplate("test.ftl");
            //5.创建数据模型
            Map map=new HashMap();
            initCodeList(map);
            //6.创建Writer对象
            Writer out =new FileWriter(new File("D:\\freemarkerdemo\\test.html"));
            //7.输出
            template.process(map, out);
            //8.关闭Writer对象
            out.close();
        }
    
        private static void initCodeList(Map map) {
            List<Code> codeList = new ArrayList();
            Code code1 = new Code();
            Code code2 = new Code();
            Code code3 = new Code();
            code1.setCodeCd("1");
            code1.setCodeText("普通会员");
            code2.setCodeCd("2");
            code2.setCodeText("银牌会员");
            code3.setCodeCd("3");
            code3.setCodeText("黄金会员");
            codeList.add(code1);
            codeList.add(code2);
            codeList.add(code3);
            map.put("codeList", codeList);
    
        }
    }

这样，我们就在模板引擎中放入了codeList对象。

2.3.3在页面中使用宏

<#import "_custom_macros.ftl" as cont>
    <html>
    <head xmlns="http://www.w3.org/1999/html">
        <meta charset="utf-8">
        <title>Freemarker入门小DEMO </title>
    </head>
    <body>
    <#--我是一个注释，我不会有任何输出  -->
    
    </br>
    
    <p>多选框：<@cont.select id="member_grade"  value="2"/></p>
    
    </body></html>

说明：

（1）首先先通过<\#import >指令导入我们定义好的下拉列表的宏，并起别名为cont方便使用

（2）通过<@cont.select>语法调用宏  其中，cont是我们自己起的别名，@+别名是规定的语法，select就是我们自己在宏中定义的宏的名称。

这里我们初始化了宏中定义的id，以及value，根据2.3.1中的逻辑，，这里其实是定义了下拉列表的value和默认选项。由于没有定义mode的值，在value为空的时候，默认显示的方式是“--全部--”，当指定mode值为1是，就可以更改为“--请选择--”，宏中逻辑很容易看出来。

我们运行main方法，生成的test.html如下：

<html>
    <head xmlns="http://www.w3.org/1999/html">
        <meta charset="utf-8">
        <title>Freemarker入门小DEMO </title>
    </head>
    <body>
    
    </br>
    
    <p>多选框：<select id=member_grade name=member_grade class=drop style=width:100px panelHeight=":auto" >
            <option value="">-- 全部 --</option>
                <option value="1" >普通会员</option>
                <option value="2"  selected >银牌会员</option>
                <option value="3" >黄金会员</option>
    </select>
    </p>
    
    </body></html>

在网页中打开效果：

![70][]

默认就是银牌会员。

### *2.3.4宏功能扩展* ###

我们可以把日常用的，单选，多选，日历甚至分页宏加入我们的宏逻辑中

<#-- 下拉框:mode：""全部，1请选择 -->
    <#macro select id  name="" value="" mode="" class="drop" style="width:100px" disabled="">
        <#if name == "">
            <#local localName=id/>
        <#else>
            <#local localName=name/>
        </#if>
    <select id=${id} name=${localName} class=${class} style=${style} panelHeight="auto" ${disabled}>
        <#if mode == "">
            <option value="">-- 全部 --</option>
        <#elseif mode == "1">
            <option value="">-- 请选择 --</option>
        <#else>
    
        </#if>
        <#if codeList?? && codeList?size > 0>
            <#list codeList as code>
                <option value="${code.codeCd}" <#if code.codeCd == value> selected </#if>>${code.codeText!''}</option>
            </#list>
        </#if>
    </select>
    </#macro>
    
    <#-- 单选钮  -->
    <#macro radio id name="" value=""  class="rad" isDefault = "true" disabled="">
        <#if name == "">
            <#local localName=id/>
        <#else>
            <#local localName=name/>
        </#if>
        <#if codeList?? && codeList?size > 0>
            <#list codeList as code>
            <input type="radio" id="${id}" name="${localName}" class="${class}" value="${code.codeCd}" <#if code.codeCd == value  || (isDefault == 'true' && value == '' && code_index == 0)> checked </#if>  ${disabled}/> ${code.codeText}
            </#list>
        </#if>
    </#macro>
    
    
    <#-- 复选钮  -->
    <#macro checkbox id name="" value=[] >
        <#if name == "">
            <#local localName=id/>
        <#else>
            <#local localName=name/>
        </#if>
        <#list codeList as code>
            <#local checked=""/>
            <#list value as val>
                <#if val == code.codeCd>
                    <#local checked="checked"/>
                    <#break>
                </#if>
            </#list>
        <input type="checkbox" id="${id}" name="${localName}" value="${code.codeCd}" class="chk" ${checked} /> ${code.codeText}
        </#list>
    </#macro>
    
    <#-- 日历控件  -->
    <#macro calendar id name="" value="">
        <#if name == "">
            <#local localName=id/>
        <#else>
            <#local localName=name/>
        </#if>
    <input type="text" id="${id}" name="${localName}" value="${value}" class="Wdate" />
    </#macro>

2.4freemarker的宏在实际开发中的应用场景

以上提到，codeList是我们定义死的，这个显然是不合理的，那么以上例子在实际开发中的应用场景到底是什么样的呢。

2.4.1字典应用场景

企业开发中字典被广泛应用，一般主要是一个codeCd和一个codeText，我们在给这一组字典起名为codeNamecode，将该字典封装为到叫code的pojo。字典的使用会使我们相关的显示更加灵活，就比如上面举的会员等级text，有一天老板说：“叫金牌会员，银牌会员太土了，改叫尊享会员和至尊会员吧”   你：“啊啊？” 这么多页面，相信你会改到怀疑人生。

在使用字典的项目中，使用以上的宏将非常有意义，他可以确保所有的显示都是引用字典中定义的，一旦需要修改，只需要更改字典中的text即可。

我们可以定义一个CodeManager用来管理字典表，这个类启动时加载，加载时查询数据库中的字典表并装到内存（或外部缓存）中（烂尾文章，前面还是很实用的）

[Freemarker20_Demo]: https://blog.csdn.net/qq_31457665/article/details/81908430
[70]: /images/20220516/fe040c2322ad422ab2b1e7243396d3df.png