初建FreeMarker工程
——@梁WP
背景:聽說freemarker可以用來寫頁面的組件,熱衷于編寫可重用代碼的我,迫不及待地研究了freemarker,不過,在寫組件之前,還是先研究一下freemarker的基本用法。
摘要:本文用了3種不同的方式(main、servlet、action),將freemarker融入工程之中。
一、通過main方法使用freemarker
1.新建一個普通的java工程,在工程引入freemarker.jar,(右鍵-BuildPath(構建路徑)-ConfigureBuildPath(配置構建路徑) )。
2.在工程的根目錄下建立一個文件夾,命名為templates(命名隨意),用來放freemarker的模板文件。
3.在templates下面新建一個模板文件,命名為sample(命名隨意),后綴格式ftl(后綴隨意,一般是ftl),文件內容就寫一句簡單的:
你好${username}
(以后通過這個模板文件,就可以生成:你好張三、你好李四、你好王五。這個模板,看起來跟使用了struts2的jsp文件差不多,其實struts2本來就用了freemarker,struts2的基礎jar包里就有freemarker.jar)
4.main方法如下:
public class Test{ public static void main(String[] args) throws Exception { //讀取模板文件的所在目錄 Configuration configuration = new Configuration(); configuration.setDirectoryForTemplateLoading(new File("templates")); //讀取模板文件 Template template = configuration.getTemplate("sample.ftl"); //數據 Map<String, Object> map = new HashMap<String, Object>(); map.put("username", "lwp"); //輸出方式 Writer out = new OutputStreamWriter(System.out); //將模板轉換并輸出 template.PRocess(map, out); //使用了流之后,記得要關掉 out.close(); }}
5.在控制臺看輸出結果為:
你好lwp
(體驗了簡單的,接著就試試高級一點的)
6.在templates下面新建一個模板文件header.ftl,內容如下:
<#macro show age="50">${username}-${age}</#macro><#macro show2 age="50"><#nested>-${age}</#macro>
7.修改sample.ftl,內容如下:
1.你好,${username}2.你好,<#if username=="lwp">程序猿<#else>${username}</#if>3.你好,${user.name}<#include "header.ftl">4.你好,<@show />5.你好,<@show age="12" />6.你好,<@show2>${username}</@show2>7.你好,<@show2 age="12">${username}</@show2><#import "header.ftl" as lwp>8.你好,<@lwp.show />9.你好,<@lwp.show age="12" />
8.新建一個User類:
public class User implements Serializable{ private static final long serialVersionUID = 1L; private String name; public User(String name) { this.name = name; } public String getName() { return name; } public void setName(String name) { this.name = name; }}
9.main方法改為這樣:(多了一句map.put("user", new User("userLWP"));)
public class Test{ public static void main(String[] args) throws Exception { //讀取模板文件的所在目錄 Configuration configuration = new Configuration(); configuration.setDirectoryForTemplateLoading(new File("templates")); //讀取模板文件 Template template = configuration.getTemplate("sample.ftl"); //數據 Map<String, Object> map = new HashMap<String, Object>(); map.put("username", "lwp"); map.put("user", new User("userLWP")); //輸出方式 Writer out = new OutputStreamWriter(System.out); //將模板轉換并輸出 template.process(map, out); //使用了流之后,記得要關掉 out.close(); }}
10.在控制臺看結果:
1.你好,lwp2.你好,程序猿3.你好,userLWP4.你好,lwp-505.你好,lwp-126.你好,lwp-507.你好,lwp-128.你好,lwp-509.你好,lwp-12
(效果甚好,我打算以后就用macro來寫組件了)
二、通過servlet使用freemarker
1.新建一個動態web工程,把freemarker.jar復制到WEB-INF的lib里面,(如果不起作用,就用上面的方式引入freemarker.jar吧)。
2.在WebRoot或WebContent下面,建立一個文件夾,命名為templates(命名隨意),用來放freemarker的模板文件。
3.在templates下面新建一個模板文件,命名為sample(命名隨意),后綴格式ftl(后綴隨意,一般是ftl),文件內容如下:
(在servlet中,使用了response輸出為網頁,所以模板內容按照html5的規范來寫,不能像上面那樣隨意了)
<!DOCTYPE html><html> <head> <title>MyHtml.html</title> <meta charset="utf-8"> </head> <body> 1.你好,${username}<br> 2.你好,<#if username=="lwp">程序猿<#else>${username}</#if><br> 3.你好,${user.name}<br> <#include "header.ftl"> 4.你好,<@show /><br> 5.你好,<@show age="12" /><br> 6.你好,<@show2>${username}</@show2><br> 7.你好,<@show2 age="12">${username}</@show2><br> <#import "header.ftl" as lwp> 8.你好,<@lwp.show /><br> 9.你好,<@lwp.show age="12" /><br> </body></html>
4.header.ftl專門被引用,跟之前的一樣就行:
<#macro show age="50">${username}-${age}</#macro><#macro show2 age="50"><#nested>-${age}</#macro>
5.復制剛才的User類:
public class User implements Serializable{ private static final long serialVersionUID = 1L; private String name; public User(String name) { this.name = name; } public String getName() { return name; } public void setName(String name) { this.name = name; }}
6.新建servlet類,內容如下:
public class TestServlet extends HttpServlet{ private static final long serialVersionUID = 1L; @Override protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException { try { this.execute(req, resp); } catch (Exception e) { e.printStackTrace(); } } @Override protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException { try { this.execute(req, resp); } catch (Exception e) { e.printStackTrace(); } } public void execute(HttpServletRequest req, HttpServletResponse resp) throws Exception { //讀取模板文件的所在目錄 Configuration configuration = new Configuration(); configuration.setServletContextForTemplateLoading(super.getServletContext(), "templates"); configuration.setDefaultEncoding("utf-8"); //讀取模板文件 Template template = configuration.getTemplate("sample.ftl"); //數據 Map<String, Object> map = new HashMap<String, Object>(); map.put("username", "lwp"); map.put("user", new User("userLWP")); //輸出方式:response輸出 resp.setCharacterEncoding("utf-8"); Writer out = resp.getWriter(); //將模板轉換并輸出 template.process(map, out); //使用了流之后,記得要關掉 out.close(); }}
7.在web.xml配置一下servlet:
<?xml version="1.0" encoding="UTF-8"?><web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://java.sun.com/xml/ns/javaee" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd" id="WebApp_ID" version="3.0"> <!-- 項目名稱 --> <display-name>freemarker_servlet</display-name> <servlet> <!-- servlet的名稱(隨意) --> <servlet-name>TestServlet</servlet-name> <!-- servlet的所在路徑(按實際填寫) --> <servlet-class>lwp.TestServlet</servlet-class> </servlet> <servlet-mapping> <!-- servlet的名稱(跟上面一樣) --> <servlet-name>TestServlet</servlet-name> <!-- servlet的請求url --> <url-pattern>/TestServlet</url-pattern> </servlet-mapping></web-app>
8.啟動一下tomcat,在地址欄輸入http://localhost:8080/freemarker_servlet/TestServlet
9.看到運行結果:
1.你好,lwp2.你好,程序猿3.你好,userLWP4.你好,lwp-505.你好,lwp-126.你好,lwp-507.你好,lwp-128.你好,lwp-509.你好,lwp-12
(其實,自從接觸struts2之后,我已經好久沒用servlet了)
三、通過action使用freemarker
1.新建一個動態web工程,把struts2的基礎包復制到WEB-INF的lib下面。
(基礎包在struts-2.3.16.1/apps/struts2-blank.war,用解壓軟件打開之后,找到WEB-INF/lib,里面那些包就是基礎包了,其中包括了freemarker-2.3.19.jar)。
2.在WebRoot或WebContent下面,建立一個文件夾,命名為templates(命名隨意),用來放freemarker的模板文件。
3.在templates下面新建一個模板文件,命名為sample(命名隨意),后綴格式ftl(后綴隨意,一般是ftl),文件內容如下:
(因為要輸出為網頁,所以模板內容按照html5的規范來寫)
<!DOCTYPE html><html> <head> <title>MyHtml.html</title> <meta charset="utf-8"> </head> <body> <#if user ?? || username ??> 1.你好,${username}<br> 2.你好,<#if username=="lwp">程序猿<#else>${username}</#if><br> 3.你好,${user.name}<br> <#include "header.ftl"> 4.你好,<@show /><br> 5.你好,<@show age="12" /><br> 6.你好,<@show2>${username}</@show2><br> 7.你好,<@show2 age="12">${username}</@show2><br> <#import "header.ftl" as lwp> 8.你好,<@lwp.show /><br> 9.你好,<@lwp.show age="12" /><br> </#if> </body></html>
4.header.ftl專門被引用,跟之前的一樣就行:
<#macro show age="50">${username}-${age}</#macro><#macro show2 age="50"><#nested>-${age}</#macro>
5.復制之前的User類:
public class User implements Serializable{ private static final long serialVersionUID = 1L; private String name; public User(String name) { this.name = name; } public String getName() { return name; } public void setName(String name) { this.name = name; }}
6.新建action,內容如下:
public class TestAction extends ActionSupport{ private static final long serialVersionUID = 1L; private String username; private User user; @Override public String execute() throws Exception { //數據 this.username = "lwp"; this.user = new User("userLWP"); //返回 return ActionSupport.SUCCESS; } public String getUsername() { return username; } public void setUsername(String username) { this.username = username; } public User getUser() { return user; } public void setUser(User user) { this.user = user; }}
7.在struts.xml配置action:
<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE struts PUBLIC "-//Apache Software Foundation//DTD Struts Configuration 2.3//EN" "http://struts.apache.org/dtds/struts-2.3.dtd"><struts> <package name="default" extends="struts-default"> <!-- action的請求名字 --> <action name="test" class="lwp.TestAction"> <result name="success" type="freemarker">/templates/sample.ftl</result> </action> <!-- ftl模板文件是不能直接輸出的,經過action之后才能轉化頁面顯示。以下這個配置是經過action的直接返回 --> <action name="*"> <result type="freemarker">/templates/{1}.ftl</result> </action> </package></struts>
8.在web.xml配置struts:
<?xml version="1.0" encoding="UTF-8"?><web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://java.sun.com/xml/ns/javaee" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd" id="WebApp_ID" version="3.0"> <!-- 項目名稱 --> <display-name>freemarker_struts</display-name> <!-- struts2的配置 --> <filter> <filter-name>struts2</filter-name> <filter-class>org.apache.struts2.dispatcher.ng.filter.StrutsPrepareAndExecuteFilter</filter-class> </filter> <filter-mapping> <filter-name>struts2</filter-name> <url-pattern>/*</url-pattern> </filter-mapping></web-app>
9.啟動一下tomcat,在地址欄輸入http://localhost:8080/freemarker_struts/test.action
10.看到運行結果:
1.你好,lwp2.你好,程序猿3.你好,userLWP4.你好,lwp-50 5.你好,lwp-12 6.你好,lwp-50 7.你好,lwp-12 8.你好,lwp-50 9.你好,lwp-12
新聞熱點
疑難解答