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注解实现鉴权内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Java读取文件方法汇总

    Java读取文件方法汇总

    这篇文章主要为大家详细介绍了Java读取文件方法,按字节读取文件内容、按字符读取文件内容、随机读取文件内容等,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2016-12-12
  • Java+MySQL实现学生信息管理系统源码

    Java+MySQL实现学生信息管理系统源码

    这篇文章主要为大家详细介绍了Java+MySQL实现学生信息管理系统,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-11-11
  • Spring Boot实战之逐行释义Hello World程序

    Spring Boot实战之逐行释义Hello World程序

    spring boot 是基于Spring的一个框架,Spring boot帮我们集成很多常用的功能,使得整个配置更加简单。这篇文章主要介绍了Spring Boot实战之逐行释义Hello World,需要的朋友可以参考下
    2017-12-12
  • Java RabbitMQ的三种Exchange模式

    Java RabbitMQ的三种Exchange模式

    这篇文章主要介绍了Java RabbitMQ的三种Exchange模式,分别为Direct模式、Fanout模式、Topic模式,Rabbit的Direct Exchange模式是指消息发送导RouteKey中指定的Queue,Direct模式可以使用Rabbit自带的Exchange
    2022-08-08
  • 关于Java中的 JSP 详解

    关于Java中的 JSP 详解

    JSP 代表 Java 服务器页面。它是一种在应用服务器端使用的编程工具。JSP 基本上用于支持平台–独立和动态的方法来构建 Web 依赖的应用程序。JSP 页面类似于 ASP 页面,因为它们是在服务器上编译的,而不是在用户的 Web 浏览器上进行编译。下面来看看文章的详细介绍内容
    2021-11-11
  • springboot 通过代码自动生成pid的方法

    springboot 通过代码自动生成pid的方法

    这篇文章主要介绍了springboot 通过代码自动生成pid的方法,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-07-07
  • java定时任务cron表达式每周执行一次的坑及解决

    java定时任务cron表达式每周执行一次的坑及解决

    这篇文章主要介绍了java定时任务cron表达式每周执行一次的坑及解决,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-06-06
  • Maven3种打包方式中maven-assembly-plugin的使用详解

    Maven3种打包方式中maven-assembly-plugin的使用详解

    这篇文章主要介绍了Maven3种打包方式中maven-assembly-plugin的使用,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-07-07
  • nacos配置中心持久化相关配置方式

    nacos配置中心持久化相关配置方式

    这篇文章主要介绍了nacos配置中心持久化相关配置方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-11-11
  • mybatis plus 关联数据库排除不必要字段方式

    mybatis plus 关联数据库排除不必要字段方式

    这篇文章主要介绍了mybatis plus 关联数据库排除不必要字段方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-03-03

最新评论