freemarker快速上手

╰半橙微兮° 2022-05-21 11:29 267阅读 0赞

FreeMarker是一个用Java语言编写的模板引擎，它基于模板来生成文本输出。FreeMarker与Web容器无关，即在Web运行时，它并不知道Servlet或HTTP。它不仅可以用作表现层的实现技术，而且还可以用于生成XML，JSP或Java 等。

目前企业中:主要用Freemarker做静态页面或是页面展示。

Freemarker的使用方法：

原理一句话，就是你给Freemarker模板和数据，Freemarker帮你把数据充入模板中并生成一个文件。

引入Freemarker依赖包

<dependency>
      <groupId>org.freemarker</groupId>
      <artifactId>freemarker</artifactId>
      <version>版本</version>
    </dependency>

使用步骤：

第一步：创建一个Configuration对象，直接new一个对象。构造方法的参数就是freemarker对于的版本号。

第二步：设置模板文件所在的路径。

第三步：设置模板文件使用的字符集。一般就是utf-8.

第四步：加载一个模板，创建一个模板对象。

第五步：创建一个模板使用的数据集，可以是pojo也可以是map。一般是Map。

第六步：创建一个Writer对象，一般创建一FileWriter对象，指定生成的文件名。

第七步：调用模板对象的process方法输出文件。

第八步：关闭流。

模板：

${hello}

代码：

@Test
    	public void genFile() throws Exception {
    		// 第一步：创建一个Configuration对象，直接new一个对象。构造方法的参数就是freemarker对于的版本号。
    		Configuration configuration = new Configuration(Configuration.getVersion());
    		// 第二步：设置模板文件所在的路径。
    		configuration.setDirectoryForTemplateLoading(new File("D:/ftls"));
    		// 第三步：设置模板文件使用的字符集。一般就是utf-8.
    		configuration.setDefaultEncoding("utf-8");
    		// 第四步：加载一个模板，创建一个模板对象。
    		Template template = configuration.getTemplate("hello.ftl");
    		// 第五步：创建一个模板使用的数据集，可以是pojo也可以是map。一般是Map。
    		Map dataModel = new HashMap<>();
    		//向数据集中添加数据
    		dataModel.put("hello", "this is my first freemarker test.");
    		// 第六步：创建一个Writer对象，一般创建一FileWriter对象，指定生成的文件名。
    		Writer out = new FileWriter(new File("D:/hello.html"));
    		// 第七步：调用模板对象的process方法输出文件。
    		template.process(dataModel, out);
    		// 第八步：关闭流。
    		out.close();
    	}

### 模板的语法： ###

访问map中的key：      **$\{key\}**

访问pojo中的属性：    **$\{key.property\}**

取集合中的数据：

**<\#list studentList as student>**

**$\{student.id\}        **

**$\{studnet.name\}**

**</\#list>**

取循环中的下标：

**<\#list studentList as student>**

**$\{ student\_index\}**

**</\#list>**

判断：

**<\#if student\_index % 2 == 0>**

**<\#else>**

**</\#if>**

日期类型格式化：

![70][]

Null值的处理：

![70 1][]

Include标签：

![70 2][]

## Freemarker整合spring ##

引入Freemarker的jar包外，还要引入spring与Freemarker的整合包：

![70 3][]

spring的配置文件如下：配置一个bean

编写一Controller进行测试：

请求的url：/genhtml        参数：无 返回值：ok （String， 需要使用@ResponseBody）

业务逻辑：

1、从spring容器中获得FreeMarkerConfigurer对象。

2、从FreeMarkerConfigurer对象中获得Configuration对象。

3、使用Configuration对象获得Template对象。

4、创建数据集

5、创建输出文件的Writer对象。

6、调用模板对象的process方法，生成文件。

7、关闭流。

加载配置文件web.xml的配置：

![70 4][]

@Controller
    public class HtmlGenController {
    	
    	@Autowired
    	private FreeMarkerConfigurer freeMarkerConfigurer;
    
    	@RequestMapping("/genhtml")
    	@ResponseBody
    	public String genHtml()throws Exception {
    		// 1、从spring容器中获得FreeMarkerConfigurer对象。
    		// 2、从FreeMarkerConfigurer对象中获得Configuration对象。
    		Configuration configuration = freeMarkerConfigurer.getConfiguration();
    		// 3、使用Configuration对象获得Template对象。
    		Template template = configuration.getTemplate("hello.ftl");
    		// 4、创建数据集
    		Map dataModel = new HashMap<>();
    		dataModel.put("hello", "1000");
    		// 5、创建输出文件的Writer对象。
    		Writer out = new FileWriter(new File("D:/temp/term197/out/spring-freemarker.html"));
    		// 6、调用模板对象的process方法，生成文件。
    		template.process(dataModel, out);
    		// 7、关闭流。
    		out.close();
    		return "OK";
    	}
    }

[70]: /images/20220521/4d1b927b99584c0db8d5b24178efc6e1.png
[70 1]: /images/20220521/53fb272f9222421aae48baa828e59283.png
[70 2]: /images/20220521/4e5037e74fb1408daaf6d3b8343515bb.png
[70 3]: /images/20220521/2c368a7a8f194f4cbaa66c3897c0fbd7.png
[70 4]: /images/20220521/143b6d3781b949e08225e40222fcdc0d.png