springboot使用注解实现鉴权功能

 更新时间:2024年12月23日 11:01:57   作者:Gms89  
这篇文章主要介绍了springboot使用注解实现鉴权功能,本文通过实例代码给大家介绍的非常详细,感兴趣的朋友跟随小编一起看看吧

Spring Boot 使用注解和AOP实现鉴权功能

一、自定义注解

自定义一个注解,实现以下几个要求:

1、注解使用使用在方法上;

2、注解保留到运行时;

3、注解可以传入单个参数、多个参数或者不传参数

@Documented
@Target({ElementType.METHOD})  // 用在方法上
@Retention(RetentionPolicy.RUNTIME)  //注解保留到运行时
public @interface RoleType {
    String[] value() default {};
}

二、用户信息上下文

定义了一个名为 UserContext 的类,用于管理用户上下文信息。它使用 ThreadLocal 变量来存储每个线程独立的用户数据,包括用户名、角色列表和登录状态。

public class UserContext {
    private static final ThreadLocal<List<String>> role = new ThreadLocal<>();
    private static final ThreadLocal<String> username = new ThreadLocal<>();
    private static final ThreadLocal<Boolean> loginStatus = new ThreadLocal<>();
    public static boolean loginStatus() {
        return loginStatus.get();
    }
    public static void login() {
        UserContext.loginStatus.set(true);
    }
    public static void logout() {
        UserContext.loginStatus.set(false);
    }
    public static String getUsername() {
        return username.get();
    }
    public static void setUsername(String username) {
        UserContext.username.set(username);
    }
    public static void clearUsername() {
        username.remove();
    }
    public static List<String> getRole() {
        return role.get();
    }
    public static void setRole(List<String> role) {
        UserContext.role.set(role);
    }
    public static void setRole(String role) {
        UserContext.role.set(List.of(role));
    }
    public static void clearRole() {
        role.remove();
    }
}

三、设置用于拦截识别用户信息的过滤器

@Component
public class AuthFilter extends OncePerRequestFilter {
    @Override
    protected void doFilterInternal(HttpServletRequest request,
                                    HttpServletResponse response,
                                    FilterChain filterChain ) throws ServletException, IOException {
        //将用户信息写入上下文,可以从session或redis或者从关系型数据库获取用户信息及角色信息
        UserContext.setUsername(username);
        UserContext.setRole(roles);
        UserContext.login();
        filterChain.doFilter(request,response);
    }
}

四、使用AOP实现权限校验

使用Spring AOP(面向切面编程)实现的权限控制切面。使用注解的方法检查用户是否具有访问该方法所需的权限。

@Aspect
@Component
public class AuthAspect extends HttpServlet {
    @Pointcut("@annotation(RoleType)")
    public void annotatedMethod() {
    }
    //注解存在时,需要在登陆情况下v爱可以访问接口
    @Around("annotatedMethod()")
    public Object aroundAnnotatedMethod(ProceedingJoinPoint joinPoint) throws Throwable {
        //访问接口时需要的权限标识集合
        List<String> apiRole = Arrays.asList(AnnotationUtils.findAnnotation(((MethodSignature) joinPoint.getSignature()).getMethod(), RoleType.class).value());
        //用户拥有的权限标识集合
        List<String> userRole = UserContext.getRole();
        //注解存在,并且登陆情况下可以访问接口
        if (UserContext.loginStatus()){
            //如果任意接口标识中元素在用户权限标识中存在,则有权访问该接口
            if (apiRole.isEmpty() || apiRole.stream().anyMatch(userRole::contains)) {
                return joinPoint.proceed();
            } else {
                throw new MallException(403, "无权限访问!");
            }
        }else {
            throw new MallException(500,"请先登陆再访问!");
        }
    }
    //程序运行结束后清楚上下文
    @After("annotatedMethod()")
    public void afterAnnotatedMethod(JoinPoint joinPoint) {
        UserContext.clearRole();
        UserContext.clearUsername();
        UserContext.clearRole();
    }
}

六、注解的使用

1、无参数

使用注解情况下,必须登录情况下才可以访问

    @RoleType
    public String test(){
        return UserContext.getRole();
    }

2、一个参数

用户有role权限标识才可以访问该方法

    @RoleType("role")
    public String test(){
        return UserContext.getRole();
    }

3、多个参数

用户有role或test等任意一个权限标识才可以访问该方法

    @RoleType({"role","test",...})
    public String test(){
        return UserContext.getRole();
    }

到此这篇关于springboot使用注解实现鉴权功能的文章就介绍到这了,更多相关springbbot注解实现鉴权内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • MyBatis不同Mapper文件引用resultMap实例代码

    MyBatis不同Mapper文件引用resultMap实例代码

    这篇文章主要介绍了mybatis 不同Mapper文件引用resultMap的实例代码,非常不错具有参考借鉴价值,需要的朋友可以参考下
    2017-07-07
  • SpringBoot实现缓存与数据库双写策略的详细代码

    SpringBoot实现缓存与数据库双写策略的详细代码

    在SpringBoot企业开发中,为了提升系统性能,我们都会给高频查询接口加上缓存,把热点数据缓存起来,减少数据库查询压力,因此本文给大家介绍了SpringBoot实现缓存与数据库双写策略的详细方法,需要的朋友可以参考下
    2026-04-04
  • DolphinScheduler容错Master源码分析

    DolphinScheduler容错Master源码分析

    这篇文章主要为大家介绍了DolphinScheduler容错Master源码分析,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-02-02
  • Spring Security OAuth2.0登出的实现

    Spring Security OAuth2.0登出的实现

    本文主要介绍了Spring Security OAuth2.0登出的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2026-03-03
  • Java基础之命名规范的详解

    Java基础之命名规范的详解

    这篇文章主要介绍了Java基础之命名规范的详解,文中有非常详细的代码示例,对正在学习Java基础的小伙伴们有很好地帮助,需要的朋友可以参考下
    2021-05-05
  • Java如何优雅替换if-else语句

    Java如何优雅替换if-else语句

    当逻辑分支非常多的时候,if-else套了一层又一层,那么如何干掉过多的if-else,本文就详细的介绍一下,感兴趣的小伙伴们可以参考一下
    2021-08-08
  • Java数据结构之二叉搜索树详解

    Java数据结构之二叉搜索树详解

    二叉搜索树作为一个经典的数据结构,具有链表的快速插入与删除的特点,同时查询效率也很优秀,所以应用十分广泛。本文将详细讲讲二叉搜索树的原理与实现,需要的可以参考一下
    2022-06-06
  • java报错:javax.xml.bind.JAXBException: JAXB解决办法

    java报错:javax.xml.bind.JAXBException: JAXB解决办法

    这篇文章主要介绍了java报错:javax.xml.bind.JAXBException: JAXB的解决办法,文中通过示例提出多种解决方案,帮助开发者快速定位并解决问题,需要的朋友可以参考下
    2025-05-05
  • java web项目实现文件下载实例代码

    java web项目实现文件下载实例代码

    现在项目里面有个需求,需要把系统产生的日志文件给下载到本地 先获取所有的日志文件列表,显示到界面,选择一个日志文件,把文件名传到后台
    2013-09-09
  • EntityWrapper如何在and条件中嵌套or语句

    EntityWrapper如何在and条件中嵌套or语句

    这篇文章主要介绍了EntityWrapper如何在and条件中嵌套or语句,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-03-03

最新评论