應用Java停止FreeMarker的web模板開辟的基本教程。本站提示廣大學習愛好者:(應用Java停止FreeMarker的web模板開辟的基本教程)文章只能為提供參考,不一定能成為您想要的結果。以下是應用Java停止FreeMarker的web模板開辟的基本教程正文
1、概述
FreeMarker 是一個模板引擎,一個基於模板生成文本輸入的通用對象,應用純 Java 編寫,FreeMarker 被設計用來生成 HTML Web 頁面,特殊是基於 MVC 形式的運用法式,固然 FreeMarker 具有一些編程的才能,但平日由 Java 法式預備要顯示的數據,由FreeMarker 生成頁面,經由過程模板顯示預備的數據(以下圖)
FreeMarker 不是一個 Web 運用框架,而合適作為 Web 運用框架一個組件。FreeMarker 與容器有關,由於它其實不曉得 HTTP 或 Servlet;FreeMarker 異樣可以運用於非Web運用法式情況,FreeMarker 更合適作為 Model2 框架(如 Struts)的視圖組件,你也能夠在模板中應用 JSP標志庫。別的,FreeMarker是收費的。
2、Freemarker的預備前提
freemarker.2.3.16.jar,下載地址這裡就不貼了..(這個jar包其其實struts2外面)
3、Freemarker生成靜態頁面的道理
Freemarker 生成靜態頁面,起首須要應用本身界說的模板頁面,這個模板頁面可所以最最通俗的html,也能夠是嵌套freemarker中的 取值表達式, 標簽或許自界說標簽等等,然後後台讀取這個模板頁面,解析個中的標簽完成絕對應的操作, 然後采取鍵值對的方法傳遞參數調換模板中的的取值表達式,做完以後 依據設置裝備擺設的途徑生成一個新的html頁面, 以到達靜態化拜訪的目標。
4、Freemarker供給的標簽
Freemarker供給了許多有效 經常使用的標簽,Freemarker標簽都是<#標簽稱號>如許子定名的,${value} 表現輸入變量名的內容 ,詳細以下:
1、list:該標簽重要是停止迭代辦事器端傳遞過去的List聚集,好比:
<#list nameList as names>
${names}
</#list>
name是list輪回的時刻取的一個輪回變量,freemarker在解析list標簽的時刻,等價於:
for (String names : nameList) {
System.out.println(names);
}
2、if:該標簽重要是做if斷定用的,好比:
<#if (names=="陳靖仇")> 他的兵器是: 十五~~ </#if>
這個是前提斷定標簽,要留意的是前提等式必需用括號括起來, 等價於:
if(names.equals("陳靖仇")){
System.out.println("他的兵器是: 十五~~");
}
3、include:該標簽用於導入文件用的。
<#include "include.html"/>
這個導入標簽異常好用,特殊是頁面的重用。
別的在靜態文件中可使用${} 獲得值,取值方法和el表達式一樣,異常便利。
上面舉個例子(static.html):
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Insert title here</title>
</head>
<body>
描寫:${description}
<br/>
聚集年夜小:${nameList?size}
<br/>
迭代list聚集:
<br/>
<#list nameList as names>
這是第${names_index+1}小我,叫做:<label >${names}</label>
if斷定:
<br/>
<#if (names=="陳靖仇")>
他的兵器是: 十五~~
<#elseif (names=="宇文拓")> <#--留意這裡沒有前往而是在最初面-->
他的兵器是: 軒轅劍~·
<#else>
她的絕招是:蠱毒~~
</#if>
<br/>
</#list>
迭代map聚集:
<br/>
<#list weaponMap?keys as key>
key--->${key}<br/>
value----->${weaponMap[key]!("null")}
<#--
fremarker 不支撐null, 可以用! 來取代為空的值。
其實也能夠給一個默許值
value-----${weaponMap[key]?default("null")}
還可以 在輸入前斷定能否為null
<#if weaponMap[key]??></#if>都可以
-->
<br/>
</#list>
include導入文件:
<br/>
<#include "include.html"/>
</body>
</html>
現實代碼:
package com.chenghui.test;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStreamWriter;
import java.io.Writer;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import freemarker.template.Configuration;
import freemarker.template.DefaultObjectWrapper;
import freemarker.template.Template;
import freemarker.template.TemplateException;
public class CreateHtml {
public static void main(String[] args) {
try {
//創立一個適合的Configration對象
Configuration configuration = new Configuration();
configuration.setDirectoryForTemplateLoading(new File("D:\\project\\webProject\\WebContent\\WEB-INF\\template"));
configuration.setObjectWrapper(new DefaultObjectWrapper());
configuration.setDefaultEncoding("UTF-8"); //這個必定要設置,否則在生成的頁面中 會亂碼
//獲得或創立一個模版。
Template template = configuration.getTemplate("static.html");
Map<String, Object> paramMap = new HashMap<String, Object>();
paramMap.put("description", "我正在進修應用Freemarker生成靜態文件!");
List<String> nameList = new ArrayList<String>();
nameList.add("陳靖仇");
nameList.add("玉兒");
nameList.add("宇文拓");
paramMap.put("nameList", nameList);
Map<String, Object> weaponMap = new HashMap<String, Object>();
weaponMap.put("first", "軒轅劍");
weaponMap.put("second", "崆峒印");
weaponMap.put("third", "女娲石");
weaponMap.put("fourth", "神農鼎");
weaponMap.put("fifth", "宓羲琴");
weaponMap.put("sixth", "昆侖鏡");
weaponMap.put("seventh", null);
paramMap.put("weaponMap", weaponMap);
Writer writer = new OutputStreamWriter(new FileOutputStream("success.html"),"UTF-8");
template.process(paramMap, writer);
System.out.println("祝賀,生成勝利~~");
} catch (IOException e) {
e.printStackTrace();
} catch (TemplateException e) {
e.printStackTrace();
}
}
}
如許子根本上可以算的上可以簡略的去做一點簡略的生成了,然則要在現實中去應用,照樣差的很遠的,由於freemarker給的標簽完整知足不了我們的須要,這時候候就須要自界說標簽來完成我們的需求了。。
5、Freemarker自界說標簽
Freemarker自界說標簽就是本身寫標簽,然後本身解析,完整由本身來掌握標簽的輸出輸入,極年夜的為法式員供給了很年夜的施展空間。
基於步調:
之前寫標簽須要在<後加# ,然則freemarker要辨認自界說標簽須要在前面加上@,然後前面可以界說一些參數,當法式履行template.process(paramMap, out);,就會去解析全部頁面的一切的freemarker標簽。
自界說標簽 須要自界說一個類,然後完成TemplateDirectiveModel,重寫execute辦法,完成獲得參數,依據參數do something等等。。
將自界說標簽與解析類綁定在一路須要在paramMap中放入該解析類的實例,寄存的key與自界說標簽分歧便可。。
留意:在自界說標簽中,假如標簽內甚麼也沒有,開端標簽和停止標簽相對不克不及再統一行,否則會報錯
freemarker.log.JDK14LoggerFactory$JDK14Logger error
我已經受騙過,這是freemarker 存在的bug。
上面是static.html的例子:
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Insert title here</title>
</head>
<body>
<#--自界說變量-->
<#assign num='hehe'/>
${num}
<br/>
自界說標簽
<@content name="chenghui" age="120">
${output}
${append}
</@content>
</body>
</html>
上面是下面的static.html模板的解析類:
package com.chenghui.test;
import static freemarker.template.ObjectWrapper.DEFAULT_WRAPPER;
import java.io.IOException;
import java.io.Writer;
import java.util.Map;
import freemarker.core.Environment;
import freemarker.template.TemplateDirectiveBody;
import freemarker.template.TemplateDirectiveModel;
import freemarker.template.TemplateException;
import freemarker.template.TemplateModel;
import freemarker.template.TemplateModelException;
import freemarker.template.TemplateNumberModel;
import freemarker.template.TemplateScalarModel;
/**
* 自界說標簽解析類
* @author Administrator
*
*/
public class ContentDirective implements TemplateDirectiveModel{
private static final String PARAM_NAME = "name";
private static final String PARAM_AGE = "age";
@Override
public void execute(Environment env, Map params,TemplateModel[] loopVars,
TemplateDirectiveBody body) throws TemplateException, IOException {
if(body==null){
throw new TemplateModelException("null body");
}else{
String name = getString(PARAM_NAME, params);
Integer age = getInt(PARAM_AGE, params);
//吸收到參數以後可以依據做詳細的操作,然後將數據再在頁面中顯示出來。
if(name!=null){
env.setVariable("output", DEFAULT_WRAPPER.wrap("從ContentDirective解析類中取得的參數是:"+name+", "));
}
if(age!=null){
env.setVariable("append", DEFAULT_WRAPPER.wrap("年紀:"+age));
}
Writer out = env.getOut();
out.write("從這裡輸入可以再頁面看到詳細的內容,就像document.writer寫入操作一樣。<br/>");
body.render(out);
/*
假如仔細的話,會發明頁面上是顯示out.write()輸入的語句,然後再輸入output的內容,
可見 在body在解析的時刻會先把參數放入env中,在頁面碰到對應的而來表單時的才會去取值
然則,假如該表單時不存在,就會報錯, 我認為這裡freemarker沒有做好,解析的時刻加倍會把毛病裸露在頁面上。
可以如許子填補${output!"null"},一直感到沒有el表達式那樣好。
*/
}
}
/**
* 獲得String類型的參數的值
* @param paramName
* @param paramMap
* @return
* @throws TemplateModelException
*/
public static String getString(String paramName, Map<String, TemplateModel> paramMap) throws TemplateModelException{
TemplateModel model = paramMap.get(paramName);
if(model == null){
return null;
}
if(model instanceof TemplateScalarModel){
return ((TemplateScalarModel)model).getAsString();
}else if (model instanceof TemplateNumberModel) {
return ((TemplateNumberModel)model).getAsNumber().toString();
}else{
throw new TemplateModelException(paramName);
}
}
/**
*
* 取得int類型的參數
* @param paramName
* @param paramMap
* @return
* @throws TemplateModelException
*/
public static Integer getInt(String paramName, Map<String, TemplateModel> paramMap) throws TemplateModelException{
TemplateModel model = paramMap.get(paramName);
if(model==null){
return null;
}
if(model instanceof TemplateScalarModel){
String str = ((TemplateScalarModel)model).getAsString();
try {
return Integer.valueOf(str);
} catch (NumberFormatException e) {
throw new TemplateModelException(paramName);
}
}else if(model instanceof TemplateNumberModel){
return ((TemplateNumberModel)model).getAsNumber().intValue();
}else{
throw new TemplateModelException(paramName);
}
}
}
然後再後面的現實代碼中加上:
//自界說標簽解析
paramMap.put("content", new ContentDirective());
如許子根本上可使用,freemarker完成自界說標簽了,處理一寫簡略的營業邏輯, 然則在現實的項目中弗成能如許子去做,由於還沒有和spring停止集成應用,每次都須要在解析的時刻把解析類的實例放出來。。