Java使用Freemarker頁面靜態化生成的實現

Posted on by

前言：

頁面靜態化其實就是將原來的動態網頁(例如通過ajax請求動態獲取數據庫中的數據並展示的網頁)改為通過靜態化技術生成的靜態網頁，這樣用戶在訪問網頁時，服務器直接給用戶響應靜態html頁面，沒有瞭動態查詢數據庫的過程。

常用實現方法：Freemarker、thymeleaf等。

1、 Freemarker介紹

FreeMarker 是一個用 Java 語言編寫的模板引擎，它基於模板來生成文本輸出。FreeMarker與 Web 容器無關，即在 Web 運行時，它並不知道 Servlet 或 HTTP。它不僅可以用作表現層的實現技術，而且還可以用於生成 XML，JSP 或 Java 等。

定義一個Template模板,獲取FreeMarker裡面的內容詳細通過java傳入內容詳細給FreeMarker輸出Template模板結合內容的完成頁面 2、Freemarker入門案例 1、創建一個maven工程並導入Freemarker的maven坐標

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

2、創建模板文件

模板文件中有四種元素：

  • 文本，直接輸出的部分
  • 註釋，即<#–…–>格式不會輸出
  • 插值（Interpolation）：即${…}部分,將使用數據模型中的部分替代輸出
  • FTL指令：FreeMarker指令，和HTML標記類似，名字前加#予以區分，不會輸出

Freemarker的模板文件後綴可以任意，一般建議為ftl。

在D盤創建ftl目錄，在ftl目錄中創建名稱為test.ftl的模板文件，內容如下：

<html>
<head>
	<meta charset="utf-8">
	<title>Freemarker入門</title>
</head>
<body>
    <#--我隻是一個註釋，我不會有任何輸出  -->
    ${name}你好，${message}
</body>
</html>

創建模板文件示例

將文件保存到一個新的目錄下：

3、生成文件

使用步驟：

  • 第一步：創建一個 Configuration 對象，直接 new 一個對象。構造方法的參數就是 freemarker的版本號。
  • 第二步：設置模板文件所在的路徑。
  • 第三步：設置模板文件使用的字符集。一般就是 utf-8。
  • 第四步：加載一個模板，創建一個模板對象。
  • 第五步：創建一個模板使用的數據集，可以是 pojo 也可以是 map。一般是 Map。
  • 第六步：創建一個 Writer 對象，一般創建 FileWriter 對象，指定生成的文件名。
  • 第七步：調用模板對象的 process 方法輸出文件。
  • 第八步：關閉流。
public static void main(String[] args) throws Exception {
    // 1、創建freemarker的配置對象
    Configuration configuration = new Configuration(Configuration.getVersion());
    // 2、設置模板文件所在目錄
    configuration.setDirectoryForTemplateLoading(new File("F:\\ftl"));
    // 3、設置字符集
    configuration.setDefaultEncoding("utf-8");
    // 4、加載模板文件
    Template template = configuration.getTemplate("test.ftl");
    // 5、準備模板文件中所需要的數據，通常是通過map進行構造
    Map map = new HashMap();
    map.put("name","Hello");
    map.put("message","freemarker");
    // 6、準備輸出流對象，用於輸出靜態文件
    FileWriter fileWriter = new FileWriter("F:\\ftl\\test.html");
    // 7、使用模板輸出靜態文件
    template.process(map,fileWriter);
    // 8、關閉輸出流
    fileWriter.close();
}

上面的入門案例中Configuration配置對象是自己創建的，字符集和模板文件所在目錄也是在Java代碼中指定的。在項目中應用時可以將Configuration對象的創建交由Spring框架來完成，並通過依賴註入方式將字符集和模板所在目錄註入進去。

當程序執行完成之後，查看文件的位置就會多出與一個html的靜態文件，後面的項目也可以通過這樣的方式來提高訪問速度

4、 Freemarker指令

4.1、assign指令

用於在頁面上定義一個便變量，可以是簡單類型也可以是對象類型

定義一個簡單類型的變量：

<#assign linkman="周先生">
聯系人：${linkman}

定義一個對象類型的變量:

<#assign info={"mobile":"13812345678",'address':'北京市昌平區'} >
電話：${info.mobile}  地址：${info.address}

4.2、include指令

用於模板文件的嵌套

創建一個公共模板:

修改test.ftl模板在裡面嵌套heade.ftl公共模板

<#include "head.ftl"/>

4.3、if指令

if指令用於判斷

在模板文件中使用if指令進行判斷:

<#if success=true>
  你已通過實名認證
<#else>
  你未通過實名認證
</#if>

判斷的變量可以在java代碼中編寫也可以在模板中通過<#assign linkman="success">指令來判斷，如果同時設置的話，模板中的指令優先級大於java的

在java代碼中為success變量賦值:

map.put("success", true);

在freemarker的判斷中，可以使用= 也可以使用==

4.4、list指令

list指令用於遍歷

在模板文件中使用list指令進行遍歷

as是一個關鍵字不可以進行修改，後面是就取出來的數據作為一個變量進行獲取

<#list goodsList as goods>
  商品名稱： ${goods.name} 價格：${goods.price}

</#list>

在java代碼中為goodsList賦值:

List goodsList=new ArrayList();

Map goods1=new HashMap();
goods1.put("name", "蘋果");
goods1.put("price", 5.8);
Map goods2=new HashMap();
goods2.put("name", "香蕉");
goods2.put("price", 2.5);
Map goods3=new HashMap();
goods3.put("name", "橘子");
goods3.put("price", 3.2);
goodsList.add(goods1);
goodsList.add(goods2);
goodsList.add(goods3);
map.put("goodsList", goodsList);

5、實際項目中使用Freemarker

下面我們就可以將Freemarker應用到項目中，幫我們生成移動端套餐列表靜態頁面和套餐詳情靜態頁面。接下來我們需要思考幾個問題：

什麼時候生成靜態頁面比較合適呢？

應該是當套餐數據發生改變時，需要生成靜態頁面，即我們通過後臺系統修改套餐數據（包括新增、刪除、編輯）時。

將靜態頁面生成到什麼位置呢？

如果是在開發階段可以將文件生成到項目工程中，如果上線後可以將文件生成到移動端系統運行的tomcat中。

應該生成幾個靜態頁面呢？

套餐列表隻需要一個頁面就可以瞭，在這個頁面中展示所有的套餐列表數據即可。套餐詳情頁面需要有多個，即一個套餐應該對應一個靜態頁面。

5.1、在數據變更的業務邏輯層中定義模板消息

  • 創建模板的存放位置
  • 創建需要生成的模板代碼，通過指令配合來接收java提供的數據來生成靜態頁面

5.2、配置文件

在health_service_provider工程中創建屬性文件freemarker.properties

指定將靜態HTML頁面生成的目錄位置，方便後期修改維護

out_put_path=D:/ideaProjects

在項目工程中的通過spring創建FreeMarkerConfigurer對象

當項目啟動的時候就會去創建

<!--創建模板的對象-->
<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>
<!--引入輸出靜態模板的位置，輸出文件的時候會使用到裡面的key和value-->
<context:property-placeholder location="classpath:freemarker.properties"/>

5.3、生成靜態頁面

根據快速入門的代碼來編寫1即可

到此這篇關於Java使用Freemarker頁面靜態化生成的實現的文章就介紹到這瞭,更多相關Java Freemarker 內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：