freemarker的使用

今天药忘吃喽~ 2021-09-26 07:54 414阅读 0赞

之前写过一篇freemarker的模板语法，今天这篇博客是专门记录freemarker如何使用的

[freemarker模板语法 点击跳转][freemarker_]

首先，导入freemarker的jar包

<dependency>
      <groupId>org.freemarker</groupId>
      <artifactId>freemarker</artifactId>
      <version>2.3.23</version>
    </dependency>

![Center][]

Java代码步骤：

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

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

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

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

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

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

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

第八步：关闭流。

代码：

@Test
    	public void genFile() throws Exception {
    		// 第一步：创建一个Configuration对象，直接new一个对象。构造方法的参数就是freemarker对于的版本号。
    		Configuration configuration = new Configuration(Configuration.getVersion());
    		// 第二步：设置模板文件所在的路径。
    		configuration.setDirectoryForTemplateLoading(new File("D:/workspaces-itcast/term197/e3-item-web/src/main/webapp/WEB-INF/ftl"));
    		// 第三步：设置模板文件使用的字符集。一般就是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:/temp/term197/out/hello.html"));
    		// 第七步：调用模板对象的process方法输出文件。
    		template.process(dataModel, out);
    		// 第八步：关闭流。
    		out.close();
    	}

注：上面的hello.ftl是模板文件

**在实际项目中的使用：**

引入freemarker和Spring的整合包

![Center 1][]

创建spring的配置文件

<?xml version="1.0" encoding="UTF-8"?>
    <beans xmlns="http://www.springframework.org/schema/beans"
    	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:p="http://www.springframework.org/schema/p"
    	xmlns:context="http://www.springframework.org/schema/context"
    	xmlns:dubbo="http://code.alibabatech.com/schema/dubbo" xmlns:mvc="http://www.springframework.org/schema/mvc"
    	xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
            http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc-4.2.xsd
            http://code.alibabatech.com/schema/dubbo http://code.alibabatech.com/schema/dubbo/dubbo.xsd
            http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd">
    
    	<bean id="freemarkerConfig"
    		class="org.springframework.web.servlet.view.freemarker.FreeMarkerConfigurer">
    		<property name="templateLoaderPath" value="/WEB-INF/ftl/" />
    		<property name="defaultEncoding" value="UTF-8" />
    	</bean>
    
    
    </beans>

业务逻辑：

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

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

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

4、创建数据集

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

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

7、关闭流。

加载配置文件：

![Center 2][]

@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";
    	}
    }

[freemarker_]: http://blog.csdn.net/gwd1154978352/article/details/78011355
[Center]: /images/20210923/f945f55ef97f45eba5d5bf9b8d8e75d6.png
[Center 1]: /images/20210923/19d7cb94d6674c9c8c67fa5030b422d1.png
[Center 2]: /images/20210923/9d1ed62343c043e2aae06fb8900eef2c.png