springboot使用注解實(shí)現(xiàn)鑒權(quán)功能

更新時(shí)間：2024年12月23日 11:01:57 作者：Gms89

這篇文章主要介紹了springboot使用注解實(shí)現(xiàn)鑒權(quán)功能,本文通過(guò)實(shí)例代碼給大家介紹的非常詳細(xì),感興趣的朋友跟隨小編一起看看吧

Spring Boot 使用注解和AOP實(shí)現(xiàn)鑒權(quán)功能

一、自定義注解

自定義一個(gè)注解，實(shí)現(xiàn)以下幾個(gè)要求：

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

2、注解保留到運(yùn)行時(shí)；

3、注解可以傳入單個(gè)參數(shù)、多個(gè)參數(shù)或者不傳參數(shù)

@Documented
@Target({ElementType.METHOD})  // 用在方法上
@Retention(RetentionPolicy.RUNTIME)  //注解保留到運(yùn)行時(shí)
public @interface RoleType {
    String[] value() default {};
}

二、用戶信息上下文

定義了一個(gè)名為 UserContext 的類，用于管理用戶上下文信息。它使用 ThreadLocal 變量來(lái)存儲(chǔ)每個(gè)線程獨(dú)立的用戶數(shù)據(jù)，包括用戶名、角色列表和登錄狀態(tài)。

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();
    }
}

三、設(shè)置用于攔截識(shí)別用戶信息的過(guò)濾器

@Component
public class AuthFilter extends OncePerRequestFilter {
    @Override
    protected void doFilterInternal(HttpServletRequest request,
                                    HttpServletResponse response,
                                    FilterChain filterChain ) throws ServletException, IOException {
        //將用戶信息寫入上下文，可以從session或redis或者從關(guān)系型數(shù)據(jù)庫(kù)獲取用戶信息及角色信息
        UserContext.setUsername(username);
        UserContext.setRole(roles);
        UserContext.login();
        filterChain.doFilter(request,response);
    }
}

四、使用AOP實(shí)現(xiàn)權(quán)限校驗(yàn)

使用Spring AOP（面向切面編程）實(shí)現(xiàn)的權(quán)限控制切面。使用注解的方法檢查用戶是否具有訪問(wèn)該方法所需的權(quán)限。

@Aspect
@Component
public class AuthAspect extends HttpServlet {
    @Pointcut("@annotation(RoleType)")
    public void annotatedMethod() {
    }
    //注解存在時(shí)，需要在登陸情況下v愛可以訪問(wèn)接口
    @Around("annotatedMethod()")
    public Object aroundAnnotatedMethod(ProceedingJoinPoint joinPoint) throws Throwable {
        //訪問(wèn)接口時(shí)需要的權(quán)限標(biāo)識(shí)集合
        List<String> apiRole = Arrays.asList(AnnotationUtils.findAnnotation(((MethodSignature) joinPoint.getSignature()).getMethod(), RoleType.class).value());
        //用戶擁有的權(quán)限標(biāo)識(shí)集合
        List<String> userRole = UserContext.getRole();
        //注解存在，并且登陸情況下可以訪問(wèn)接口
        if (UserContext.loginStatus()){
            //如果任意接口標(biāo)識(shí)中元素在用戶權(quán)限標(biāo)識(shí)中存在，則有權(quán)訪問(wèn)該接口
            if (apiRole.isEmpty() || apiRole.stream().anyMatch(userRole::contains)) {
                return joinPoint.proceed();
            } else {
                throw new MallException(403, "無(wú)權(quán)限訪問(wèn)！");
            }
        }else {
            throw new MallException(500,"請(qǐng)先登陸再訪問(wèn)！");
        }
    }
    //程序運(yùn)行結(jié)束后清楚上下文
    @After("annotatedMethod()")
    public void afterAnnotatedMethod(JoinPoint joinPoint) {
        UserContext.clearRole();
        UserContext.clearUsername();
        UserContext.clearRole();
    }
}

六、注解的使用

1、無(wú)參數(shù)

使用注解情況下，必須登錄情況下才可以訪問(wèn)

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

2、一個(gè)參數(shù)

用戶有role權(quán)限標(biāo)識(shí)才可以訪問(wèn)該方法

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

3、多個(gè)參數(shù)

用戶有role或test等任意一個(gè)權(quán)限標(biāo)識(shí)才可以訪問(wèn)該方法

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

到此這篇關(guān)于springboot使用注解實(shí)現(xiàn)鑒權(quán)功能的文章就介紹到這了,更多相關(guān)springbbot注解實(shí)現(xiàn)鑒權(quán)內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: