37. 如何在Spring Boot中实现OAuth2认证？

PangHu大约 4 分钟

在 Spring Boot 中实现 OAuth2 认证可以通过集成 Spring Security 和 Spring Security OAuth2 来实现。OAuth2 是一个授权框架，它允许第三方应用程序以受限的权限访问用户资源，而不暴露用户的凭据。

Spring Boot 提供了强大的集成支持，允许开发者快速实现 OAuth2 认证。以下是使用 Spring Boot 实现 OAuth2 认证的详细步骤。

1. 引入依赖

要在 Spring Boot 项目中实现 OAuth2 认证，你需要引入必要的依赖。对于 Spring Boot 2.0 及以上的版本，Spring Security 已经将 OAuth2 支持集成在 Spring Security Core 中。

Maven 配置：

<dependencies>
    <!-- Spring Security -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-security</artifactId>
    </dependency>
    
    <!-- OAuth2 Client -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-oauth2-client</artifactId>
    </dependency>

    <!-- OAuth2 Resource Server (如果需要) -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-oauth2-resource-server</artifactId>
    </dependency>
</dependencies>

Gradle 配置：

implementation 'org.springframework.boot:spring-boot-starter-security'
implementation 'org.springframework.boot:spring-boot-starter-oauth2-client'
implementation 'org.springframework.boot:spring-boot-starter-oauth2-resource-server'

2. 配置 OAuth2 客户端

如果你需要集成第三方 OAuth2 提供者（如 Google、GitHub 等），可以在 application.properties 或 application.yml 文件中进行配置。

2.1 配置 OAuth2 客户端属性

application.yml 示例：

spring:
  security:
    oauth2:
      client:
        registration:
          google:
            client-id: your-client-id
            client-secret: your-client-secret
            scope: profile, email
            redirect-uri: "{baseUrl}/login/oauth2/code/{registrationId}"
            client-name: Google
          github:
            client-id: your-client-id
            client-secret: your-client-secret
            scope: read:user
            redirect-uri: "{baseUrl}/login/oauth2/code/{registrationId}"
            client-name: GitHub
        provider:
          google:
            authorization-uri: https://accounts.google.com/o/oauth2/auth
            token-uri: https://oauth2.googleapis.com/token
            user-info-uri: https://www.googleapis.com/oauth2/v3/userinfo
            user-name-attribute: sub
          github:
            authorization-uri: https://github.com/login/oauth/authorize
            token-uri: https://github.com/login/oauth/access_token
            user-info-uri: https://api.github.com/user
            user-name-attribute: id

在这个配置中，client-id 和 client-secret 是从 OAuth2 提供者获取的。Spring Boot 会自动根据这些配置生成 OAuth2 登录 URL。

2.2 配置 Web 安全

接下来，你需要配置 Spring Security 来处理 OAuth2 登录流程。

示例：

import org.springframework.security.config.annotation.web.builders.HttpSecurity;
import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;

@EnableWebSecurity
public class SecurityConfig extends WebSecurityConfigurerAdapter {

    @Override
    protected void configure(HttpSecurity http) throws Exception {
        http
            .authorizeRequests()
                .antMatchers("/", "/login**").permitAll()
                .anyRequest().authenticated()
                .and()
            .oauth2Login(); // 启用OAuth2登录
    }
}

在这个配置中：

authorizeRequests()：定义 URL 访问控制规则。/ 和 /login 页面允许所有用户访问，其他请求需要认证。
oauth2Login()：启用 OAuth2 登录功能。

3. 配置 OAuth2 资源服务器

如果你的应用需要充当 OAuth2 资源服务器（例如，提供受保护的 API），你可以使用以下配置。

3.1 配置资源服务器属性

application.yml 示例：

spring:
  security:
    oauth2:
      resourceserver:
        jwt:
          issuer-uri: https://issuer-uri.example.com

这个配置指向了 JWT 令牌的签发者 URI。

3.2 配置资源服务器的安全配置

示例：

import org.springframework.security.config.annotation.web.builders.HttpSecurity;
import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;

@EnableWebSecurity
public class ResourceServerConfig extends WebSecurityConfigurerAdapter {

    @Override
    protected void configure(HttpSecurity http) throws Exception {
        http
            .authorizeRequests()
                .antMatchers("/api/public").permitAll()
                .anyRequest().authenticated()
                .and()
            .oauth2ResourceServer()
                .jwt(); // 配置JWT解析
    }
}

在这个配置中：

oauth2ResourceServer().jwt()：配置 OAuth2 资源服务器使用 JWT 令牌进行认证。

4. 测试 OAuth2 认证

一旦配置完成，你可以启动 Spring Boot 应用，并尝试通过浏览器访问受保护的资源。Spring Boot 会自动重定向到 OAuth2 提供者的登录页面，并在用户成功登录后返回应用并访问受保护的资源。

5. 处理 OAuth2 登录成功后的操作

你可以通过 OAuth2UserService 来定制 OAuth2 登录成功后的用户信息处理。

示例：

import org.springframework.security.core.authority.SimpleGrantedAuthority;
import org.springframework.security.oauth2.client.userinfo.DefaultOAuth2UserService;
import org.springframework.security.oauth2.client.userinfo.OAuth2UserRequest;
import org.springframework.security.oauth2.core.user.OAuth2User;
import org.springframework.stereotype.Service;

import java.util.Collections;

@Service
public class CustomOAuth2UserService extends DefaultOAuth2UserService {

    @Override
    public OAuth2User loadUser(OAuth2UserRequest userRequest) {
        OAuth2User oAuth2User = super.loadUser(userRequest);

        // 在这里可以处理OAuth2用户信息，并将其转换为你的应用用户对象
        return new CustomOAuth2User(
                Collections.singletonList(new SimpleGrantedAuthority("ROLE_USER")),
                oAuth2User.getAttributes(),
                "name");
    }
}

然后在 SecurityConfig 中使用这个自定义的 OAuth2UserService：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.security.config.annotation.web.builders.HttpSecurity;
import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;

@EnableWebSecurity
public class SecurityConfig extends WebSecurityConfigurerAdapter {

    @Autowired
    private CustomOAuth2UserService customOAuth2UserService;

    @Override
    protected void configure(HttpSecurity http) throws Exception {
        http
            .authorizeRequests()
                .antMatchers("/", "/login**").permitAll()
                .anyRequest().authenticated()
                .and()
            .oauth2Login()
                .userInfoEndpoint()
                .userService(customOAuth2UserService); // 使用自定义OAuth2UserService
    }
}

6. 总结

在 Spring Boot 中实现 OAuth2 认证可以通过以下步骤完成：

引入依赖：引入 spring-boot-starter-security 和 spring-boot-starter-oauth2-client 依赖。
配置 OAuth2 客户端：在 application.properties 或 application.yml 中配置 OAuth2 客户端属性。
配置 Web 安全：通过 WebSecurityConfigurerAdapter 配置 OAuth2 登录。
配置资源服务器（可选）：如果需要，配置 OAuth2 资源服务器来保护 API。
自定义用户服务：使用 OAuth2UserService 来处理登录成功后的用户信息。

通过这些步骤，你可以轻松地在 Spring Boot 应用中集成 OAuth2 认证，支持第三方登录和 API 保护。