Sa-Token框架集成Freemarker模板引擎的实践指南

背景介绍

在现代Java Web开发中，权限认证框架Sa-Token与模板引擎的集成是常见需求。虽然官方文档主要展示了与Thymeleaf的集成方案，但实际项目中Freemarker作为老牌模板引擎仍被广泛使用。本文将深入探讨如何在Sa-Token框架中实现与Freemarker的无缝集成。

核心问题分析

传统Freemarker模板中访问Session对象通常采用Session["key"]语法，但在Sa-Token框架中需要特殊处理才能正确获取到框架管理的会话数据。这是因为Sa-Token采用了自身的会话管理机制，与传统Servlet Session存在差异。

集成方案实现

1. 基础环境配置

首先确保项目中已包含必要依赖：

<!-- Sa-Token核心 -->
<dependency>
    <groupId>cn.dev33</groupId>
    <artifactId>sa-token-spring-boot-starter</artifactId>
    <version>最新版本</version>
</dependency>

<!-- Freemarker -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-freemarker</artifactId>
</dependency>

2. 自定义Freemarker指令

创建扩展指令来访问Sa-Token会话：

public class SaTokenFreemarkerDirective implements TemplateDirectiveModel {
    
    @Override
    public void execute(Environment env, Map params, 
                        TemplateModel[] loopVars, 
                        TemplateDirectiveBody body) throws TemplateException {
        
        String key = params.get("key").toString();
        Object value = StpUtil.getSession().get(key);
        
        if(value != null) {
            env.setVariable("result", ObjectWrapper.DEFAULT_WRAPPER.wrap(value));
        }
        
        if(body != null) {
            body.render(env.getOut());
        }
    }
}

3. 配置Freemarker共享变量

在Spring Boot配置类中注册自定义指令：

@Configuration
public class FreemarkerConfig {

    @Autowired
    private freemarker.template.Configuration configuration;

    @PostConstruct
    public void setSharedVariable() throws TemplateModelException {
        configuration.setSharedVariable("saSession", new SaTokenFreemarkerDirective());
    }
}

模板中使用示例

改造后的模板语法更加符合Sa-Token的设计理念：

<@saSession key="userInfo"; result>
    <#if result??>
        <!-- 用户已登录时显示的内容 -->
        <div>欢迎，${result.username}!</div>
    </#if>
</@saSession>

高级特性扩展

1. 多会话支持：可扩展指令支持指定登录类型
2. 权限校验：集成StpUtil.checkLogin()等权限API
3. 标签简化：开发自定义宏简化模板代码

性能优化建议

1. 对频繁访问的会话数据建议先在Controller层获取并传入模型
2. 复杂判断逻辑尽量在Java代码中处理
3. 合理使用Freemarker的缓存机制

结语

通过本文方案，开发者可以优雅地在Freemarker模板中访问Sa-Token会话数据，既保持了框架的安全性特性，又不失模板引擎的灵活性。这种集成方式尤其适合需要渐进式改造的老项目，为传统系统引入现代化的权限管理提供了平滑过渡方案。

实际项目中，建议根据具体业务需求对指令功能进行进一步封装，打造更适合自身项目的模板工具集。同时要注意Freemarker与Sa-Token的版本兼容性，定期更新到稳定版本。