feat(plugin): 新增 freemarker 集成插件。 fix: #651

sa-token-demo/sa-token-demo-freemarker/pom.xml

@@ -0,0 +1,71 @@
+<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>
+	<groupId>cn.dev33</groupId>
+	<artifactId>sa-token-demo-freemarker</artifactId>
+	<version>0.0.1-SNAPSHOT</version>
+	
+	<!-- SpringBoot -->
+	<parent>
+		<groupId>org.springframework.boot</groupId>
+		<artifactId>spring-boot-starter-parent</artifactId>
+		<version>2.5.14</version>
+		<relativePath/>
+	</parent>
+	
+	<!-- 定义 Sa-Token 版本号 -->
+	<properties>
+		<sa-token.version>1.39.0</sa-token.version>
+	</properties>
+
+	<dependencies>
+
+		<!-- springboot依赖 -->
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-starter-web</artifactId>
+		</dependency>
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-starter-aop</artifactId>
+		</dependency>
+		
+		<!-- Freemarker 视图引擎 -->
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-starter-freemarker</artifactId>
+		</dependency>
+		
+		<!-- Sa-Token 权限认证, 在线文档：https://sa-token.cc/ -->
+		<dependency>
+            <groupId>cn.dev33</groupId>
+            <artifactId>sa-token-spring-boot-starter</artifactId>
+            <version>${sa-token.version}</version>
+        </dependency>
+        
+        <!-- 在 Freemarker 页面中使用 Sa-Token 自定义标签 -->
+        <dependency>
+            <groupId>cn.dev33</groupId>
+            <artifactId>sa-token-freemarker</artifactId>
+            <version>${sa-token.version}</version>
+        </dependency>
+
+		<!-- 热刷新 -->
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-devtools</artifactId>
+			<scope>provided</scope>
+		</dependency>
+        
+		<!-- @ConfigurationProperties -->
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-configuration-processor</artifactId>
+			<optional>true</optional>
+		</dependency>
+		
+	</dependencies>
+	
+	
+</project>

sa-token-demo/sa-token-demo-freemarker/src/main/java/com/pj/SaTokenFreemarkerDemoApplication.java

@@ -0,0 +1,16 @@
+package com.pj;
+
+import cn.dev33.satoken.SaManager;
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+@SpringBootApplication
+public class SaTokenFreemarkerDemoApplication {
+	
+	public static void main(String[] args) {
+		SpringApplication.run(SaTokenFreemarkerDemoApplication.class, args);
+		System.out.println("\n启动成功，Sa-Token 配置如下：" + SaManager.getConfig());
+		System.out.println("\n测试访问：http://localhost:8081/");
+	}
+	
+}

sa-token-demo/sa-token-demo-freemarker/src/main/java/com/pj/satoken/SaTokenConfigure.java

@@ -0,0 +1,39 @@
+package com.pj.satoken;
+
+import cn.dev33.satoken.freemarker.dialect.SaTokenTemplateModel;
+import cn.dev33.satoken.stp.StpUtil;
+import freemarker.template.TemplateModelException;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.web.servlet.view.freemarker.FreeMarkerConfigurer;
+
+import javax.annotation.PostConstruct;
+
+
+/**
+ * [Sa-Token 权限认证] 配置类
+ *
+ * @author click33
+ */
+@Configuration
+public class SaTokenConfigure {
+
+	@Autowired
+	FreeMarkerConfigurer configurer;
+
+	/**
+	 * 注入 Sa-Token Freemarker 标签模板模型 对象
+	 */
+	@PostConstruct
+	public void setSaTokenTemplateModel() throws TemplateModelException {
+
+		// 注入 Sa-Token Freemarker 标签模板模型，使之可以在 xxx.ftl 文件中使用 sa 标签，
+		// 例如：<#if sa.login()>...</#if>
+		configurer.getConfiguration().setSharedVariable("sa", new SaTokenTemplateModel());
+
+		// 注入 Sa-Token Freemarker 全局对象，使之可以在 xxx.ftl 文件中调用 StpLogic 相关方法，
+		// 例如：<span>${stp.getSession().get('name')}</span>
+		configurer.getConfiguration().setSharedVariable("stp", StpUtil.stpLogic);
+	}
+
+}

sa-token-demo/sa-token-demo-freemarker/src/main/java/com/pj/satoken/StpInterfaceImpl.java

@@ -0,0 +1,43 @@
+package com.pj.satoken;
+
+import cn.dev33.satoken.stp.StpInterface;
+import org.springframework.stereotype.Component;
+
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * 自定义权限验证接口扩展 
+ */
+@Component	// 打开此注解，保证此类被springboot扫描，即可完成sa-token的自定义权限验证扩展 
+public class StpInterfaceImpl implements StpInterface {
+
+	/**
+	 * 返回一个账号所拥有的权限码集合 
+	 */
+	@Override
+	public List<String> getPermissionList(Object loginId, String loginType) {
+		// 本list仅做模拟，实际项目中要根据具体业务逻辑来查询权限
+		List<String> list = new ArrayList<String>();	
+		list.add("101");
+		list.add("user-add");
+		list.add("user-delete");
+		list.add("user-update");
+		list.add("user-get");
+		list.add("article-get");
+		return list;
+	}
+
+	/**
+	 * 返回一个账号所拥有的角色标识集合 
+	 */
+	@Override
+	public List<String> getRoleList(Object loginId, String loginType) {
+		// 本list仅做模拟，实际项目中要根据具体业务逻辑来查询角色
+		List<String> list = new ArrayList<String>();	
+		list.add("admin");
+		list.add("super-admin");
+		return list;
+	}
+
+}

sa-token-demo/sa-token-demo-freemarker/src/main/java/com/pj/test/GlobalException.java

@@ -0,0 +1,23 @@
+package com.pj.test;
+
+import cn.dev33.satoken.util.SaResult;
+import org.springframework.web.bind.annotation.ExceptionHandler;
+import org.springframework.web.bind.annotation.RestControllerAdvice;
+
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+
+/**
+ * 全局异常处理 
+ */
+@RestControllerAdvice
+public class GlobalException {
+
+	// 全局异常拦截（拦截项目中的所有异常）
+	@ExceptionHandler
+	public SaResult handlerException(Exception e, HttpServletRequest request, HttpServletResponse response) throws Exception {
+		e.printStackTrace(); 
+		return SaResult.error(e.getMessage());
+	}
+	
+}

sa-token-demo/sa-token-demo-freemarker/src/main/java/com/pj/test/TestController.java

@@ -0,0 +1,39 @@
+package com.pj.test;
+
+import cn.dev33.satoken.stp.StpUtil;
+import cn.dev33.satoken.util.SaResult;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestParam;
+import org.springframework.web.bind.annotation.RestController;
+import org.springframework.web.servlet.ModelAndView;
+
+/**
+ * 测试 Controller
+ *
+ * @author click33
+ */
+@RestController
+public class TestController {
+
+	// 首页 
+	@RequestMapping("/")
+	public Object index() {
+		return new ModelAndView("index");
+	}
+	
+	// 登录 
+	@RequestMapping("login")
+	public SaResult login(@RequestParam(defaultValue="10001") String id) {
+		StpUtil.login(id);
+		StpUtil.getSession().set("name", "zhangsan");
+		return SaResult.ok();
+	}
+
+	// 注销 
+	@RequestMapping("logout")
+	public SaResult logout() {
+		StpUtil.logout();
+		return SaResult.ok();
+	}
+	
+}

sa-token-demo/sa-token-demo-freemarker/src/main/resources/application.yml

@@ -0,0 +1,16 @@
+# 端口
+server:
+    port: 8081
+
+spring:
+    # Freemarker 相关配置
+    freemarker:
+        # 指定模板文件的目录
+        template-loader-path: classpath:/templates
+        # 指定Freemarker模板文件的后缀名
+        suffix: .ftl
+        # 关闭模板缓存，方便测试
+        cache: false
+        # 检查模板更新延迟时间，设置为0表示立即检查，如果时间大于0会有缓存不方便进行模板测试
+        settings:
+            template_update_delay: 0

sa-token-demo/sa-token-demo-freemarker/src/main/resources/templates/index.ftl

@@ -0,0 +1,39 @@
+<!DOCTYPE html>
+<html lang="zh">
+	<head>
+		<title>Sa-Token 集成 Freemarker 标签方言</title>
+		<meta charset="utf-8">
+		<meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0, maximum-scale=1.0, user-scalable=no">
+	</head>
+	<body>
+		<div class="view-box" style="padding: 30px;">
+			<h2>Sa-Token 集成 Freemarker 标签方言 —— 测试页面</h2>
+			<p>当前是否登录：<#if stp.isLogin()>是<#else>否</#if></p>
+			<p>
+				<a href="login" target="_blank">登录</a>
+				<a href="logout" target="_blank">注销</a>
+			</p>
+
+			<p>登录之后才能显示：<@sa.login>value</@sa.login></p>
+			<p>不登录才能显示：<@sa.notLogin>value</@sa.notLogin></p>
+
+			<p>具有角色 admin 才能显示：<@sa.hasRole value="admin">value</@sa.hasRole></p>
+			<p>同时具备多个角色才能显示：<@sa.hasRoleAnd value="admin, ceo, cto">value</@sa.hasRoleAnd></p>
+			<p>只要具有其中一个角色就能显示：<@sa.hasRoleOr value="admin, ceo, cto">value</@sa.hasRoleOr></p>
+			<p>不具有角色 admin 才能显示：<@sa.notRole value="admin">value</@sa.notRole></p>
+
+			<p>具有权限 user-add 才能显示：<@sa.hasPermission value="user-add">value</@sa.hasPermission></p>
+			<p>同时具备多个权限才能显示：<@sa.hasPermissionAnd value="user-add, user-delete, user-get">value</@sa.hasPermissionAnd></p>
+			<p>只要具有其中一个权限就能显示：<@sa.hasPermissionOr value="user-add, user-delete, user-get">value</@sa.hasPermissionOr></p>
+			<p>不具有权限 user-add 才能显示：<@sa.notPermission value="user-add">value</@sa.notPermission></p>
+
+			<p>
+				从SaSession中取值：
+				<#if stp.isLogin()>
+					<span>${stp.getSession().get('name')}</span>
+				</#if>
+			</p>
+
+		</div>
+	</body>
+</html>

sa-token-demo/sa-token-demo-thymeleaf/src/main/java/com/pj/test/TestController.java

@@ -9,9 +9,9 @@ import cn.dev33.satoken.stp.StpUtil;
 import cn.dev33.satoken.util.SaResult;
 
 /**
- * Sa-Token-SSO Server端 Controller 
- * @author click33
+ * 测试 Controller
  *
+ * @author click33
  */
 @RestController
 public class TestController {