SpringBoot系列教程web篇之Freemaker環境搭建

時間 2019-11-16

標籤 springboot 系列教程 web freemaker 環境搭建欄目 Spring 简体版

原文原文鏈接

如今的開發現狀比較流行先後端分離，使用springboot搭建一個提供rest接口的後端服務特別簡單，引入spring-boot-starter-web依賴便可。那麼在不分離的場景下，好比要開發一個後端使用的控制檯，這時候可能並無前端資源，由javaer本身來客串一把，我但願簡單一點，先後端項目都集成在一塊兒，一個jar包運行起來就完事，能夠怎麼搞呢？css

本篇將介紹一下如何使用springboot集合freemaker引擎來搭建web應用html

前端

I. 準備

Freemaker是模板引擎，和jsp的做用差很少，對於它的不太清楚的同窗能夠參考一下官方文檔
https://freemarker.apache.org/docs/index.html

1. 依賴

首先咱們是須要一個springboot項目，基本的pom結構大都類似java

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.0.4.RELEASE</version>
    <relativePath/> <!-- lookup parent from update -->
</parent>

<properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
    <spring-cloud.version>Finchley.RELEASE</spring-cloud.version>
    <java.version>1.8</java.version>
</properties>

<build>
    <pluginManagement>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </pluginManagement>
</build>
<repositories>
    <repository>
        <id>spring-milestones</id>
        <name>Spring Milestones</name>
        <url>https://repo.spring.io/milestone</url>
        <snapshots>
            <enabled>false</enabled>
        </snapshots>
    </repository>
</repositories>

在這個項目中，咱們主要須要引入兩個依賴包，一個web，一個freemakergit

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-freemarker</artifactId>
    </dependency>
</dependencies>

2. 配置參數

一般咱們直接使用默認的freemaker參數配置便可，下面給出幾個經常使用的github

spring:
  freemarker:
    charset: UTF-8
    # 本機測試時建議設置爲false，上線時設置爲true
    cache: true
    # 表示模板文件(類html文件)的後綴
    suffix: .ftl

freemaker的參數，主要對應的是org.springframework.boot.autoconfigure.freemarker.FreeMarkerPropertiesweb

II. 項目搭建演示

1. 項目結構

搭建一個web項目和咱們以前的純後端項目有點不同，前端資源放在什麼地方，依賴文件怎麼處理都是有講究的，下面是一個常規的項目結構spring

如上圖，前端資源文件默認放在resources目錄下，下面有兩個目錄apache

templates：存放模板文件，能夠理解爲咱們編寫的html，注意這個文件名不能有問題
static: 存放靜態資源文件，如js,css,image等

2. Rest服務

咱們這裏提供了三個接口，主要是爲了演示三種不一樣的數據綁定方式後端

@Controller
public class IndexController {
    @GetMapping(path = {"", "/", "/index"})
    public ModelAndView index() {
        Map<String, Object> data = new HashMap<>(2);
        data.put("name", "YiHui Freemarker");
        data.put("now", LocalDateTime.now().toString());
        return new ModelAndView("index", data);
    }

    /**
     * 通常不建議直接使用jdk的String.split來分割字符串，內部實現是根據正則來處理的，雖然更強大，但在簡單的場景下，性能開銷更大
     */
    private static String[] contents =
            ("綠蟻浮觴香泛泛，黃花共薦芳辰。\n清霜天宇淨無塵。\n登高宜有賦，拈筆戲成文。\n可奈園林搖落盡，悲秋意與誰論。\n眼中相識幾番新。\n龍山高會處，落帽定何人。").split("\n");
    private static Random random = new Random();

    @GetMapping(path = "show1")
    public String showOne(Model model) {
        model.addAttribute("title", "臨江仙");
        model.addAttribute("content", contents[random.nextInt(6)]);
        return "show1";
    }

    @GetMapping(path = "show2")
    public String showTow(Map<String, Object> data) {
        data.put("name", "Show2---->");
        data.put("now", LocalDateTime.now().toString());
        return "show2";
    }
}

上面的三種case中

第一個是最好理解的，在建立ModelAndView時，傳入viewName和數據
第二個是經過接口參數Model，設置傳遞給view的數據
第三種則直接使用Map來傳遞數據

三個接口，對應的三個html文件，以下

index.ftl

<!DOCTYPE html>
<html lang="ch">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <meta name="description" content="SpringBoot FreeMaker"/>
    <meta name="author" content="YiHui"/>
    <meta name="viewport" content="width=device-width, initial-scale=1.0"/>
    <title>YiHui's SpringBoot Demo</title>
    <link rel="stylesheet" href="index.css"/>
</head>
<body>

<div>
    <div class="title">hello world!</div>
    <br/>
    <div class="content">歡迎訪問 ${name}</div>
    <br/>
    <div class="sign">當前時間: ${now}</div>
    <br/>
    <a href="show1">傳參2測試</a> &nbsp;&nbsp;&nbsp;&nbsp;
    <a href="show2">傳參3測試</a>
</div>
</body>
</html>

show1.ftl

<!DOCTYPE html>
<html>
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <meta name="description" content="SpringBoot thymeleaf"/>
    <meta name="author" content="YiHui"/>
    <meta name="viewport" content="width=device-width, initial-scale=1.0"/>
    <title>YiHui's SpringBoot Demo</title>
    <link rel="stylesheet" href="index.css"/>
</head>
<body>

<div>
    <div class="title">${title}</div>
    <div class="content">${content}</div>
</div>
</body>
</html>

show2.ft

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <meta name="description" content="SpringBoot thymeleaf"/>
    <meta name="author" content="YiHui"/>
    <meta name="viewport" content="width=device-width, initial-scale=1.0"/>
    <title>YiHui's SpringBoot Demo</title>
    <link rel="stylesheet" href="index.css"/>
</head>
<body>

<div>
    <div class="title">${name}</div>
    <div class="content">${now}</div>
</div>
</body>
</html>

在上面的模板文件中，須要注意引用css樣式文件，路徑前面並無static，咱們對應的css文件

index.css

.title {
    color: #c00;
    font-weight: normal;
    font-size: 2em;
}

.content {
    color: darkblue;
    font-size: 1.2em;
}

.sign {
    color: lightgray;
    font-size: 0.8em;
    font-style: italic;
}