Spring Boot使用模板freemarker的示例代碼

更新時(shí)間：2017年10月04日 10:05:13 作者：林祥纖

本篇文章主要介紹了Spring Boot使用模板freemarker的示例代碼，小編覺(jué)得挺不錯(cuò)的，現(xiàn)在分享給大家，也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧

最近有好久沒(méi)有更新博客了，感謝小伙伴的默默支持，不知道是誰(shuí)又打賞了我一個(gè)小紅包，謝謝。

今天我們講講怎么在Spring Boot中使用模板引擎freemarker，先看看今天的大綱：

(1) freemarker介紹；
(2) 新建spring-boot-freemarker工程；
(3) 在pom.xml引入相關(guān)依賴；
(4) 編寫啟動(dòng)類；
(5) 編寫模板文件hello.ftl;
(6) 編寫訪問(wèn)類HelloController;
(7) 測(cè)試；
(8) freemarker配置；
(9) freemarker常用語(yǔ)法；
(10) freemarker layout 布局

(1) freemarker介紹；

FreeMarker是一款模板引擎：即一種基于模板和要改變的數(shù)據(jù)，并用來(lái)生成輸出文本（HTML網(wǎng)頁(yè)、電子郵件、配置文件、源代碼等）的通用工具。它不是面向最終用戶的，而是一個(gè)Java類庫(kù)，是一款程序員可以嵌入他們所開(kāi)發(fā)產(chǎn)品的組件。

(2) 新建spring-boot-freeMarker工程；

我們新建一個(gè)maven工程，取名為：spring-boot-freemarker

(3) 在pom.xml引入相關(guān)依賴；

這里使用freeMarker需要引入相關(guān)依賴包：spring-boot-starter-freemarker，

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
 xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> 
 <modelVersion>4.0.0</modelVersion> 
  
 <groupId>com.kfit</groupId> 
 <artifactId>spring-boot-velocity</artifactId> 
 <version>0.0.1-SNAPSHOT</version> 
 <packaging>jar</packaging> 
  
 <name>spring-boot-velocity</name> 
 <url>http://maven.apache.org</url> 
  
 <properties> 
  <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> 
   <!-- jdk版本號(hào)，angel在這里使用1.8，大家修改為大家本地配置的jdk版本號(hào)即可 --> 
  <java.version>1.8</java.version> 
 </properties> 
  
  <!-- 
    spring boot 父節(jié)點(diǎn)依賴, 
    引入這個(gè)之后相關(guān)的引入就不需要添加version配置， 
    spring boot會(huì)自動(dòng)選擇最合適的版本進(jìn)行添加。 
   --> 
  <parent> 
    <groupId>org.springframework.boot</groupId> 
    <artifactId>spring-boot-starter-parent</artifactId> 
    <version>1.4.1.RELEASE</version><!-- 1.4.1.RELEASE , 1.3.3.RELEASE--> 
  </parent> 
  
 <dependencies> 
  <dependency> 
   <groupId>junit</groupId> 
   <artifactId>junit</artifactId> 
   <scope>test</scope> 
  </dependency> 
   
    <!-- spring boot web支持：mvc,aop... --> 
  <dependency> 
    <groupId>org.springframework.boot</groupId> 
    <artifactId>spring-boot-starter-web</artifactId> 
  </dependency> 
   
  <!-- 引入freeMarker的依賴包. --> 
  <dependency>   
    <groupId>org.springframework.boot</groupId>  
    <artifactId>spring-boot-starter-freemarker</artifactId> 
  </dependency> 
   
 </dependencies> 
</project>

(4) 編寫啟動(dòng)類；

啟動(dòng)類沒(méi)有什么特別之處，不過(guò)多介紹，請(qǐng)看代碼：

package com.kfit; 
  
import org.springframework.boot.SpringApplication; 
import org.springframework.boot.autoconfigure.SpringBootApplication; 
  
/** 
 * 
 * @author Angel --守護(hù)天使 
 * @version v.0.1 
 * @date 2016年10月4日 
 */ 
@SpringBootApplication 
public class App { 
  publicstaticvoid main(String[] args) { 
    SpringApplication.run(App.class, args); 
  } 
}

(5) 編寫模板文件hello.ftl;

編寫一個(gè)hello.ftl文件，此文件的路徑在src/main/resources/templates下，其中hello.ftl文件的內(nèi)容如下：

<html>  
<body>  
  welcome ${name} to freemarker! 
</body>  
</html>

(6) 編寫訪問(wèn)類HelloController;

有了模板文件之后，我們需要有個(gè)Controller控制類，能夠訪問(wèn)到hello.ftl文件，這里也很簡(jiǎn)單，具體看如下代碼：

 package com.kfit.demo.web; 
  
import java.util.Map; 
  
import org.springframework.stereotype.Controller; 
import org.springframework.web.bind.annotation.RequestMapping; 
  
/** 
 * 測(cè)試velocity; 
 * @author Angel --守護(hù)天使 
 * @version v.0.1 
 * @date 2016年10月4日 
 */ 
@Controller 
public class HelloController { 
   
  @RequestMapping("/hello") 
  public String hello(Map<String,Object> map){ 
    map.put("name", "[Angel -- 守護(hù)天使]"); 
    return "hello"; 
  } 
   
}

(7) 測(cè)試；

好了，到這里，我們就可以啟動(dòng)我們的程序進(jìn)行測(cè)試了，訪問(wèn)地址：

http://127.0.0.1:8080/hello ，如果你在瀏覽器中看到如下信息：

welcome [Angel -- 守護(hù)天使] to freemarker!

那么說(shuō)明你的demo ok 了。

(8) freemarker配置；

在spring boot的application.properties屬性文件中為freemarker提供了一些常用的配置,如下：

########################################################
###FREEMARKER (FreeMarkerAutoConfiguration)
########################################################
spring.freemarker.allow-request-override=false
spring.freemarker.cache=true
spring.freemarker.check-template-location=true
spring.freemarker.charset=UTF-8
spring.freemarker.content-type=text/html
spring.freemarker.expose-request-attributes=false
spring.freemarker.expose-session-attributes=false
spring.freemarker.expose-spring-macro-helpers=false
#spring.freemarker.prefix=
#spring.freemarker.request-context-attribute=
#spring.freemarker.settings.*=
#spring.freemarker.suffix=.ftl
#spring.freemarker.template-loader-path=classpath:/templates/ #comma-separated list
#spring.freemarker.view-names= # whitelist of view names that can be resolved

(9) freemarker常用語(yǔ)法；

freemarker的語(yǔ)法并不是本節(jié)的重點(diǎn)，這里還是簡(jiǎn)單的介紹下幾個(gè)常用的if else,list；

首先我們改造下HelloController的hello方法

@RequestMapping("/hello") 
  public String hello(Map<String,Object> map){ 
    map.put("name", "[Angel -- 守護(hù)天使]"); 
    map.put("gender",1);//gender:性別，1：男；0：女； 
    
    List<Map<String,Object>> friends =new ArrayList<Map<String,Object>>(); 
    Map<String,Object> friend = new HashMap<String,Object>(); 
    friend.put("name", "張三"); 
    friend.put("age", 20); 
    friends.add(friend); 
    friend = new HashMap<String,Object>(); 
    friend.put("name", "李四"); 
    friend.put("age", 22); 
    friends.add(friend); 
    map.put("friends", friends); 
    return "hello"; 
  }

這里我們返回了gender和friends的列表；

接下來(lái)我們看看怎么在freemarker進(jìn)行展示呢?

<!DOCTYPE html> 
<html xmlns="http://www.w3.org/1999/xhtml" xmlns:th="http://www.thymeleaf.org" 
   xmlns:sec="http://www.thymeleaf.org/thymeleaf-extras-springsecurity3"> 
  <head> 
    <title>Hello World!</title> 
  </head> 
  <body> 
    <p> 
      welcome ${name} to freemarker! 
    </p>    
    
    
    <p>性別： 
      <#if gender==0> 
       女 
      <#elseif gender==1> 
       男 
      <#else> 
       保密   
      </#if> 
    </p> 
    
    
    <h4>我的好友：</h4> 
    <#list friends as item> 
      姓名：${item.name} , 年齡${item.age} 
      <br> 
    </#list> 
    
  </body> 
</html>

(10) freemarker layout

freemarker layout主要處理具有相同內(nèi)容的頁(yè)面，比如每個(gè)網(wǎng)站的header和footer頁(yè)面。

freemarker 的布局主要常見(jiàn)的兩種方式是#import(“文件路徑”)和#include(“文件路徑”)，其中import和include的區(qū)別在于，include常用于公共部分的頁(yè)面，如果要使用<#assign username=“張三”>涉及到內(nèi)部函數(shù)以及變量聲明之類的，使用import進(jìn)行導(dǎo)入，如果在import中的頁(yè)面含有頁(yè)面當(dāng)前將不會(huì)進(jìn)行渲染。我們編寫一個(gè)header和footer，其中的header使用include引入，footer頁(yè)面也使用include引入。（當(dāng)然freemarker 還有別的布局方式，這里只是介紹一種，請(qǐng)自行學(xué)習(xí)研究）

header.ftl內(nèi)容：

<header> 
  This is a header,welcome ${name} to my web site! 
</header> 
<hr>

footer.ftl內(nèi)容：

<hr> 
<footer> 
  This is a footer,welcome ${name} to my web site! 
</footer>

修改hello.ftl：

<!DOCTYPE html> 
<html xmlns="http://www.w3.org/1999/xhtml" xmlns:th="http://www.thymeleaf.org" 
   xmlns:sec="http://www.thymeleaf.org/thymeleaf-extras-springsecurity3"> 
  <head> 
    <title>Hello World!</title> 
  </head> 
  <body> 
   
    <#include "/header.ftl" > 
     
    <p> 
      welcome ${name} to freemarker! 
    </p>    
    
    
    <p>性別： 
      <#if gender==0> 
       女 
      <#elseif gender==1> 
       男 
      <#else> 
       保密   
      </#if> 
    </p> 
    
    
    <h4>我的好友：</h4> 
    <#list friends as item> 
      姓名：${item.name} , 年齡${item.age} 
      <br> 
    </#list> 
    
    
    <#include "/footer.ftl" > 
  </body> 
</html>

到這里就ok了，我們?cè)L問(wèn)/hello頁(yè)面，應(yīng)該會(huì)看到如下圖的效果：