# FreeMarkerJS 教程与应用

FreeMarker 是一种基于 Java 语言的模板引擎，它主要用于根据模板文件和数据模型生成各种文本输出，如 HTML、XML、Java 等，尽管 FreeMarker 本身是 Java 编写的，但它可以通过一些方式在 JavaScript 项目中使用，例如通过后端 API 生成动态内容并传递给前端，本文将详细介绍如何在 JavaScript 项目中使用 FreeMarker，并提供相关示例和问题解答。

## 一、FreeMarker 简介

FreeMarker 是一个用 Java 语言编写的模板引擎，它能够基于模板文件生成其他文本，FreeMarker 不是 Web 应用框架，但非常适合作为 Web 应用框架的组件，它轻量级且易于嵌入到应用程序中，不需要Servlet环境就可以运行，FreeMarker 支持生成各种格式的文本，包括 HTML、XML、Java 等。

### 工作原理

FreeMarker 的工作原理是通过模板文件（通常以 `.ftl` 为扩展名）和数据模型来生成最终的文本输出，模板文件中包含静态内容和插值表达式（如 `${...}`），这些插值表达式会被替换为数据模型中的实际数据。

### 核心概念

**模板**：包含静态内容和插值表达式的文件。

**数据模型**：提供给模板的数据，可以是复杂的 Java 对象或简单的 Map。

**指令**：控制模板处理流程的指令，如循环、条件判断等。

## 二、在 JavaScript 项目中使用 FreeMarker

虽然 FreeMarker 是用 Java 编写的，但在 JavaScript 项目中也可以通过以下几种方式使用它：

1. **通过后端 API**：最常见的方式是在后端使用 FreeMarker 生成动态内容，然后通过 HTTP 请求将内容传递给前端。

2. **Node.js 集成**：可以使用 Node.js 的子进程模块调用 Java 程序来执行 FreeMarker。

3. **JNI（Java Native Interface）**：通过 JNI 在 JavaScript 中直接调用 Java 代码，但这种方式较为复杂。

### 1. 通过后端 API 使用 FreeMarker

这是最常见和推荐的方式，以下是一个简单的示例，展示如何在 Spring Boot 项目中使用 FreeMarker 生成动态 HTML 并通过 API 提供给前端。

#### 步骤 1：添加依赖

在 Maven 项目的 `pom.xml` 中添加 FreeMarker 和 Spring Boot Starter 的依赖：

```xml

org.springframework.bootspring-boot-starter-weborg.freemarkerfreemarker2.3.30

```

#### 步骤 2：配置 FreeMarker

创建一个配置类来设置 FreeMarker 的配置：

```java

import freemarker.template.Configuration;

import org.springframework.context.annotation.Bean;

import org.springframework.context.annotation.Configuration;

@Configuration

public class FreeMarkerConfig {

@Bean

public Configuration freeMarkerConfiguration() throws Exception {

Configuration configuration = new Configuration(Configuration.VERSION_2_3_30);

configuration.setClassForTemplateLoading(this.getClass(), "/templates");

configuration.setDefaultEncoding("UTF-8");

configuration.setTemplateExceptionHandler(TemplateExceptionHandler.RETHROW_HANDLER);

configuration.setLogTemplateExceptions(false);

configuration.setWrapUncheckedExceptions(true);

return configuration;

}

```

#### 步骤 3：创建模板文件

在 `src/main/resources/templates` 目录下创建一个名为 `example.ftl` 的模板文件：

```html

Hello, ${name}!

```

#### 步骤 4：创建控制器

创建一个控制器来处理请求并生成动态内容：

```java

import freemarker.template.Configuration;

import freemarker.template.Template;

import freemarker.template.TemplateExceptionHandler;

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.stereotype.Controller;

import org.springframework.ui.ModelMap;

import org.springframework.web.bind.annotation.GetMapping;

import org.springframework.web.bind.annotation.RequestParam;

import org.springframework.web.bind.annotation.ResponseBody;

import java.io.StringWriter;

import java.util.HashMap;

import java.util.Map;

@Controller

public class FreeMarkerController {

@Autowired

private Configuration configuration;

@GetMapping("/hello")

@ResponseBody

public String sayHello(@RequestParam("name") String name) throws Exception {

// 加载模板

Template template = configuration.getTemplate("example.ftl");

// 创建数据模型

Map model = new HashMap<>();

model.put("name", name);

// 生成内容

StringWriter writer = new StringWriter();

template.process(model, writer);

return writer.toString();

}

```

#### 步骤 5：启动项目并测试

启动 Spring Boot 项目，然后在浏览器中访问 `http://localhost:8080/hello?name=World`，应该会看到生成的 HTML 内容：

```html

Hello, World!

```

### 2. 使用 Node.js 集成 FreeMarker（可选）

如果需要在纯 JavaScript 环境中使用 FreeMarker，可以考虑通过 Node.js 的子进程模块调用 Java 程序，这种方法相对复杂，不推荐用于一般项目。

## 三、FreeMarker 的优势与应用场景

### 优势

1. **轻量级**：FreeMarker 是一个轻量级的模板引擎，不需要复杂的依赖即可运行。

2. **易于嵌入**：可以很容易地嵌入到现有的 Java 应用程序中。

3. **强大的模板语言**：FreeMarker 模板语言（FTL）功能强大，支持复杂的逻辑控制和数据处理。

4. **多文本格式支持**：不仅可以生成 HTML，还可以生成 XML、Java 等多种文本格式。

5. **安全性**：通过适当的配置，可以避免常见的安全漏洞，如跨站脚本攻击（XSS）。

### 应用场景

1. **动态网页生成**：根据用户请求动态生成 HTML 页面。

2. **代码自动生成工具**：根据模板生成源代码或其他代码文件。

3. **邮件内容生成**：生成个性化的邮件内容。

4. **报告生成**：生成各种格式的报告，如 PDF、HTML 等。

5. **国际化支持**：结合资源包实现多语言支持。

## 四、常见问题与解答

### 问题1：如何在 FreeMarker 模板中处理复杂对象？

答：FreeMarker 支持将复杂的 Java 对象作为数据模型传递到模板中，在模板中，可以通过点操作符访问对象的属性。

假设有一个 `User` 类：

```java

public class User {

private String name;

private int age;

// getters and setters

```

在模板中可以这样访问：

```html

Hello, ${user.name}! You are ${user.age} years old.

```

### 问题2：如何在 FreeMarker 中实现条件判断和循环？

答：FreeMarker 提供了丰富的指令来实现条件判断和循环，以下是一些常用的指令：

**条件判断**：`<#if>...<#elseif>...<#else>`**循环**：`<#list items as item>...>`、`<#macro>`（宏定义）等。

示例：

```html

<#-条件判断 --><#if user?? && user.admin> >

Welcome, admin ${user.name}!

<#elseif user?? && user.editor??>>

Hello, editor ${user.name}!

<#else>

Hello, guest!

<#-循环 --><#list users as user>

${user.name} is ${user.age} years old.

```

## 五、归纳

FreeMarker 是一个功能强大且灵活的模板引擎，适用于各种文本生成场景，通过结合后端 API，可以在 JavaScript 项目中轻松使用 FreeMarker 生成动态内容，无论是动态网页生成、代码自动生成还是邮件内容生成，FreeMarker 都能提供高效且安全的解决方案，希望本文能帮助你更好地理解和使用 FreeMarker，如果你有任何疑问或需要进一步的帮助，请随时提问！

各位小伙伴们，我刚刚为大家分享了有关“freemarkerjs中”的知识，希望对你们有所帮助。如果您还有其他相关问题需要解决，欢迎随时提出哦！