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

feat: 新增 SaTokenPlugin 接口，重构插件体系

Browse Source
This commit is contained in:
click33 2025-02-21 02:32:57 +08:00
parent 54bf228ec9
commit a4c9dc1e68
11 changed files with 209 additions and 117 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
sa-token-core/src/main/java/cn/dev33/satoken/plugin/SaTokenPlugin.java Normal file
View File

@ -0,0 +1,31 @@
/*
* 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.plugin;
/**
* Sa-Token 插件总接口
*
* @author click33
* @since 1.41.0
*/
public interface SaTokenPlugin {
/**
* 安装插件
*/
void setup();
}

45
sa-token-core/src/main/java/cn/dev33/satoken/plugin/SaTokenPluginLoader.java Normal file
View File

@ -0,0 +1,45 @@
/*
* 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.plugin;
import java.util.ArrayList;
import java.util.List;
import java.util.ServiceLoader;
/**
* Sa-Token 插件加载器，管理所有插件的加载
*
* @author click33
* @since 1.41.0
*/
public class SaTokenPluginLoader {
public static List<SaTokenPlugin> pluginList;
/**
* 初始化插件
*/
public static void init() {
List<SaTokenPlugin> list = new ArrayList<>();
ServiceLoader<SaTokenPlugin> plugins = ServiceLoader.load(SaTokenPlugin.class);
for (SaTokenPlugin plugin : plugins) {
plugin.setup();
list.add(plugin);
}
pluginList = list;
}
}

9
sa-token-demo/sa-token-demo-test/pom.xml
View File

@ -53,7 +53,14 @@
<artifactId>sa-token-redis</artifactId>
<version>${sa-token.version}</version>
</dependency> -->
<!-- Sa-Token整合 Redis (使用jackson序列化方式) -->
<dependency>
<groupId>cn.dev33</groupId>
<artifactId>sa-token-jackson</artifactId>
<version>${sa-token.version}</version>
</dependency>
<!-- Sa-Token整合 Redis (使用jackson序列化方式) -->
<dependency>
<groupId>cn.dev33</groupId>

2
sa-token-plugin/pom.xml
View File

@ -18,6 +18,8 @@
<!-- 所有子模块 -->
<modules>
<module>sa-token-jackson</module>
<module>sa-token-redis</module>
<module>sa-token-redis-jackson</module>
<module>sa-token-redis-fastjson</module>

41
sa-token-plugin/sa-token-jackson/pom.xml Normal file
View File

@ -0,0 +1,41 @@
<?xml version='1.0' encoding='utf-8'?>
<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/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>cn.dev33</groupId>
<artifactId>sa-token-plugin</artifactId>
<version>${revision}</version>
<relativePath>../pom.xml</relativePath>
</parent>
<packaging>jar</packaging>
<name>sa-token-jackson</name>
<artifactId>sa-token-jackson</artifactId>
<description>sa-token-jackson</description>
<dependencies>
<!-- sa-token-core -->
<dependency>
<groupId>cn.dev33</groupId>
<artifactId>sa-token-core</artifactId>
</dependency>
<!-- jackson-databind -->
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<optional>true</optional>
</dependency>
<!-- jackson-datatype-jsr310 -->
<dependency>
<groupId>com.fasterxml.jackson.datatype</groupId>
<artifactId>jackson-datatype-jsr310</artifactId>
<optional>true</optional>
</dependency>
</dependencies>
</project>

49
sa-token-starter/sa-token-spring-boot-autoconfig/src/main/java/cn/dev33/satoken/spring/json/SaJsonTemplateForJackson.java → sa-token-plugin/sa-token-jackson/src/main/java/cn/dev33/satoken/dao/SaJsonTemplateForJackson.java
View File

@ -13,29 +13,47 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package cn.dev33.satoken.spring.json;
package cn.dev33.satoken.dao;
import cn.dev33.satoken.error.SaSpringBootErrorCode;
import cn.dev33.satoken.exception.SaJsonConvertException;
import cn.dev33.satoken.json.SaJsonTemplate;
import cn.dev33.satoken.util.SaFoxUtil;
import com.fasterxml.jackson.annotation.JsonTypeInfo;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature;
import com.fasterxml.jackson.databind.jsontype.BasicPolymorphicTypeValidator;
import com.fasterxml.jackson.databind.jsontype.PolymorphicTypeValidator;
import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
import com.fasterxml.jackson.datatype.jsr310.deser.LocalDateDeserializer;
import com.fasterxml.jackson.datatype.jsr310.deser.LocalDateTimeDeserializer;
import com.fasterxml.jackson.datatype.jsr310.deser.LocalTimeDeserializer;
import com.fasterxml.jackson.datatype.jsr310.ser.LocalDateSerializer;
import com.fasterxml.jackson.datatype.jsr310.ser.LocalDateTimeSerializer;
import com.fasterxml.jackson.datatype.jsr310.ser.LocalTimeSerializer;
import java.time.LocalDate;
import java.time.LocalDateTime;
import java.time.LocalTime;
import java.time.format.DateTimeFormatter;
import java.util.Map;
/**
* JSON 转换器， Jackson 版实现
* JSON 转换器， Jackson 版实现
*
* @author click33
* @since 1.34.0
*/
public class SaJsonTemplateForJackson implements SaJsonTemplate {
public static final String DATE_TIME_PATTERN = "yyyy-MM-dd HH:mm:ss";
public static final String DATE_PATTERN = "yyyy-MM-dd";
public static final String TIME_PATTERN = "HH:mm:ss";
public static final DateTimeFormatter DATE_TIME_FORMATTER = DateTimeFormatter.ofPattern(DATE_TIME_PATTERN);
public static final DateTimeFormatter DATE_FORMATTER = DateTimeFormatter.ofPattern(DATE_PATTERN);
public static final DateTimeFormatter TIME_FORMATTER = DateTimeFormatter.ofPattern(TIME_PATTERN);
/**
* 底层 Mapper 对象
*/
@ -63,6 +81,25 @@ public class SaJsonTemplateForJackson implements SaJsonTemplate {
// 2、使空 bean 在序列化时也能记录类型信息，而不是只序列化成 {}
objectMapper.configure(SerializationFeature.FAIL_ON_EMPTY_BEANS, false);
// 3、配置 [ 忽略未知字段 ]
this.objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
// 4、配置 [ 时间类型转换 ]
JavaTimeModule timeModule = new JavaTimeModule();
// LocalDateTime序列化与反序列化
timeModule.addSerializer(new LocalDateTimeSerializer(DATE_TIME_FORMATTER));
timeModule.addDeserializer(LocalDateTime.class, new LocalDateTimeDeserializer(DATE_TIME_FORMATTER));
// LocalDate序列化与反序列化
timeModule.addSerializer(new LocalDateSerializer(DATE_FORMATTER));
timeModule.addDeserializer(LocalDate.class, new LocalDateDeserializer(DATE_FORMATTER));
// LocalTime序列化与反序列化
timeModule.addSerializer(new LocalTimeSerializer(TIME_FORMATTER));
timeModule.addDeserializer(LocalTime.class, new LocalTimeDeserializer(TIME_FORMATTER));
//
this.objectMapper.registerModule(timeModule);
}
/**
@ -73,7 +110,7 @@ public class SaJsonTemplateForJackson implements SaJsonTemplate {
try {
return objectMapper.writeValueAsString(obj);
} catch (JsonProcessingException e) {
throw new SaJsonConvertException(e).setCode(SaSpringBootErrorCode.CODE_20103);
throw new SaJsonConvertException(e);
}
}
@ -89,7 +126,7 @@ public class SaJsonTemplateForJackson implements SaJsonTemplate {
Object value = objectMapper.readValue(jsonStr, Object.class);
return value;
} catch (JsonProcessingException e) {
throw new SaJsonConvertException(e).setCode(SaSpringBootErrorCode.CODE_20106);
throw new SaJsonConvertException(e);
}
}
@ -106,7 +143,7 @@ public class SaJsonTemplateForJackson implements SaJsonTemplate {
Map<String, Object> map = objectMapper.readValue(jsonStr, Map.class);
return map;
} catch (JsonProcessingException e) {
throw new SaJsonConvertException(e).setCode(SaSpringBootErrorCode.CODE_20104);
throw new SaJsonConvertException(e);
}
}

35
sa-token-plugin/sa-token-jackson/src/main/java/cn/dev33/satoken/plugin/impl/SaTokenPluginForJackson.java Normal file
View File

@ -0,0 +1,35 @@
/*
* 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.plugin.impl;
import cn.dev33.satoken.SaManager;
import cn.dev33.satoken.dao.SaJsonTemplateForJackson;
import cn.dev33.satoken.plugin.SaTokenPlugin;
/**
* SaToken 插件：JSON 转换器安装
*
* @author click33
* @since 1.41.0
*/
public class SaTokenPluginForJackson implements SaTokenPlugin {
@Override
public void setup() {
SaManager.setSaJsonTemplate(new SaJsonTemplateForJackson());
}
}

1
sa-token-plugin/sa-token-jackson/src/main/resources/META-INF/services/cn.dev33.satoken.plugin.SaTokenPlugin Normal file
View File

@ -0,0 +1 @@
cn.dev33.satoken.plugin.impl.SaTokenPluginForJackson

91
sa-token-plugin/sa-token-redis-jackson/src/main/java/cn/dev33/satoken/dao/SaTokenDaoRedisJackson.java
View File

@ -17,28 +17,11 @@ package cn.dev33.satoken.dao;
import cn.dev33.satoken.strategy.SaStrategy;
import cn.dev33.satoken.util.SaFoxUtil;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
import com.fasterxml.jackson.datatype.jsr310.deser.LocalDateDeserializer;
import com.fasterxml.jackson.datatype.jsr310.deser.LocalDateTimeDeserializer;
import com.fasterxml.jackson.datatype.jsr310.deser.LocalTimeDeserializer;
import com.fasterxml.jackson.datatype.jsr310.ser.LocalDateSerializer;
import com.fasterxml.jackson.datatype.jsr310.ser.LocalDateTimeSerializer;
import com.fasterxml.jackson.datatype.jsr310.ser.LocalTimeSerializer;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.redis.connection.RedisConnectionFactory;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.data.redis.core.StringRedisTemplate;
import org.springframework.data.redis.serializer.GenericJackson2JsonRedisSerializer;
import org.springframework.data.redis.serializer.StringRedisSerializer;
import org.springframework.stereotype.Component;
import java.lang.reflect.Field;
import java.time.LocalDate;
import java.time.LocalDateTime;
import java.time.LocalTime;
import java.time.format.DateTimeFormatter;
import java.util.ArrayList;
import java.util.List;
import java.util.Set;
@ -53,35 +36,11 @@ import java.util.concurrent.TimeUnit;
@Component
public class SaTokenDaoRedisJackson implements SaTokenDao {
public static final String DATE_TIME_PATTERN = "yyyy-MM-dd HH:mm:ss";
public static final String DATE_PATTERN = "yyyy-MM-dd";
public static final String TIME_PATTERN = "HH:mm:ss";
public static final DateTimeFormatter DATE_TIME_FORMATTER = DateTimeFormatter.ofPattern(DATE_TIME_PATTERN);
public static final DateTimeFormatter DATE_FORMATTER = DateTimeFormatter.ofPattern(DATE_PATTERN);
public static final DateTimeFormatter TIME_FORMATTER = DateTimeFormatter.ofPattern(TIME_PATTERN);
/**
* ObjectMapper 对象 (以 public 作用域暴露出此对象，方便开发者二次更改配置)
*
* <p> 例如：
* <pre>
* SaTokenDaoRedisJackson redisJackson = (SaTokenDaoRedisJackson) SaManager.getSaTokenDao();
* redisJackson.objectMapper.xxx = xxx;
* </pre>
* </p>
*/
public ObjectMapper objectMapper;
/**
* String 读写专用
*/
public StringRedisTemplate stringRedisTemplate;
/**
* Object 读写专用
*/
public RedisTemplate<String, Object> objectRedisTemplate;
/**
* 标记：是否已初始化成功
*/
@ -93,59 +52,15 @@ public class SaTokenDaoRedisJackson implements SaTokenDao {
if(this.isInit) {
return;
}
// 指定相应的序列化方案
StringRedisSerializer keySerializer = new StringRedisSerializer();
GenericJackson2JsonRedisSerializer valueSerializer = new GenericJackson2JsonRedisSerializer();
// 通过反射获取Mapper对象, 增加一些配置, 增强兼容性
try {
Field field = GenericJackson2JsonRedisSerializer.class.getDeclaredField("mapper");
field.setAccessible(true);
this.objectMapper = (ObjectMapper) field.get(valueSerializer);
// 配置[忽略未知字段]
this.objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
// 配置[时间类型转换]
JavaTimeModule timeModule = new JavaTimeModule();
// LocalDateTime序列化与反序列化
timeModule.addSerializer(new LocalDateTimeSerializer(DATE_TIME_FORMATTER));
timeModule.addDeserializer(LocalDateTime.class, new LocalDateTimeDeserializer(DATE_TIME_FORMATTER));
// LocalDate序列化与反序列化
timeModule.addSerializer(new LocalDateSerializer(DATE_FORMATTER));
timeModule.addDeserializer(LocalDate.class, new LocalDateDeserializer(DATE_FORMATTER));
// LocalTime序列化与反序列化
timeModule.addSerializer(new LocalTimeSerializer(TIME_FORMATTER));
timeModule.addDeserializer(LocalTime.class, new LocalTimeDeserializer(TIME_FORMATTER));
this.objectMapper.registerModule(timeModule);
// 重写 SaSession 生成策略
SaStrategy.instance.createSession = (sessionId) -> new SaSessionForJacksonCustomized(sessionId);
} catch (Exception e) {
System.err.println(e.getMessage());
}
// 构建StringRedisTemplate
StringRedisTemplate stringTemplate = new StringRedisTemplate();
stringTemplate.setConnectionFactory(connectionFactory);
stringTemplate.afterPropertiesSet();
// 构建RedisTemplate
RedisTemplate<String, Object> template = new RedisTemplate<>();
template.setConnectionFactory(connectionFactory);
template.setKeySerializer(keySerializer);
template.setHashKeySerializer(keySerializer);
template.setValueSerializer(valueSerializer);
template.setHashValueSerializer(valueSerializer);
template.afterPropertiesSet();
// 开始初始化相关组件
this.stringRedisTemplate = stringTemplate;
this.objectRedisTemplate = template;
// 重写 SaSession 生成策略
SaStrategy.instance.createSession = (sessionId) -> new SaSessionForJacksonCustomized(sessionId);
// 打上标记，表示已经初始化成功，后续无需再重新初始化
this.isInit = true;

0
sa-token-plugin/sa-token-redis-jackson/src/main/resources/META-INF/services/cn.dev33.satoken.plugin.SaTokenPlugin Normal file
View File

22
sa-token-starter/sa-token-spring-boot-autoconfig/src/main/java/cn/dev33/satoken/spring/SaBeanRegister.java
View File

@ -16,10 +16,7 @@
package cn.dev33.satoken.spring;
import cn.dev33.satoken.config.SaTokenConfig;
import cn.dev33.satoken.json.SaJsonTemplate;
import cn.dev33.satoken.json.SaJsonTemplateDefaultImpl;
import cn.dev33.satoken.spring.context.path.ApplicationContextPathLoading;
import cn.dev33.satoken.spring.json.SaJsonTemplateForJackson;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Bean;
@ -41,25 +38,6 @@ public class SaBeanRegister {
public SaTokenConfig getSaTokenConfig() {
return new SaTokenConfig();
}
/**
* 获取 json 转换器 Bean (Jackson版)
*
* @return json 转换器 Bean (Jackson版)
*/
@Bean
public SaJsonTemplate getSaJsonTemplateForJackson() {
try {
// 部分开发者会在 springboot 项目中排除 jackson 依赖，所以这里做一个判断：
// 1、如果项目中存在 jackson 依赖，则使用 jackson 的 json 转换器
// 2、如果项目中不存在 jackson 依赖，则使用默认的 json 转换器
// to：防止因为 jackson 依赖问题导致项目无法启动
Class.forName("com.fasterxml.jackson.databind.ObjectMapper");
return new SaJsonTemplateForJackson();
} catch (ClassNotFoundException e) {
return new SaJsonTemplateDefaultImpl();
}
}
/**
* 应用上下文路径加载器