Spring Security 优化鉴权注解：自定义鉴权注解的崭新征程

喜欢ヅ旅行 2024-04-16 04:33 17阅读 0赞

#### 文章目录 ####

*   *  1. 引言
     *  2. Spring Security基础
     *   *  2.1 Spring Security概述
         *  2.2 @PreAuthorize注解
     *  3. 自定义鉴权注解的优势
     *   *  3.1 业务语义更明确
         *  3.2 参数化鉴权更灵活
         *  3.3 可维护性更好
     *  4. 实现自定义鉴权注解
     *   *  4.1 创建自定义注解
         *  4.2 实现鉴权逻辑
         *  4.3 注册自定义注解和逻辑
         *  4.4 使用自定义注解
     *  5. 拓展：其他自定义鉴权注解场景
     *  6. 总结

![在这里插入图片描述][579a429daf314744b995f37351b46548.gif_pic_center]

> 🎉Spring Security 优化鉴权注解：自定义鉴权注解的崭新征程
> 
> --------------------
> 
>  *  ☆\* o(≧▽≦)o \*☆嗨~我是IT·陈寒🍹
>  *  ✨博客主页：[IT·陈寒的博客][IT]
>  *  🎈该系列文章专栏：[架构设计][Link 1]
>  *  📜其他专栏：[Java学习路线][Java] [Java面试技巧][Java 1] [Java实战项目][Java 2] [AIGC人工智能][AIGC] [数据结构学习][Link 2]
>  *  🍹文章作者技术和水平有限，如果文中出现错误，希望大家能指正🙏
>  *  📜 欢迎大家关注！ ❤️

--------------------

### 1. 引言 ###

在Spring Security中，鉴权是保障系统安全的关键环节之一。而Spring Security提供的`@PreAuthorize`注解是一种常见的鉴权方式，但在实际应用中，我们可能需要更灵活、可维护性更好的鉴权方案。本文将探讨如何通过自定义鉴权注解来优化Spring Security中的鉴权机制，使其更符合实际业务需求，提高代码的可读性和可维护性。![在这里插入图片描述][a638833d554243b2b753fd938a355ea5.png_pic_center]

### 2. Spring Security基础 ###

在深入研究自定义鉴权注解之前，让我们简要回顾一下Spring Security的基础概念和`@PreAuthorize`注解的使用。

#### 2.1 Spring Security概述 ####

Spring Security是一个功能强大且灵活的安全框架，用于保护Spring应用程序中的资源。它提供了身份验证（Authentication）和授权（Authorization）等安全性功能，可用于Web应用程序和非Web应用程序。

#### 2.2 @PreAuthorize注解 ####

`@PreAuthorize`是Spring Security提供的一个注解，用于在方法执行前进行权限验证。它的使用方式如下：

@PreAuthorize("hasRole('ROLE_ADMIN')")
    public void adminOperation() {
        
        // 执行需要管理员权限的操作
    }

上述代码表示只有拥有`ROLE_ADMIN`角色的用户才能执行`adminOperation`方法。虽然`@PreAuthorize`非常灵活，但在实际应用中，我们可能需要更直观、可维护性更好的鉴权方式。

### 3. 自定义鉴权注解的优势 ###

自定义鉴权注解是指根据业务需求，在Spring Security基础上创建符合具体场景的鉴权注解。相对于`@PreAuthorize`，自定义鉴权注解具有以下优势：

#### 3.1 业务语义更明确 ####

自定义鉴权注解可以根据业务场景命名，使得代码更符合业务语义，提高代码的可读性。例如，如果有一个业务场景是需要VIP用户才能访问，可以创建一个名为`@VipAccess`的自定义注解。

@VipAccess
    public void vipOperation() {
        
        // 执行需要VIP权限的操作
    }

#### 3.2 参数化鉴权更灵活 ####

通过自定义鉴权注解，我们可以实现参数化的鉴权，根据方法参数或其他上下文信息来动态决定是否具有权限。这在某些场景下比静态的`@PreAuthorize`更灵活。

@CustomPermission(role = "ROLE_USER", level = 3)
    public void customOperation() {
        
        // 执行需要特定权限级别的操作
    }

#### 3.3 可维护性更好 ####

将鉴权逻辑封装在自定义注解中，使得鉴权逻辑与业务逻辑分离，提高了代码的可维护性。当鉴权逻辑需要调整时，只需修改自定义注解的实现，而不影响业务逻辑。

### 4. 实现自定义鉴权注解 ###

接下来，让我们通过一个实际的例子来演示如何实现自定义鉴权注解。假设我们有一个场景，只有在特定时间段内才能执行某个操作，我们可以创建一个`@AccessDuringOfficeHours`注解。

#### 4.1 创建自定义注解 ####

import java.lang.annotation.ElementType;
    import java.lang.annotation.Retention;
    import java.lang.annotation.RetentionPolicy;
    import java.lang.annotation.Target;
    
    @Target({
        ElementType.METHOD, ElementType.TYPE})
    @Retention(RetentionPolicy.RUNTIME)
    public @interface AccessDuringOfficeHours {
        
    }

上述代码定义了一个名为`AccessDuringOfficeHours`的自定义注解，它可以用于方法和类上。

#### 4.2 实现鉴权逻辑 ####

import org.springframework.security.access.prepost.PreAuthorize;
    
    import java.lang.annotation.Annotation;
    import java.time.LocalTime;
    
    public class AccessDuringOfficeHoursSecurityExpressionRoot extends CustomSecurityExpressionRoot {
        
    
        public AccessDuringOfficeHoursSecurityExpressionRoot(Authentication authentication) {
        
            super(authentication);
        }
    
        public boolean hasAccessDuringOfficeHours() {
        
            LocalTime now = LocalTime.now();
            return now.isAfter(LocalTime.of(9, 0)) && now.isBefore(LocalTime.of(18, 0));
        }
    }

上述代码继承了`CustomSecurityExpressionRoot`，并实现了判断是否在办公时间内的逻辑。

#### 4.3 注册自定义注解和逻辑 ####

import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.security.access.expression.method.DefaultMethodSecurityExpressionHandler;
    import org.springframework.security.access.expression.method.MethodSecurityExpressionHandler;
    
    @Configuration
    public class SecurityConfig {
        
    
        @Autowired
        private CustomPermissionEvaluator customPermissionEvaluator;
    
        @Bean
        public MethodSecurityExpressionHandler methodSecurityExpressionHandler() {
        
            DefaultMethodSecurityExpressionHandler expressionHandler = new DefaultMethodSecurityExpressionHandler();
            expressionHandler.setPermissionEvaluator(customPermissionEvaluator);
            expressionHandler.setExpressionParser(new DefaultSpelExpressionParser());
            return expressionHandler;
        }
    }

上述代码通过`DefaultMethodSecurityExpressionHandler`注册了自定义的鉴权逻辑。

#### 4.4 使用自定义注解 ####

@AccessDuringOfficeHours
    public void officeHourOperation() {
        
        // 执行需要在办公时间内操作的逻辑
    }

上述代码表示`officeHourOperation`方法只有在办公时间内才能执行。

### 5. 拓展：其他自定义鉴权注解场景 ###

通过上述例子，我们可以看到自定义鉴权注解的强大之处。除了上文提到的场景，还有很多其他可能需要自定义鉴权注解的情况，比如：

*  **特定用户组访问：** 创建一个`@UserGroupAccess`注解，只有属于特定用户组的用户才能访问。
 *  **特定请求来源：** 创建一个`@ValidRequestSource`注解，只有来自合法请求来源的请求才能通过。
 *  **过期访问：** 创建一个`@AccessExpired`注解，只有在特定时间段之前或之后的请求才能通过。

通过这些自定义注解，我们能够更加直观地表达业务需求，使得代码更清晰，更容易维护。

### 6. 总结 ###

通过本文的介绍，我们深入探讨了Spring Security中鉴权注解的优化方案，通过自定义鉴权注解实现了更灵活、更具语义化的鉴权方式。通过这种方式，我们能够更好地适应实际业务需求，提高代码的可读性和可维护性。在实际项目中，根据具体业务场景，我们可以创建更多自定义的鉴权注解，从而更好地满足系统安全性的要求。希望通过本文的介绍，读者对Spring Security中自定义鉴权注解的使用有更深入的了解。

--------------------

> 🧸结尾 ❤️ 感谢您的支持和鼓励！ 😊🙏  
> 📜您可能感兴趣的内容：
> 
>  *  【[Java面试技巧][Java 1]】[Java面试八股文 - 掌握面试必备知识（目录篇）][Java_ -]
>  *  【[Java学习路线][Java]】[2023年完整版Java学习路线图][2023_Java]
>  *  【[AIGC人工智能][AIGC]】[Chat GPT是什么，初学者怎么使用Chat GPT，需要注意些什么][Chat GPT_Chat GPT]
>  *  【[Java实战项目][Java 2]】[SpringBoot+SSM实战：打造高效便捷的企业级Java外卖订购系统][SpringBoot_SSM_Java]
>  *  【[数据结构学习][Link 2]】[从零起步：学习数据结构的完整路径][Link 3]
> 
> > ![在这里插入图片描述][d7565cfc032647bfb69e7971731a06a2.gif_pic_center]

[579a429daf314744b995f37351b46548.gif_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/e0e79addaca548aa904b588a72b032ba.gif
[IT]: https://blog.csdn.net/qq_43546721?type=blog
[Link 1]: https://blog.csdn.net/qq_43546721/category_12435443.html?spm=1001.2014.3001.5482
[Java]: https://blog.csdn.net/qq_43546721/category_12367981.html
[Java 1]: https://blog.csdn.net/qq_43546721/category_12384780.html?spm=1001.2014.3001.5482
[Java 2]: https://blog.csdn.net/qq_43546721/category_12378614.html?spm=1001.2014.3001.5482
[AIGC]: https://blog.csdn.net/qq_43546721/category_12369819.html?spm=1001.2014.3001.5482
[Link 2]: https://blog.csdn.net/qq_43546721/category_12417284.html?spm=1001.2014.3001.5482
[a638833d554243b2b753fd938a355ea5.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/e3b4f5e080a149a99623ef06b167541c.png
[Java_ -]: https://blog.csdn.net/qq_43546721/article/details/131832856
[2023_Java]: https://blog.csdn.net/qq_43546721/article/details/131550605
[Chat GPT_Chat GPT]: https://blog.csdn.net/qq_43546721/article/details/131866932
[SpringBoot_SSM_Java]: https://blog.csdn.net/qq_43546721/article/details/132119791
[Link 3]: https://blog.csdn.net/qq_43546721/article/details/132404477
[d7565cfc032647bfb69e7971731a06a2.gif_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/36033004a9304b80aaca7b3860f67d18.gif