Spring Security @PreAuthorize注解分析

更新時間：2024年11月25日 09:52:12 作者：瘋一樣的碼農

本教程介紹了如何使用 Spring 方法級安全和 @PreAuthorize 注解來保護 RestController 方法,通過這些步驟,您可以確保只有具有適當角色或權限的用戶才能訪問特定的 REST API,感興趣的朋友跟隨小編一起看看吧

什么是 @PreAuthorize？

@PreAuthorize 是 Spring Security 的一個注解，用于指定在方法調用前應評估的表達式，以確定調用者是否有權執(zhí)行該方法。

將 Spring Security 添加到項目中

確保您的項目中包含 Spring Security。對于 Maven，將以下依賴項添加到 pom.xml 文件中：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-security</artifactId>
</dependency>

對于 Gradle，將以下內容添加到 build.gradle 文件中：

implementation 'org.springframework.boot:spring-boot-starter-security'

啟用方法級安全

要在 Spring Boot 應用的 Rest Controller 類中對特定方法應用 Spring Security，必須啟用方法級安全。為此，您需要使用 @EnableMethodSecurity 注解。

@Configuration
@EnableMethodSecurity
public class SpringSecurityConfig {
    @Bean
    public SecurityFilterChain securityFilterChain(HttpSecurity http) throws Exception {
        http.csrf(csrf -> csrf.disable())
            .authorizeHttpRequests(authorize -> authorize
                .requestMatchers(HttpMethod.GET, "/api/user").hasRole("USER")
                .requestMatchers(HttpMethod.GET, "/api/admin").hasRole("ADMIN")
                .anyRequest().authenticated()
            )
            .httpBasic(Customizer.withDefaults());
        return http.build();
    }
    @Bean
    public UserDetailsService userDetailsService() {
        UserDetails ramesh = User.builder()
            .username("ramesh")
            .password(passwordEncoder().encode("password"))
            .roles("USER")
            .build();
        UserDetails admin = User.builder()
            .username("admin")
            .password(passwordEncoder().encode("admin"))
            .roles("ADMIN")
            .build();
        return new InMemoryUserDetailsManager(ramesh, admin);
    }
}

@EnableMethodSecurity 是一個 Spring 注解，用于在 Spring 應用中啟用方法級安全。使用此注解后，Spring 將為包含安全方法的類創(chuàng)建代理，并在調用這些方法時攔截以檢查調用者是否具有執(zhí)行方法所需的權限。

此注解與其他注解（如 @PreAuthorize、@PostAuthorize、@Secured 和 @RolesAllowed）一起工作，這些注解用于指定方法的訪問控制規(guī)則。例如，您可以使用 @PreAuthorize 指定只有具有特定角色或權限的用戶才能調用某個方法；或者使用 @PostAuthorize 指定方法只返回調用者有權查看的數(shù)據(jù)。

使用 @PreAuthorize 注解保護 REST API

以下代碼展示了如何使用 Spring Security 進行基于角色的 RESTful 端點授權。

@RestController
@RequestMapping("/api/")
public class AdminController {
    @PreAuthorize("hasRole('ADMIN')")
    @GetMapping("/admin")
    public ResponseEntity<String> helloAdmin() {
        return ResponseEntity.ok("Hello Admin");
    }
    @PreAuthorize("hasRole('USER')")
    @GetMapping("/user")
    public ResponseEntity<String> helloUser() {
        return ResponseEntity.ok("Hello User");
    }
}

@PreAuthorize("hasRole('ADMIN')"): 應用于 helloAdmin() 方法，表示只有具有 ‘ADMIN’ 角色的用戶才能訪問此端點。
@PreAuthorize("hasRole('USER')"): 應用于 helloUser() 方法，限制只有具有 ‘USER’ 角色的用戶才能訪問。