《SpringBoot篇》24.SpringBoot整合Freemarker

陈老老老板 ‍本文专栏：SpringBoot篇（主要讲一些与springboot整合相关的内容）
‍本文简述：本文讲一下SpringBoot整合Freemarker的整合教程超详细教程。
‍上一篇文章：《SpringBoot篇》23.SpringBoot整合JavaMail实现发送邮件详解
‍有任何问题，都可以私聊我，我能帮得上的一定帮忙，感谢大佬们支持。
如果喜欢可以投个票吗？在文章最后，感谢感谢！

一、Freemarker简介

说明:FreeMarker 是一款 免费的模板引擎： 即一种基于模板和要改变的数据， 并用来生成输出文本(HTML网页，电子邮件，配置文件，源代码等)的通用工具。 它不是面向最终用户的，而是一个Java类库，是一款程序员可以嵌入他们所开发产品的组件。（我所接触到的是用Freemarker来导出excel、word、pdf）

模板编写为FreeMarker Template Language (FTL)。它是简单的，专用的语言. 那就意味着要准备数据在真实编程语言中来显示，比如数据库查询和业务运算， 之后模板显示已经准备好的数据。在模板中，你可以专注于如何展现数据， 而在模板之外可以专注于要展示什么数据。

二、Freemarker语法：

说明：这里给大家展示一些常用的语法，这些就足以完成复杂的语法功能。

（1）if elseif，条件判断语句

说明：你可以使用 if， elseif 和 else 指令来条件判断是否越过模板的一个部分。 condition 必须计算成布尔值， 否则错误将会中止模板处理。elseif 和 else 必须出现在 if 内部 (也就是，在 if 的开始标签和结束标签之间)。 if 中可以包含任意数量的 elseif(包括0个) 而且结束时 else 是可选的。比如：

只有 if 没有 elseif 和 else：

x is 1</#if>

只有 if 没有 elseif 但是有 else：

x is 1<#else>x is not 1</#if>

有 if 和两个 elseif 但是没有 else：

x is 1x is 2x is 3</#if>

有 if 和三个 elseif 还有 else:

x is 1x is 2x is 3x is 4<#else>x is not 1 nor 2 nor 3 nor 4</#if>

（2）list 遍历

说明：list 指令执行在 list 开始标签和 list 结束标签 ( list 中间的部分) 之间的代码， 对于在序列(或集合)中每个值指定为它的第一个参数。 对于每次迭代，循环变量(本例中的 user)将会存储当前项的值。

循环变量(user) 仅仅存在于 list 标签体内。 而且从循环中调用的宏/函数不会看到它(就像它只是局部变量一样)。

假设 users 包含 ['Joe', 'Kate', 'Fred'] 序列：

<#list users as user><p>${user}</#list>

输出：

<p>Joe<p>Kate<p>Fred

（3）assign 在模板中定义变量

说明：在模板中可以定义三种类型的变量：（我们最多就能使用到简单的使用assign就可以了）

• ‘‘简单’’变量： 它能从模板中的任何位置来访问，或者从使用 include 指令引入的模板访问。可以使用 assign 指令来创建或替换这些变量。因为宏和方法只是变量，那么 macro 指令 和 function 指令 也可以用来设置变量，就像 assign 那样。

• 局部变量：它们只能被设置在 宏定义体内， 而且只在宏内可见。一个局部变量的生命周期只是宏的调用过程。可以使用 local指令 在宏定义体内创建或替换局部变量。

• 循环变量：循环变量是由如 list 指令自动创建的，而且它们只在指令的开始和结束标记内有效。宏 的参数是局部变量而不是循环变量。

• 全局变量：这是一个高级话题了， 并且这种变量最好别用。即便它们属于不同的命名空间， 全局变量也被所有模板共享，因为它们是被 import进来的， 不同于 include 进来的。那么它们的可见度就像数据模型那样。 全局变量通过 global指令来定义。

<#assign x = 1><#-- create variable x -->${x}<#assign x = x + 3> <#-- replace variable x -->${x}

输出：

14

（4）字符串切分 (子串)

说明：前面的是对字符串进行分割，后面的在进行遍历的时候需要进行字符串分割。

• 降序域不允许进行字符串切分。 (因为不像序列那样，很少情况下会想反转字符串。 如果真要这样做了，那就是疏忽。)

• 如果变量的值既是字符串又是序列(多类型值)， 那么切分将会对序列进行，而不是字符串。当处理XML时， 这样的值就是普通的了。此时，可以使用 someXMLnode” /><#assign s = “ABCDEF“>${s[2..3]}${s[2..<4]}${s[2..*3]}${s[2..*100]}${s[2..]}

  输出：

  CDCDCDECDEFCDEF

  Slicing with length limited ranges:- <#list seq[0..*2] as i>${i}</#list>- <#list seq[1..*2] as i>${i}</#list>- <#list seq[2..*2] as i>${i}</#list> <#-- Not an error -->- <#list seq[3..*2] as i>${i}</#list> <#-- Not an error -->Slicing with right-unlimited ranges:- <#list seq[0..] as i>${i}</#list>- <#list seq[1..] as i>${i}</#list>- <#list seq[2..] as i>${i}</#list>- <#list seq[3..] as i>${i}</#list>

  输出：

  Slicing with length limited ranges:- AB- BC- C-Slicing with right-unlimited ranges:- ABC- BC- C-

  三、SpringBoot整合Freemarker

  项目运行环境：

  • idea2020.2
  • jdk1.8
  • springboot 2.7.5

  （1）pom.xml文件

   <dependencies><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-freemarker</artifactId></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId><optional>true</optional></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-test</artifactId><scope>test</scope></dependency></dependencies>

  （2）实体类

  说明: 在domain下建立实体类Student

  @Datapublic class Student {private Integer id;private String name;}

  项目样图：这里把目录也给大家看一下
  

  （3）实现类

  说明:在Service下创建StudentService，在Impl下创建StudentServiceImpl

  public interface StudentService {//生成数据方法public List<Student> initFillData();//生成Excel方法publicvoid parse(String templateDir, String templateName, String excelPath, Map<String, Object> data)throws IOException, TemplateException;}

  项目样图：
  

  @Servicepublic class StudentServiceImplimplements StudentService{/** * 解析模板生成Excel * @param templateDir模板目录 * @param templateName 模板名称 * @param excelPath 生成的Excel文件路径 * @param data 数据参数 */public void parse(String templateDir,String templateName,String excelPath,Map<String,Object> data) throws IOException, TemplateException {//初始化工作 1.12日更改注意这里最新版需要加上版本号，如果不知道版本号就这样写，如果知道就直接写Configuration.VERSION_2_3_20对应版本即可 （感谢阿浩吖兄弟纠正）Configuration cfg = new Configuration(Configuration.DEFAULT_INCOMPATIBLE_IMPROVEMENTS);//设置默认编码格式为UTF-8cfg.setDefaultEncoding("UTF-8");//全局数字格式cfg.setNumberFormat("0.00");//设置模板文件位置cfg.setDirectoryForTemplateLoading(new File(templateDir));cfg.setObjectWrapper(new DefaultObjectWrapper());//加载模板Template template = cfg.getTemplate(templateName,"utf-8");OutputStreamWriter writer = null;try{//填充数据至Excelwriter = new OutputStreamWriter(new FileOutputStream(excelPath),"UTF-8");template.process(data, writer);writer.flush();}finally{writer.close();}}//生成数据方式publicList<Student> initFillData() {ArrayList<Student> fillDatas = new ArrayList<Student>();for (int i = 1; i < 51; i++) {Student fillData = new Student();fillData.setId(i);fillData.setName("0123456789="+ i);fillDatas.add(fillData);}return fillDatas;}}

  项目样图：
  

  （4）测试类

  说明:要注意模板位置与excel生成位置，自己更改或先创建目录。

  @SpringBootTestclass FreemarkerApplicationTests {@Autowiredprivate StudentService studentService;@Testpublic void excelTest(){List<Student> students = studentService.initFillData();int totalCount = students.size();Map<String,Object> data = new HashMap<String, Object>();data.put("studentList", students);data.put("totalCount",totalCount);try {//这里前面是模板位置，后面是生成的excel位置studentService.parse("D:\\study\\projecct\\freemarker\\src\\main\\resources\\templates\\", "Freemark.xml","E:\\excel\\excelTest30.xls", data);} catch (IOException e) {e.printStackTrace();} catch (TemplateException e) {e.printStackTrace();}}}

  项目样图：
  

  （5）模板

  说明: 注意模板中使用了一个list对数据进行遍历。模板名就是测试类中模板名。

  <Workbook xmlns="urn:schemas-microsoft-com:office:spreadsheet" xmlns:o="urn:schemas-microsoft-com:office:office"xmlns:x="urn:schemas-microsoft-com:office:excel" xmlns:ss="urn:schemas-microsoft-com:office:spreadsheet"xmlns:html="http://www.w3.org/TR/REC-html40" xmlns:dt="uuid:C2F41010-65B3-11d1-A29F-00AA00C14882"><DocumentProperties xmlns="urn:schemas-microsoft-com:office:office"><Author>Apache POI</Author><LastAuthor>chenqingtao</LastAuthor><Created>2020-03-16T08:20:00Z</Created><LastSaved>2022-11-03T07:31:58Z</LastSaved></DocumentProperties><CustomDocumentProperties xmlns="urn:schemas-microsoft-com:office:office"><ICV dt:dt="string">9DC2DE9132B4460BB7A5E14BF585E55C</ICV><KSOProductBuildVer dt:dt="string">2052-11.1.0.12650</KSOProductBuildVer></CustomDocumentProperties><ExcelWorkbook xmlns="urn:schemas-microsoft-com:office:excel"><WindowWidth>24225</WindowWidth><WindowHeight>12540</WindowHeight><ProtectStructure>False</ProtectStructure><ProtectWindows>False</ProtectWindows></ExcelWorkbook><Styles><Style ss:ID="Default" ss:Name="Normal">ss:Vertical="Center"/><Font ss:FontName="等线" x:CharSet="134" ss:Size="11" ss:Color="#000000"/></Style><Style ss:ID="s49"/><Style ss:ID="s50">ss:Horizontal="Center" ss:Vertical="Center" ss:WrapText="1"/><Border ss:Position="Bottom" ss:LineStyle="Continuous" ss:Weight="1"/><Border ss:Position="Left" ss:LineStyle="Continuous" ss:Weight="1"/><Border ss:Position="Right" ss:LineStyle="Continuous" ss:Weight="1"/><Border ss:Position="Top" ss:LineStyle="Continuous" ss:Weight="1"/><Font ss:FontName="宋体" x:CharSet="134" ss:Size="14" ss:Bold="1"/><Interior ss:Color="#C0C0C0" ss:Pattern="Solid"/></Style></Styles><Worksheet ss:Name="0"><Table ss:ExpandedColumnCount="2" ss:ExpandedRowCount="2" x:FullColumns="1" x:FullRows="1" ss:DefaultColumnWidth="54" ss:DefaultRowHeight="14.25"><Column ss:Index="1" ss:StyleID="Default" ss:AutoFitWidth="0" ss:Width="120" ss:Span="1"/><Row ss:Height="30"><Cell ss:StyleID="s50"><Data ss:Type="String">学生姓名</Data></Cell><Cell ss:StyleID="s50"><Data ss:Type="String">学生ID</Data></Cell></Row><#list studentList as student><Row><Cell><Data ss:Type="String">${student.name}</Data></Cell><Cell><Data ss:Type="Number">${student.id}</Data></Cell></Row></#list></Table><WorksheetOptions xmlns="urn:schemas-microsoft-com:office:excel"><PageSetup><Header x:Margin="0.3"/><Footer x:Margin="0.3"/><PageMargins x:Left="0.7" x:Right="0.7" x:Top="0.75" x:Bottom="0.75"/></PageSetup><Selected/><TopRowVisible>0</TopRowVisible><LeftColumnVisible>0</LeftColumnVisible><PageBreakZoom>100</PageBreakZoom><Panes><Pane><Number>3</Number><ActiveRow>7</ActiveRow><ActiveCol>3</ActiveCol><RangeSelection>R8C4</RangeSelection></Pane></Panes><ProtectObjects>False</ProtectObjects><ProtectScenarios>False</ProtectScenarios></WorksheetOptions></Worksheet></Workbook>

  项目样图：
  

  生成位置：
  
  生成excel样式：
  

  总结：SpringBoot整合Freemarker超详细教程。希望对您有帮助，感谢阅读

  结束语：裸体一旦成为艺术，便是最圣洁的。道德一旦沦为虚伪，便是最下流的。
  勇敢去做你认为正确的事，不要被世俗的流言蜚语所困扰。