Spring Boot整合FreeMarker全攻略

以下是 Spring Boot 集成 FreeMarker 模板引擎的完整实现方案:

一、环境准备与依赖配置

  1. Maven 依赖
    需添加 spring-boot-starter-freemarker 和 Web 基础依赖:

    <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>
    
  2. 配置文件
    application.yml 中配置模板路径与开发模式参数:

    spring:
      freemarker:
        template-loader-path: classpath:/templates/
        cache: false  # 开发时关闭缓存
        charset: UTF-8
        suffix: .ftl  # 模板文件扩展名
    

二、核心实现步骤

  1. 模板文件存放
    resources/templates/ 下创建 .ftl 文件(如 hello.ftl):

    <!DOCTYPE html>
    <html>
    <body>
        <h1>Hello ${userName}!</h1>
    </body>
    </html>
    
  2. 控制器编写
    使用 @Controller 注解(非 @RestController)返回模板名称:

    @Controller
    public class DemoController {
        @GetMapping("/greet")
        public String greet(Model model) {
            model.addAttribute("userName", "FreeMarker");
            return "hello"; // 对应模板文件名(无后缀)
        }
    }
    

三、高级配置与优化

  1. 静态资源处理
    静态文件(CSS/JS)需放在 resources/static/ 目录,模板中通过相对路径引用。

  2. 全局变量注入
    通过配置类添加共享变量:

    @Configuration
    public class FreeMarkerConfig implements FreeMarkerConfigurer {
        @Override
        public void postProcessConfiguration(Configuration config) {
            config.setSharedVariable("appVersion", "1.0.0");
        }
    }
    
  3. 安全防护
    防止 XSS 攻击需在模板中使用 ?html 转义:

    ${unsafeContent?html}
    

四、调试与问题排查

  • 模板热更新:开发时保持 spring.freemarker.cache=false
  • 错误定位:开启详细日志 logging.level.org.springframework.web=DEBUG
  • 语法检查:使用 IDE 插件(如 FreeMarker IDE)验证模板语法

注意:若需生成非 HTML 内容(如 Word/PDF),可通过 StringTemplateLoader 动态加载模板并输出字节流。

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

代码的余温

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值