lsm/sa-token
1
0
Fork 0
mirror of https://gitee.com/dromara/sa-token.git synced 2025-04-05 08:37:21 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

feat: 新增 base64、hex、ISO_8859_1 三种编码的序列化方案

Browse Source
This commit is contained in:
click33 2025-02-24 01:59:51 +08:00
parent e898ad70c5
commit d551066238
14 changed files with 290 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
sa-token-core/src/main/java/cn/dev33/satoken/SaManager.java
View File

@ -31,7 +31,7 @@ import cn.dev33.satoken.log.SaLog;
import cn.dev33.satoken.log.SaLogForConsole;
import cn.dev33.satoken.same.SaSameTemplate;
import cn.dev33.satoken.serializer.SaSerializerTemplate;
import cn.dev33.satoken.serializer.SaSerializerTemplateDefaultImpl;
import cn.dev33.satoken.serializer.impl.SaSerializerTemplateForJson;
import cn.dev33.satoken.sign.SaSignTemplate;
import cn.dev33.satoken.stp.StpInterface;
import cn.dev33.satoken.stp.StpInterfaceDefaultImpl;
@ -240,7 +240,7 @@ public class SaManager {
if (saSerializerTemplate == null) {
synchronized (SaManager.class) {
if (saSerializerTemplate == null) {
SaManager.saSerializerTemplate = new SaSerializerTemplateDefaultImpl();
SaManager.saSerializerTemplate = new SaSerializerTemplateForJson();
}
}
}

10
sa-token-core/src/main/java/cn/dev33/satoken/dao/auto/SaTokenDaoByObjectFollowStringUseJsonSerializer.java → sa-token-core/src/main/java/cn/dev33/satoken/dao/auto/SaTokenDaoByObjectFollowString.java
View File

@ -18,12 +18,12 @@ package cn.dev33.satoken.dao.auto;
import cn.dev33.satoken.SaManager;
/**
* SaTokenDao 次级实现，以 JSON 序列化方式实现 Object 读写相关操作
* SaTokenDao 次级实现，Object 读写跟随 String 读写
*
* @author click33
* @since 1.41.0
*/
public interface SaTokenDaoByObjectFollowStringUseJsonSerializer extends SaTokenDaoBySessionFollowObject {
public interface SaTokenDaoByObjectFollowString extends SaTokenDaoBySessionFollowObject {
// --------------------- Object 读写 ---------------------
@ -36,7 +36,7 @@ public interface SaTokenDaoByObjectFollowStringUseJsonSerializer extends SaToken
@Override
default Object getObject(String key) {
String jsonString = get(key);
return SaManager.getSaJsonTemplate().jsonToObject(jsonString);
return SaManager.getSaSerializerTemplate().stringToObject(jsonString);
}
/**
@ -48,7 +48,7 @@ public interface SaTokenDaoByObjectFollowStringUseJsonSerializer extends SaToken
*/
@Override
default void setObject(String key, Object object, long timeout) {
String jsonString = SaManager.getSaJsonTemplate().objectToJson(object);
String jsonString = SaManager.getSaSerializerTemplate().objectToString(object);
set(key, jsonString, timeout);
}
@ -59,7 +59,7 @@ public interface SaTokenDaoByObjectFollowStringUseJsonSerializer extends SaToken
*/
@Override
default void updateObject(String key, Object object) {
String jsonString = SaManager.getSaJsonTemplate().objectToJson(object);
String jsonString = SaManager.getSaSerializerTemplate().objectToString(object);
update(key, jsonString);
}

78
sa-token-core/src/main/java/cn/dev33/satoken/serializer/impl/SaSerializerTemplateForJdk.java Normal file
View File

@ -0,0 +1,78 @@
/*
* Copyright 2020-2099 sa-token.cc
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package cn.dev33.satoken.serializer.impl;
import cn.dev33.satoken.exception.SaTokenException;
import cn.dev33.satoken.serializer.SaSerializerTemplate;
import java.io.*;
/**
* 序列化器次级实现: jdk序列化
*
* @author click33
* @since 1.41.0
*/
public interface SaSerializerTemplateForJdk extends SaSerializerTemplate {
@Override
default String objectToString(Object obj) {
if (obj == null) {
return null;
}
try (
ByteArrayOutputStream baos = new ByteArrayOutputStream();
ObjectOutputStream oos = new ObjectOutputStream(baos)
) {
oos.writeObject(obj);
byte[] bytes = baos.toByteArray();
return bytesToString(bytes);
} catch (IOException e) {
throw new SaTokenException(e);
}
}
@Override
default Object stringToObject(String str) {
if(str == null) {
return null;
}
byte[] data = stringToBytes(str);
try (
ByteArrayInputStream bais = new ByteArrayInputStream(data);
ObjectInputStream ois = new ObjectInputStream(bais)
) {
return ois.readObject();
} catch (IOException | ClassNotFoundException e) {
throw new SaTokenException(e);
}
}
/**
* byte[] 转换为 String
* @param bytes /
* @return /
*/
String bytesToString(byte[] bytes);
/**
* String 转换为 byte[]
* @param str /
* @return /
*/
byte[] stringToBytes(String str);
}

38
sa-token-core/src/main/java/cn/dev33/satoken/serializer/impl/SaSerializerTemplateForJdkUseBase64.java Normal file
View File

@ -0,0 +1,38 @@
/*
* Copyright 2020-2099 sa-token.cc
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package cn.dev33.satoken.serializer.impl;
import java.util.Base64;
/**
* 序列化器: jdk序列化、Base64 编码 (体积+33%)
*
* @author click33
* @since 1.41.0
*/
public class SaSerializerTemplateForJdkUseBase64 implements SaSerializerTemplateForJdk {
@Override
public String bytesToString(byte[] bytes) {
return Base64.getEncoder().encodeToString(bytes);
}
@Override
public byte[] stringToBytes(String str) {
return Base64.getDecoder().decode(str);
}
}

38
sa-token-core/src/main/java/cn/dev33/satoken/serializer/impl/SaSerializerTemplateForJdkUseHex.java Normal file
View File

@ -0,0 +1,38 @@
/*
* Copyright 2020-2099 sa-token.cc
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package cn.dev33.satoken.serializer.impl;
import cn.dev33.satoken.util.SaHexUtil;
/**
* 序列化器: jdk序列化、16 进制编码 (体积+100%)
*
* @author click33
* @since 1.41.0
*/
public class SaSerializerTemplateForJdkUseHex implements SaSerializerTemplateForJdk {
@Override
public String bytesToString(byte[] bytes) {
return SaHexUtil.bytesToHex(bytes);
}
@Override
public byte[] stringToBytes(String str) {
return SaHexUtil.hexToBytes(str);
}
}

38
sa-token-core/src/main/java/cn/dev33/satoken/serializer/impl/SaSerializerTemplateForJdkUseISO_8859_1.java Normal file
View File

@ -0,0 +1,38 @@
/*
* Copyright 2020-2099 sa-token.cc
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package cn.dev33.satoken.serializer.impl;
import java.nio.charset.StandardCharsets;
/**
* 序列化器: jdk序列化、ISO-8859-1 编码 (体积无变化)
*
* @author click33
* @since 1.41.0
*/
public class SaSerializerTemplateForJdkUseISO_8859_1 implements SaSerializerTemplateForJdk {
@Override
public String bytesToString(byte[] bytes) {
return new String(bytes, StandardCharsets.ISO_8859_1);
}
@Override
public byte[] stringToBytes(String str) {
return str.getBytes(StandardCharsets.ISO_8859_1);
}
}

7
sa-token-core/src/main/java/cn/dev33/satoken/serializer/SaSerializerTemplateDefaultImpl.java → sa-token-core/src/main/java/cn/dev33/satoken/serializer/impl/SaSerializerTemplateForJson.java
View File

@ -13,17 +13,18 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package cn.dev33.satoken.serializer;
package cn.dev33.satoken.serializer.impl;
import cn.dev33.satoken.SaManager;
import cn.dev33.satoken.serializer.SaSerializerTemplate;
/**
* 序列化器，默认实现类 (使用 json 转换器)
* 序列化器: 使用 json 转换器
*
* @author click33
* @since 1.41.0
*/
public class SaSerializerTemplateDefaultImpl implements SaSerializerTemplate {
public class SaSerializerTemplateForJson implements SaSerializerTemplate {
@Override
public String objectToString(Object obj) {

74
sa-token-core/src/main/java/cn/dev33/satoken/util/SaHexUtil.java Normal file
View File

@ -0,0 +1,74 @@
/*
* Copyright 2020-2099 sa-token.cc
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package cn.dev33.satoken.util;
/**
* 十六进制工具类
*
* @author deepseek
* @since 2025/2/24
*/
public class SaHexUtil {
// 十六进制字符表（大写）
private static final char[] HEX_ARRAY = "0123456789ABCDEF".toCharArray();
/**
* 将字节数组转换为十六进制字符串（JDK8兼容）
* @param bytes 要转换的字节数组
* @return 十六进制字符串（大写）
*/
public static String bytesToHex(byte[] bytes) {
if (bytes == null) return null;
char[] hexChars = new char[bytes.length * 2];
for (int i = 0; i < bytes.length; i++) {
int v = bytes[i] & 0xFF;
hexChars[i * 2] = HEX_ARRAY[v >>> 4];
hexChars[i * 2 + 1] = HEX_ARRAY[v & 0x0F];
}
return new String(hexChars);
}
/**
* 将十六进制字符串转换为字节数组（JDK8兼容）
* @param hexString 有效的十六进制字符串（不区分大小写）
* @return 对应的字节数组
* @throws IllegalArgumentException 输入字符串格式错误时抛出异常
*/
public static byte[] hexToBytes(String hexString) {
if (hexString == null) return null;
int len = hexString.length();
if (len % 2 != 0) {
throw new IllegalArgumentException("Hex string must have even length");
}
byte[] data = new byte[len / 2];
for (int i = 0; i < len; i += 2) {
int high = Character.digit(hexString.charAt(i), 16);
int low = Character.digit(hexString.charAt(i+1), 16);
if (high == -1 || low == -1) {
throw new IllegalArgumentException(
"Invalid hex character at position " + i + " or " + (i+1)
);
}
data[i/2] = (byte) ((high << 4) + low);
}
return data;
}
}

10
sa-token-demo/pom.xml
View File

@ -26,7 +26,7 @@
<module>sa-token-demo-oauth2/sa-token-demo-oauth2-client</module>
<module>sa-token-demo-quick-login</module>
<module>sa-token-demo-remember-me/sa-token-demo-remember-me-server</module>
<module>sa-token-demo-solon</module>
<!-- <module>sa-token-demo-solon</module>-->
<module>sa-token-demo-solon-redisson</module>
<module>sa-token-demo-springboot</module>
<module>sa-token-demo-springboot3-redis</module>
@ -39,10 +39,10 @@
<module>sa-token-demo-sso/sa-token-demo-sso3-client</module>
<module>sa-token-demo-sso/sa-token-demo-sso3-client-test2</module>
<module>sa-token-demo-sso/sa-token-demo-sso3-client-nosdk</module>
<module>sa-token-demo-sso-for-solon/sa-token-demo-sso-server-solon</module>
<module>sa-token-demo-sso-for-solon/sa-token-demo-sso1-client-solon</module>
<module>sa-token-demo-sso-for-solon/sa-token-demo-sso2-client-solon</module>
<module>sa-token-demo-sso-for-solon/sa-token-demo-sso3-client-solon</module>
<!-- <module>sa-token-demo-sso-for-solon/sa-token-demo-sso-server-solon</module>-->
<!-- <module>sa-token-demo-sso-for-solon/sa-token-demo-sso1-client-solon</module>-->
<!-- <module>sa-token-demo-sso-for-solon/sa-token-demo-sso2-client-solon</module>-->
<!-- <module>sa-token-demo-sso-for-solon/sa-token-demo-sso3-client-solon</module>-->
<module>sa-token-demo-test</module>
<module>sa-token-demo-thymeleaf</module>
<module>sa-token-demo-webflux</module>

1
sa-token-plugin/sa-token-alone-redis/src/main/java/cn/dev33/satoken/dao/alone/SaAloneRedisInject.java
View File

@ -229,6 +229,7 @@ public class SaAloneRedisInject implements EnvironmentAware{
}
// 至此，说明开发者一个 redis 插件也没引入，或者引入的 redis 插件不在 sa-token-alone-redis 的支持范围内
throw new SaTokenException("未引入 sa-token-redis-xxx 相关插件，或引入的插件不在 Alone-Redis 支持范围内");
} catch (Exception e) {
e.printStackTrace();

4
sa-token-plugin/sa-token-redis-template-jdk-serializer/src/main/java/cn/dev33/satoken/dao/SaTokenDaoForRedisTemplate.java
View File

@ -15,7 +15,7 @@
*/
package cn.dev33.satoken.dao;
import cn.dev33.satoken.dao.auto.SaTokenDaoByObjectFollowStringUseJsonSerializer;
import cn.dev33.satoken.dao.auto.SaTokenDaoByObjectFollowString;
import cn.dev33.satoken.util.SaFoxUtil;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.redis.connection.RedisConnectionFactory;
@ -33,7 +33,7 @@ import java.util.concurrent.TimeUnit;
* @author click33
* @since 1.34.0
*/
public class SaTokenDaoForRedisTemplate implements SaTokenDaoByObjectFollowStringUseJsonSerializer {
public class SaTokenDaoForRedisTemplate implements SaTokenDaoByObjectFollowString {
public StringRedisTemplate stringRedisTemplate;

2
sa-token-plugin/sa-token-redis-template-jdk-serializer/src/main/java/cn/dev33/satoken/dao/SaTokenDaoForRedisTemplateUseJdkSerializer.java
View File

@ -50,7 +50,7 @@ public class SaTokenDaoForRedisTemplateUseJdkSerializer extends SaTokenDaoForRed
template.setValueSerializer(valueSerializer);
template.setHashValueSerializer(valueSerializer);
template.afterPropertiesSet();
this.objectRedisTemplate = template;
}

4
sa-token-plugin/sa-token-redis-template/src/main/java/cn/dev33/satoken/dao/SaTokenDaoForRedisTemplate.java
View File

@ -15,7 +15,7 @@
*/
package cn.dev33.satoken.dao;
import cn.dev33.satoken.dao.auto.SaTokenDaoByObjectFollowStringUseJsonSerializer;
import cn.dev33.satoken.dao.auto.SaTokenDaoByObjectFollowString;
import cn.dev33.satoken.util.SaFoxUtil;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.redis.connection.RedisConnectionFactory;
@ -32,7 +32,7 @@ import java.util.concurrent.TimeUnit;
* @author click33
* @since 1.34.0
*/
public class SaTokenDaoForRedisTemplate implements SaTokenDaoByObjectFollowStringUseJsonSerializer {
public class SaTokenDaoForRedisTemplate implements SaTokenDaoByObjectFollowString {
public StringRedisTemplate stringRedisTemplate;

4
sa-token-plugin/sa-token-redisson/src/main/java/cn/dev33/satoken/dao/SaTokenDaoForRedisson.java
View File

@ -15,7 +15,7 @@
*/
package cn.dev33.satoken.dao;
import cn.dev33.satoken.dao.auto.SaTokenDaoByObjectFollowStringUseJsonSerializer;
import cn.dev33.satoken.dao.auto.SaTokenDaoByObjectFollowString;
import cn.dev33.satoken.util.SaFoxUtil;
import org.redisson.api.RBatch;
import org.redisson.api.RBucket;
@ -34,7 +34,7 @@ import java.util.stream.Stream;
* @author noear
* @since 1.34.0
*/
public class SaTokenDaoForRedisson implements SaTokenDaoByObjectFollowStringUseJsonSerializer {
public class SaTokenDaoForRedisson implements SaTokenDaoByObjectFollowString {
/**
* redisson 客户端