如何在Spring Boot中使用OAuth2认证和授权

更新时间：2023年12月01日 16:33:49 作者：毕设徐师兄

这篇文章主要介绍了如何在Spring Boot中使用OAuth2认证和授权的相关资料,OAuth2.0是一种开放的授权协议,它允许用户授权第三方应用访问其账户(或资源),而无需共享其用户账户凭据,需要的朋友可以参考下

前言

OAuth2 是一种授权协议，用于授权第三方应用程序访问受保护的资源。Spring Security 是一个强大的安全框架，支持 OAuth2 协议。在本文中，我们将介绍如何在 Spring Boot 中使用 Spring Security 实现 OAuth2 认证和授权。

什么是 OAuth2

OAuth2 是一种流行的授权协议，用于授权第三方应用程序访问受保护的资源。OAuth2 协议定义了四种角色：资源所有者、客户端、授权服务器和资源服务器。资源所有者是资源的拥有者，客户端是请求访问资源的应用程序，授权服务器是授权客户端访问资源的服务器，资源服务器是托管受保护资源的服务器。

OAuth2 协议涉及以下几个步骤：

客户端向授权服务器发送请求，请求授权访问某个资源。
授权服务器向资源所有者询问是否授权客户端访问该资源。
如果资源所有者授权客户端访问该资源，则授权服务器向客户端颁发访问令牌。
客户端使用访问令牌向资源服务器请求访问受保护的资源。

OAuth2 协议定义了多种授权方式，包括授权码模式、隐式授权模式、密码模式和客户端凭证模式。每种授权方式都适用于不同的场景。

Spring Security OAuth2

Spring Security 是一个强大的安全框架，支持 OAuth2 协议。Spring Security OAuth2 提供了一组类和接口，用于实现 OAuth2 认证和授权。Spring Security OAuth2 支持多种授权方式，包括授权码模式、隐式授权模式、密码模式和客户端凭证模式。

Spring Boot 中使用 OAuth2

在 Spring Boot 中使用 OAuth2，我们需要添加以下依赖：

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

<dependency>
    <groupId>org.springframework.security.oauth.boot</groupId>
    <artifactId>spring-security-oauth2-autoconfigure</artifactId>
</dependency>

Spring Boot 会自动配置 Spring Security 和 Spring Security OAuth2。

为了使用 OAuth2，我们需要定义以下三个组件：

授权服务器：用于颁发访问令牌。
资源服务器：用于托管受保护的资源。
客户端：用于请求访问受保护的资源。

配置授权服务器

我们可以使用 @EnableAuthorizationServer 注解来启用授权服务器。以下是一个示例配置：

@Configuration
@EnableAuthorizationServer
public class AuthorizationServerConfig extends AuthorizationServerConfigurerAdapter {

    @Autowired
    private AuthenticationManager authenticationManager;

    @Autowired
    private UserDetailsService userDetailsService;

    @Bean
    public TokenStore tokenStore() {
        return new InMemoryTokenStore();
    }

    @Bean
    public DefaultTokenServices tokenServices() {
        DefaultTokenServices tokenServices = new DefaultTokenServices();
        tokenServices.setTokenStore(tokenStore());
        tokenServices.setSupportRefreshToken(true);
        tokenServices.setAccessTokenValiditySeconds(60 * 60);
        tokenServices.setRefreshTokenValiditySeconds(60 * 60 * 24);
        return tokenServices;
    }

    @Override
    public void configure(ClientDetailsServiceConfigurer clients) throws Exception {
        clients.inMemory()
                .withClient("client")
                .secret("secret")
                .authorizedGrantTypes("password", "refresh_token")
                .scopes("read", "write")
                .accessTokenValiditySeconds(60 * 60)
                .refreshTokenValiditySeconds(60 * 60 * 24);
    }

    @Override
    public void configure(AuthorizationServerEndpointsConfigurer endpoints) throws Exception {
        endpoints.tokenStore(tokenStore())
                .tokenServices(tokenServices())
                .authenticationManager(authenticationManager)
                .userDetailsService(userDetailsService);
    }
}

在这个示例中，我们创建了一个 AuthorizationServerConfig 类，并使用 @EnableAuthorizationServer注解来启用授权服务器。我们注入了 AuthenticationManager 和 UserDetailsService 对象，并定义了一个 InMemoryTokenStore 对象来存储访问令牌。

我们使用 configure 方法来配置客户端详细信息。在这个示例中，我们定义了一个名为 “client” 的客户端，使用密码模式和刷新令牌模式来授权访问资源。我们还定义了 read 和 write 两个范围，并设置访问令牌的有效期和刷新令牌的有效期。

我们使用 configure 方法来配置授权服务器的端点。在这个示例中，我们使用 tokenStore、tokenServices、authenticationManager 和 userDetailsService 属性来配置授权服务器的端点。

配置资源服务器

我们可以使用 @EnableResourceServer 注解来启用资源服务器。以下是一个示例配置：

@Configuration
@EnableResourceServer
public class ResourceServerConfig extends ResourceServerConfigurerAdapter {

    @Override
    public void configure(HttpSecurity http) throws Exception {
        http.authorizeRequests()
                .antMatchers("/api/**").authenticated()
                .anyRequest().permitAll();
    }
}

在这个示例中，我们创建了一个 ResourceServerConfig 类，并使用 @EnableResourceServer 注解来启用资源服务器。我们使用 configure 方法来配置资源服务器的安全性。在这个示例中，我们配置了 /api/** 路径需要身份验证，其他路径允许匿名访问。

配置客户端

我们可以使用 @EnableOAuth2Client 注解来启用 OAuth2 客户端。以下是一个示例配置：

@Configuration
@EnableOAuth2Client
public class OAuth2ClientConfig {

    @Bean
    public OAuth2ProtectedResourceDetails clientCredentialsResourceDetails() {
        ClientCredentialsResourceDetails details = new ClientCredentialsResourceDetails();
        details.setAccessTokenUri("http://localhost:8080/oauth/token");
        details.setClientId("client");
        details.setClientSecret("secret");
        details.setGrantType("client_credentials");
        details.setScope(Arrays.asList("read", "write"));
        return details;
    }

    @Bean
    public RestTemplate restTemplate(OAuth2ClientContext oauth2ClientContext) {
        return new OAuth2RestTemplate(clientCredentialsResourceDetails(), oauth2ClientContext);
    }
}

在这个示例中，我们创建了一个 OAuth2ClientConfig 类，并使用 @EnableOAuth2Client 注解来启用 OAuth2 客户端。我们定义了一个 OAuth2ProtectedResourceDetails 对象，用于配置客户端详细信息。我们设置了访问令牌的 URI、客户端 ID、客户端密码、授权类型、范围等属性。

我们还定义了一个 RestTemplate 对象，并使用 OAuth2RestTemplate 类来包装它。OAuth2RestTemplate 类会自动处理 OAuth2 认证，并在每个请求中包含访问令牌。

测试 OAuth2

我们可以使用以下代码测试 OAuth2：

@RestController
@RequestMapping("/api")
public class ApiController {

    @Autowired
    private RestTemplate restTemplate;

    @GetMapping("/hello")
    public String hello() {
        ResponseEntity<String> response = restTemplate.getForEntity("http://localhost:8080/hello", String.class);
        return response.getBody();
    }
}

在这个示例中，我们创建了一个 ApiController 类，并定义了一个 hello 方法。在 hello 方法中，我们使用 RestTemplate 对象发送 GET 请求，并访问受保护的资源。RestTemplate 对象会自动处理 OAuth2 认证。

总结

在本文中，我们介绍了如何在 Spring Boot 中使用 OAuth2。我们使用 Spring Security OAuth2 实现了授权服务器、资源服务器和客户端，并使用 @EnableAuthorizationServer、@EnableResourceServer 和 @EnableOAuth2Client 注解来启用它们。希望本文可以帮助你了解如何在 Spring Boot 中使用 OAuth2。

到此这篇关于如何在Spring Boot中使用OAuth2认证和授权的文章就介绍到这了,更多相关SpringBoot OAuth2认证和授权内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

SpringBoot+Guacamole实现远程桌面教程
文章讨论了坐席远程帮办的技术解决方案,比较了VNC和RDP两种协议的优缺点,最终选择了基于RDP的Guacamole框架,文中详细介绍了Guacamole的部署方法和如何通过Springboot集成,同时也提供了一些关于远程桌面技术的基础知识和实际应用的建议
2025-10-10
Java设计模式之命令模式（Command模式）介绍
这篇文章主要介绍了Java设计模式之命令模式（Command模式）介绍,本文讲解了Command模式的定义、如何使用命令模式等内容,需要的朋友可以参考下
2015-03-03
Java中LocalDate日期格式转换(使用系统时区)
本文主要介绍了Java中LocalDate日期格式转换(使用系统时区)，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2007-02-02
Java Lombok实现手机号码校验的示例代码
手机号码校验通常是系统开发中最基础的功能之一，本文主要介绍了Java Lombok实现手机号码校验的示例代码，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2023-07-07
spring boot security 没有合适的构造器问题
这篇文章主要介绍了spring boot security 没有合适的构造器问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
2023-12-12
Java实现文件分片上传接口的示例代码
这篇文章主要为大家详细介绍了如何利用Java语言实现文件分片上传的功能，文中的示例代码讲解详细，感兴趣的小伙伴可以跟随小编一起了解一下
2022-07-07
SpringBoot配置文件application.properties的使用
这篇文章主要介绍了SpringBoot配置文件application.properties的使用方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
2024-05-05
Java运算符从见过到掌握下
计算机的最基本用途之一就是执行数学运算，作为一门计算机语言，Java也提供了一套丰富的运算符来操纵变量，本篇对大家的学习或工作具有一定的价值，紧接上篇，需要的朋友可以参考下
2021-09-09
idea项目中target文件提示拒绝访问的解决
这篇文章主要介绍了idea项目中target文件提示拒绝访问的解决方案,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
2023-11-11
SpringBoot整合Echarts实现数据大屏
这篇文章给大家介绍了三步实现SpringBoot全局日志记录,整合Echarts实现数据大屏,文中通过代码示例给大家介绍的非常详细,具有一定的参考价值,需要的朋友可以参考下
2024-03-03