这周主要学习怎么在Spring Boot中使用模板引擎FreeMaker,主要从以下几方面进行学习。
(1) freemarker介绍:
FreeMarker是一款模板引擎: 即一种基于模板和要改变的数据, 并用来生成输出文本(HTML网页、电子邮件、配置文件、源代码等)的通用工具。 它不是面向最终用户的,而是一个Java类库,是一款程序员可以嵌入他们所开发产品的组件。
(2) 新建spring-boot-freeMarker工程;
我们新建一个maven工程,取名为:spring-boot-freemarker
(3) 在pom.xml引入相关依赖;
这里使用freeMarker需要引入相关依赖包:spring-boot-starter-freemarker
13 4.0.0 4 5com.kfit 6spring-boot-velocity 70.0.1-SNAPSHOT 8jar 9 10spring-boot-velocity 11http://maven.apache.org 12 1314 18 19 24UTF-8 15 161.8 1725 29 30org.springframework.boot 26spring-boot-starter-parent 271.4.1.RELEASE 2831 5032 36 37 38junit 33junit 34test 3539 42 43 44org.springframework.boot 40spring-boot-starter-web 4145 48 49org.springframework.boot 46spring-boot-starter-freemarker 47
(4) 编写启动类;
启动类没有什么特别之处,不过多介绍,请看代码:
1 package com.kfit; 2 3 import org.springframework.boot.SpringApplication; 4 import org.springframework.boot.autoconfigure.SpringBootApplication; 5 6 @SpringBootApplication 7 public class App { 8 publicstaticvoid main(String[] args) { 9 SpringApplication.run(App.class, args);10 }11 }
(5) 编写模板文件hello.ftl;
编写一个hello.ftl文件,此文件的路径在src/main/resources/templates下,其中hello.ftl文件的内容如下:
1 2 3 welcome ${name} to freemarker!4 5
(6) 编写访问类HelloController;
有了模板文件之后,我们需要有个Controller控制类,能够访问到hello.ftl文件,这里也很简单,具体看如下代码:
1 package com.kfit.demo.web; 2 3 import java.util.Map; 4 5 import org.springframework.stereotype.Controller; 6 import org.springframework.web.bind.annotation.RequestMapping; 7 8 @Controller 9 public class HelloController {10 11 @RequestMapping("/hello")12 public String hello(Mapmap){13 map.put("name", "[zsliu]");14 return "hello";15 }16 17 }
(7) 测试;
好了,到这里,我们就可以启动我们的程序进行测试了,访问地址:
,如果你在浏览器中看到如下信息:
welcome [zsliu] to freemarker! 那么说明你的demo ok 了。
(8) freemarker配置;
在spring boot的application.properties属性文件中为freemarker提供了一些常用的配置,如下:
1 ######################################################## 2 ###FREEMARKER (FreeMarkerAutoConfiguration) 3 ######################################################## 4 spring.freemarker.allow-request-override=false 5 spring.freemarker.cache=true 6 spring.freemarker.check-template-location=true 7 spring.freemarker.charset=UTF-8 8 spring.freemarker.content-type=text/html 9 spring.freemarker.expose-request-attributes=false10 spring.freemarker.expose-session-attributes=false11 spring.freemarker.expose-spring-macro-helpers=false12 #spring.freemarker.prefix=13 #spring.freemarker.request-context-attribute=14 #spring.freemarker.settings.*=15 #spring.freemarker.suffix=.ftl16 #spring.freemarker.template-loader-path=classpath:/templates/ #comma-separated list17 #spring.freemarker.view-names= # whitelist of view names that can be resolved
(9) freemarker常用语法;
freemarker的语法并不是本节的重点,这里还是简单的介绍下几个常用的if else,list;
首先我们改造下HelloController的hello方法
1 @RequestMapping("/hello") 2 public String hello(Mapmap){ 3 map.put("name", "[zsliu]"); 4 map.put("gender",1);//gender:性别,1:男;0:女; 5 6 List
这里我们返回了gender和friends的列表, 接下来我们看看怎么在freemarker进行展示呢?
1 2 4 5Hello World! 6 7 89 welcome ${name} to freemarker!10
11 12 13性别:14 <#if gender==0>15 女16 <#elseif gender==1>17 男18 <#else>19 保密 20
21 22 23 24我的好友:
25 <#list friends as item>26 姓名:${item.name} , 年龄${item.age}27 28 29 30 31
10) freemarker layout
freemarker layout主要处理具有相同内容的页面,比如每个网站的header和footer页面。
freemarker 的布局主要常见的两种方式是#import(“文件路径”)和#include(“文件路径”),其中import和include的区别在于,include常用于公共部分的页面,如果要使用<#assign username=“张三”>涉及到内部函数以及变量声明之类的,使用import进行导入,如果在import中的页面含有页面当前将不会进行渲染。 我们编写一个header和footer,其中的header使用include引入,footer页面也使用include引入。
header.ftl内容:
12 This is a header,welcome ${name} to my web site!3 4
footer.ftl内容:
1
2
修改hello.ftl:
Hello World! <#include "/header.ftl" >welcome ${name} to freemarker!
性别: <#if gender==0> 女 <#elseif gender==1> 男 <#else> 保密
我的好友:
<#list friends as item> 姓名:${item.name} , 年龄${item.age} <#include "/footer.ftl" >
到这里就ok了,我们访问/hello页面,应该会看到修改后的效果:
END