feat: 新增 SaToken 自动配置(认证模块)

This commit is contained in:
2023-11-25 16:59:50 +08:00
parent d4cc1dfc5b
commit b147f6189b
7 changed files with 245 additions and 0 deletions

View File

@@ -0,0 +1,31 @@
<?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/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>top.charles7c.continew</groupId>
<artifactId>continew-starter-auth</artifactId>
<version>${revision}</version>
</parent>
<artifactId>continew-starter-auth-satoken</artifactId>
<packaging>jar</packaging>
<name>${project.artifactId}</name>
<description>ContiNew Starter 认证模块 - SaToken</description>
<dependencies>
<!-- Sa-Token轻量级 Java 权限认证框架,让鉴权变得简单、优雅) -->
<dependency>
<groupId>cn.dev33</groupId>
<artifactId>sa-token-spring-boot3-starter</artifactId>
</dependency>
<!-- Sa-Token 整合 JWT -->
<dependency>
<groupId>cn.dev33</groupId>
<artifactId>sa-token-jwt</artifactId>
</dependency>
</dependencies>
</project>

View File

@@ -0,0 +1,89 @@
/*
* Copyright (c) 2022-present Charles7c Authors. All Rights Reserved.
* <p>
* Licensed under the GNU LESSER GENERAL PUBLIC LICENSE 3.0;
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* <p>
* http://www.gnu.org/licenses/lgpl.html
* <p>
* 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 top.charles7c.continew.starter.auth.satoken.autoconfigure;
import cn.dev33.satoken.dao.SaTokenDao;
import cn.dev33.satoken.interceptor.SaInterceptor;
import cn.dev33.satoken.jwt.StpLogicJwtForSimple;
import cn.dev33.satoken.stp.StpInterface;
import cn.dev33.satoken.stp.StpLogic;
import cn.dev33.satoken.stp.StpUtil;
import cn.hutool.core.util.ReflectUtil;
import jakarta.annotation.PostConstruct;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.boot.autoconfigure.AutoConfiguration;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
/**
* Sa-Token 自动配置
*
* @author Charles7c
* @since 1.0.0
*/
@Slf4j
@AutoConfiguration
@RequiredArgsConstructor
@EnableConfigurationProperties(SaTokenExtensionProperties.class)
@ConditionalOnProperty(prefix = "sa-token.extension", name = "enabled", havingValue = "true")
public class SaTokenAutoConfiguration implements WebMvcConfigurer {
private final SaTokenExtensionProperties properties;
@Override
public void addInterceptors(InterceptorRegistry registry) {
// 注册 Sa-Token 拦截器,校验规则为 StpUtil.checkLogin() 登录校验
registry.addInterceptor(new SaInterceptor(handle -> StpUtil.checkLogin())).addPathPatterns("/**")
.excludePathPatterns(properties.getSecurity().getExcludes());
}
/**
* 整合 JWT简单模式
*/
@Bean
public StpLogic stpLogic() {
return new StpLogicJwtForSimple();
}
/**
* 自定义缓存实现
*/
@Bean
@ConditionalOnMissingBean
public SaTokenDao saTokenDao() {
return ReflectUtil.newInstance(properties.getDaoImpl());
}
/**
* 权限认证实现
*/
@Bean
@ConditionalOnMissingBean
public StpInterface stpInterface() {
return ReflectUtil.newInstance(properties.getPermissionImpl());
}
@PostConstruct
public void postConstruct() {
log.info("[ContiNew Starter] - Auto Configuration 'SaToken' completed initialization.");
}
}

View File

@@ -0,0 +1,66 @@
/*
* Copyright (c) 2022-present Charles7c Authors. All Rights Reserved.
* <p>
* Licensed under the GNU LESSER GENERAL PUBLIC LICENSE 3.0;
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* <p>
* http://www.gnu.org/licenses/lgpl.html
* <p>
* 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 top.charles7c.continew.starter.auth.satoken.autoconfigure;
import cn.dev33.satoken.dao.SaTokenDao;
import cn.dev33.satoken.stp.StpInterface;
import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
/**
* SaToken 扩展配置属性
*
* @author Charles7c
* @since 1.0.0
*/
@Data
@ConfigurationProperties(prefix = "sa-token.extension")
public class SaTokenExtensionProperties {
/**
* 是否启用扩展
*/
private boolean enabled = false;
/**
* 自定义缓存实现
*/
private Class<? extends SaTokenDao> daoImpl;
/**
* 权限认证实现
*/
private Class<? extends StpInterface> permissionImpl;
/**
* 安全配置
*/
private SecurityProperties security;
/**
* 安全配置属性
*/
@Data
public static class SecurityProperties {
/**
* 排除(放行)路径配置
*/
private String[] excludes = new String[0];
}
}

View File

@@ -0,0 +1 @@
top.charles7c.continew.starter.auth.satoken.autoconfigure.SaTokenAutoConfiguration