FreeMarker工具类，用来根据模板文件生成html文件，html字符串等

最新推荐文章于 2025-07-28 09:39:02 发布
最新推荐文章于 2025-07-28 09:39:02 发布
阅读量1.6k 收藏 2
点赞数 1
CC 4.0 BY-SA版权
分类专栏： FreeMarker 文章标签： 模板 FreeMarker Java Java Web 静态化Html
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/lsq112233/article/details/21610361
本文详细介绍了如何利用FreeMarker模板引擎生成静态HTML文件、HTML字符串、响应流及控制台输出流的方法，包括配置、实例化、初始化、设置参数等关键步骤，并提供了具体代码实现。

----使用FreeMarker来生成

1、静态Htm文件

2、Html字符串

3、html的response响应流

4、控制台输出流

package com.XX.XX.freemarker;

import java.io.BufferedWriter;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.FileWriter;
import java.io.IOException;
import java.io.OutputStreamWriter;
import java.io.PrintWriter;
import java.io.UnsupportedEncodingException;
import java.io.Writer;
import java.util.Map;
import java.util.Properties;

import javax.servlet.ServletContext;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.apache.commons.lang.StringUtils;

import freemarker.cache.MultiTemplateLoader;
import freemarker.cache.TemplateLoader;
import freemarker.cache.WebappTemplateLoader;
import freemarker.template.Configuration;
import freemarker.template.Template;
import freemarker.template.TemplateException;

public class Freemarker {
	  private HttpServletRequest request;
	  private HttpServletResponse response;
	  private ServletContext context;
	  
	  private String ftlName;//模板名称
	  
	  private String generatedFilePath;//待生成的静态文件存放的位置(默认“/site/generated”)
	  
	  private String generatedFileName;//待生成的静态文件名称
	  
	  private Map map;//Freemarker数据模型
	  
	  private String templatePath;//模板存放的位置(默认“/WEB-INF/templates”)
	  
	  private String encoding;//编码格式(默认“gbk”)
	  
	  private String articleTemplatePath;//文章模板存放的位置，动态设置
	  
	  public String getArticleTemplatePath() {
		return articleTemplatePath;
	}

	public void setArticleTemplatePath(String articleTemplatePath) {
		this.articleTemplatePath = articleTemplatePath;
	}

	public String getEncoding() {
		return encoding;
	}

	public void setEncoding(String encoding) {
		this.encoding = encoding;
	}

	public String getFtlName() {
		return ftlName;
	}

	public void setFtlName(String ftlName) {
		this.ftlName = ftlName;
	}

	public String getGeneratedFileName() {
		return generatedFileName;
	}

	public void setGeneratedFileName(String generatedFileName) {
		this.generatedFileName = generatedFileName;
	}

	public String getGeneratedFilePath() {
		return generatedFilePath;
	}

	public void setGeneratedFilePath(String generatedFilePath) {
		this.generatedFilePath = generatedFilePath;
	}

	public Map getMap() {
		return map;
	}

	public void setMap(Map map) {
		this.map = map;
	}

	public String getTemplatePath() {
		return templatePath;
	}

	public void setTemplatePath(String templatePath) {
		this.templatePath = templatePath;
	}

	public Freemarker()
	  {
	  }

	  public Freemarker(ServletContext context)
	  {
	    this.context = context;
	  }

	  public void init(HttpServletRequest request, HttpServletResponse response) {
	    this.request = request;
	    this.response = response;
	  }

	  public void init(HttpServletRequest request, HttpServletResponse response, ServletContext context)
	  {
	    this.request = request;
	    this.response = response;
	    this.context = context;
	  }

	  /**
	   * 
	   * @param ftl 模板名称,包括后缀名----必传
	   * @param htmlPath 待生成的HTML存在服务器的位置
	   * @param htmlFileName 待生成的HTML文件名----必传
	   * @param map 模板数据----必传
	   * @param templatePath 模板存放在位置
	   * @param encode 编码格式
	   * @return string 生成的HTML文件的相对路径 不带contextPath
	   * @throws IOException
	   * @throws TemplateException
	   */
	  public String process(String ftl,String htmlPath,String htmlFileName, Map map, String templatePath, String encode)
	  {
	    BufferedWriter buff = null;
		Writer out = null;
		String generatedFile = "";
		try 
		{
			Configuration freemarkerCfg = new Configuration();
			//生成的HTML文件存放的位置
			if (StringUtils.isBlank(htmlPath))
			{
				htmlPath = this.request.getContextPath() + "/generated";
			}
			else if (!htmlPath.startsWith("/"))
			{
				htmlPath = "/" + htmlPath;
			}
			if (StringUtils.isBlank(templatePath))
			{
				templatePath = this.request.getContextPath() + "/templates/default";
			}
			else if (!templatePath.startsWith("/"))
			{
				templatePath = "/" + templatePath;
			}
			if (StringUtils.isBlank(encode))
			{
				encode = "UTF-8";
			}
			if (-1 == ftlName.lastIndexOf('.'))
			{
				ftlName = ftlName + ".ftl";
			}
			if (-1 == generatedFileName.lastIndexOf('.'))
			{
				generatedFileName = generatedFileName + ".html";
			}
			//加载模板所在路径
			WebappTemplateLoader loader1 = new WebappTemplateLoader(this.context, templatePath); 
			WebappTemplateLoader loader2 = null;
			if (StringUtils.isNotBlank(articleTemplatePath))
			{
				loader2 = new WebappTemplateLoader(this.context, articleTemplatePath);
			}
			else
			{
				loader2 = new WebappTemplateLoader(this.context, "/dj/sharedtemplates/");
			}
			MultiTemplateLoader multiTemplateLoader = new MultiTemplateLoader(new TemplateLoader[] {loader1,loader2});
			freemarkerCfg.setTemplateLoader(multiTemplateLoader);
	        Properties p = new Properties();   
	        try {
				p.load(Thread.currentThread().getContextClassLoader().getResourceAsStream("freemarker.properties"));   
				freemarkerCfg.setSettings(p);
			} catch (IOException e) {
				e.printStackTrace();
			} catch (TemplateException e) {
				e.printStackTrace();
			}  


			Template template = freemarkerCfg.getTemplate(ftl);
			template.setEncoding(encode);
			this.request.setCharacterEncoding(encode);
			this.response.setContentType("text/html; charset=" + encode);
			String path = this.context.getRealPath("/" + htmlPath);
			File dir = new File(path);
			if (!dir.exists())
			{
				dir.mkdirs();
			}
			buff = new BufferedWriter(new FileWriter(path + htmlFileName));
			File htmlFile = new File(path + File.separator + htmlFileName);
			out = new BufferedWriter(new OutputStreamWriter(
			  new FileOutputStream(htmlFile), encode));
			template.process(map, out);
			generatedFile = htmlPath + "/" + htmlFileName;
		} 
		catch (UnsupportedEncodingException e)
		{
			e.printStackTrace();
		} 
		catch (FileNotFoundException e)
		{
			e.printStackTrace();
		} 
		catch (IOException e) 
		{
			e.printStackTrace();
		} 
		catch (TemplateException e)
		{
			e.printStackTrace();
		}
		finally
		{
		    try 
		    {
		    	if (null != buff)
		    	{
		    		buff.close();
		    	}
		    	if (null != out)
		    	{
					out.flush();
					out.close();
		    	}
			} 
		    catch (IOException e)
		    {
				e.printStackTrace();
			}
		}
	    return generatedFile;
	  }
	  
	  /**
	   * 处理模板文件并生成静态文件
	   * @return 生成文件的路径
	   */
	  public String process()
	  {
	    BufferedWriter buff = null;
		Writer out = null;
		String generatedFile = "";
		try 
		{
			Configuration freemarkerCfg = new Configuration();
			//生成的HTML文件存放的位置
			if (StringUtils.isBlank(generatedFilePath))
			{
				generatedFilePath = this.request.getContextPath() + "/generated/";
			}
			else if (!generatedFilePath.startsWith("/"))
			{
				generatedFilePath = "/" + generatedFilePath;
			}
			if (StringUtils.isBlank(templatePath))
			{
				templatePath = this.request.getContextPath() + "/templates/default";
			}
			else if (!templatePath.startsWith("/"))
			{
				templatePath = "/" + templatePath;
			}
			if (StringUtils.isBlank(encoding))
			{
				encoding = "GBK";
			}
			if (-1 == ftlName.lastIndexOf('.'))
			{
				ftlName = ftlName + ".ftl";
			}
			if (-1 == generatedFileName.lastIndexOf('.'))
			{
				generatedFileName = generatedFileName + ".html";
			}
			//加载模板所在路径(使用多模板加载器加载模板文件)
			WebappTemplateLoader loader1 = new WebappTemplateLoader(this.context, templatePath); 
			WebappTemplateLoader loader2 = null;
			if (StringUtils.isNotBlank(articleTemplatePath))
			{
				loader2 = new WebappTemplateLoader(this.context, articleTemplatePath);
			}
			else
			{
				loader2 = new WebappTemplateLoader(this.context, "/dj/sharedtemplates/");
			}
			MultiTemplateLoader multiTemplateLoader = new MultiTemplateLoader(new TemplateLoader[] {loader1,loader2});
			freemarkerCfg.setTemplateLoader(multiTemplateLoader);
	        Properties p = new Properties();   
	        try {
				p.load(Thread.currentThread().getContextClassLoader().getResourceAsStream("freemarker.properties"));   
				freemarkerCfg.setSettings(p);
			} catch (IOException e) {
				e.printStackTrace();
			} catch (TemplateException e) {
				e.printStackTrace();
			}  

			Template template = freemarkerCfg.getTemplate(ftlName);
			template.setEncoding(encoding);
			this.request.setCharacterEncoding(encoding);
			this.response.setContentType("text/html; charset=" + encoding);
			String path = this.context.getRealPath(generatedFilePath);
			File dir = new File(path);
			if (!dir.exists())
			{
				dir.mkdirs();
			}
			buff = new BufferedWriter(new FileWriter(path + generatedFileName));
			File htmlFile = new File(path + File.separator + generatedFileName);
			out = new BufferedWriter(new OutputStreamWriter(
			  new FileOutputStream(htmlFile), encoding));
			template.process(map, out);
			out.flush();
			generatedFile = generatedFilePath + generatedFileName;
		} 
		catch (UnsupportedEncodingException e)
		{
			e.printStackTrace();
		} 
		catch (FileNotFoundException e)
		{
			e.printStackTrace();
		} 
		catch (IOException e) 
		{
			e.printStackTrace();
		} 
		catch (TemplateException e)
		{
			e.printStackTrace();
		}
		finally
		{
		    try 
		    {
		    	if (null != buff)
		    	{
		    		buff.close();
		    	}
		    	if (null != out)
		    	{
					out.flush();
					out.close();
		    	}
			} 
		    catch (IOException e)
		    {
				e.printStackTrace();
			}
		}
	    return generatedFile;
	  }
	  
	  /**
	   * 处理模板文件并输出到响应端的流中
	   */
	  public void processUsingResponse()
	  {
		try 
		{
			Configuration freemarkerCfg = new Configuration();
			if (StringUtils.isBlank(templatePath))
			{
				templatePath = this.request.getContextPath() + "/templates/default";
			}
			else if (!templatePath.startsWith("/"))
			{
				templatePath = "/" + templatePath;
			}
			if (StringUtils.isBlank(encoding))
			{
				encoding = "GBK";
			}
			if (-1 == ftlName.lastIndexOf('.'))
			{
				ftlName = ftlName + ".ftl";
			}
			//加载模板所在路径
			WebappTemplateLoader loader1 = new WebappTemplateLoader(this.context, templatePath); 
			WebappTemplateLoader loader2 = null;
			if (StringUtils.isNotBlank(articleTemplatePath))
			{
				loader2 = new WebappTemplateLoader(this.context, articleTemplatePath);
			}
			else
			{
				loader2 = new WebappTemplateLoader(this.context, "/dj/sharedtemplates/");
			}
			MultiTemplateLoader multiTemplateLoader = new MultiTemplateLoader(new TemplateLoader[] {loader1,loader2});
			freemarkerCfg.setTemplateLoader(multiTemplateLoader);
	        Properties p = new Properties();   
	        try {
				p.load(Thread.currentThread().getContextClassLoader().getResourceAsStream("freemarker.properties"));   
				freemarkerCfg.setSettings(p);
			} catch (IOException e) {
				e.printStackTrace();
			} catch (TemplateException e) {
				e.printStackTrace();
			}  

			Template template = freemarkerCfg.getTemplate(ftlName);
			template.setEncoding(encoding);
			this.request.setCharacterEncoding(encoding);
			this.response.setContentType("text/html; charset=" + encoding);
			PrintWriter out = response.getWriter();
			template.process(map, out);
		} 
		catch (UnsupportedEncodingException e)
		{
			e.printStackTrace();
		} 
		catch (FileNotFoundException e)
		{
			e.printStackTrace();
		} 
		catch (IOException e) 
		{
			e.printStackTrace();
		} 
		catch (TemplateException e)
		{
			e.printStackTrace();
		}
	  }
	  
	  
	  /**
	   * 处理模板文件并输出到控制台中
	   */
	  public void processUsingSysout()
	  {
		try 
		{
			Configuration freemarkerCfg = new Configuration();
			if (StringUtils.isBlank(templatePath))
			{
				templatePath = "/WEB-INF/templates";
			}
			else if (!templatePath.startsWith("/"))
			{
				templatePath = "/" + templatePath;
			}
			if (StringUtils.isBlank(encoding))
			{
				encoding = "GBK";
			}
			if (-1 == ftlName.lastIndexOf('.'))
			{
				ftlName = ftlName + ".ftl";
			}
			//加载模板所在路径
			WebappTemplateLoader loader1 = new WebappTemplateLoader(this.context, templatePath); 
			WebappTemplateLoader loader2 = null;
			if (StringUtils.isNotBlank(articleTemplatePath))
			{
				loader2 = new WebappTemplateLoader(this.context, articleTemplatePath);
			}
			else
			{
				loader2 = new WebappTemplateLoader(this.context, "/dj/sharedtemplates/");
			}
			MultiTemplateLoader multiTemplateLoader = new MultiTemplateLoader(new TemplateLoader[] {loader1,loader2});
			freemarkerCfg.setTemplateLoader(multiTemplateLoader);

			Template template = freemarkerCfg.getTemplate(ftlName);
			template.setEncoding(encoding);
			this.request.setCharacterEncoding(encoding);
			this.response.setContentType("text/html; charset=" + encoding);
			template.process(map, new PrintWriter(System.out));
		} 
		catch (UnsupportedEncodingException e)
		{
			e.printStackTrace();
		} 
		catch (FileNotFoundException e)
		{
			e.printStackTrace();
		} 
		catch (IOException e) 
		{
			e.printStackTrace();
		} 
		catch (TemplateException e)
		{
			e.printStackTrace();
		}
	  }
   
/**
    * 处理模板文件并将解析的后html内容以字符串方式返回给调用者
    */
   public String processReturnString()
   {
  try 
  {
   Configuration freemarkerCfg = new Configuration();
   if (StringUtils.isBlank(templatePath))
   {
    templatePath = "/WEB-INF/templates";
   }
   else if (!templatePath.startsWith("/"))
   {
    templatePath = "/" + templatePath;
   }
   if (StringUtils.isBlank(encoding))
   {
    encoding = "GBK";
   }
   if (-1 == ftlName.lastIndexOf('.'))
   {
    ftlName = ftlName + ".ftl";
   }
   //加载模板所在路径
   freemarkerCfg.setServletContextForTemplateLoading(this.context, templatePath);
         Properties p = new Properties();   
         try {
    p.load(Thread.currentThread().getContextClassLoader().getResourceAsStream("freemarker.properties"));   
    freemarkerCfg.setSettings(p);
   } catch (IOException e) {
    e.printStackTrace();
   } catch (TemplateException e) {
    e.printStackTrace();
   }  
   
   Template template = freemarkerCfg.getTemplate(ftlName);
   template.setEncoding(encoding);
   this.request.setCharacterEncoding(encoding);
   this.response.setContentType("text/html; charset=" + encoding);
   StringWriter sw = new StringWriter();
   template.process(map, new PrintWriter(sw));
   return sw.toString();
  } 
  catch (UnsupportedEncodingException e)
  {
   e.printStackTrace();
  } 
  catch (FileNotFoundException e)
  {
   e.printStackTrace();
  } 
  catch (IOException e) 
  {
   e.printStackTrace();
  } 
  catch (TemplateException e)
  {
   e.printStackTrace();
  }
  return "";
   }
}

使用方法为：

			Freemarker free = new Freemarker(context);//实例化模板类
			free.init(getRequest(), getResponse());//初始化请求和响应
			free.setFtlName(info.getIndexFtl());//设置模板的文件名
			free.setGeneratedFileName("index.html");//设置生成的静态html文件的名称
			free.setGeneratedFilePath(info.getGeneratedPath());//设置模板文件生成静态文件的路径
			free.setTemplatePath(info.getTemplatePath());//设置模板的加载路径
			free.setMap(root);//设置模板的数据模型
			String indexPath = free.process();//开始处理，返回结果，这里返回的就是静态html的相对路径



 

使用freemarker模板生成html文件(一)
owen_william的博客
01-30 6802
导言 本次的博客，笔者将会向读者分享的是，如何通过freemarker的模板生成HTML的文件。众所周知，有时候项目上需要开发人员通过java的代码动态生成HTML文件，如日报、月报、账务报表等。为了可提高访问的性能，我们会预先生成HTML文件，这个的话可以提高访问的效率。在这一次博客中，笔者将会通过一个例子来分享这个功能，这个例子的功能点是：首先，将一份Json的文件转化为对象，及将对象转换为...
Spring Boot Freemark HTML 生成 PDF、生成水印Logo、docx文件生成PDF，Jar包运行可读取模板文件、字体文件
lisaihang96的博客
08-09 5555
Spring Boot Freemark HTML 生成 PDF，Jar包运行可读取模板文件、字体文件
Freemarker生成HTML页面及字符串，HTML页面生成PDF文件
IManiy的博客
07-14 1873
Freemarker生成生成HTML三种情况 1、通过.flt模板生成file 2、根据模板字符串生成file 3、根据模板字符串生成HTML文件字符串 开始 模板数据准备 private static void autoGenHTMLTest() { //给模板文件组装数据 Map<String, Object> dataMap = new HashMap<String, Object>(); SpecialInfo spe
FreeMarker工具类全面教程
最新发布
weixin_29317963的博客
07-28 707
FreeMarker是一款用Java编写的模板引擎，其历史可以追溯到2000年，最初是为了简化Web应用中页面的生成而设计。与早期的JSP等技术相比，FreeMarker提供了一个更加清晰、灵活的方式来生成HTML页面或其他格式的文本文件，尤其是在MVC架构的Web应用中。FreeMarkerUtils是围绕FreeMarker模板引擎开发的一套工具类，它通过封装提供了更多便捷的功能，简化了模板操作的复杂度。
FreeMarker 生成HTML文件
Aero_duan的专栏
08-14 2343
1. 什么是FreeMarker？ FreeMarker是一个模板引擎，简单地讲，它就是将你的数据映射到模板上，形成一个静态的文件，可以是HTML文件，也可以是其他类型的一些文件。 下面是对其官网上描述的翻译： Apache FreeMarker是一个模板引擎：基于模板和可变数据，用于文本生成的库（这些文本可以是HTML网页，e-mails，配置文件，源代码，等等）。模板是使用FreeMar...
Java使用FreeMarker模板引擎动态生成html页面
热门推荐
田野上的风筝
07-07 1万+
因一个功能需要动态生成HTML文件，所以接触了下FreeMarker模板引擎。一般可以使用该模板引擎来生成月报，日报，单据报表等等。我们都知道预先生成静态HTML文件，当访问时可以提高效率的。 Freemarker简单介绍 Freemarker是一款模板引擎，基于模板用来生成文本(任何来自HTML格式的文本用来生成源代码)的通用工具。FreeMarker实际上是被设计生成HTML页面的，尤其是...
根据freemark模板生成静态html字符串
hello_IT_的博客
05-28 274
pom <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-freemarker</artifactId> </dependency> 生成方法 private String generateHtml(String temp
使用FreeMarker生成Html静态文件
05-28
4. **生成HTML**：使用`Template`类加载模板文件，然后用`process`方法将数据模型应用到模板上，生成最终的HTML字符串。 5. **保存或返回HTML**：生成的HTML字符串可以保存为静态文件，或者直接作为HTTP响应返回给...
FreeMarker模板引擎在Html静态文件生成中的应用
- 内建函数：提供了一系列的内建函数，如日期时间格式化、字符串处理等。 #### 4. FreeMarker配置 在使用FreeMarker时，需要进行一些配置，包括： - 模板加载器：用于指定模板文件的存放位置和加载方式。 - 编码...
通过freemarker模板 生成PDF
03-29
3. **处理模板**：使用Freemarker API的`Configuration`和`Template`类，将数据模型应用到模板上，生成HTML字符串。 4. **调用wkhtmltox**：通过Java绑定库，将生成的HTML字符串转换为PDF。 5. **保存PDF**：将生成...
freemarker根据模版生成文件使用例子
03-27
本文将详细解析一个具体的使用案例：如何利用Freemarker根据模板生成文件，特别是Java环境下生成Hibernate的配置文件（*.hbm.xml）。此案例不仅展示了Freemarker的基本用法，还涉及到了自定义类、接口以及模板加载...
访问FreeMarker的工具类
03-17
FreeMarkerUtils源码 博文链接：https://lxy19791111.iteye.com/blog/547612
freemarker生成html导出word
08-14
使用Itextpdf组件通过freemarker模板技术生成好html内容并导出word文件，提供下载。
使用FreeMarker生成静态HTML
杜海的博客
12-15 465
1、FreeMarker需要添加的Maven依赖： 1 2 org.freemarker 3 freemarker 4 2.3.23 5 2、使用模板生成HTML代码 2.1 数据模型 1 public class User { 2 3 private String username; 4 5 private Str
Freemarker工具类
weixin_30478619的博客
09-11 179
Freemarker文件模板工具类 提供了解析生成文件、解析生成字符串的两个方法！ package org.lunatic.util; import java.io.File; import java.io.FileWriter; import java.io.IOException; import java.io.StringWriter; import java.util...
FreeMarker根据Fti模板生成HTML
深望的博客
06-18 395
FreeMarker根据Fti模板生成HTML 一，认识FreeMarker FreeMarker是一个模板引擎，一个基于模板生成文本输出的通用工具，使用纯Java编写。 FreeMarker被设计用来生成HTML Web页面，特别是基于MVC模式的应用程序。 虽然FreeMarker具有一些编程的能力，但通常由Java程序准备要显示的数据，由FreeMarker生成页面，通过模板显示准备的数据，...
JAVA FreeMarker工具类
weixin_30325793的博客
01-04 332
FreeMarkerUtil.java 1 package pers.kangxu.datautils.utils; 2 3 import java.io.File; 4 import java.io.StringWriter; 5 import java.util.Map; 6 7 import pers.kangxu.datautils.common.C...
【Java工具类】（21）—Freemarker工具类
九离的博客
03-29 1148
Java工具类（21）—Freemarker工具类 package com.awifi.capacity.docker.manager.utils; import com.baomidou.mybatisplus.core.toolkit.CollectionUtils; import freemarker.cache.StringTemplateLoader; import freemarker.template.Configuration; import freemarker.template.Te
使用freemarker生成静态html文件
Soda_lw的博客
02-13 3285
一、引入依赖 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-freemarker</artifactId> <version>2.1.10.RELEASE</version> </dependency> 二、yml配置 #freemarker相关配置属性
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值