Github的OAuth2登录

在 Spring Boot 3.3.5 中使用 Spring Security 接入 GitHub 社区登录的过程大致与之前的版本相似，但需要根据 Spring Boot 3.x 的新特性稍作调整。以下是具体步骤：

1. 在 GitHub 上创建 OAuth 应用

登录 GitHub Developer Settings。
在 OAuth Apps 中点击 New OAuth App。
填写应用信息： - Application name：应用名称。- Homepage URL：应用主页地址。- Authorization callback URL：通常为 http://localhost:8080/login/oauth2/code/github。
创建完成后，记录下 Client ID 和 Client Secret，稍后在 Spring Security 中使用。

2. 配置 Spring Security OAuth2 Client

.xml

配置

<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-oauth2-client</artifactId></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-security</artifactId></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-thymeleaf</artifactId></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><dependency><groupId>org.thymeleaf.extras</groupId><artifactId>thymeleaf-extras-springsecurity6</artifactId></dependency>

在 Spring Boot 3.3.5 中，你可以在

application.yml

或

application.properties

文件中配置 GitHub 的 OAuth Client 信息。

在

application.yml

中配置

spring:security:oauth2:client:registration:github:client-id: YOUR_CLIENT_ID
            client-secret: YOUR_CLIENT_SECRET
            scope: read:user, user:email
            redirect-uri:"{baseUrl}/login/oauth2/code/{registrationId}"authorization-grant-type: authorization_code
            # client-authentication-method: basic            client-authentication-method: client_secret_basic

        provider: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

替换
YOUR_CLIENT_ID
和
YOUR_CLIENT_SECRET
为 GitHub 中生成的 Client ID 和 Client Secret。

3. 配置 Spring Security

在 Spring Boot 3 中，Spring Security 的默认配置会自动适配 OAuth2 登录，但你仍然可以自定义配置。

自定义 Security 配置类

通过

SecurityFilterChain

配置自定义的安全规则和 OAuth2 登录参数。

importorg.springframework.context.annotation.Bean;importorg.springframework.context.annotation.Configuration;importorg.springframework.security.config.annotation.web.builders.HttpSecurity;importorg.springframework.security.web.SecurityFilterChain;@ConfigurationpublicclassSecurityConfig{@BeanpublicSecurityFilterChainsecurityFilterChain(HttpSecurity http)throwsException{
        http
            .authorizeHttpRequests(authorize -> authorize
                .requestMatchers("/","/login").permitAll()// 配置访问权限.anyRequest().authenticated()// 其他请求需要认证).oauth2Login(oauth2 -> oauth2
                .loginPage("/login")// 自定义登录页面.defaultSuccessUrl("/home")// 登录成功后的页面.failureUrl("/login?error=true")// 登录失败跳转页面);
           http.logout(logout -> logout
                .logoutUrl("/logout")// 指定注销路径.logoutSuccessUrl("/")// 注销后跳转到主页.invalidateHttpSession(true).clearAuthentication(true).permitAll()// 允许所有用户访问 /logout);//        http.logout(logout -> logout.logoutSuccessUrl("/"));;return http.build();}}

4. 创建控制器和视图

控制器类

定义一个简单的控制器，用于处理主页、登录页和成功登录后的主页。

importorg.springframework.stereotype.Controller;importorg.springframework.web.bind.annotation.GetMapping;@ControllerpublicclassHomeController{@GetMapping("/")publicStringindex(){return"index";// 首页}@GetMapping("/login")publicStringlogin(){return"login";// 登录页}@GetMapping("/home")publicStringhome(){return"home";// 登录成功后的页面}}

视图文件

在

src/main/resources/templates

目录下创建以下 Thymeleaf 文件。

index.html：主页内容
login.html：自定义登录页面
home.html：登录成功后的页面

index.html

<!DOCTYPEhtml><htmlxmlns:th="http://www.thymeleaf.org"><head><title>Welcome</title></head><body><h1>Welcome to the GitHub Login Demo</h1><ahref="/oauth2/authorization/github">Login with GitHub</a></body></html>

login.html

<!DOCTYPEhtml><htmlxmlns:th="http://www.thymeleaf.org"><head><title>Login</title></head><body><h1>Login</h1><ahref="/oauth2/authorization/github">Login with GitHub</a></body></html>

home.html

<!DOCTYPEhtml><htmlxmlns:th="http://www.thymeleaf.org"><head><title>Home</title></head><body><h1>Welcome, <spanth:text="${name}">User</span>!</h1><p>GitHub Username: <spanth:text="${login}"></span></p><p>Email: <spanth:text="${email}">N/A</span></p><div><imgth:src="${avatar_url}"alt="GitHub Avatar"width="100"height="100"/></div><formth:action="@{/logout}"method="post"><buttontype="submit">Logout</button></form><!--<a th:href="@{/logout}">Logout</a>--></body></html>

5. 测试 GitHub 登录

运行 Spring Boot 应用。
访问 http://localhost:8080，点击 Login with GitHub，会跳转到 GitHub 登录页面。
使用 GitHub 账号登录授权后，应用会跳转到 /home 页面，显示登录成功的信息。

6. 自定义用户信息处理（可选）

如需自定义 GitHub 返回的用户信息，可以实现

OAuth2UserService<OAuth2UserRequest, OAuth2User>

接口，解析 GitHub 返回的用户数据。

自定义

OAuth2UserService

实现

importorg.springframework.security.oauth2.client.userinfo.DefaultOAuth2UserService;importorg.springframework.security.oauth2.client.userinfo.OAuth2UserRequest;importorg.springframework.security.oauth2.core.OAuth2AuthenticationException;importorg.springframework.security.oauth2.core.user.DefaultOAuth2User;importorg.springframework.security.oauth2.core.user.OAuth2User;importorg.springframework.stereotype.Service;importjava.util.Map;@ServicepublicclassCustomOAuth2UserServiceextendsDefaultOAuth2UserService{@OverridepublicOAuth2UserloadUser(OAuth2UserRequest userRequest)throwsOAuth2AuthenticationException{OAuth2User user =super.loadUser(userRequest);// 提取并处理用户信息Map<String,Object> attributes = user.getAttributes();returnnewDefaultOAuth2User(user.getAuthorities(), attributes,"id");// GitHub 用 'id' 作为用户名属性}}

在上面

SecurityConfig

中注入自定义的

OAuth2UserService

：

在 Spring Boot 3.3.5 中使用 Spring Security 接入 GitHub 社区登录并不复杂，主要依赖 OAuth2 协议完成 GitHub 的授权认证，通过简单的配置文件和安全配置即可实现。