????????????????????????????????????????????????????????????Spring Boot 集成 FreeMarker

主目錄:http://www.spring4all.com/article/246

轉(zhuǎn)載于:http://www.spring4all.com/article/269

SpringBoot 很方便的集成 FreeMarker ，DAO 數(shù)據(jù)庫(kù)操作層依舊用的是 Mybatis，本文將會(huì)一步一步到來(lái)如何集成 FreeMarker 以及配置的詳解：

git clone 下載工程?springboot-learning-example ，項(xiàng)目地址見?GitHub?-https://github.com/JeffLi1993/springboot-learning-example;下面開始運(yùn)行工程步驟(Quick Start):

1.數(shù)據(jù)庫(kù)準(zhǔn)備

a.創(chuàng)建數(shù)據(jù)庫(kù) springbootdb:

CREATE DATABASE springbootdb;

b.創(chuàng)建表 city ：(因?yàn)槲蚁矚g徒步)

DROP TABLE IF EXISTS? `city`;

CREATE TABLE `city` (

? `id` int(10) unsigned NOT NULL AUTO_INCREMENT COMMENT '城市編號(hào)',

? `province_id` int(10) unsigned? NOT NULL COMMENT '省份編號(hào)',

? `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.插入數(shù)據(jù)

INSERT city VALUES (1 ,1,'溫嶺市','BYSocket 的家在溫嶺。');

項(xiàng)目結(jié)構(gòu)圖

3.改數(shù)據(jù)庫(kù)配置

打開 application.properties 文件， 修改相應(yīng)的數(shù)據(jù)源配置，比如數(shù)據(jù)源地址、賬號(hào)、密碼等;(如果不是用 MySQL，pom 自行添加連接驅(qū)動(dòng)依賴，然后修改驅(qū)動(dòng)名配置)

4.編譯工程

在項(xiàng)目根目錄 springboot-learning-example，運(yùn)行 maven 指令：

mvn clean install

5.運(yùn)行工程

右鍵運(yùn)行?springboot-freemarker 工程 Application 應(yīng)用啟動(dòng)類的 main 函數(shù)，然后在瀏覽器訪問(wèn)：

獲取 ID 編號(hào)為 1 的城市信息頁(yè)面：

localhost:8080/api/city/1

獲取城市列表頁(yè)面：

localhost:8080/api/city

6.補(bǔ)充

運(yùn)行環(huán)境：JDK 7 或 8，Maven 3.0+

技術(shù)棧：SpringBoot、Mybatis、FreeMarker

springboot-freemarker 工程配置詳解

具體代碼見 GitHub -?https://github.com/JeffLi1993/springboot-learning-example

1.pom.xml 依賴

pom.xml 代碼如下：

<?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">

? ? <modelVersion>4.0.0</modelVersion>

? ? <groupId>springboot</groupId>

? ? <artifactId>springboot-freemarker</artifactId>

? ? <version>0.0.1-SNAPSHOT</version>

? ? <name>springboot-freemarker :: Spring Boot 集成 FreeMarker 案例</name>

? ? <!-- Spring Boot 啟動(dòng)父依賴 -->

? ? <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 連接驅(qū)動(dòng)依賴 -->

? ? ? ? <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>

</project>

在 pom.xml 依賴中增加?Spring Boot?FreeMarker 依賴;

2.配置?FreeMarker

然后在 application.properties 中加入 FreeMarker 相關(guān)的配置:

## 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 配置，可以查看下面的詳解：

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 詳解

//城市 Controller 實(shí)現(xiàn) Restful HTTP 服務(wù)

@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 文件配置路徑下的各個(gè) *.ftl 文件名一致。這樣才會(huì)準(zhǔn)確地把數(shù)據(jù)渲染到 ftl 文件里面進(jìn)行展示。

c.用 Model 類，向 Model 加入數(shù)據(jù)，并指定在該數(shù)據(jù)在?Freemarker 取值指定的名稱。

推薦:

FreeMarker 是常用的模板引擎，很多開發(fā) Web 的必選。

推薦閱讀《Springboot 那些事》，地址:https://www.bysocket.com/?page_id=1639