!232 sa-token-solon-plugin: 添加 dao 和 json 的实现类（可选）

Merge pull request !232 from 西东/dev

sa-token-starter/sa-token-solon-plugin/pom.xml

@@ -41,5 +41,17 @@
             <optional>true</optional>
         </dependency>
 
+        <dependency>
+            <groupId>org.noear</groupId>
+            <artifactId>snack3</artifactId>
+            <scope>provided</scope>
+        </dependency>
+
+        <dependency>
+            <groupId>org.noear</groupId>
+            <artifactId>redisx</artifactId>
+            <scope>provided</scope>
+        </dependency>
+
     </dependencies>
 </project>

sa-token-starter/sa-token-solon-plugin/src/main/java/cn/dev33/satoken/solon/dao/SaSessionForJson.java

@@ -0,0 +1,73 @@
+package cn.dev33.satoken.solon.dao;
+
+import cn.dev33.satoken.session.SaSession;
+import cn.dev33.satoken.util.SaFoxUtil;
+import org.noear.snack.ONode;
+
+/**
+ * Snack3 定制版 SaSession，重写类型转换API
+ * 
+ * @author noear
+ * @since 1.12
+ */
+public class SaSessionForJson extends SaSession {
+
+	private static final long serialVersionUID = -7600983549653130681L;
+
+	public SaSessionForJson() {
+		super();
+	}
+
+	/**
+	 * 构建一个 SaSession 对象
+	 * @param id Session 的 id
+	 */
+	public SaSessionForJson(String id) {
+		super(id);
+	}
+
+	/**
+	 * 取值 (指定转换类型)
+	 * @param <T> 泛型
+	 * @param key key 
+	 * @param cs 指定转换类型 
+	 * @return 值 
+	 */
+	@Override
+	public <T> T getModel(String key, Class<T> cs) {
+		if(SaFoxUtil.isBasicType(cs)) {
+			return SaFoxUtil.getValueByType(get(key), cs);
+		}
+		return ONode.deserialize(getString(key), cs);
+	}
+
+	/**
+	 * 取值 (指定转换类型, 并指定值为Null时返回的默认值)
+	 * @param <T> 泛型
+	 * @param key key 
+	 * @param cs 指定转换类型 
+	 * @param defaultValue 值为Null时返回的默认值
+	 * @return 值 
+	 */
+	@Override
+	@SuppressWarnings("unchecked")
+	public <T> T getModel(String key, Class<T> cs, Object defaultValue) {
+		Object value = get(key);
+		if(valueIsNull(value)) {
+			return (T)defaultValue;
+		}
+		if(SaFoxUtil.isBasicType(cs)) {
+			return SaFoxUtil.getValueByType(get(key), cs);
+		}
+		return ONode.deserialize(getString(key), cs);
+	}
+
+	/**
+	 * 忽略 timeout 字段的序列化
+	 */
+	@Override
+	public long getTimeout() {
+		return super.getTimeout();
+	}
+	
+}

sa-token-starter/sa-token-solon-plugin/src/main/java/cn/dev33/satoken/solon/dao/SaTokenDaoOfRedis.java

@@ -0,0 +1,23 @@
+package cn.dev33.satoken.solon.dao;
+
+import org.noear.redisx.RedisClient;
+import org.noear.solon.annotation.Note;
+
+import java.util.Properties;
+
+/**
+ * SaTokenDao 的 redis 适配
+ *
+ * @author noear
+ * @since 1.6
+ */
+public class SaTokenDaoOfRedis extends SaTokenDaoOfRedisBase64 {
+
+    public SaTokenDaoOfRedis(Properties props) {
+        super(props);
+    }
+
+    public SaTokenDaoOfRedis(RedisClient redisClient) {
+        super(redisClient);
+    }
+}

sa-token-starter/sa-token-solon-plugin/src/main/java/cn/dev33/satoken/solon/dao/SaTokenDaoOfRedisBase64.java

@@ -0,0 +1,186 @@
+package cn.dev33.satoken.solon.dao;
+
+import cn.dev33.satoken.dao.SaTokenDao;
+import cn.dev33.satoken.util.SaFoxUtil;
+import org.noear.redisx.RedisClient;
+import org.noear.redisx.plus.RedisBucket;
+
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Properties;
+import java.util.Set;
+
+/**
+ * SaTokenDao 的 redis 适配（可以完全精准还原所有序列化类型）
+ *
+ * @author noear
+ * @since 1.6
+ */
+public class SaTokenDaoOfRedisBase64 implements SaTokenDao {
+    private final RedisBucket redisBucket;
+
+    public SaTokenDaoOfRedisBase64(Properties props) {
+        this(new RedisClient(props));
+    }
+
+    public SaTokenDaoOfRedisBase64(RedisClient redisClient) {
+        redisBucket = redisClient.getBucket();
+    }
+
+
+    /**
+     * 获取Value，如无返空
+     */
+    @Override
+    public String get(String key) {
+        return redisBucket.get(key);
+    }
+
+    /**
+     * 写入Value，并设定存活时间 (单位: 秒)
+     */
+    @Override
+    public void set(String key, String value, long timeout) {
+        if (timeout == 0 || timeout <= SaTokenDao.NOT_VALUE_EXPIRE) {
+            return;
+        }
+        // 判断是否为永不过期
+        if (timeout == SaTokenDao.NEVER_EXPIRE) {
+            redisBucket.store(key, value, (int) SaTokenDao.NEVER_EXPIRE);
+        } else {
+            redisBucket.store(key, value, (int) timeout);
+        }
+    }
+
+    /**
+     * 修改指定key-value键值对 (过期时间不变)
+     */
+    @Override
+    public void update(String key, String value) {
+        long expire = getTimeout(key);
+        // -2 = 无此键
+        if (expire == SaTokenDao.NOT_VALUE_EXPIRE) {
+            return;
+        }
+        this.set(key, value, expire);
+    }
+
+    /**
+     * 删除Value
+     */
+    @Override
+    public void delete(String key) {
+        redisBucket.remove(key);
+    }
+
+    /**
+     * 获取Value的剩余存活时间 (单位: 秒)
+     */
+    @Override
+    public long getTimeout(String key) {
+        return redisBucket.ttl(key);
+    }
+
+    /**
+     * 修改Value的剩余存活时间 (单位: 秒)
+     */
+    @Override
+    public void updateTimeout(String key, long timeout) {
+        // 判断是否想要设置为永久
+        if (timeout == SaTokenDao.NEVER_EXPIRE) {
+            long expire = getTimeout(key);
+            if (expire == SaTokenDao.NEVER_EXPIRE) {
+                // 如果其已经被设置为永久，则不作任何处理
+            } else {
+                // 如果尚未被设置为永久，那么再次set一次
+                this.set(key, this.get(key), timeout);
+            }
+            return;
+        }
+        redisBucket.delay(key, (int) timeout);
+    }
+
+
+    /**
+     * 获取Object，如无返空
+     */
+    @Override
+    public Object getObject(String key) {
+        return redisBucket.getAndDeserialize(key);
+    }
+
+    /**
+     * 写入Object，并设定存活时间 (单位: 秒)
+     */
+    @Override
+    public void setObject(String key, Object object, long timeout) {
+        if (timeout == 0 || timeout <= SaTokenDao.NOT_VALUE_EXPIRE) {
+            return;
+        }
+        // 判断是否为永不过期
+        if (timeout == SaTokenDao.NEVER_EXPIRE) {
+            redisBucket.storeAndSerialize(key, object);
+        } else {
+            redisBucket.storeAndSerialize(key, object, (int) timeout);
+        }
+    }
+
+    /**
+     * 更新Object (过期时间不变)
+     */
+    @Override
+    public void updateObject(String key, Object object) {
+        long expire = getObjectTimeout(key);
+        // -2 = 无此键
+        if (expire == SaTokenDao.NOT_VALUE_EXPIRE) {
+            return;
+        }
+        this.setObject(key, object, expire);
+    }
+
+    /**
+     * 删除Object
+     */
+    @Override
+    public void deleteObject(String key) {
+        redisBucket.remove(key);
+    }
+
+    /**
+     * 获取Object的剩余存活时间 (单位: 秒)
+     */
+    @Override
+    public long getObjectTimeout(String key) {
+        return redisBucket.ttl(key);
+    }
+
+    /**
+     * 修改Object的剩余存活时间 (单位: 秒)
+     */
+    @Override
+    public void updateObjectTimeout(String key, long timeout) {
+        // 判断是否想要设置为永久
+        if (timeout == SaTokenDao.NEVER_EXPIRE) {
+            long expire = getObjectTimeout(key);
+            if (expire == SaTokenDao.NEVER_EXPIRE) {
+                // 如果其已经被设置为永久，则不作任何处理
+            } else {
+                // 如果尚未被设置为永久，那么再次set一次
+                this.setObject(key, this.getObject(key), timeout);
+            }
+            return;
+        }
+        redisBucket.delay(key, (int) timeout);
+    }
+
+
+    /**
+     * 搜索数据
+     */
+    @Override
+    public List<String> searchData(String prefix, String keyword, int start, int size, boolean sortType) {
+        Set<String> keys = redisBucket.keys(prefix + "*" + keyword + "*");
+        List<String> list = new ArrayList<String>(keys);
+        return SaFoxUtil.searchList(list, start, size, sortType);
+    }
+}

sa-token-starter/sa-token-solon-plugin/src/main/java/cn/dev33/satoken/solon/dao/SaTokenDaoOfRedisJson.java

@@ -0,0 +1,199 @@
+package cn.dev33.satoken.solon.dao;
+
+import cn.dev33.satoken.dao.SaTokenDao;
+import cn.dev33.satoken.session.SaSession;
+import cn.dev33.satoken.strategy.SaStrategy;
+import cn.dev33.satoken.util.SaFoxUtil;
+import org.noear.redisx.RedisClient;
+import org.noear.redisx.plus.RedisBucket;
+import org.noear.snack.ONode;
+
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Properties;
+import java.util.Set;
+
+/**
+ * SaTokenDao 的 redis 适配（基于json序列化，不能完全精准还原所有类型）
+ *
+ * @author noear
+ * @since 1.6
+ */
+public class SaTokenDaoOfRedisJson implements SaTokenDao {
+    private final RedisBucket redisBucket;
+
+    public SaTokenDaoOfRedisJson(Properties props) {
+        this(new RedisClient(props));
+    }
+
+    public SaTokenDaoOfRedisJson(RedisClient redisClient) {
+        redisBucket = redisClient.getBucket();
+
+        // 重写 SaSession 生成策略
+        SaStrategy.me.createSession = (sessionId) -> new SaSessionForJson(sessionId);
+
+    }
+
+    @Override
+    public SaSession getSession(String sessionId) {
+        Object obj = getObject(sessionId);
+        if (obj == null) {
+            return null;
+        }
+        return ONode.deserialize(obj.toString(), SaSessionForJson.class);
+    }
+
+
+    /**
+     * 获取Value，如无返空
+     */
+    @Override
+    public String get(String key) {
+        return redisBucket.get(key);
+    }
+
+    /**
+     * 写入Value，并设定存活时间 (单位: 秒)
+     */
+    @Override
+    public void set(String key, String value, long timeout) {
+        if (timeout == 0 || timeout <= SaTokenDao.NOT_VALUE_EXPIRE) {
+            return;
+        }
+        // 判断是否为永不过期
+        if (timeout == SaTokenDao.NEVER_EXPIRE) {
+            redisBucket.store(key, value, (int) SaTokenDao.NEVER_EXPIRE);
+        } else {
+            redisBucket.store(key, value, (int) timeout);
+        }
+    }
+
+    /**
+     * 修改指定key-value键值对 (过期时间不变)
+     */
+    @Override
+    public void update(String key, String value) {
+        long expire = getTimeout(key);
+        // -2 = 无此键
+        if (expire == SaTokenDao.NOT_VALUE_EXPIRE) {
+            return;
+        }
+        this.set(key, value, expire);
+    }
+
+    /**
+     * 删除Value
+     */
+    @Override
+    public void delete(String key) {
+        redisBucket.remove(key);
+    }
+
+    /**
+     * 获取Value的剩余存活时间 (单位: 秒)
+     */
+    @Override
+    public long getTimeout(String key) {
+        return redisBucket.ttl(key);
+    }
+
+    /**
+     * 修改Value的剩余存活时间 (单位: 秒)
+     */
+    @Override
+    public void updateTimeout(String key, long timeout) {
+        // 判断是否想要设置为永久
+        if (timeout == SaTokenDao.NEVER_EXPIRE) {
+            long expire = getTimeout(key);
+            if (expire == SaTokenDao.NEVER_EXPIRE) {
+                // 如果其已经被设置为永久，则不作任何处理
+            } else {
+                // 如果尚未被设置为永久，那么再次set一次
+                this.set(key, this.get(key), timeout);
+            }
+            return;
+        }
+        redisBucket.delay(key, (int) timeout);
+    }
+
+
+    /**
+     * 获取Object，如无返空
+     */
+    @Override
+    public Object getObject(String key) {
+        return get(key);
+    }
+
+    /**
+     * 写入Object，并设定存活时间 (单位: 秒)
+     */
+    @Override
+    public void setObject(String key, Object object, long timeout) {
+        if (timeout == 0 || timeout <= SaTokenDao.NOT_VALUE_EXPIRE) {
+            return;
+        }
+
+        String value = ONode.serialize(object);
+        set(key, value, timeout);
+    }
+
+    /**
+     * 更新Object (过期时间不变)
+     */
+    @Override
+    public void updateObject(String key, Object object) {
+        long expire = getObjectTimeout(key);
+        // -2 = 无此键
+        if (expire == SaTokenDao.NOT_VALUE_EXPIRE) {
+            return;
+        }
+        this.setObject(key, object, expire);
+    }
+
+    /**
+     * 删除Object
+     */
+    @Override
+    public void deleteObject(String key) {
+        redisBucket.remove(key);
+    }
+
+    /**
+     * 获取Object的剩余存活时间 (单位: 秒)
+     */
+    @Override
+    public long getObjectTimeout(String key) {
+        return redisBucket.ttl(key);
+    }
+
+    /**
+     * 修改Object的剩余存活时间 (单位: 秒)
+     */
+    @Override
+    public void updateObjectTimeout(String key, long timeout) {
+        // 判断是否想要设置为永久
+        if (timeout == SaTokenDao.NEVER_EXPIRE) {
+            long expire = getObjectTimeout(key);
+            if (expire == SaTokenDao.NEVER_EXPIRE) {
+                // 如果其已经被设置为永久，则不作任何处理
+            } else {
+                // 如果尚未被设置为永久，那么再次set一次
+                this.setObject(key, this.getObject(key), timeout);
+            }
+            return;
+        }
+        redisBucket.delay(key, (int) timeout);
+    }
+
+
+    /**
+     * 搜索数据
+     */
+    @Override
+    public List<String> searchData(String prefix, String keyword, int start, int size, boolean sortType) {
+        Set<String> keys = redisBucket.keys(prefix + "*" + keyword + "*");
+        List<String> list = new ArrayList<String>(keys);
+        return SaFoxUtil.searchList(list, start, size, sortType);
+    }
+}

sa-token-starter/sa-token-solon-plugin/src/main/java/cn/dev33/satoken/solon/json/SaJsonTemplateForSnack3.java

@@ -0,0 +1,22 @@
+package cn.dev33.satoken.solon.json;
+
+import cn.dev33.satoken.json.SaJsonTemplate;
+import org.noear.snack.ONode;
+
+import java.util.Map;
+
+/**
+ * @author noear
+ * @since 2.0
+ */
+public class SaJsonTemplateForSnack3 implements SaJsonTemplate {
+    @Override
+    public String toJsonString(Object o) {
+        return ONode.stringify(o);
+    }
+
+    @Override
+    public Map<String, Object> parseJsonToMap(String s) {
+        return ONode.deserialize(s, Map.class);
+    }
+}