FreeMarker 入门示例及操作手册

最新推荐文章于 2023-10-18 23:06:51 发布

qqxhb

最新推荐文章于 2023-10-18 23:06:51 发布

阅读量510

点赞数

分类专栏： SpringBoot 文章标签： java模板引擎 Freemarker 操作手册入门

本文链接：https://blog.csdn.net/qq_43792385/article/details/90737539

版权

1 FreeMarker 简介

1.1 java模板引擎之一

FreeMarker 是一款模板引擎：即一种基于模板和要改变的数据，并用来生成输出文本(HTML网页，电子邮件，配置文件，源代码等)的通用工具。它不是面向最终用户的，而是一个Java类库，是一款程序员可以嵌入他们所开发产品的组件。
模板编写为FreeMarker Template Language (FTL)。它是简单的，专用的语言，不是像PHP那样成熟的编程语言。那就意味着要准备数据在真实编程语言中来显示，比如数据库查询和业务运算，之后模板显示已经准备好的数据。在模板中，你可以专注于如何展现数据，而在模板之外可以专注于要展示什么数据。
在这里插入图片描述
这种方式通常被称为 MVC (模型视图控制器) 模式，对于动态网页来说，是一种特别流行的模式。它帮助从开发人员(Java 程序员)中分离出网页设计师(HTML设计师)。设计师无需面对模板中的复杂逻辑，在没有程序员来修改或重新编译代码时，也可以修改页面的样式。
而FreeMarker最初的设计，是被用来在MVC模式的Web开发框架中生成HTML页面的，它没有被绑定到 Servlet或HTML或任意Web相关的东西上。它也可以用于非Web应用环境中。
FreeMarker 是免费的，基于Apache许可证2.0版本发布。

1.2 模板+数据模型=输出

freemarker并不关心数据的来源，只是根据模板的内容，将数据模型在模板中显示并输出文件（通常为html，也可以生成其它格式的文本文件）
数据模型在java中可以是基本类型也可以List、Map、Pojo等复杂类型。

#模型
(root)
  |
  +- user = "Big Joe"
  |
  +- latestProduct
      |
      +- url = "products/greenmouse.html"
      |
      +- name = "green mouse"

#模板
<html>
<head>
  <title>Welcome!</title>
</head>
<body>
  <h1>Welcome ${user}!</h1>
  <p>Our latest product:
  <a href="${latestProduct.url}">${latestProduct.name}</a>!
</body>
</html>

#输出
<html>
<head>
  <title>Welcome!</title>
</head>
<body>
  <h1>Welcome John Doe!</h1>
  <p>Our latest product:
  <a href="products/greenmouse.html">green mouse</a>!
</body>
</html>

以上信息来源于FreeMarker官网。

2 FreeMarker 快速入门

2.1 创建Spring Boot+Freemarker演示工程。

工程结构

2.2 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/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>
	<parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>2.1.4.RELEASE</version>
		<relativePath /> <!-- lookup parent from repository -->
	</parent>
	<groupId>com.qqxhb</groupId>
	<artifactId>freemarkeer-demo</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<dependencies>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-freemarker</artifactId>
		</dependency>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-web</artifactId>
		</dependency>
		<dependency>
			<groupId>org.projectlombok</groupId>
			<artifactId>lombok</artifactId>
		</dependency>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-test</artifactId>
		</dependency>
	</dependencies>
</project>

2.3 application.yml文件配置

server:
  port: 8080 #服务端口

spring:
  freemarker:
    cache: false  #关闭模板缓存，方便测试
    settings:
      template_update_delay: 0 #检查模板更新延迟时间，设置为0表示立即检查，如果时间大于0会有缓存不方便进行模板测试

2.4 创建模板

在 src/main/resources下创建templates，此目录为freemarker的默认模板存放目录。在templates下创建模板文件simple.ftl，模板中的${name}最终会被freemarker替换成具体的数据。

<html>
<head>
  <title>Welcome!</title>
</head>
<body>
  <h1>Welcome ${user} to FreeMarker!</h1>
</body>
</html>

2.5 创建FreemarkerController

package com.qqxhb.freemarker.controller;

import java.util.ArrayList;
import java.util.Date;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;

import com.qqxhb.freemarker.model.Student;

@RequestMapping("/freemarker")
@Controller
public class FreemarkerController {
   
	@GetMapping("simple")
	public String simpleDemo(Map<String, Object> map) {
   
		map.put("user", "小宝");
		// 返回模板文件名称
		return "simple";
	}
}

2.6 创建启动类

package com.qqxhb.freemarker;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class FreemarkerApplication {
   
	public static void main(String[] args) {
   
		SpringApplication.run(FreemarkerApplication.class, args);
	}
}

2.7 启动项目测试

测试截图

3 FreeMarker 基础

3.1 常用指令

3.1.1 创建模型类

package com.qqxhb.freemarker.model;

import lombok.Data;
import lombok.ToString;

import java.util.Date;
import java.util.List;

@Data
@ToString
public class Student {
   
	private String name;// 姓名
	private int age;// 年龄
	private Date birthday;// 生日
	private long number;// 学号
	private List<Student> friends;// 朋友列表
	private Student bestFriend;// 最好的朋友
}

3.1.2 添加controller映射设置模型数据

最低0.47元/天解锁文章

qqxhb

关注

0
点赞
踩
1

收藏

觉得还不错? 一键收藏
0
评论
FreeMarker 入门示例及操作手册

1 FreeMarker 简介1.1 java模板引擎之一FreeMarker 是一款模板引擎：即一种基于模板和要改变的数据，并用来生成输出文本(HTML网页，电子邮件，配置文件，源代码等)的通用工具。它不是面向最终用户的，而是一个Java类库，是一款程序员可以嵌入他们所开发产品的组件。模板编写为FreeMarker Template Language (FTL)。它是简单的，专用的...
复制链接

扫一扫