说一下Spring Security中@PermitAll和@PreAuthorize的使用

本文主要来自于看Java开源项目,方便理解开源项目的代码是怎么实现的,加深自己的基本功。

一、@PermitAll注解

这个是Spring Security框架中带有的一个注解,一般写在接口方法上,表示这个接口所有人都可以访问

例如

	@PostMapping("/login")
    @PermitAll
    public CommonResult<xxx> login(@RequestBody User user) {
        ...
    }

然后客户端在发送http请求的时候就带有@PermitAll的所有接口都设置成permitAll()方法
这里先写一个获取所有接口中带有@PermitAll的方法

private Multimap<HttpMethod, String> getPermitAllUrlsFromAnnotations() {
        Multimap<HttpMethod, String> result = HashMultimap.create();
        // 获得接口对应的 HandlerMethod 集合
        RequestMappingHandlerMapping requestMappingHandlerMapping = (RequestMappingHandlerMapping)
                applicationContext.getBean("requestMappingHandlerMapping");
        Map<RequestMappingInfo, HandlerMethod> handlerMethodMap = requestMappingHandlerMapping.getHandlerMethods();
        // 获得有 @PermitAll 注解的接口
        for (Map.Entry<RequestMappingInfo, HandlerMethod> entry : handlerMethodMap.entrySet()) {
            HandlerMethod handlerMethod = entry.getValue();
            if (!handlerMethod.hasMethodAnnotation(PermitAll.class)) {
                continue;
            }
            if (entry.getKey().getPatternsCondition() == null) {
                continue;
            }
            Set<String> urls = entry.getKey().getPatternsCondition().getPatterns();
            // 根据请求方法,添加到 result 结果
            entry.getKey().getMethodsCondition().getMethods().forEach(requestMethod -> {
                switch (requestMethod) {
                    case GET:
                        result.putAll(HttpMethod.GET, urls);
                        break;
                    case POST:
                        result.putAll(HttpMethod.POST, urls);
                        break;
                    case PUT:
                        result.putAll(HttpMethod.PUT, urls);
                        break;
                    case DELETE:
                        result.putAll(HttpMethod.DELETE, urls);
                        break;
                }
            });
        }
        return result;
    }

http请求到来的时候将这些接口都设置成permitAll()方法

@Bean
protected SecurityFilterChain filterChain(HttpSecurity httpSecurity) throws Exception {
        // 登出
        httpSecurity
        // 获得 @PermitAll 带来的 URL 列表,免登录
        Multimap<HttpMethod, String> permitAllUrls = getPermitAllUrlsFromAnnotations();
        // 设置每个请求的权限
        httpSecurity
                //  设置 @PermitAll 无需认证
                .antMatchers(HttpMethod.GET, permitAllUrls.get(HttpMethod.GET).toArray(new String[0])).permitAll()
                .antMatchers(HttpMethod.POST, permitAllUrls.get(HttpMethod.POST).toArray(new String[0])).permitAll()
                .antMatchers(HttpMethod.PUT, permitAllUrls.get(HttpMethod.PUT).toArray(new String[0])).permitAll()
                .antMatchers(HttpMethod.DELETE, permitAllUrls.get(HttpMethod.DELETE).toArray(new String[0])).permitAll()
               // 兜底规则,必须认证
                .authorizeRequests()
                .anyRequest().authenticated()
        ;
        return httpSecurity.build();
    }

这些接口都不设置任何权限,当然这是个Bean方法,还需要使用@Configuration将这个方法的类注入容器,这里就不写了

二、@PreAuthorize 注解

在开源项目中但凡使用了Spring Security框架的总会在部分接口上看到这个方法
比如

 	@PostMapping("/create")
    @Operation(summary = "新增用户")
    @PreAuthorize("@ss.hasPermission('system:user:create')")
    public CommonResult<Long> createUser(@Valid @RequestBody UserCreateReqVO reqVO) {
        Long id = userService.createUser(reqVO);
        return success(id);
    }

很明显这是个创建用户的接口,我们都能看出这个注解的大致意思,就是判断登录的人是否有添加权限
下面来详细说明一下@ss.hasPermission(‘system:user:create’)是什么意思,怎么用的
首先,@PreAuthorize是 Spring Security 内置的前置权限注解,添加在接口方法上,声明需要的权限,实现访问权限的控制。
实现原理:

当 @PreAuthorize 注解里的 Spring EL 表达式返回 false 时,表示没有权限。
而 @PreAuthorize(“@ss.hasPermission(‘system:user:create’)”) 表示调用 Bean 名字为 ss 的 hasPermission(…) 方法,方法参数为"system:user:create" 字符串。

所以你只需要找到在哪儿创建的Bean,并且Bean的名字是ss,就知道这个方法到底是怎么实现的了
在这里插入图片描述
果然

以下是在Spring Boot项目使用Spring Security的示例代码: 1. 添加依赖项: 在Maven构建文件添加以下依赖项: ``` <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-security</artifactId> </dependency> ``` 2. 创建Security配置类: 创建一个类来配置Spring Security,该类需要继承WebSecurityConfigurerAdapter类。以下是一个简单的示例: ``` @Configuration @EnableWebSecurity public class SecurityConfig extends WebSecurityConfigurerAdapter { @Autowired private UserDetailsService userDetailsService; @Autowired public void configureGlobal(AuthenticationManagerBuilder auth) throws Exception { auth.userDetailsService(userDetailsService); } @Override protected void configure(HttpSecurity http) throws Exception { http .authorizeRequests() .antMatchers("/admin/**").hasRole("ADMIN") .antMatchers("/user/**").hasAnyRole("ADMIN", "USER") .anyRequest().authenticated() .and() .formLogin() .loginPage("/login") .permitAll() .and() .logout() .permitAll(); } } ``` 在上面的配置,我们指定了哪些URL需要保护,并定义了用户身份验证方式。具体来: - configureGlobal方法用于配置用户存储,我们使用了一个实现了UserDetailsService接口的类来加载用户信息。 - configure方法用于配置访问控制和身份验证方式。我们使用了一个基于角色的访问控制策略,指定了哪些URL需要哪些角色。我们还配置了登录页面和注销功能。 3. 配置用户存储: 我们可以使用内存,数据库或LDAP等不同类型的存储来存储用户及其角色信息。以下是一个使用内存存储的示例: ``` @Service public class UserDetailsServiceImpl implements UserDetailsService { private Map<String, UserDetails> users = new HashMap<>(); public UserDetailsServiceImpl() { User admin = new User("admin", "{noop}admin123", AuthorityUtils.createAuthorityList("ROLE_ADMIN")); User user = new User("user", "{noop}user123", AuthorityUtils.createAuthorityList("ROLE_USER")); users.put(admin.getUsername(), admin); users.put(user.getUsername(), user); } @Override public UserDetails loadUserByUsername(String username) throws UsernameNotFoundException { UserDetails user = users.get(username); if (user == null) { throw new UsernameNotFoundException("User not found: " + username); } return user; } } ``` 在上述示例,我们创建了两个用户,一个是管理员,一个是普通用户。我们使用了NoOpPasswordEncoder来存储用户密码。在实际项目,建议使用更安全的PasswordEncoder。 4. 配置登录和注销: 在Security配置类,我们可以通过配置登录和注销URL,以及相关的身份验证和授权逻辑,来实现用户登录和注销功能。以下是一个简单的示例: ``` @Controller public class LoginController { @GetMapping("/login") public String login() { return "login"; } @GetMapping("/logout") public String logout(HttpServletRequest request, HttpServletResponse response) { Authentication auth = SecurityContextHolder.getContext().getAuthentication(); if (auth != null) { new SecurityContextLogoutHandler().logout(request, response, auth); } return "redirect:/login?logout"; } } ``` 在上述示例,我们定义了/login和/logout两个URL,分别用于用户登录和注销。我们使用Spring Security提供的SecurityContextHolder和SecurityContextLogoutHandler来实现注销功能。 5. 配置访问控制: 我们可以通过配置访问规则,以及使用注解或表达式来控制用户访问应用程序的各个部分。以下是一个使用注解控制访问的示例: ``` @Controller @RequestMapping("/user") public class UserController { @PreAuthorize("hasRole('USER')") @GetMapping("/profile") public String profile() { return "profile"; } } ``` 在上述示例,我们在UserController类定义了/profile URL,并使用了@PreAuthorize注解来指定只有拥有USER角色的用户才能访问该URL。 这些示例代码可以帮助您在Spring Boot项目使用Spring Security。请注意,这只是一个简单的概述,实际实现可能会更加复杂。建议您查看Spring Security官方文档,以获取更详细的信息和示例代码。
评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

暮春二十四

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值