Spring Boot 整合 FreeMarker 詳解案例

摘要: 原創出處:www.bysocket.com 泥瓦匠BYSocket 希望轉載，保留摘要，謝謝！ “年輕就不應該讓自己過得太舒服” – From yong 一、Springboot 那些事

SpringBoot 很方便的整合 FreeMarker ，DAO 資料庫操作層依舊用的是 Mybatis，本文將會一步一步到來如何整合 FreeMarker 以及配置的詳解： Springboot 那些事： 系類文章： 《Spring Boot 之 RESRful API 許可權控制》 《Spring Boot 之 HelloWorld詳解》 《Springboot 整合 Mybatis 的完整 Web 案例》 《Springboot 實現 Restful 服務，基於 HTTP / JSON 傳輸》 《Springboot 整合 FreeMarker》 二、執行 springboot-freemarker 工程

git clone 下載工程 springboot-learning-example ，專案地址見 GitHub – https://github.com/JeffLi1993/springboot-learning-example。下面開始執行工程步驟（Quick Start）： 1.資料庫準備 a.建立資料庫 springbootdb：

1 CREATE DATABASE springbootdb; b.建立表 city ：(因為我喜歡徒步) 1 2 3 4 5 6 7 8 DROP TABLE IF EXISTS city; CREATE TABLE city ( id int(10) unsigned NOT NULL AUTO_INCREMENT COMMENT '城市編號', province_id int(10) unsigned NOT NULL COMMENT '省份編號', city_name varchar(25) DEFAULT NULL COMMENT '城市名稱', description varchar(25) DEFAULT NULL COMMENT '描述', PRIMARY KEY (id) ) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8; c.插入資料

1 INSERT city VALUES (1 ,1,'溫嶺市','BYSocket 的家在溫嶺。'); 2. 專案結構介紹 專案結構如下圖所示： org.spring.springboot.controller – Controller 層 org.spring.springboot.dao – 資料操作層 DAO org.spring.springboot.domain – 實體類 org.spring.springboot.service – 業務邏輯層 Application – 應用啟動類 resources/application.properties – 應用配置檔案，應用啟動會自動讀取配置 resources/web – *.ftl檔案，是 FreeMarker 檔案配置路徑。在 application.properties 配置 resources/mapper – DAO Maper XML 檔案 3.改資料庫配置 開啟 application.properties 檔案， 修改相應的資料來源配置，比如資料來源地址、賬號、密碼等。（如果不是用 MySQL，pom 自行新增連線驅動依賴，然後修改驅動名配置。） 4.編譯工程 在專案根目錄 springboot-learning-example，執行 maven 指令： mvn clean install 5.執行工程 右鍵執行 springboot-freemarker 工程 Application 應用啟動類的 main 函式，然後在瀏覽器訪問： 獲取 ID 編號為 1 的城市資訊頁面： 1 localhost:8080/api/city/1 獲取城市列表頁面： 1 localhost:8080/api/city 6.補充 執行環境：JDK 7 或 8，Maven 3.0+ 技術棧：SpringBoot、Mybatis、FreeMarker 三、 springboot-freemarker 工程配置詳解

具體程式碼見 GitHub – https://github.com/JeffLi1993/springboot-learning-example 1.pom.xml 依賴 pom.xml 程式碼如下：

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 <?xml version="1.0" encoding="UTF-8"?> <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"> 4.0.0

<groupId>springboot</groupId>
<artifactId>springboot-freemarker</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>springboot-freemarker :: Spring Boot 整合 FreeMarker 案例</name>

<!-- Spring Boot 啟動父依賴 -->
<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>1.5.1.RELEASE</version>
</parent>

<properties>
    <mybatis-spring-boot>1.2.0</mybatis-spring-boot>
    <mysql-connector>5.1.39</mysql-connector>
</properties>

<dependencies>
    <!-- Spring Boot Freemarker 依賴 -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-freemarker</artifactId>
    </dependency>

    <!-- Spring Boot Web 依賴 -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

    <!-- Spring Boot Test 依賴 -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>

    <!-- Spring Boot Mybatis 依賴 -->
    <dependency>
        <groupId>org.mybatis.spring.boot</groupId>
        <artifactId>mybatis-spring-boot-starter</artifactId>
        <version>${mybatis-spring-boot}</version>
    </dependency>

    <!-- MySQL 連線驅動依賴 -->
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>${mysql-connector}</version>
    </dependency>

    <!-- Junit -->
    <dependency>
        <groupId>junit</groupId>
        <artifactId>junit</artifactId>
        <version>4.12</version>
    </dependency>
</dependencies>

在 pom.xml 依賴中增加 Spring Boot FreeMarker 依賴。 2.配置 FreeMarker 然後在 application.properties 中加入 FreeMarker 相關的配置：

1 2 3 4 5 6 7 8 9 10 11

Freemarker 配置

檔案配置路徑

spring.freemarker.template-loader-path=classpath:/web/ spring.freemarker.cache=false spring.freemarker.charset=UTF-8 spring.freemarker.check-template-location=true spring.freemarker.content-type=text/html spring.freemarker.expose-request-attributes=true spring.freemarker.expose-session-attributes=true spring.freemarker.request-context-attribute=request spring.freemarker.suffix=.ftl 這是我這塊的配置，如果需要更多的 FreeMarker 配置，可以檢視下面的詳解： 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 spring.freemarker.allow-request-override=false # Set whether HttpServletRequest attributes are allowed to override (hide) controller generated model attributes of the same name. spring.freemarker.allow-session-override=false # Set whether HttpSession attributes are allowed to override (hide) controller generated model attributes of the same name. spring.freemarker.cache=false # Enable template caching. spring.freemarker.charset=UTF-8 # Template encoding. spring.freemarker.check-template-location=true # Check that the templates location exists. spring.freemarker.content-type=text/html # Content-Type value. spring.freemarker.enabled=true # Enable MVC view resolution for this technology. spring.freemarker.expose-request-attributes=false # Set whether all request attributes should be added to the model prior to merging with the template. spring.freemarker.expose-session-attributes=false # Set whether all HttpSession attributes should be added to the model prior to merging with the template. spring.freemarker.expose-spring-macro-helpers=true # Set whether to expose a RequestContext for use by Spring's macro library, under the name "springMacroRequestContext". spring.freemarker.prefer-file-system-access=true # Prefer file system access for template loading. File system access enables hot detection of template changes. spring.freemarker.prefix= # Prefix that gets prepended to view names when building a URL. spring.freemarker.request-context-attribute= # Name of the RequestContext attribute for all views. spring.freemarker.settings.= # Well-known FreeMarker keys which will be passed to FreeMarker's Configuration. spring.freemarker.suffix= # Suffix that gets appended to view names when building a URL. spring.freemarker.template-loader-path=classpath:/templates/ # Comma-separated list of template paths. spring.freemarker.view-names= # White list of view names that can be resolved. 3.展示層 Controller 詳解 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 /* * 城市 Controller 實現 Restful HTTP 服務 *

* Created by bysocket on 07/02/2017. */ @Controller public class CityController {

@Autowired
private CityService cityService;

@RequestMapping(value = "/api/city/{id}", method = RequestMethod.GET)
public String findOneCity(Model model, @PathVariable("id") Long id) {
    model.addAttribute("city", cityService.findCityById(id));
    return "city";
}

@RequestMapping(value = "/api/city", method = RequestMethod.GET)
public String findAllCity(Model model) {
    List<City> cityList = cityService.findAllCity();
    model.addAttribute("cityList",cityList);
    return "cityList";
}

} a.這裡不是走 HTTP + JSON 模式，使用了 @Controller 而不是先前的 @RestController b.方法返回值是 String 型別，和 application.properties 配置的 Freemarker 檔案配置路徑下的各個 *.ftl 檔名一致。這樣才會準確地把資料渲染到 ftl 檔案裡面進行展示。 c.用 Model 類，向 Model 加入資料，並指定在該資料在 Freemarker 取值指定的名稱。 四、小結

FreeMarker 是常用的模板引擎，很多開發 Web 的必選。 推薦閱讀《Springboot 那些事》 歡迎掃一掃我的公眾號關注 — 及時得到部落格訂閱哦！ — http://www.bysocket.com/ — — https://github.com/JeffLi1993 —