com.zznote.basecommon.common.config.satoken.SaTokenConfigure Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of baserole-common Show documentation
快速开发工具包
The newest version!
package com.zznote.basecommon.common.config.satoken;

import cn.dev33.satoken.context.SaHolder;
import cn.dev33.satoken.filter.SaServletFilter;
import cn.dev33.satoken.interceptor.SaAnnotationInterceptor;
import cn.dev33.satoken.jwt.StpLogicJwtForStyle;
import cn.dev33.satoken.router.SaRouter;
import cn.dev33.satoken.stp.StpLogic;
import cn.dev33.satoken.stp.StpUtil;
import cn.dev33.satoken.util.SaResult;
import com.zznote.basecommon.common.constant.HttpStatus;
import lombok.extern.slf4j.Slf4j;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

/**
 * 注解拦截器
 *
 * @Author: zhangzhen
 * @date 2022/2/15
 */
@Configuration
@Slf4j
public class SaTokenConfigure implements WebMvcConfigurer {

	// 注册Sa-Token的注解拦截器，打开注解式鉴权功能
    // 在高版本 SpringBoot (≥2.6.x) 版本下，需要额外添加 @EnableWebMvc 注解才可以使注册拦截器生效。
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        // 注册注解拦截器，并排除不需要注解鉴权的接口地址 (与登录拦截器无关)
        registry.addInterceptor(new SaAnnotationInterceptor()).addPathPatterns("/**");
    }

    /**
     * 注册 [Sa-Token全局过滤器]
     */
    @Bean
    public SaServletFilter getSaServletFilter(IgnoreWhiteProperties ignoreWhite) {
        return new SaServletFilter()
                // 拦截地址
                .addInclude("/**")
                // 开放地址
                .setExcludeList(ignoreWhite.getWhites())
                .addExclude("/favicon.ico", "/actuator/**")
                // 鉴权方法：每次访问进入
                .setAuth(obj -> {
                    // 登录校验 -- 拦截所有路由
                    SaRouter.match("/**", r -> {
                        // 检查是否登录 是否有token
                        StpUtil.checkLogin();
                    });
                }).setError(e -> SaResult.error("认证失败，无法访问系统资源").setCode(HttpStatus.UNAUTHORIZED))

            // 前置函数：在每次认证函数之前执行
            .setBeforeAuth(r -> {
                // ---------- 设置一些安全响应头 ----------
                SaHolder.getResponse()
                        // 服务器名称
                        .setServer("sa-server")
                        // 是否可以在iframe显示视图： DENY=不可以 | SAMEORIGIN=同域下可以 | ALLOW-FROM uri=指定域名下可以
                        .setHeader("X-Frame-Options", "SAMEORIGIN")
                        // 是否启用浏览器默认XSS防护： 0=禁用 | 1=启用 | 1; mode=block 启用, 并在检查到XSS攻击时，停止渲染页面
                        .setHeader("X-XSS-Protection", "1; mode=block")
                        // 禁用浏览器内容嗅探
                        .setHeader("X-Content-Type-Options", "nosniff");

                // ---------- 设置跨域响应头 ----------
//                SaHolder.getResponse()
//                        // 允许指定域访问跨域资源
//                        .setHeader("Access-Control-Allow-Origin", "*")
//                        // 允许所有请求方式
//                        .setHeader("Access-Control-Allow-Methods", "POST, GET, OPTIONS, DELETE")
//                        // 有效时间
//                        .setHeader("Access-Control-Max-Age", "3600")
//                        // 允许的header参数
//                        .setHeader("Access-Control-Allow-Headers", "*");
            });
    }

    // Sa-Token 整合 jwt (Style模式)
    @Bean
    public StpLogic getStpLogicJwt() {
        return new StpLogicJwtForStyle();
    }

}