ThymeLeaf是什么
Thymeleaf是一個用於服務器端的java模板引擎，它使用簡單但功能強大，目前可以處理的模板類型包括：HTML、XML、TEXT、JavaScript、CSS等。
搭建thymeleaf開發環境
首先創建一個Maven web項目，pom文件依賴信息如下：
<dependencies> <dependency> <groupId>junit</groupId> <artifactId>junit</artifactId> <version>3.8.1</version> <scope>test</scope> </dependency> <dependency> <groupId>org.thymeleaf</groupId> <artifactId>thymeleaf</artifactId> <version>3.0.7.RELEASE</version> </dependency> <dependency> <groupId>javax.servlet</groupId> <artifactId>javax.servlet-api</artifactId> <version>3.1.0</version> <scope>provided</scope> </dependency> </dependencies>
可見，thymeleaf的依賴並不復雜，它只需要一個庫文件。
TemplateEngin、ITemplateResolver和IContext
這三個組件構成thymeleaf的核心：
- ITemplateResolver用於設置模板引擎，例如模板的存放目錄，模板的后綴，是否開啟模板緩存等等。
- TemplateEngine用於解析模板。
- IContext用於保存模板中需要的一些變量。例如要把變量傳遞到模板中，就可以先把變量放入IContext的實現類中，然后在模板中獲取該變量的值。
一個簡單的thymeleaf使用例子
為了讓程序代碼盡可能簡單，這里只使用最基本的servlet處理web請求。
創建Servlet
servlet代碼如下，它只是一個簡單的servlet，沒有什么功能：
@WebServlet(urlPatterns="/index") public class IndexServlet extends HttpServlet { private static final long serialVersionUID = 1L; @Override public void init() throws ServletException { super.init(); } @Override protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { } @Override protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { doGet(request, response); } }
引入模板引擎屬性
要使模板引擎可以工作，至少需要創建TemplateEngine類和ITemplateResolver接口的實例，因此在剛才創建的servlet中創建兩個類屬性， 如下：
@WebServlet(urlPatterns="/index") public class IndexServlet extends HttpServlet { private static final long serialVersionUID = 1L; TemplateEngine templateEngine; ServletContextTemplateResolver templateResolver; //其他servlet方法 }
初始化模板引擎
這一步可以在servlet的init方法中初始化上面加入的兩個屬性。一般情況下，模板解析器有一些默認值，例如它默認以html方式解析模板。但是，模板的保存路徑和后綴是空的，這兩個必須由我們自己設置。
@Override public void init() throws ServletException { super.init(); templateEngine = new TemplateEngine(); templateResolver = new ServletContextTemplateResolver(getServletContext()); templateResolver.setPrefix("/WEB-INF/templates"); //模板位置 templateResolver.setSuffix(".html"); //模板擴展名 templateEngine.setTemplateResolver(templateResolver); }
其中prefix就是模板保存的路徑，suffix就是模板的擴展名（后綴）。
使用WebContext
WebContext是IContext的其中一個實現類，它的基本作用是保存變量。
@Override protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { WebContext context = new WebContext(request, response, getServletContext()); //添加變量message到context context.setVariable("message", "hello thymeleaf"); //解析模板並顯示到瀏覽器 templateEngine.process("home", context, response.getWriter()); }
當請求到來的時候，我們創建一個上下文對象用於保存變量，將來可以在模板中獲取變量的值。
TemplateEngine的process方法用於解析模板並利用當前response對象的writer把模板輸出到瀏覽器。
整個過程是非常簡單清晰的。
在模板中獲取變量的值
home.html文件內容：
<!DOCTYPE html> <html xmlns:th="http://www.thymeleaf.org"> <head> <meta charset="UTF-8"> <title>Insert title here</title> </head> <body> <h3 th:text="${message}">this is a greeting</h3> </body> </html>
代碼中的核心是th:text標簽和${message}占位符，它們用於把從上下文中獲取到的變量值替換掉當前標簽的文本，這里是：this is a greeting
完整代碼：
pom.xml
<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/maven-v4_0_0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>cn.sharpcode</groupId> <artifactId>learnthymeleaf</artifactId> <packaging>war</packaging> <version>0.0.1-SNAPSHOT</version> <name>learnthymeleaf Maven Webapp</name> <url>http://maven.apache.org</url> <dependencies> <dependency> <groupId>junit</groupId> <artifactId>junit</artifactId> <version>3.8.1</version> <scope>test</scope> </dependency> <dependency> <groupId>org.thymeleaf</groupId> <artifactId>thymeleaf</artifactId> <version>3.0.7.RELEASE</version> </dependency> <dependency> <groupId>javax.servlet</groupId> <artifactId>javax.servlet-api</artifactId> <version>3.1.0</version> <scope>provided</scope> </dependency> </dependencies> <build> <finalName>learnthymeleaf</finalName> <plugins> <plugin> <groupId>org.apache.tomcat.maven</groupId> <artifactId>tomcat7-maven-plugin</artifactId> <version>2.2</version> </plugin> </plugins> </build> </project>
IndexServlet
@WebServlet(urlPatterns = "/home") public class IndexServlet extends HttpServlet { private static final long serialVersionUID = 1L; TemplateEngine templateEngine; ServletContextTemplateResolver templateResolver; @Override public void init() throws ServletException { super.init(); templateEngine = new TemplateEngine(); templateResolver = new ServletContextTemplateResolver(getServletContext()); templateResolver.setPrefix("/WEB-INF/templates/"); templateResolver.setSuffix(".html"); templateEngine.setTemplateResolver(templateResolver); } @Override protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { WebContext context = new WebContext(request, response, getServletContext()); // 添加變量message到context context.setVariable("message", "hello thymeleaf"); // 解析模板並顯示到瀏覽器 templateEngine.process("home", context, response.getWriter()); } @Override protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { doGet(request, response); } }