第一版

2026-02-27 16:50:24 +08:00 · 2020-02-05 00:31:51 +08:00
parent 9a372b742d
commit 3329910bdd
38 changed files with 2079 additions and 0 deletions
--- a/sa-token-demo-springboot/src/main/java/com/pj/SaTokenDemoApplication.java
+++ b/sa-token-demo-springboot/src/main/java/com/pj/SaTokenDemoApplication.java
@@ -0,0 +1,18 @@
+package com.pj;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+import com.fasterxml.jackson.core.JsonProcessingException;
+
+import cn.dev33.satoken.spring.SaTokenSetup;
+
+@SaTokenSetup // 标注启动 sa-token
+@SpringBootApplication
+public class SaTokenDemoApplication {
+
+	public static void main(String[] args) throws JsonProcessingException {
+		SpringApplication.run(SaTokenDemoApplication.class, args); // run-->
+	}
+
+}
--- a/sa-token-demo-springboot/src/main/java/com/pj/satoken/SaTokenDaoRedis.java
+++ b/sa-token-demo-springboot/src/main/java/com/pj/satoken/SaTokenDaoRedis.java
@@ -0,0 +1,91 @@
+package com.pj.satoken;
+
+import java.util.concurrent.TimeUnit;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.data.redis.core.RedisTemplate;
+import org.springframework.data.redis.core.StringRedisTemplate;
+import org.springframework.data.redis.serializer.RedisSerializer;
+import org.springframework.data.redis.serializer.StringRedisSerializer;
+// import org.springframework.stereotype.Component;
+
+import cn.dev33.satoken.dao.SaTokenDao;
+import cn.dev33.satoken.session.SaSession;
+
+/**
+ * sa-token持久层的实现类 , 基于redis 
+ */
+// @Component	// 打开此注解，保证此类被springboot扫描，即可完成sa-token与redis的集成 
+public class SaTokenDaoRedis implements SaTokenDao {
+
+
+	// string专用
+	@Autowired
+	StringRedisTemplate stringRedisTemplate;	
+
+	// SaSession专用 
+	RedisTemplate<String, SaSession> redisTemplate;
+	@Autowired
+	@SuppressWarnings({ "rawtypes", "unchecked" })
+	public void setRedisTemplate(RedisTemplate redisTemplate) {
+		RedisSerializer stringSerializer = new StringRedisSerializer();
+	    redisTemplate.setKeySerializer(stringSerializer);
+		this.redisTemplate = redisTemplate;
+	}
+	
+	
+	// 根据key获取value ，如果没有，则返回空 
+	@Override
+	public String getValue(String key) {
+		return stringRedisTemplate.opsForValue().get(key);
+	}
+
+	// 写入指定key-value键值对，并设定过期时间(单位：秒)
+	@Override
+	public void setValue(String key, String value, long timeout) {
+		stringRedisTemplate.opsForValue().set(key, value, timeout, TimeUnit.SECONDS);
+	}
+
+	// 删除一个指定的key 
+	@Override
+	public void delKey(String key) {
+		stringRedisTemplate.delete(key);
+	}
+
+	
+	// 根据指定key的session，如果没有，则返回空 
+	@Override
+	public SaSession getSaSession(String sessionId) {
+		return redisTemplate.opsForValue().get(sessionId);
+	}
+
+	// 将指定session持久化 
+	@Override
+	public void saveSaSession(SaSession session, long timeout) {
+		redisTemplate.opsForValue().set(session.getId(), session, timeout, TimeUnit.SECONDS);
+	}
+
+	// 更新指定session 
+	@Override
+	public void updateSaSession(SaSession session) {
+		long expire = redisTemplate.getExpire(session.getId());
+		if(expire == -2) {	// -2 = 无此键 
+			return;
+		}
+		redisTemplate.opsForValue().set(session.getId(), session, expire, TimeUnit.SECONDS);
+	}
+
+	// 删除一个指定的session 
+	@Override
+	public void delSaSession(String sessionId) {
+		redisTemplate.delete(sessionId);
+	}
+
+	
+
+	
+	
+	
+	
+	
+}
--- a/sa-token-demo-springboot/src/main/java/com/pj/satoken/StpCustom.java
+++ b/sa-token-demo-springboot/src/main/java/com/pj/satoken/StpCustom.java
@@ -0,0 +1,28 @@
+package com.pj.satoken;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import org.springframework.stereotype.Component;
+
+import cn.dev33.satoken.stp.StpInterface;
+
+/**
+ *    自定义权限验证接口扩展 
+ */
+@Component	// 打开此注解，保证此类被springboot扫描，即可完成sa-token的自定义权限验证扩展 
+public class StpCustom implements StpInterface {
+
+	@Override
+	public List<Object> getPermissionCodeList(Object login_id, String login_key) {
+		List<Object> list = new ArrayList<Object>();
+		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;
+	}
+
+}
--- a/sa-token-demo-springboot/src/main/java/com/pj/test/AjaxJson.java
+++ b/sa-token-demo-springboot/src/main/java/com/pj/test/AjaxJson.java
@@ -0,0 +1,163 @@
+package com.pj.test;
+
+import java.io.Serializable;
+import java.util.List;
+
+
+/**
+ * ajax返回Json的封装 
+ * 【此类封装了Meta和Body的功能，写法不同，但是返回数据格式相同】
+ */
+public class AjaxJson implements Serializable{
+
+	private static final long serialVersionUID = 1L;	// 序列化版本号
+	
+	public static final int CODE_SUCCESS = 200;			// 成功状态码
+	public static final int CODE_ERROR = 500;			// 错误状态码
+	public static final int CODE_WARNING = 501;			// 警告状态码
+	public static final int CODE_NOT_JUR = 403;			// 无权限状态码
+	public static final int CODE_NOT_LOGIN = 401;		// 未登录状态码
+	public static final int CODE_INVALID_REQUEST = 400;	// 无效请求状态码
+
+	public int code; 	// 状态码
+	public String msg; 	// 描述信息 
+	public Object data; // 携带对象
+	public Long dataCount;	// 数据总数 
+	
+	/**
+	 * 返回code  
+	 * @return
+	 */
+	public int getCode() {
+		return this.code;
+	}
+
+	/**
+	 * 给msg赋值，连缀风格
+	 */
+	public AjaxJson setMsg(String msg) {
+		this.msg = msg;
+		return this;
+	}
+	public String getMsg() {
+		return this.msg;
+	}
+
+	/**
+	 * 给data赋值，连缀风格
+	 */
+	public AjaxJson setData(Object data) {
+		this.data = data;
+		return this;
+	}
+
+	/**
+	 * 将data还原为指定类型并返回
+	 */
+	@SuppressWarnings("unchecked")
+	public <T> T getData(Class<T> cs) {
+		return (T) data;
+	}
+	
+	// ============================  构建  ================================== 
+	
+	public AjaxJson(int code, String msg, Object data, Long dataCount) {
+		this.code = code;
+		this.msg = msg;
+		this.data = data;
+		this.dataCount = dataCount;
+	}
+	
+	// 返回成功
+	public static AjaxJson getSuccess() {
+		return new AjaxJson(CODE_SUCCESS, "ok", null, null);
+	}
+	public static AjaxJson getSuccess(String msg) {
+		return new AjaxJson(CODE_SUCCESS, msg, null, null);
+	}
+	public static AjaxJson getSuccess(String msg, Object data) {
+		return new AjaxJson(CODE_SUCCESS, msg, data, null);
+	}
+	public static AjaxJson getSuccessData(Object data) {
+		return new AjaxJson(CODE_SUCCESS, "ok", data, null);
+	}
+	public static AjaxJson getSuccessArray(Object... data) {
+		return new AjaxJson(CODE_SUCCESS, "ok", data, null);
+	}
+	
+	// 返回失败
+	public static AjaxJson getError() {
+		return new AjaxJson(CODE_ERROR, "error", null, null);
+	}
+	public static AjaxJson getError(String msg) {
+		return new AjaxJson(CODE_ERROR, msg, null, null);
+	}
+	
+	// 返回警告 
+	public static AjaxJson getWarning() {
+		return new AjaxJson(CODE_ERROR, "warning", null, null);
+	}
+	public static AjaxJson getWarning(String msg) {
+		return new AjaxJson(CODE_WARNING, msg, null, null);
+	}
+	
+	// 返回未登录
+	public static AjaxJson getNotLogin() {
+		return new AjaxJson(CODE_NOT_LOGIN, "未登录，请登录后再次访问", null, null);
+	}
+	
+	// 返回没有权限的 
+	public static AjaxJson getNotJur(String msg) {
+		return new AjaxJson(CODE_NOT_JUR, msg, null, null);
+	}
+	
+	// 返回一个自定义状态码的
+	public static AjaxJson get(int code, String msg){
+		return new AjaxJson(code, msg, null, null);
+	}
+	
+	// 返回分页和数据的
+	public static AjaxJson getPageData(Long dataCount, Object data){
+		return new AjaxJson(CODE_SUCCESS, "ok", data, dataCount);
+	}
+	
+	// 返回，根据受影响行数的(大于0=ok，小于0=error)
+	public static AjaxJson getByLine(int line){
+		if(line > 0){
+			return getSuccess("ok", line);
+		}
+		return getError("error").setData(line); 
+	}
+
+	// 返回，根据布尔值来确定最终结果的  (true=ok，false=error)
+	public static AjaxJson getByBoolean(boolean b){
+		return b ? getSuccess("ok") : getError("error"); 
+	}
+	
+	/* (non-Javadoc)
+	 * @see java.lang.Object#toString()
+	 */
+	@SuppressWarnings("rawtypes")
+	@Override
+	public String toString() {
+		String data_string = null;
+		if(data == null){
+			
+		} else if(data instanceof List){
+			data_string = "List(length=" + ((List)data).size() + ")";
+		} else {
+			data_string = data.toString();
+		}
+		return "{"
+				+ "\"code\": " + this.getCode()
+				+ ", \"msg\": \"" + this.getMsg() + "\""
+				+ ", \"data\": " + data_string
+				+ ", \"dataCount\": " + dataCount
+				+ "}";
+	}
+	
+	
+	
+	
+	
+}
--- a/sa-token-demo-springboot/src/main/java/com/pj/test/TestController.java
+++ b/sa-token-demo-springboot/src/main/java/com/pj/test/TestController.java
@@ -0,0 +1,83 @@
+package com.pj.test;
+
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestParam;
+import org.springframework.web.bind.annotation.RestController;
+
+import cn.dev33.satoken.session.SaSessionUtil;
+import cn.dev33.satoken.stp.StpUtil;
+
+@RestController
+@RequestMapping("/test/")
+public class TestController {
+
+	// 测试登录接口， 浏览器访问： http://localhost:8081/test/login
+	@RequestMapping("login")
+	public AjaxJson login(@RequestParam(defaultValue="10001") String id) {
+		System.out.println("======================= 进入方法，测试登录接口 ========================= ");
+		System.out.println("当前会话的token：" + StpUtil.getTokenValue());
+		System.out.println("当前是否登录：" + StpUtil.isLogin());
+		System.out.println("当前登录账号：" + StpUtil.getLoginId_defaultNull());
+		StpUtil.setLoginId(id);			// 在当前会话登录此账号 	
+		System.out.println("登录成功");
+		System.out.println("当前是否登录：" + StpUtil.isLogin());
+		System.out.println("当前登录账号：" + StpUtil.getLoginId());
+		System.out.println("当前登录账号：" + StpUtil.getLoginId_asInt());	// 获取登录id并转为int 
+
+		System.out.println("当前token信息：" + StpUtil.getTokenInfo());	// 获取登录id并转为int 
+		
+		return AjaxJson.getSuccess();
+	}
+	
+	// 测试权限接口， 浏览器访问： http://localhost:8081/test/jur
+	@RequestMapping("jur")
+	public AjaxJson jur() {
+		System.out.println("======================= 进入方法，测试权限接口 ========================= ");
+		
+		System.out.println("是否具有权限101" + StpUtil.hasPermission(101));
+		System.out.println("是否具有权限user-add" + StpUtil.hasPermission("user-add"));
+		System.out.println("是否具有权限article-get" + StpUtil.hasPermission("article-get"));
+		
+		System.out.println("没有user-add权限就抛出异常");
+		StpUtil.checkPermission("user-add");
+		
+		System.out.println("在【101、102】中只要拥有一个就不会抛出异常");
+		StpUtil.checkPermissionOr("101", "102");
+
+		System.out.println("在【101、102】中必须全部拥有才不会抛出异常");
+		StpUtil.checkPermissionAnd("101", "102");
+
+		System.out.println("权限测试通过");
+		
+		return AjaxJson.getSuccess();
+	}
+
+	// 测试会话session接口， 浏览器访问： http://localhost:8081/test/session 
+	@RequestMapping("session")
+	public AjaxJson session() {
+		System.out.println("======================= 进入方法，测试会话session接口 ========================= ");
+		System.out.println("当前是否登录：" + StpUtil.isLogin());
+		System.out.println("当前登录账号session的id" + StpUtil.getSession().getId());
+		System.out.println("当前登录账号session的id" + StpUtil.getSession().getId());
+		System.out.println("测试取值name：" + StpUtil.getSession().getAttribute("name"));
+		StpUtil.getSession().setAttribute("name", "张三");	// 写入一个值 
+		System.out.println("测试取值name：" + StpUtil.getSession().getAttribute("name"));
+		return AjaxJson.getSuccess();
+	}
+	
+	// 测试自定义session接口， 浏览器访问： http://localhost:8081/test/session2 
+	@RequestMapping("session2")
+	public AjaxJson session2() {
+		System.out.println("======================= 进入方法，测试自定义session接口 ========================= ");
+		// 自定义session就是无需登录也可以使用 的session ：比如拿用户的手机号当做 key， 来获取 session 
+		System.out.println("自定义 session的id为：" + SaSessionUtil.getSessionById("1895544896").getId());
+		System.out.println("测试取值name：" + SaSessionUtil.getSessionById("1895544896").getAttribute("name"));
+		SaSessionUtil.getSessionById("1895544896").setAttribute("name", "张三");	// 写入值 
+		System.out.println("测试取值name：" + SaSessionUtil.getSessionById("1895544896").getAttribute("name"));
+		System.out.println("测试取值name：" + SaSessionUtil.getSessionById("1895544896").getAttribute("name"));
+		return AjaxJson.getSuccess();
+	}
+	
+	
+	
+}
--- a/sa-token-demo-springboot/src/main/java/com/pj/test/TopController.java
+++ b/sa-token-demo-springboot/src/main/java/com/pj/test/TopController.java
@@ -0,0 +1,57 @@
+package com.pj.test;
+
+import java.io.IOException;
+
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+
+import org.springframework.web.bind.annotation.ControllerAdvice;
+import org.springframework.web.bind.annotation.ExceptionHandler;
+import org.springframework.web.bind.annotation.ModelAttribute;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+
+import cn.dev33.satoken.exception.NotLoginException;
+import cn.dev33.satoken.exception.NotPermissionException;
+
+/**
+ * 加强版控制器
+ */
+@ControllerAdvice // 可指定包前缀，比如：(basePackages = "com.zyd.blog.controller.admin")
+public class TopController {
+
+	// 在每个控制器之前触发的操作
+	@ModelAttribute
+	public void get(HttpServletRequest request) throws IOException {
+
+	}
+
+	// 全局异常拦截（拦截项目中的所有异常）
+	@ExceptionHandler
+	public void handlerException(Exception e, HttpServletRequest request, HttpServletResponse response)
+			throws Exception {
+
+		e.printStackTrace(); // 打印堆栈，以供调试
+
+		response.setContentType("application/json; charset=utf-8"); // http说明，我要返回JSON对象
+
+		// 如果是未登录异常
+		if (e instanceof NotLoginException) {
+			String jsonStr = new ObjectMapper().writeValueAsString(AjaxJson.getNotLogin());
+			response.getWriter().print(jsonStr);
+			return;
+		}
+		// 如果是权限异常
+		if (e instanceof NotPermissionException) {
+			NotPermissionException ee = (NotPermissionException) e;
+			String jsonStr = new ObjectMapper().writeValueAsString(AjaxJson.getNotJur("无此权限：" + ee.getCode()));
+			response.getWriter().print(jsonStr);
+			return;
+		}
+
+		// 普通异常输出：500 + 异常信息
+		response.getWriter().print(new ObjectMapper().writeValueAsString(AjaxJson.getError(e.getMessage())));
+
+	}
+
+}
--- a/sa-token-demo-springboot/src/main/resources/application.yml
+++ b/sa-token-demo-springboot/src/main/resources/application.yml
@@ -0,0 +1,44 @@
+# 端口
+server:
+    port: 8081
+
+spring: 
+    # sa-token配置
+    sa-token: 
+        # token名称（同时也是cookie名称）
+        token-name: satoken
+        # token有效期，单位s 默认30天，-1为永不过期   
+        timeout: 2592000
+        # 在多人登录同一账号时，是否共享会话（为true时共用一个，为false时新登录挤掉旧登录）
+        is-share: true
+        # 是否在cookie读取不到token时，继续从请求header里继续尝试读取 
+        is-read-head: true
+        #  是否在header读取不到token时，继续从请求题参数里继续尝试读取 
+        is-read-body: true
+        # 是否在初始化配置时打印版本字符画
+        is-v: true
+        
+          
+    # redis配置 
+    redis:
+        # Redis数据库索引（默认为0）
+        database: 1
+        # Redis服务器地址
+        host: 127.0.0.1
+        # Redis服务器连接端口
+        port: 6379
+        # Redis服务器连接密码（默认为空）
+        password: 
+        # 连接池最大连接数（使用负值表示没有限制）
+        pool:
+            maxActive: 20
+            # 连接池最大阻塞等待时间（使用负值表示没有限制）
+            maxWait: -1
+            # 连接池中的最大空闲连接
+            maxIdle: 8
+            # 连接池中的最小空闲连接
+            minIdle: 1
+        # 连接超时时间（毫秒）
+        timeout: 0
+        
+